underlay 1.50.1

data/lib/underlay/generators/app_generator.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Underlay
+  class AppGenerator < Rails::Generators::AppGenerator
+    hide!
+
+    class_option :database,
+      type: :string, aliases: '-d', default: 'postgresql',
+      desc: "Configure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :github,
+      type: :string, default: nil,
+      desc: 'Create Github repository and add remote origin pointed to repo'
+
+    class_option :help,
+      type: :boolean, aliases: '-h', group: :underlay,
+      desc: 'Show this help message and quit'
+
+    class_option :heroku,
+      type: :boolean, aliases: '-H', default: false,
+      desc: 'Create staging and production Heroku apps'
+
+    class_option :heroku_flags,
+      type: :string, default: '',
+      desc: 'Set extra Heroku flags'
+
+    class_option :path,
+      type: :string, default: nil,
+      desc: 'Path to the gem'
+
+    class_option :skip_system_test,
+      type: :boolean, default: true,
+      desc: 'Skip system test files'
+
+    class_option :skip_test,
+      type: :boolean, default: true,
+      desc: 'Skip Test Unit'
+
+    class_option :skip_turbolinks,
+      type: :boolean, default: true,
+      desc: 'Skip turbolinks gem'
+
+    class_option :version,
+      type: :boolean, aliases: '-v', group: :underlay,
+      desc: 'Show Underlay version number and quit'
+
+    def finish_template
+      invoke :underlay_customization
+      super
+    end
+
+    def underlay_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_secret_token
+      invoke :create_underlay_views
+      invoke :configure_app
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_config_comment_lines
+      invoke :remove_routes_comment_lines
+      invoke :setup_figaro
+      invoke :setup_database
+      invoke :create_local_heroku_setup
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :setup_google_tag_manager
+      invoke :setup_bundler_audit
+      invoke :setup_spring
+      invoke :generate_default
+      invoke :setup_default_directories
+      invoke :clean_up
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile, options[:path]
+      build :set_ruby_to_version_being_used
+      bundle_command 'install'
+      build_for_non_api :configure_simple_form
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if options[:database] == 'postgresql'
+        build :use_postgres_config_template
+      end
+
+      build :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build_for_non_api :raise_on_missing_assets_in_test
+      build :raise_on_delivery_errors
+      build :set_test_delivery_method
+      build :add_bullet_gem_configuration
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :provide_rake_script
+      build :provide_update_script
+      build :provide_dev_prime_task
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+      build_for_non_api :configure_quiet_assets
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :set_up_factory_bot_for_rspec
+      build :generate_factories_file
+      build :generate_rspec
+      build :configure_rspec
+      build :enable_database_cleaner
+      build :provide_shoulda_matchers_config
+      build :configure_spec_support_features
+      build :configure_ci
+      build :configure_rubocop
+      build_for_non_api :configure_linters
+      build :configure_i18n_for_test_environment
+      build :configure_action_mailer_in_specs
+      build_for_non_api :configure_capybara
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_smtp
+      build :configure_rack_timeout
+      build :enable_rack_canonical_host
+      build :enable_rack_deflater
+      build_for_non_api :setup_asset_host
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+    def create_underlay_views
+      say 'Creating underlay views'
+      build :create_partials_directory
+      build_for_non_api :create_shared_flashes
+      build_for_non_api :create_shared_javascripts
+      build_for_non_api :create_shared_css_overrides
+      build_for_non_api :create_application_layout
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_active_job
+      build :configure_time_formats
+      build :setup_default_rake_task
+      build :replace_default_puma_configuration
+      build :set_up_forego
+      build :setup_rack_mini_profiler
+    end
+
+    def create_local_heroku_setup
+      say 'Creating local Heroku setup'
+      build :create_review_apps_setup_script
+      build :create_deploy_script
+      build :create_heroku_application_manifest_file
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say 'Creating Heroku apps'
+        build :create_heroku_apps, options[:heroku_flags]
+        build :set_heroku_remotes
+        build :set_heroku_rails_secrets
+        build :set_heroku_application_host
+        build :set_heroku_backup_schedule
+        build :create_heroku_pipeline
+        build :configure_automatic_deployment
+      end
+    end
+
+    def create_github_repo
+      if !options[:skip_git] && options[:github]
+        say 'Creating Github repo'
+        build :create_github_repo, options[:github]
+      end
+    end
+
+    def setup_google_tag_manager
+      say 'Setting up Google Tage Manager' unless options[:api]
+      build_for_non_api :setup_google_tag_manager
+    end
+
+    def setup_figaro
+      build :copy_figaro_files
+    end
+
+    def setup_default_directories
+      build :setup_default_directories
+    end
+
+    def setup_bundler_audit
+      say 'Setting up bundler-audit'
+      build :setup_bundler_audit
+    end
+
+    def clean_up
+      say 'Code cleaning'
+      build :rubocop_autocorrect
+      build :manual_code_correct
+      build_for_api :non_api_files_removal
+    end
+
+    def setup_spring
+      say 'Springifying binstubs'
+      build :setup_spring
+    end
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_miscellaneous_files
+    end
+
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages' unless options[:api]
+      build_for_non_api :customize_error_pages
+    end
+
+    def remove_config_comment_lines
+      build :remove_config_comment_lines
+    end
+
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def generate_default
+      run('spring stop')
+      generate('underlay:initialize_active_job')
+      generate('underlay:enforce_ssl')
+      generate('underlay:static')
+      generate('underlay:stylesheet_base')
+    end
+
+    def outro
+      say 'You just laid the underlay. Time to add some value!'
+    end
+
+    def self.banner
+      "underlay #{arguments.map(&:usage).join(' ')} [options]"
+    end
+
+    protected
+
+    # rubocop:disable AccessorMethodName
+    def get_builder_class
+      Underlay::AppBuilder
+    end
+    # rubocop:enable AccessorMethodName
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+
+    def build_for_non_api(args)
+      return if options[:api]
+
+      build args
+    end
+
+    def build_for_api(args)
+      return unless options[:api]
+
+      build args
+    end
+  end
+end

data/lib/underlay/generators/enforce_ssl_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative '../actions'
+
+module Underlay
+  class EnforceSslGenerator < Rails::Generators::Base
+    include Underlay::Actions
+
+    def enforce_ssl
+      configure_environment 'production', 'config.force_ssl = true'
+    end
+  end
+end

data/lib/underlay/generators/initialize_active_job_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Underlay
+  class InitializeActiveJobGenerator < Rails::Generators::Base
+    source_root(
+      File.expand_path(
+        File.join('..', '..', '..', 'templates'),
+        File.dirname(__FILE__)
+      )
+    )
+
+    def initialize_active_job
+      copy_file(
+        'active_job.rb',
+        'config/initializers/active_job.rb'
+      )
+    end
+  end
+end

data/lib/underlay/generators/static_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Underlay
+  class StaticGenerator < Rails::Generators::Base
+    def add_high_voltage
+      gem 'high_voltage'
+      Bundler.with_clean_env { run 'bundle install' }
+    end
+  end
+end

data/lib/underlay/generators/stylesheet_base_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Underlay
+  class StylesheetBaseGenerator < Rails::Generators::Base
+    source_root File.expand_path(
+      File.join('..', '..', '..', 'templates'),
+      File.dirname(__FILE__)
+    )
+
+    def add_css_config
+      copy_file(
+        'application.scss',
+        'app/assets/stylesheets/application.scss',
+        force: true
+      )
+    end
+
+    def add_flashes_css
+      copy_file(
+        '_flashes.scss',
+        'app/assets/stylesheets/partials/_flashes.scss',
+        force: true
+      )
+    end
+
+    def remove_prior_config
+      remove_file 'app/assets/stylesheets/application.css'
+    end
+
+    def install_normalize_css
+      run 'bin/yarn add normalize.css'
+    end
+  end
+end

data/lib/underlay/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Underlay
+  RAILS_VERSION = '~> 5.1.3'
+  RUBY_VERSION = IO
+    .read("#{File.dirname(__FILE__)}/../../.ruby-version")
+    .strip
+    .freeze
+  VERSION = '1.50.1'
+end

data/lib/underlay.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'underlay/version'
+require 'underlay/generators/app_generator'
+require 'underlay/generators/enforce_ssl_generator'
+require 'underlay/generators/initialize_active_job_generator'
+require 'underlay/generators/static_generator'
+require 'underlay/generators/stylesheet_base_generator'
+require 'underlay/actions'
+require 'underlay/adapters/heroku'
+require 'underlay/app_builder'

data/spec/adapters/heroku_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Underlay
+  module Adapters
+    RSpec.describe Heroku do
+      it 'sets the heroku remotes' do
+        setup_file = 'bin/setup'
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:append_file)
+
+        Heroku.new(app_builder).set_heroku_remotes
+
+        expect(app_builder).to have_received(:append_file).with(
+          setup_file, /heroku join --app #{app_name.dasherize}-production/
+        )
+        expect(app_builder).to have_received(:append_file).with(
+          setup_file, /heroku join --app #{app_name.dasherize}-staging/
+        )
+      end
+
+      it 'sets the heroku rails secrets' do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+
+        Heroku.new(app_builder).set_heroku_rails_secrets
+
+        expect(app_builder).to(
+          have_configured_var('staging', 'SECRET_KEY_BASE')
+        )
+        expect(app_builder).to(
+          have_configured_var('production', 'SECRET_KEY_BASE')
+        )
+      end
+
+      it 'sets the heroku backup schedule' do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+
+        Heroku.new(app_builder).set_heroku_backup_schedule
+
+        expect(app_builder).to have_backup_schedule('staging')
+        expect(app_builder).to have_backup_schedule('production')
+      end
+
+      it 'sets the application host' do
+        app_builder = double(app_name: app_name)
+        allow(app_builder).to receive(:run)
+
+        Heroku.new(app_builder).set_heroku_application_host
+
+        expect(app_builder).to(
+          have_configured_var('staging', 'APPLICATION_HOST')
+        )
+
+        expect(app_builder).to(
+          have_configured_var('production', 'APPLICATION_HOST')
+        )
+      end
+
+      def app_name
+        UnderlayTestHelpers::APP_NAME
+      end
+
+      def have_backup_schedule(remote_name)
+        have_received(:run).with(
+          /pg:backups:schedule DATABASE_URL --at '10:00 UTC'/ +
+          /--remote #{remote_name}/
+        )
+      end
+
+      def have_configured_var(remote_name, var)
+        have_received(:run).with(/config:add #{var}=.+ --remote #{remote_name}/)
+      end
+    end
+  end
+end

data/spec/fakes/bin/heroku

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', '..', 'support', 'fake_heroku'),
+  File.dirname(__FILE__)
+)
+
+FakeHeroku.new(ARGV).run!

data/spec/fakes/bin/hub

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', '..', 'support', 'fake_github'),
+  File.dirname(__FILE__)
+)
+
+FakeGithub.new(ARGV).run!

data/spec/features/cli_help_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Command line help output' do
+  let(:help_text) { underlay_help_command }
+
+  it 'does not contain the default rails usage statement' do
+    expect(help_text).not_to include('rails new APP_PATH [options]')
+  end
+
+  it 'provides the correct usage statement for underlay' do
+    expect(help_text).to include <<~HERE
+      Usage:
+        underlay APP_PATH [options]
+    HERE
+  end
+
+  it 'does not contain the default rails group' do
+    expect(help_text).not_to include('Rails options:')
+  end
+
+  it 'provides help and version usage within the underlay group' do
+    expect(help_text).to include <<~HERE
+      Underlay options:
+        -h, [--help], [--no-help]        # Show this help message and quit
+        -v, [--version], [--no-version]  # Show Underlay version number and quit
+    HERE
+  end
+
+  it 'does not show the default extended rails help section' do
+    expect(help_text).not_to include('Create underlay files for app generator.')
+  end
+
+  it 'contains the usage statement from the underlay gem' do
+    expect(help_text).to include IO.read(usage_file)
+  end
+end

data/spec/features/github_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'GitHub' do
+  before do
+    drop_dummy_database
+    remove_project_directory
+  end
+
+  it 'suspends a project with --github option' do
+    repo_name = 'test'
+    run_underlay("--github=#{repo_name}")
+    setup_app_dependencies
+
+    expect(FakeGithub).to have_created_repo(repo_name)
+  end
+end

data/spec/features/heroku_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Heroku' do
+  context '--heroku' do
+    before(:all) do
+      clean_up
+      run_underlay('--heroku=true')
+      setup_app_dependencies
+    end
+
+    it 'suspends a project for Heroku' do
+      app_name = UnderlayTestHelpers::APP_NAME.dasherize
+
+      expect(FakeHeroku).to have_created_app_for('staging')
+      expect(FakeHeroku).to have_created_app_for('production')
+      expect(FakeHeroku).to have_configured_vars('staging', 'SECRET_KEY_BASE')
+      expect(FakeHeroku).to have_configured_vars(
+        'production',
+        'SECRET_KEY_BASE'
+      )
+      %w[staging production].each do |env|
+        expect(FakeHeroku).to have_configured_vars(env, 'APPLICATION_HOST')
+      end
+      expect(FakeHeroku).to have_setup_pipeline_for(app_name)
+
+      bin_setup_path = "#{project_path}/bin/setup"
+      bin_setup = IO.read(bin_setup_path)
+
+      expect(bin_setup).to match(/^if heroku join --app #{app_name}-production/)
+      expect(bin_setup).to match(/^if heroku join --app #{app_name}-staging/)
+      expect(bin_setup).to match(/^git config heroku.remote staging/)
+      expect(File.stat(bin_setup_path)).to be_executable
+
+      readme = IO.read("#{project_path}/README.md")
+
+      expect(readme).to include('./bin/deploy staging')
+      expect(readme).to include('./bin/deploy production')
+
+      circle_yml_path = "#{project_path}/circle.yml"
+      circle_yml = IO.read(circle_yml_path)
+
+      expect(circle_yml).to include <<-YML.strip_heredoc
+      deployment:
+        staging:
+          branch: master
+          commands:
+            - bin/deploy staging
+      YML
+    end
+  end
+
+  context '--heroku with region flag' do
+    before(:all) do
+      clean_up
+      run_underlay(%(--heroku=true --heroku-flags="--region eu"))
+      setup_app_dependencies
+    end
+
+    it 'suspends a project with extra Heroku flags' do
+      expect(FakeHeroku).to have_created_app_for('staging', '--region eu')
+      expect(FakeHeroku).to have_created_app_for('production', '--region eu')
+    end
+  end
+
+  def clean_up
+    drop_dummy_database
+    remove_project_directory
+    FakeHeroku.clear!
+  end
+end