underlay 1.50.1

data/lib/underlay/adapters/heroku.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Underlay
+  module Adapters
+    class Heroku
+      def initialize(app_builder)
+        @app_builder = app_builder
+      end
+
+      def set_heroku_remotes
+        remotes = <<~SHELL
+          #{command_to_join_heroku_app('staging')}
+          #{command_to_join_heroku_app('production')}
+
+          git config heroku.remote staging
+        SHELL
+
+        app_builder.append_file 'bin/setup', remotes
+      end
+
+      def create_staging_heroku_app(flags)
+        app_name = heroku_app_name_for('staging')
+
+        run_toolbelt_command "create #{app_name} #{flags}", 'staging'
+      end
+
+      def create_production_heroku_app(flags)
+        app_name = heroku_app_name_for('production')
+
+        run_toolbelt_command "create #{app_name} #{flags}", 'production'
+      end
+
+      def set_heroku_rails_secrets
+        %w[staging production].each do |environment|
+          run_toolbelt_command(
+            "config:add SECRET_KEY_BASE=#{generate_secret}",
+            environment
+          )
+        end
+      end
+
+      def set_heroku_backup_schedule
+        %w[staging production].each do |environment|
+          run_toolbelt_command(
+            "pg:backups:schedule DATABASE_URL --at '10:00 UTC'",
+            environment
+          )
+        end
+      end
+
+      def create_review_apps_setup_script
+        app_builder.template(
+          'bin_setup_review_app.erb',
+          'bin/setup_review_app',
+          force: true
+        )
+        app_builder.run 'chmod a+x bin/setup_review_app'
+      end
+
+      def create_heroku_application_manifest_file
+        app_builder.template 'app.json.erb', 'app.json'
+      end
+
+      def create_heroku_pipeline
+        pipelines_plugin = `heroku help | grep pipelines`
+        if pipelines_plugin.empty?
+          puts(
+            'You need heroku pipelines plugin.' \
+            'Run: brew upgrade heroku-toolbelt'
+          )
+          exit 1
+        end
+
+        run_toolbelt_command(
+          "pipelines:create #{heroku_app_name} \
+            -a #{heroku_app_name}-staging --stage staging",
+          'staging'
+        )
+
+        run_toolbelt_command(
+          "pipelines:add #{heroku_app_name} \
+            -a #{heroku_app_name}-production --stage production",
+          'production'
+        )
+      end
+
+      def set_heroku_application_host
+        %w[staging production].each do |environment|
+          run_toolbelt_command(
+            "config:add APPLICATION_HOST=#{heroku_app_name}-#{environment}"\
+            '.herokuapp.com',
+            environment
+          )
+        end
+      end
+
+      private
+
+      attr_reader :app_builder
+
+      def command_to_join_heroku_app(environment)
+        heroku_app_name = heroku_app_name_for(environment)
+        <<~SHELL
+
+          if heroku join --app #{heroku_app_name} > /dev/null 2>&1; then
+            git remote add #{environment} git@heroku.com:#{heroku_app_name}.git || true
+            printf 'You are a collaborator on the "#{heroku_app_name}" Heroku app\n'
+          else
+            printf 'Ask for access to the "#{heroku_app_name}" Heroku app\n'
+          fi
+        SHELL
+      end
+
+      def heroku_app_name
+        app_builder.app_name.dasherize
+      end
+
+      def heroku_app_name_for(environment)
+        "#{heroku_app_name}-#{environment}"
+      end
+
+      def generate_secret
+        SecureRandom.hex(64)
+      end
+
+      def run_toolbelt_command(command, environment)
+        app_builder.run(
+          "heroku #{command} --remote #{environment}"
+        )
+      end
+    end
+  end
+end

data/lib/underlay/app_builder.rb

@@ -0,0 +1,556 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Underlay
+  class AppBuilder < Rails::AppBuilder
+    include Underlay::Actions
+    extend Forwardable
+
+    def_delegators(
+      :heroku_adapter,
+      :create_heroku_application_manifest_file,
+      :create_heroku_pipeline,
+      :create_production_heroku_app,
+      :create_review_apps_setup_script,
+      :create_staging_heroku_app,
+      :set_heroku_application_host,
+      :set_heroku_backup_schedule,
+      :set_heroku_rails_secrets,
+      :set_heroku_remotes
+    )
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def gitignore
+      copy_file 'dvelp_gitignore', '.gitignore'
+    end
+
+    def gemfile
+      template 'Gemfile.erb', 'Gemfile'
+    end
+
+    def setup_rack_mini_profiler
+      copy_file(
+        'rack_mini_profiler.rb',
+        'config/initializers/rack_mini_profiler.rb'
+      )
+    end
+
+    def raise_on_missing_assets_in_test
+      configure_environment 'test', 'config.assets.raise_runtime_errors = true'
+    end
+
+    def raise_on_delivery_errors
+      replace_in_file 'config/environments/development.rb',
+        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+    end
+
+    def set_test_delivery_method
+      inject_into_file(
+        'config/environments/development.rb',
+        "\n  config.action_mailer.delivery_method = :file",
+        after: 'config.action_mailer.raise_delivery_errors = true'
+      )
+    end
+
+    def add_bullet_gem_configuration
+      config = <<-RUBY
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+  end
+
+      RUBY
+
+      inject_into_file(
+        'config/environments/development.rb',
+        config,
+        after: "config.action_mailer.raise_delivery_errors = true\n"
+      )
+    end
+
+    def raise_on_unpermitted_parameters
+      config = <<-RUBY
+    config.action_controller.action_on_unpermitted_parameters = :raise
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def configure_quiet_assets
+      config = <<-RUBY
+    config.assets.quiet = true
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def provide_setup_script
+      template 'bin_setup', 'bin/setup', force: true
+      run 'chmod a+x bin/setup'
+    end
+
+    def provide_rake_script
+      template 'bin_rake', 'bin/rake', force: true
+      run 'chmod a+x bin/rake'
+    end
+
+    def provide_update_script
+      template 'bin_setup', 'bin/update', force: true
+      run 'chmod a+x bin/update'
+    end
+
+    def provide_dev_prime_task
+      copy_file 'dev.rake', 'lib/tasks/dev.rake'
+    end
+
+    def configure_generators
+      config = <<-RUBY
+
+    config.generators do |generate|
+      generate.helper false
+      generate.javascripts false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def set_up_factory_bot_for_rspec
+      copy_file 'factory_bot_rspec.rb', 'spec/support/factory_bot.rb'
+    end
+
+    def generate_factories_file
+      copy_file 'factories.rb', 'spec/factories.rb'
+    end
+
+    def configure_smtp
+      copy_file 'smtp.rb', 'config/smtp.rb'
+
+      prepend_file 'config/environments/production.rb',
+        %{require Rails.root.join('config', 'smtp')\n}
+
+      config = <<-RUBY
+
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = SMTP_SETTINGS
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        after: 'config.action_mailer.raise_delivery_errors = false'
+    end
+
+    def enable_rack_canonical_host
+      config = <<-RUBY
+
+  if ENV.fetch("HEROKU_APP_NAME", "").include?("staging-pr-")
+    ENV["APPLICATION_HOST"] = ENV["HEROKU_APP_NAME"] + ".herokuapp.com"
+  end
+
+  config.middleware.use Rack::CanonicalHost, ENV.fetch("APPLICATION_HOST")
+      RUBY
+
+      configure_environment 'production', config
+    end
+
+    def enable_rack_deflater
+      configure_environment 'production', 'config.middleware.use Rack::Deflater'
+    end
+
+    def setup_asset_host
+      replace_in_file 'config/environments/production.rb',
+        "# config.action_controller.asset_host = 'http://assets.example.com'",
+        'config.action_controller.asset_host = ' \
+        "ENV.fetch(\n    'ASSET_HOST',\n" \
+        "    ENV.fetch('APPLICATION_HOST'\n)\n  )"
+
+      replace_in_file 'config/initializers/assets.rb',
+        "config.assets.version = '1.0'",
+        'config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'
+
+      config = <<~HERE
+        config.public_file_server.headers = {
+            "Cache-Control" => "public, max-age=31557600",
+          }
+      HERE
+
+      configure_environment('production', config)
+    end
+
+    def setup_secret_token
+      template 'secrets.yml', 'config/secrets.yml', force: true
+    end
+
+    def disallow_wrapping_parameters
+      remove_file 'config/initializers/wrap_parameters.rb'
+    end
+
+    def create_partials_directory
+      empty_directory 'app/views/application'
+    end
+
+    def create_shared_flashes
+      copy_file '_flashes.html.slim', 'app/views/application/_flashes.html.slim'
+      copy_file 'flashes_helper.rb', 'app/helpers/flashes_helper.rb'
+    end
+
+    def create_shared_javascripts
+      copy_file(
+        '_javascript.html.slim',
+        'app/views/application/_javascript.html.slim'
+      )
+    end
+
+    def create_shared_css_overrides
+      copy_file(
+        '_css_overrides.html.slim',
+        'app/views/application/_css_overrides.html.slim'
+      )
+    end
+
+    def create_application_layout
+      template 'dvelp_layout.html.slim',
+        'app/views/layouts/application.html.slim',
+        force: true
+
+      remove_file 'app/views/layouts/application.html.erb'
+    end
+
+    def use_postgres_config_template
+      template 'postgresql_database.yml.erb', 'config/database.yml',
+        force: true
+    end
+
+    def create_database
+      bundle_command 'exec rails db:create db:migrate'
+    end
+
+    def replace_gemfile(path)
+      template 'Gemfile.erb', 'Gemfile', force: true do |content|
+        if path
+          content.gsub(/gem .underlay./) { |s| %(#{s}, path: "#{path}") }
+        else
+          content
+        end
+      end
+    end
+
+    def set_ruby_to_version_being_used
+      create_file '.ruby-version', "#{Underlay::RUBY_VERSION}\n"
+    end
+
+    def enable_database_cleaner
+      copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
+    end
+
+    def provide_shoulda_matchers_config
+      copy_file(
+        'shoulda_matchers_config_rspec.rb',
+        'spec/support/shoulda_matchers.rb'
+      )
+    end
+
+    def configure_spec_support_features
+      empty_directory_with_keep_file 'spec/features'
+      empty_directory_with_keep_file 'spec/support/features'
+    end
+
+    def configure_rspec
+      remove_file 'spec/rails_helper.rb'
+      remove_file 'spec/spec_helper.rb'
+      copy_file 'rails_helper.rb', 'spec/rails_helper.rb'
+      copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
+    end
+
+    def configure_ci
+      template 'circle.yml.erb', 'circle.yml'
+    end
+
+    def configure_rubocop
+      template 'rubocop.yml.erb', '.rubocop.yml'
+    end
+
+    def configure_linters
+      template 'scss-lint.yml.erb', '.scss-lint.yml'
+      template 'slim-lint.yml.erb', '.slim-lint.yml'
+    end
+
+    def configure_i18n_for_test_environment
+      copy_file 'i18n.rb', 'spec/support/i18n.rb'
+    end
+
+    def configure_i18n_for_missing_translations
+      raise_on_missing_translations_in('development')
+      raise_on_missing_translations_in('test')
+    end
+
+    def configure_action_mailer_in_specs
+      copy_file 'action_mailer.rb', 'spec/support/action_mailer.rb'
+    end
+
+    def configure_capybara
+      copy_file 'capybara.rb', 'spec/support/capybara.rb'
+    end
+
+    def configure_time_formats
+      remove_file 'config/locales/en.yml'
+      template 'config_locales_en.yml.erb', 'config/locales/en.yml'
+    end
+
+    def configure_rack_timeout
+      rack_timeout_config = <<~RUBY
+        Rack::Timeout.timeout = (ENV["RACK_TIMEOUT"] || 10).to_i
+      RUBY
+
+      append_file 'config/environments/production.rb', rack_timeout_config
+    end
+
+    def configure_simple_form
+      bundle_command 'exec rails generate simple_form:install'
+    end
+
+    def configure_action_mailer
+      action_mailer_host 'development', %("localhost:3000")
+      action_mailer_asset_host 'development', %("http://localhost:3000")
+      action_mailer_host 'test', %("www.example.com")
+      action_mailer_asset_host 'test', %("http://www.example.com")
+      action_mailer_host 'production', "ENV['APPLICATION_HOST']"
+      action_mailer_asset_host(
+        'production',
+        "ENV.fetch(\n    'ASSET_HOST',\n" \
+        "    ENV.fetch('APPLICATION_HOST'\n)\n  )"
+      )
+    end
+
+    def configure_active_job
+      configure_application_file(
+        'config.active_job.queue_adapter = :sidekiq'
+      )
+      configure_environment 'test', 'config.active_job.queue_adapter = :inline'
+      copy_file 'sidekiq.yml', 'config/sidekiq.yml', force: true
+    end
+
+    def generate_rspec
+      generate 'rspec:install'
+    end
+
+    def replace_default_puma_configuration
+      copy_file 'puma.rb', 'config/puma.rb', force: true
+    end
+
+    def set_up_forego
+      copy_file 'Procfile', 'Procfile'
+    end
+
+    def setup_default_directories
+      [
+        'app/views/pages',
+        'spec/lib',
+        'spec/controllers',
+        'spec/helpers',
+        'spec/support/matchers',
+        'spec/support/mixins',
+        'spec/support/shared_examples'
+      ].each do |dir|
+        empty_directory_with_keep_file dir
+      end
+    end
+
+    def copy_figaro_files
+      copy_file 'application.example.yml', 'config/application.example.yml'
+      copy_file 'application.example.yml', 'config/application.yml'
+    end
+
+    def create_heroku_apps(flags)
+      create_staging_heroku_app(flags)
+      create_production_heroku_app(flags)
+    end
+
+    def create_deploy_script
+      copy_file 'bin_deploy', 'bin/deploy'
+
+      instructions = <<~MARKDOWN
+
+        ## Deploying
+
+        If you have previously run the `./bin/setup` script,
+        you can deploy to staging and production with:
+
+            % ./bin/deploy staging
+            % ./bin/deploy production
+      MARKDOWN
+
+      append_file 'README.md', instructions
+      run 'chmod a+x bin/deploy'
+    end
+
+    def configure_automatic_deployment
+      deploy_command = <<-YML.strip_heredoc
+      deployment:
+        staging:
+          branch: master
+          commands:
+            - bin/deploy staging
+      YML
+
+      append_file 'circle.yml', deploy_command
+    end
+
+    def create_github_repo(repo_name)
+      run "hub create #{repo_name} -p"
+    end
+
+    def setup_google_tag_manager
+      copy_file '_analytics.html.slim',
+        'app/views/application/_analytics.html.slim'
+    end
+
+    def setup_bundler_audit
+      copy_file 'bundler_audit.rake', 'lib/tasks/bundler_audit.rake'
+      append_file 'Rakefile', %(\ntask default: "bundle:audit"\n)
+    end
+
+    def setup_spring
+      bundle_command 'exec spring binstub --all'
+    end
+
+    def copy_miscellaneous_files
+      copy_file 'browserslist', 'browserslist'
+      copy_file 'errors.rb', 'config/initializers/errors.rb'
+      copy_file 'json_encoding.rb', 'config/initializers/json_encoding.rb'
+      copy_file 'lograge.rb', 'config/initializers/lograge.rb'
+      copy_file 'sentry.rb', 'config/initializers/sentry.rb'
+    end
+
+    def customize_error_pages
+      meta_tags = <<-HERE
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <meta name="viewport" content="initial-scale=1" />
+      HERE
+
+      %w[500 404 422].each do |page|
+        inject_into_file "public/#{page}.html", meta_tags, after: "<head>\n"
+        replace_in_file "public/#{page}.html", /<!--.+-->\n/, ''
+      end
+    end
+
+    def remove_config_comment_lines
+      config_files = [
+        'application.rb',
+        'initializers/backtrace_silencers.rb',
+        'initializers/wrap_parameters.rb',
+        '../db/seeds.rb',
+        'environment.rb',
+        'environments/development.rb',
+        'environments/production.rb',
+        'environments/test.rb',
+        '../Rakefile'
+      ] + mode_dependent_files
+
+      config_files.each do |config_file|
+        path = File.join(destination_root, "config/#{config_file}")
+
+        accepted_content = File.readlines(path).reject do |line|
+          line =~ /^.*#.*$/ || line =~ /^$\n/
+        end
+
+        File.open(path, 'w') do |file|
+          accepted_content.each { |line| file.puts line }
+        end
+      end
+    end
+
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb',
+        /Rails\.application\.routes\.draw do.*end/m,
+        "Rails.application.routes.draw do\nend"
+    end
+
+    def setup_default_rake_task
+      append_file 'Rakefile' do
+        <<~HERE
+          task(:default).clear
+          task default: [:spec]
+
+          if defined? RSpec
+            task(:spec).clear
+            RSpec::Core::RakeTask.new(:spec) do |t|
+              t.verbose = false
+            end
+          end
+        HERE
+      end
+    end
+
+    def rubocop_autocorrect
+      run 'bundle exec rubocop -a'
+    end
+
+    def manual_code_correct
+      replace_in_file(
+        'config/environments/development.rb',
+        "if Rails.root.join('tmp/caching-dev.txt').exist?",
+        "if Rails.root.join('tmp', 'caching-dev.txt').exist?"
+      )
+
+      simple_form_corrections unless options[:api]
+    end
+
+    def non_api_files_removal
+      remove_file 'app.json'
+      remove_file 'browserslist'
+      remove_file 'config/cable.yml'
+      run 'rm -r -f app/channels'
+      run 'rm -r -f app/views/pages'
+    end
+
+    private
+
+    def raise_on_missing_translations_in(environment)
+      config = 'config.action_view.raise_on_missing_translations = true'
+
+      uncomment_lines("config/environments/#{environment}.rb", config)
+    end
+
+    def heroku_adapter
+      @heroku_adapter ||= Adapters::Heroku.new(self)
+    end
+
+    def simple_form_corrections
+      replace_in_file(
+        'config/initializers/simple_form.rb',
+        'config.wrappers :default, class: :input,',
+        'config.wrappers :default,'
+      )
+      replace_in_file(
+        'config/initializers/simple_form.rb',
+        '                            hint_class: :field_with_hint, ' \
+          'error_class: :field_with_errors, '\
+          'valid_class: :field_without_errors do |b|',
+        "    class: :input,\n"\
+        "    hint_class: :field_with_hint,\n" \
+        "    error_class: :field_with_errors,\n" \
+        '    valid_class: :field_without_errors do |b|'
+      )
+    end
+
+    def mode_dependent_files
+      if options[:api]
+        ['initializers/cors.rb']
+      else
+        ['initializers/simple_form.rb']
+      end
+    end
+  end
+end