Rails (5.x) application template (to customize new or existing app)

rails_template.rb

## To create a new project: `rails new MY_APP -m __FILE__`
## To run on existing projects: `bin/rails app:template LOCATION=__FILE__`

##
# Generate Gemfile.lock
##
bundle install

git add: '.'
git commit: %Q{ -m 'Initial commit: Rails vanilla' }

##
# Staging
##
copy_file 'config/environments/production.rb', 'config/environments/staging.rb'

##
# Database
##
gem 'pg'
gsub_file "Gemfile", /^gem\s+["']sqlite3["'].*$/,''
remove_file 'config/database.yml'
file 'config/database.yml', <<-EOS
default: &default
  adapter: postgresql
  encoding: unicode
  timeout: 5000
  host:     <%= ENV['DB_HOST'] || '127.0.0.1' %>
  username: <%= ENV['DB_USER'] || 'postgres' %>
  password: <%= ENV['DB_PASSWORD'] || 'pass' %>
  pool: <%= ENV["RAILS_MAX_THREADS"] || 5 %>

development:
  <<: *default
  database: FooDevelop

# Warning: The database defined as "test" will be erased and
# re-generated from your development database when you run "rake".
# Do not set this db to the same as development or production.
test:
  <<: *default
  database: FooTest

staging:
  <<: *default
  database: FooStaging

production:
  <<: *default
  database: FooProd
EOS

##
# Rubocop configuration
##
file '.rubocop.yml', <<-EOS
AllCops:
  Exclude:
    - 'db/schema.rb' # auto-generated
    - 'db/migrate/*' # mostly auto-generated
    - 'bin/*' # auto-generated
    - 'vendor/**' # gems location in CircleCI
    - 'vendor/**/**' # gems location in CircleCI

Bundler/OrderedGems:
  Enabled: false

Style/Documentation:
  Enabled: false

Style/FrozenStringLiteralComment:
  Enabled: false

# Single or double quote string: no noticeable performance change
Style/StringLiterals:
  Enabled: false

Style/SymbolArray:
  Enabled: false

Style/EmptyMethod:
  Enabled: false

Metrics/LineLength:
  Max: 120

Style/ClassAndModuleChildren:
  Enabled: false

Style/RedundantSelf:
  Enabled: false

Style/SymbolProc:
  Exclude:
    - 'test/factories/**'

Metrics/MethodLength:
  Exclude:
    - 'app/models/ability.rb'

Style/BlockComments:
  Exclude:
    - 'spec/spec_helper.rb'

Metrics/ClassLength:
  Exclude:
    - 'test/**/**' # tests are never too long
    - 'spec/**/**' # tests are never too long

EOS


file 'app/models/ability.rb', <<-EOS
class Ability
  include CanCan::Ability

  def initialize(user)
    # can :manager if user.admin?
  end
end
EOS

file 'config/newrelic.yml', <<-EOS
common: &default_settings
  # Required license key associated with your New Relic account.
  license_key: ''
  # agent_enabled: false
  # Logging level for log/newrelic_agent.log
  log_level: info

test:
  <<: *default_settings
  # It doesn't make sense to report to New Relic from automated test runs.
  monitor_mode: false

development:
  <<: *default_settings
  app_name: My Application (Development)

staging:
  <<: *default_settings
  app_name: My Application (Staging)

production:
  <<: *default_settings
  app_name: My Application (Production)
EOS

file '.circleci/config.yml', <<-EOS
version: 2
jobs:
  build:
    docker:
       - image: circleci/ruby:2.6.0-node-browsers
         environment:
           DB_HOST: 127.0.0.1
           RAILS_ENV: test

       - image: circleci/postgres:10.5-alpine-postgis-ram
         environment:
           - POSTGRES_PASSWORD=pass
           - POSTGRES_USER=postgres

    working_directory: ~/repo

    steps:
      - checkout

      # Download and cache dependencies
      - restore_cache:
          keys:
          - v1-dependencies-{{ checksum "Gemfile.lock" }}
          # fallback to using the latest cache if no exact match is found
          - v1-dependencies-

      # Don't install gems' documentation
      - run: "echo 'gem: --no-rdoc --no-ri' >> ~/.gemrc"

      - run:
          name: install dependencies
          command: |
            bundle install --jobs=4 --retry=3 --path vendor/bundle
      # - run:
      #     name: install js dependencies
      #     command: |
      #       yarn install

      - save_cache:
          paths:
            - ./vendor/bundle
            - public/assets
            - tmp/cache/assets/sprockets
          key: v1-dependencies-{{ checksum "Gemfile.lock" }}

      # Database setup
      - run: bundle exec rake db:setup

      # run tests!
      - run:
          name: Ruby tests
          command: bundle exec rspec

      - run:
          name: Test missing translations
          command: bundle exec i18n-tasks missing

      - run:
          name: Test unused translations
          command: bundle exec i18n-tasks unused

      - run:
          name: Test translations that have the same value
          command: bundle exec i18n-tasks eq-base

      - run:
          name: Test Ruby syntax
          command: bundle exec rubocop

      - run:
          name: Static analysis security vulnerability
          command: bundle exec brakeman

      # - run:
      #     name: run javascript tests
      #     command: yarn test

      # collect reports
      - store_test_results:
          path: /tmp/test-results
      - store_artifacts:
          path: /tmp/test-results
          destination: test-results
EOS

file 'config/initialize/devise.rb', <<-EOS
# frozen_string_literal: true

# Use this hook to configure devise mailer, warden hooks and so forth.
# Many of these configuration options can be set straight in your model.
Devise.setup do |config|
  # The secret key used by Devise. Devise uses this key to generate
  # random tokens. Changing this key will render invalid all existing
  # confirmation, reset password and unlock tokens in the database.
  # Devise will use the `secret_key_base` as its `secret_key`
  # by default. You can change it below and use your own secret key.
  # config.secret_key = '...'

  # ==> Controller configuration
  # Configure the parent class to the devise controllers.
  # config.parent_controller = 'DeviseController'

  # ==> Mailer Configuration
  # Configure the e-mail address which will be shown in Devise::Mailer,
  # note that it will be overwritten if you use your own mailer class
  # with default "from" parameter.
  config.mailer_sender = '[email protected]'

  # Configure the class responsible to send e-mails.
  # config.mailer = 'Devise::Mailer'

  # Configure the parent class responsible to send e-mails.
  # config.parent_mailer = 'ActionMailer::Base'

  # ==> ORM configuration
  # Load and configure the ORM. Supports :active_record (default) and
  # :mongoid (bson_ext recommended) by default. Other ORMs may be
  # available as additional gems.
  require 'devise/orm/active_record'

  # ==> Configuration for any authentication mechanism
  # Configure which keys are used when authenticating a user. The default is
  # just :email. You can configure it to use [:username, :subdomain], so for
  # authenticating a user, both parameters are required. Remember that those
  # parameters are used only when authenticating and not when retrieving from
  # session. If you need permissions, you should implement that in a before filter.
  # You can also supply a hash where the value is a boolean determining whether
  # or not authentication should be aborted when the value is not present.
  # config.authentication_keys = [:email]

  # Configure parameters from the request object used for authentication. Each entry
  # given should be a request method and it will automatically be passed to the
  # find_for_authentication method and considered in your model lookup. For instance,
  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
  # The same considerations mentioned for authentication_keys also apply to request_keys.
  # config.request_keys = []

  # Configure which authentication keys should be case-insensitive.
  # These keys will be downcased upon creating or modifying a user and when used
  # to authenticate or find a user. Default is :email.
  config.case_insensitive_keys = [:email]

  # Configure which authentication keys should have whitespace stripped.
  # These keys will have whitespace before and after removed upon creating or
  # modifying a user and when used to authenticate or find a user. Default is :email.
  config.strip_whitespace_keys = [:email]

  # Tell if authentication through request.params is enabled. True by default.
  # It can be set to an array that will enable params authentication only for the
  # given strategies, for example, `config.params_authenticatable = [:database]` will
  # enable it only for database (email + password) authentication.
  # config.params_authenticatable = true

  # Tell if authentication through HTTP Auth is enabled. False by default.
  # It can be set to an array that will enable http authentication only for the
  # given strategies, for example, `config.http_authenticatable = [:database]` will
  # enable it only for database authentication. The supported strategies are:
  # :database      = Support basic authentication with authentication key + password
  # config.http_authenticatable = false

  # If 401 status code should be returned for AJAX requests. True by default.
  # config.http_authenticatable_on_xhr = true

  # The realm used in Http Basic Authentication. 'Application' by default.
  # config.http_authentication_realm = 'Application'

  # It will change confirmation, password recovery and other workflows
  # to behave the same regardless if the e-mail provided was right or wrong.
  # Does not affect registerable.
  # config.paranoid = true

  # By default Devise will store the user in session. You can skip storage for
  # particular strategies by setting this option.
  # Notice that if you are skipping storage for all authentication paths, you
  # may want to disable generating routes to Devise's sessions controller by
  # passing skip: :sessions to `devise_for` in your config/routes.rb
  config.skip_session_storage = [:http_auth]

  # By default, Devise cleans up the CSRF token on authentication to
  # avoid CSRF token fixation attacks. This means that, when using AJAX
  # requests for sign in and sign up, you need to get a new CSRF token
  # from the server. You can disable this option at your own risk.
  # config.clean_up_csrf_token_on_authentication = true

  # When false, Devise will not attempt to reload routes on eager load.
  # This can reduce the time taken to boot the app but if your application
  # requires the Devise mappings to be loaded during boot time the application
  # won't boot properly.
  # config.reload_routes = true

  # ==> Configuration for :database_authenticatable
  # For bcrypt, this is the cost for hashing the password and defaults to 11. If
  # using other algorithms, it sets how many times you want the password to be hashed.
  #
  # Limiting the stretches to just one in testing will increase the performance of
  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
  # a value less than 10 in other environments. Note that, for bcrypt (the default
  # algorithm), the cost increases exponentially with the number of stretches (e.g.
  # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
  config.stretches = Rails.env.test? ? 1 : 11

  #### TODO: change the pepper hash (generate a new one with `rails secret`)
  # Set up a pepper to generate the hashed password.
  # config.pepper = '...'

  # Send a notification to the original email when the user's email is changed.
  # config.send_email_changed_notification = false

  # Send a notification email when the user's password is changed.
  # config.send_password_change_notification = false

  # ==> Configuration for :confirmable
  # A period that the user is allowed to access the website even without
  # confirming their account. For instance, if set to 2.days, the user will be
  # able to access the website for two days without confirming their account,
  # access will be blocked just in the third day. Default is 0.days, meaning
  # the user cannot access the website without confirming their account.
  # config.allow_unconfirmed_access_for = 2.days

  # A period that the user is allowed to confirm their account before their
  # token becomes invalid. For example, if set to 3.days, the user can confirm
  # their account within 3 days after the mail was sent, but on the fourth day
  # their account can't be confirmed with the token any more.
  # Default is nil, meaning there is no restriction on how long a user can take
  # before confirming their account.
  # config.confirm_within = 3.days

  # If true, requires any email changes to be confirmed (exactly the same way as
  # initial account confirmation) to be applied. Requires additional unconfirmed_email
  # db field (see migrations). Until confirmed, new email is stored in
  # unconfirmed_email column, and copied to email column on successful confirmation.
  config.reconfirmable = true

  # Defines which key will be used when confirming an account
  # config.confirmation_keys = [:email]

  # ==> Configuration for :rememberable
  # The time the user will be remembered without asking for credentials again.
  # config.remember_for = 2.weeks

  # Invalidates all the remember me tokens when the user signs out.
  config.expire_all_remember_me_on_sign_out = true

  # If true, extends the user's remember period when remembered via cookie.
  # config.extend_remember_period = false

  # Options to be passed to the created cookie. For instance, you can set
  # secure: true in order to force SSL only cookies.
  # config.rememberable_options = {}

  # ==> Configuration for :validatable
  # Range for password length.
  config.password_length = 8..128

  # Email regex used to validate email formats. It simply asserts that
  # one (and only one) @ exists in the given string. This is mainly
  # to give user feedback and not to assert the e-mail validity.
  config.email_regexp = /\A[^@\s]+@[^@\s]+\z/

  # ==> Configuration for :timeoutable
  # The time you want to timeout the user session without activity. After this
  # time the user will be asked for credentials again. Default is 30 minutes.
  # config.timeout_in = 30.minutes

  # ==> Configuration for :lockable
  # Defines which strategy will be used to lock an account.
  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
  # :none            = No lock strategy. You should handle locking by yourself.
  # config.lock_strategy = :failed_attempts

  # Defines which key will be used when locking and unlocking an account
  # config.unlock_keys = [:email]

  # Defines which strategy will be used to unlock an account.
  # :email = Sends an unlock link to the user email
  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
  # :both  = Enables both strategies
  # :none  = No unlock strategy. You should handle unlocking by yourself.
  # config.unlock_strategy = :both

  # Number of authentication tries before locking an account if lock_strategy
  # is failed attempts.
  # config.maximum_attempts = 20

  # Time interval to unlock the account if :time is enabled as unlock_strategy.
  # config.unlock_in = 1.hour

  # Warn on the last attempt before the account is locked.
  # config.last_attempt_warning = true

  # ==> Configuration for :recoverable
  #
  # Defines which key will be used when recovering the password for an account
  # config.reset_password_keys = [:email]

  # Time interval you can reset your password with a reset password key.
  # Don't put a too small interval or your users won't have the time to
  # change their passwords.
  config.reset_password_within = 6.hours

  # When set to false, does not sign a user in automatically after their password is
  # reset. Defaults to true, so a user is signed in automatically after a reset.
  # config.sign_in_after_reset_password = true

  # ==> Configuration for :encryptable
  # Allow you to use another hashing or encryption algorithm besides bcrypt (default).
  # You can use :sha1, :sha512 or algorithms from others authentication tools as
  # :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
  # for default behavior) and :restful_authentication_sha1 (then you should set
  # stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
  #
  # Require the `devise-encryptable` gem when using anything other than bcrypt
  # config.encryptor = :sha512

  # ==> Scopes configuration
  # Turn scoped views on. Before rendering "sessions/new", it will first check for
  # "users/sessions/new". It's turned off by default because it's slower if you
  # are using only default views.
  # config.scoped_views = false

  # Configure the default scope given to Warden. By default it's the first
  # devise role declared in your routes (usually :user).
  # config.default_scope = :user

  # Set this configuration to false if you want /users/sign_out to sign out
  # only the current scope. By default, Devise signs out all scopes.
  # config.sign_out_all_scopes = true

  # ==> Navigation configuration
  # Lists the formats that should be treated as navigational. Formats like
  # :html, should redirect to the sign in page when the user does not have
  # access, but formats like :xml or :json, should return 401.
  #
  # If you have any extra navigational formats, like :iphone or :mobile, you
  # should add them to the navigational formats lists.
  #
  # The "*/*" below is required to match Internet Explorer requests.
  # config.navigational_formats = ['*/*', :html]

  # The default HTTP method used to sign out a resource. Default is :delete.
  config.sign_out_via = :delete

  # ==> OmniAuth
  # Add a new OmniAuth provider. Check the wiki for more information on setting
  # up on your models and hooks.
  # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'

  # ==> Warden configuration
  # If you want to use other strategies, that are not supported by Devise, or
  # change the failure app, you can configure them inside the config.warden block.
  #
  # config.warden do |manager|
  #   manager.intercept_401 = false
  #   manager.default_strategies(scope: :user).unshift :some_external_strategy
  # end

  # ==> Mountable engine configurations
  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
  # is mountable, there are some extra configurations to be taken into account.
  # The following options are available, assuming the engine is mounted as:
  #
  #     mount MyEngine, at: '/my_engine'
  #
  # The router that invoked `devise_for`, in the example above, would be:
  # config.router_name = :my_engine
  #
  # When using OmniAuth, Devise cannot automatically set OmniAuth path,
  # so you need to do it manually. For the users scope, it would be:
  # config.omniauth_path_prefix = '/my_engine/users/auth'

  # ==> Turbolinks configuration
  # If your app is using Turbolinks, Turbolinks::Controller needs to be included to make redirection work correctly:
  #
  # ActiveSupport.on_load(:devise_failure_app) do
  #   include Turbolinks::Controller
  # end
end
EOS

# Log in page with Bootstrap style (and don't enforce the email format in the HTML)
file 'app/views/devise/sessions/new.html.slim', <<-EOS
.row

  .col-md-6.offset-md-3.mt-3.mb-5

    h2.mb-5 = t('.sign_in')

    = form_for(resource, as: resource_name, url: session_path(resource_name), html: {class: 'form-signin'}) do |f|
      .form-group
        = f.text_field :email, autofocus: true, placeholder: t('activerecord.attributes.user.email'), class: 'form-control'

      .form-group
        = f.password_field :password, autocomplete: "current-password",  placeholder: t('activerecord.attributes.user.password'), class: 'form-control'

      - if devise_mapping.rememberable?
        .form-group.form-check
          = f.check_box :remember_me, class: 'form-check-input'
          = f.label :remember_me, class: 'form-check-label'

      = f.submit t('.sign_in'), class: 'btn btn-primary float-right'

    = render "devise/shared/links"
EOS

remove_file 'app/views/layouts/application.html.erb'
file 'app/views/layouts/application.html.slim', <<-EOS
doctype html
html
  head
    meta content=("text/html; charset=UTF-8") http-equiv="Content-Type" /
    meta charset="utf-8" /
    title = t('html_application_title')
    = csrf_meta_tags
    = csp_meta_tag
    = stylesheet_link_tag    'application', media: 'all'
    = javascript_include_tag 'application'

  body.bg-light
    .container
      == render(partial: 'shared/navbar')
      .row
        .col-12
          - if notice
            .alert.alert-primary.mt-3.mb-0 = notice
          - if alert
            .alert.alert-danger.mt-3.mb-0 = alert

      .row
        .col-12
          .shadow-sm.p-3.my-3.bg-white.rounded
            = yield
EOS


file 'app/views/shared/_navbar.html.slim', <<-EOS
nav.navbar.navbar-expand-lg.navbar-light.bg-white.shadow-sm.mt-2

  a.navbar-brand href=root_path = t('navbar.project_name')

  button.navbar-toggler data-target="#navbar-nav" data-toggle="collapse" type="button"
    span.navbar-toggler-icon

  #navbar-nav.collapse.navbar-collapse.navbar-nav
    ul.navbar-nav.mr-auto
      li.nav-item
        a.nav-link href=root_path = t('navbar.homepage')
      / - if can?(:index, Fund)
      /   li.nav-item
      /     = link_to(t('navbar.funds'), funds_path, class: 'nav-link')

      - if current_user
        = link_to(t('navbar.logout'), destroy_user_session_path, method: :delete, class: 'nav-link')
      - else
        = link_to(t('navbar.login'), new_user_session_path, class: 'nav-link')
EOS

remove_file 'config/locales/en.yml'
file 'config/locales/en.yml', <<-EOS
---
en:
  html_application_title: My Application

  navbar:
    project_name: My App
    login: Log in
    logout: Logout
EOS

file 'config/locales/ja.yml', <<-EOS
---
ja:
  html_application_title: マイアップリケシオン

  navbar:
    project_name: マイアップ
    login: ログイン
    logout: ログアウト
EOS

remove_file('app/assets/stylesheets/application.css')
file 'app/assets/stylesheets/application.scss', <<-EOS
/*
 * Don't use Sprockets to import files because it isn't possible to extend class
 * Bootstrap have most (all?) css class needed. Dig in!
 */
@import 'bootstrap'; // Bootstrap v4.x
EOS

remove_file('app/assets/javascripts/application.js')
file 'app/assets/javascripts/application.js', <<-EOS
//= require bootstrap.native/bootstrap-native-v4
//= require rails-ujs
//= require activestorage
//= require turbolinks
//= require_tree .
EOS

remove_file('app/controllers/application_controller.rb')
file 'app/controllers/application_controller.rb', <<-EOS
class ApplicationController < ActionController::Base
  protect_from_forgery
  include HttpAcceptLanguage::AutoLocale
  check_authorization unless: :devise_controller?

  rescue_from CanCan::AccessDenied, with: :access_denied unless Rails.env.development?

  private

  def access_denied(exception)
    if current_user.nil?
      session[:next] = request.fullpath
      redirect_to new_user_session_url, alert: t('user.login_needed')
    else
      respond_to do |format|
        format.json { head :forbidden, content_type: 'text/html' }
        # format.html { render file: "#{Rails.root}/public/403.html", status: :forbidden, notice: exception.message }
        format.html { redirect_back(fallback_location: main_app.root_url, notice: exception.message) }
        format.js   { head :forbidden, content_type: 'text/html' }
      end
    end
  end
end
EOS


file '.editorconfig', <<-EOS
root = true

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

[*.md]
trim_trailing_whitespace = false

[.ruby-version]
insert_final_newline = false
EOS

file '.ruby-version', '2.6.2'
run 'echo ".DS_Store" >> .gitignore'
file '.env.example', ''
run 'echo ".env" >> .gitignore'

##
# Rails configuration
##
environment 'config.action_mailer.delivery_method = :letter_opener', env: 'development'
environment 'config.action_mailer.perform_deliveries = true', env: 'development'
environment 'config.consider_all_requests_local = true', env: 'development'
environment 'config.i18n.fallbacks = [:ja, :en]'
environment <<-EOS
config.generators do |g|
  g.test_framework :rspec
  g.integration_tool :rspec
end

config.generators do |generator|
  generator.orm :active_record, primary_key_type: :uuid
end
EOS


##
# Gems
##
gsub_file "Gemfile", /^\# Use CoffeeScript for .coffee assets and views.*$/,''
gsub_file "Gemfile", /^gem\s+["']coffee-rails["'].*$/,''
gem 'devise', '~> 4.5'
gem 'devise-i18n', '~> 1.7'
gem 'slim-rails', '~> 3.1'
gem 'cancancan', '~> 2.3' # Authenrization
gem 'http_accept_language', '~> 2.1' # Use the "Accept-Language" HTTP header for locale
gem 'rails-i18n', '~> 5.1'
gem 'bootstrap', '~> 4.1'
gem 'rails-assets-bootstrap.native', source: 'https://rails-assets.org'

gem_group :development do
  gem 'letter_opener'
  gem 'better_errors'
  gem 'binding_of_caller'
end

gem_group :development, :test do
  gem 'pry-rails'
  gem 'rubocop'
  gem 'brakeman'
  gem 'i18n-tasks'
  gem 'dotenv-rails'
end

gem_group :test do
  gem 'rspec-rails', '~> 3.8'
end

group :production, :staging do
  gem 'newrelic_rpm', '~> 5.7', '>= 5.7.0.350'
end

run <<-EOS
echo "ruby '2.6.0'" >> Gemfile
EOS

bundle install

run('git rm -r test')
generate('rspec:install')
file 'spec/fixtures/.keep', ''
run('echo "config.global_fixtures = :all # TODO move into the config block" >> spec/rails_helper.rb')
run('echo "require \'bcrypt\' # For password in fixtures" >> spec/rails_helper.rb')

generate(:controller, 'home', 'index')
route "root to: 'home#index'"

remove_file('app/controllers/home_controller.rb')
file 'app/controllers/home_controller.rb', <<-EOS
class HomeController < ApplicationController
  skip_authorization_check only: :index

  def index
  end
end
EOS


run('git add .')

##
# Instructions
##
puts <<-EOS


##
# Instructions
##
- To generate devise user: `rails generate devise user`
- Change the location of new gems and configuration (definatly in non-normal places
- __COMMIT NOW__ the current state of the code
- Add a favicon.ico in the public folder

EOS