Rails Template

Tempered to my personal preferences.

How to use this template

Verify that you have the most recent stable Ruby version installed, and are using it
Create a directory for your rails app and move into it
Run the following commands:

(Note that you may also use --webpack=react or --webpack=stimulus during the rails new command if you already know you will be using one of these frameworks)

gem install rails --no-document
gem update bundler
rails new . -T --skip-coffee --webpack --database=postgresql -m https://raw.githubusercontent.com/JeremiahChurch/jc-rails-template/master/rails-kickoff-template.rb

Clean up your Gemfile

Reference: Step By Step Process

This section explains the changes made by the template

Rails Setup of RSpec

Add gem 'rspec-rails' to the development and test group of Gemfile

bundle install
rails generate rspec:install
bundle binstubs rspec-core

Configuration Files

config/database.yml

default: &default
  ...
  reaping_frequency: <%= ENV['DB_REAP_FREQ'] || 10 %> # https://devcenter.heroku.com/articles/concurrency-and-database-connections#bad-connections
  connect_timeout: 1 # raises PG::ConnectionBad
  checkout_timeout: 1 # raises ActiveRecord::ConnectionTimeoutError
  variables:
    statement_timeout: 10000 # manually override on a per-query basis

config/puma.rb

# Uncomment this:
workers ENV.fetch("WEB_CONCURRENCY") { 2 }

# and this:
preload_app!

# Note that the on_worker_boot suggestions in heroku are outdated for Rails 5.2+!

config/environments/development.rb

  config.after_initialize do
    Bullet.enable = true
    # Bullet.sentry = true
    Bullet.alert = false
    Bullet.bullet_logger = true
    Bullet.console = true
    # Bullet.growl = true
    Bullet.rails_logger = true
    # Bullet.add_footer = true
    # Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
    # Bullet.stacktrace_excludes = [ 'their_gem', 'their_middleware', ['my_file.rb', 'my_method'], ['my_file.rb', 16..20] ]
    # Bullet.slack = { webhook_url: 'http://some.slack.url', channel: '#default', username: 'notifier' }
    # Bullet.raise = true
  end

Procfile

web: bundle exec puma -C config/puma.rb
release: bundle exec rake db:migrate

.editorconfig

# This file is for unifying the coding style for different editors and IDEs
# editorconfig.org

root = true

[*]
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2
end_of_line = lf

Add to .gitignore:

spec/examples.txt

# dotenv
# TODO Comment out this rule if environment variables can be committed
.env
.env.development.local
.env.local
.env.test.local

Sidekiq Setup

Add the sidekiq gem.

To the Procfile, add:

worker: RAILS_MAX_THREADS=${SIDEKIQ_CONCURRENCY:-25} bundle exec sidekiq -t 25

Update config/application.rb like this:

class Application < Rails::Application
  # ...
  config.active_job.queue_adapter = :sidekiq
end

Email Setup

Setup sendgrid mailer defaults

Styleguide/Linter Setup

Setup the RuboCop and ESLint configuration files from the template. install the hooks then execute bundle exec rubocop -a to configure the project with the configured style.

Testing Setup

Browser Testing

bundle add "capybara" --group "test"
bundle add "capybara-selenium" --group "test"

edit spec/support/chromedriver.rb

require "selenium/webdriver"

Capybara.register_driver :chrome do |app|
  Capybara::Selenium::Driver.new(app, browser: :chrome)
end

Capybara.register_driver :headless_chrome do |app|
  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
    chromeOptions: { args: %w(headless disable-gpu) },
  )

  Capybara::Selenium::Driver.new app,
    browser: :chrome,
    desired_capabilities: capabilities
end

Capybara.javascript_driver = :headless_chrome

add to spec/rails_helper.rb

require 'capybara/rails'

FactoryBot

bundle add "factory_bot_rails" --group "development, test"

add to spec/rails_helper.rb under RSpec.configure:

config.include FactoryBot::Syntax::Methods

add to spec/lint_spec.rb

# consider switching to rake task in the future: https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#linting-factories
require 'rails_helper'
RSpec.describe "Factories" do
  it "lints successfully" do
    FactoryBot.lint
  end
end

Other RSpec setup

In spec/spec_helper.rb, remove the =begin and =end lines to use the RSpec suggested defaults. Additionally, uncomment the line in spec/rails_helper.rb that automatically loads all of the ruby files in spec/support

add the shoulda matchers to the support folder

Additional minor gems

Slim

gem install html2slim --no-document
erb2slim app/views/ -d
gem uninstall html2slim -x

Newrelic

bundle add "newrelic-rpm"

configure app/controllers/application_controller.rb

  before_action :new_relic_user_info
  
  private

  def new_relic_user_info
    return unless current_user # just capturing info for logged in users right now

    ::NewRelic::Agent.add_custom_attributes(
      user_id: current_user.id,
      user_email: current_user.email
      # true_user_name: true_user&.id != current_user&.id ? true_user.name : nil
    )
  end

Other gems

bundle add dotenv-rails --group "development, test"
bundle add bullet --group "development"
bundle add rack-timeout --group "production"
simplecov
oj
discard
pg_hero
blazer
sendgrid_mailer
slim
annotate
simpleform

Setup a README

Copy and update templates/README-template.md to README.md

to test

ruby test/test_*.rb

JeremiahChurch / jc-rails-template