bulldozer 1.6.0

data/lib/bulldozer/generators/app_generator.rb

@@ -0,0 +1,231 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Bulldozer
+  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 :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 :github, type: :string, default: nil,
+      desc: "Create Github repository and add remote origin pointed to repo"
+
+    class_option :version, type: :boolean, aliases: "-v", group: :bulldozer,
+      desc: "Show Bulldozer version number and quit"
+
+    class_option :help, type: :boolean, aliases: '-h', group: :bulldozer,
+      desc: "Show this help message and quit"
+
+    class_option :path, type: :string, default: nil,
+      desc: "Path to the gem"
+
+    class_option :skip_test, type: :boolean, default: true,
+      desc: "Skip Test Unit"
+
+    class_option :skip_system_test,
+                 type: :boolean, default: true, desc: "Skip system test files"
+
+    class_option :skip_turbolinks,
+                 type: :boolean, default: true, desc: "Skip turbolinks gem"
+
+    def finish_template
+      invoke :bulldozer_customization
+      super
+    end
+
+    def bulldozer_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_production_environment
+      invoke :setup_secret_token
+      invoke :configure_app
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :setup_dotfiles
+      invoke :setup_database
+      invoke :create_github_repo
+      invoke :setup_bundler_audit
+      invoke :setup_spring
+      invoke :generate_default
+      invoke :setup_default_directories
+      invoke :create_heroku_apps
+      invoke :generate_deployment_default
+      invoke :remove_config_comment_lines
+      invoke :remove_routes_comment_lines
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile, options[:path]
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if 'postgresql' == options[:database]
+        build :use_postgres_config_template
+      end
+
+      build :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :configure_local_mail
+      build :raise_on_missing_assets_in_test
+      build :raise_on_delivery_errors
+      build :set_test_delivery_method
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+      build :configure_quiet_assets
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :enable_rack_canonical_host
+      build :enable_rack_deflater
+      build :setup_asset_host
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      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_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_honeybadger_env
+        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_dotfiles
+      build :copy_dotfiles
+    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 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'
+      build :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("bulldozer:json")
+      generate("bulldozer:static")
+      generate("bulldozer:stylesheet_base")
+      generate("bulldozer:testing")
+      generate("bulldozer:ci")
+      generate("bulldozer:js_driver")
+      unless options[:api]
+        generate("bulldozer:forms")
+      end
+      generate("bulldozer:db_optimizations")
+      generate("bulldozer:factories")
+      generate("bulldozer:lint")
+      generate("bulldozer:jobs")
+      generate("bulldozer:analytics")
+      generate("bulldozer:views")
+    end
+
+    def generate_deployment_default
+      generate("bulldozer:staging:pull_requests")
+      generate("bulldozer:production:force_tls")
+      generate("bulldozer:production:email")
+      generate("bulldozer:production:timeout")
+      generate("bulldozer:production:deployment")
+      generate("bulldozer:production:manifest")
+    end
+
+    def outro
+      say 'Congratulations! You just pulled our bulldozer.'
+      say honeybadger_outro
+    end
+
+    def self.banner
+      "bulldozer #{arguments.map(&:usage).join(' ')} [options]"
+    end
+
+    protected
+
+    def get_builder_class
+      Bulldozer::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+
+    private
+
+    def honeybadger_outro
+      "Run 'bundle exec honeybadger heroku install' with your API key#{honeybadger_message_suffix}."
+    end
+
+    def honeybadger_message_suffix
+      if options[:heroku]
+        " unless you're using the Heroku Honeybadger add-on"
+      end
+    end
+  end
+end

data/lib/bulldozer/generators/base.rb

@@ -0,0 +1,20 @@
+require "rails/generators"
+require_relative "../actions"
+
+module Bulldozer
+  module Generators
+    class Base < Rails::Generators::Base
+      include Bulldozer::Actions
+
+      def self.default_source_root
+        File.expand_path(File.join("..", "..", "..", "templates"), __dir__)
+      end
+
+      private
+
+      def app_name
+        Rails.app_class.parent_name.demodulize.underscore.dasherize
+      end
+    end
+  end
+end

data/lib/bulldozer/generators/ci_generator.rb

@@ -0,0 +1,22 @@
+require_relative "base"
+
+module Bulldozer
+  class CiGenerator < Generators::Base
+    def simplecov_test_integration
+      inject_into_file "spec/spec_helper.rb", before: 'SimpleCov.start "rails"' do
+        <<-RUBY
+
+  if ENV["CIRCLE_ARTIFACTS"]
+    dir = File.join(ENV["CIRCLE_ARTIFACTS"], "coverage")
+    SimpleCov.coverage_dir(dir)
+  end
+
+        RUBY
+      end
+    end
+
+    def configure_ci
+      template "circle.yml.erb", "circle.yml"
+    end
+  end
+end

data/lib/bulldozer/generators/db_optimizations_generator.rb

@@ -0,0 +1,30 @@
+require_relative "base"
+
+module Bulldozer
+  class DbOptimizationsGenerator < Generators::Base
+    def add_bullet
+      gem "bullet", group: %i(development test)
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_bullet
+      inject_into_file(
+        "config/environments/development.rb",
+        configuration,
+        after: "config.action_mailer.raise_delivery_errors = true\n",
+      )
+    end
+
+    private
+
+    def configuration
+      <<-RUBY
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+  end
+      RUBY
+    end
+  end
+end

data/lib/bulldozer/generators/factories_generator.rb

@@ -0,0 +1,22 @@
+require_relative "base"
+
+module Bulldozer
+  class FactoriesGenerator < Generators::Base
+    def add_factory_bot
+      gem "factory_bot_rails", group: %i(development test)
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def set_up_factory_bot_for_rspec
+      copy_file "factory_bot_rspec.rb", "spec/support/factory_bot.rb"
+    end
+
+    def generate_empty_factories_file
+      copy_file "factories.rb", "spec/factories.rb"
+    end
+
+    def provide_dev_prime_task
+      copy_file "dev.rake", "lib/tasks/dev.rake"
+    end
+  end
+end

data/lib/bulldozer/generators/forms_generator.rb

@@ -0,0 +1,18 @@
+require_relative "base"
+
+module Bulldozer
+  class FormsGenerator < Generators::Base
+    def add_simple_form
+      gem "simple_form"
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_simple_form
+      create_file "config/initializers/simple_form.rb" do
+        "SimpleForm.setup {|config|}"
+      end
+
+      generate "simple_form:install", "--force"
+    end
+  end
+end

data/lib/bulldozer/generators/jobs_generator.rb

@@ -0,0 +1,38 @@
+require_relative "base"
+
+module Bulldozer
+  class JobsGenerator < Generators::Base
+    def add_jobs_gem
+      gem "delayed_job_active_record"
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_background_jobs_for_rspec
+      generate "delayed_job:active_record"
+    end
+
+    def initialize_active_job
+      copy_file(
+        "active_job.rb",
+        "config/initializers/active_job.rb",
+      )
+    end
+
+    def configure_active_job
+      configure_application_file(
+        "config.active_job.queue_adapter = :delayed_job",
+      )
+      configure_environment "test", "config.active_job.queue_adapter = :inline"
+    end
+
+    private
+
+    def configure_application_file(config)
+      inject_into_file(
+        "config/application.rb",
+        "\n    #{config}",
+        before: "\n  end",
+      )
+    end
+  end
+end

data/lib/bulldozer/generators/js_driver_generator.rb

@@ -0,0 +1,15 @@
+require_relative "base"
+
+module Bulldozer
+  class JsDriverGenerator < Generators::Base
+    def add_gems
+      gem "capybara-selenium", group: :test
+      gem "chromedriver-helper", group: :test
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_chromedriver
+      copy_file "chromedriver.rb", "spec/support/chromedriver.rb"
+    end
+  end
+end

data/lib/bulldozer/generators/json_generator.rb

@@ -0,0 +1,10 @@
+require_relative "base"
+
+module Bulldozer
+  class JsonGenerator < Generators::Base
+    def add_oj
+      gem "oj"
+      Bundler.with_clean_env { run "bundle install" }
+    end
+  end
+end

data/lib/bulldozer/generators/lint_generator.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Bulldozer
+  class LintGenerator < Generators::Base
+    def set_up_hound
+      copy_file "hound.yml", ".hound.yml"
+    end
+  end
+end

data/lib/bulldozer/generators/production/deployment_generator.rb

@@ -0,0 +1,27 @@
+require_relative "../base"
+
+module Bulldozer
+  module Production
+    class DeploymentGenerator < Generators::Base
+      def copy_script
+        copy_file "bin_deploy", "bin/deploy"
+        chmod "bin/deploy", 0o755
+      end
+
+      def inform_user
+        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
+      end
+    end
+  end
+end