suspenders 1.54.1 → 1.56.1

data/lib/suspenders/app_builder.rb

@@ -15,11 +15,11 @@ module Suspenders
       :set_heroku_honeybadger_env,
       :set_heroku_rails_secrets,
       :set_heroku_remotes,
-      :set_heroku_buildpacks,
+      :set_heroku_buildpacks
     )
 
     def readme
-      template 'README.md.erb', 'README.md'
+      template "README.md.erb", "README.md"
     end
 
     def gitignore
@@ -33,7 +33,7 @@ module Suspenders
     def setup_rack_mini_profiler
       copy_file(
         "rack_mini_profiler.rb",
-        "config/initializers/rack_mini_profiler.rb",
+        "config/initializers/rack_mini_profiler.rb"
       )
     end
 
@@ -42,15 +42,15 @@ module Suspenders
     end
 
     def raise_on_delivery_errors
-      replace_in_file 'config/environments/development.rb',
-        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+      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",
+        after: "config.action_mailer.raise_delivery_errors = true"
       )
     end
 
@@ -81,7 +81,8 @@ module Suspenders
     config.generators do |generate|
       generate.helper false
       generate.javascripts false
-      generate.request_specs false
+      generate.controller_specs false
+      generate.request_specs true
       generate.routing_specs false
       generate.stylesheets false
       generate.test_framework :rspec
@@ -90,7 +91,7 @@ module Suspenders
 
       RUBY
 
-      inject_into_class 'config/application.rb', 'Application', config
+      inject_into_class "config/application.rb", "Application", config
     end
 
     def configure_local_mail
@@ -98,27 +99,27 @@ module Suspenders
     end
 
     def setup_asset_host
-      replace_in_file 'config/environments/production.rb',
+      replace_in_file "config/environments/production.rb",
         "# config.action_controller.asset_host = 'http://assets.example.com'",
         'config.action_controller.asset_host = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))'
 
       if File.exist?("config/initializers/assets.rb")
-        replace_in_file 'config/initializers/assets.rb',
+        replace_in_file "config/initializers/assets.rb",
           "config.assets.version = '1.0'",
           'config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'
       end
 
-      config = <<-EOD
-config.public_file_server.headers = {
-    "Cache-Control" => "public, max-age=31557600",
-  }
+      config = <<~EOD
+        config.public_file_server.headers = {
+            "Cache-Control" => "public, max-age=31557600",
+          }
       EOD
 
       configure_environment("production", config)
     end
 
     def setup_secret_token
-      template 'secrets.yml', 'config/secrets.yml', force: true
+      template "secrets.yml", "config/secrets.yml", force: true
     end
 
     def disallow_wrapping_parameters
@@ -126,7 +127,7 @@ config.public_file_server.headers = {
     end
 
     def use_postgres_config_template
-      template 'postgresql_database.yml.erb', 'config/database.yml',
+      template "postgresql_database.yml.erb", "config/database.yml",
         force: true
     end
 
@@ -134,10 +135,14 @@ config.public_file_server.headers = {
       bundle_command "exec rails db:create db:migrate"
     end
 
+    def run_database_migrations
+      bundle_command "exec rails db:migrate"
+    end
+
     def replace_gemfile(path)
-      template 'Gemfile.erb', 'Gemfile', force: true do |content|
+      template "Gemfile.erb", "Gemfile", force: true do |content|
         if path
-          content.gsub(%r{gem .suspenders.}) { |s| %{#{s}, path: "#{path}"} }
+          content.gsub(%r{gem .suspenders.}) { |s| %(#{s}, path: "#{path}") }
         else
           content
         end
@@ -145,7 +150,7 @@ config.public_file_server.headers = {
     end
 
     def ruby_version
-      create_file '.ruby-version', "#{Suspenders::RUBY_VERSION}\n"
+      create_file ".ruby-version", "#{Suspenders::RUBY_VERSION}\n"
     end
 
     def configure_i18n_for_missing_translations
@@ -154,7 +159,7 @@ config.public_file_server.headers = {
     end
 
     def configure_action_mailer_in_specs
-      copy_file 'action_mailer.rb', 'spec/support/action_mailer.rb'
+      copy_file "action_mailer.rb", "spec/support/action_mailer.rb"
     end
 
     def configure_time_formats
@@ -163,15 +168,17 @@ config.public_file_server.headers = {
     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 "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.fetch("APPLICATION_HOST")}
+      # rubocop:disable Lint/InterpolationCheck
       action_mailer_asset_host(
         "production",
-        %{ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))},
+        %q{"https://#{ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))}"}
       )
+      # rubocop:enable Lint/InterpolationCheck
     end
 
     def create_heroku_apps(flags)
@@ -199,40 +206,35 @@ config.public_file_server.headers = {
         "environment.rb",
         "environments/development.rb",
         "environments/production.rb",
-        "environments/test.rb",
+        "environments/test.rb"
       ]
 
       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
+        path = Pathname(destination_root).join("config", config_file)
+        source = Actions::StripCommentsAction.call(path.read)
 
-        File.open(path, "w") do |file|
-          accepted_content.each { |line| file.puts line }
-        end
+        path.write(source)
       end
     end
 
     def remove_routes_comment_lines
-      replace_in_file 'config/routes.rb',
+      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
-        <<-EOS
-task(:default).clear
-task default: [:spec]
-
-if defined? RSpec
-  task(:spec).clear
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.verbose = false
-  end
-end
+      append_file "Rakefile" do
+        <<~EOS
+          task(:default).clear
+          task default: [:spec]
+
+          if defined? RSpec
+            task(:spec).clear
+            RSpec::Core::RakeTask.new(:spec) do |t|
+              t.verbose = false
+            end
+          end
         EOS
       end
     end
@@ -240,7 +242,7 @@ end
     private
 
     def raise_on_missing_translations_in(environment)
-      config = 'config.action_view.raise_on_missing_translations = true'
+      config = "config.action_view.raise_on_missing_translations = true"
 
       uncomment_lines("config/environments/#{environment}.rb", config)
     end

data/lib/suspenders/exit_on_failure.rb

@@ -0,0 +1,19 @@
+require "active_support/concern"
+require "English"
+
+module Suspenders
+  module ExitOnFailure
+    extend ActiveSupport::Concern
+
+    def bundle_command(*)
+      super
+      exit(false) if $CHILD_STATUS.exitstatus.nonzero?
+    end
+
+    module ClassMethods
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/suspenders/generators/advisories_generator.rb

@@ -9,7 +9,7 @@ module Suspenders
 
     def rake_task
       copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
-      append_file "Rakefile", %{\ntask default: "bundle:audit"\n}
+      append_file "Rakefile", %(\ntask default: "bundle:audit"\n)
     end
   end
 end

data/lib/suspenders/generators/analytics_generator.rb

@@ -10,7 +10,7 @@ module Suspenders
     def render_partial
       if File.exist?(js_partial)
         inject_into_file js_partial,
-          %{\n\n<%= render "analytics" %>},
+          %(\n\n<%= render "analytics" %>),
           after: "<%= yield :javascript %>"
       end
     end

data/lib/suspenders/generators/app_generator.rb

@@ -1,8 +1,10 @@
-require 'rails/generators'
-require 'rails/generators/rails/app/app_generator'
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
 
 module Suspenders
   class AppGenerator < Rails::Generators::AppGenerator
+    include ExitOnFailure
+
     hide!
 
     class_option :database, type: :string, aliases: "-d", default: "postgresql",
@@ -20,7 +22,7 @@ module Suspenders
     class_option :version, type: :boolean, aliases: "-v", group: :suspenders,
       desc: "Show Suspenders version number and quit"
 
-    class_option :help, type: :boolean, aliases: '-h', group: :suspenders,
+    class_option :help, type: :boolean, aliases: "-h", group: :suspenders,
       desc: "Show this help message and quit"
 
     class_option :path, type: :string, default: nil,
@@ -30,10 +32,13 @@ module Suspenders
       desc: "Skip Test Unit"
 
     class_option :skip_system_test,
-                 type: :boolean, default: true, desc: "Skip system test files"
+      type: :boolean, default: true, desc: "Skip system test files"
 
     class_option :skip_turbolinks,
-                 type: :boolean, default: true, desc: "Skip turbolinks gem"
+      type: :boolean, default: true, desc: "Skip turbolinks gem"
+
+    class_option :skip_spring, type: :boolean, default: true,
+      desc: class_options[:skip_spring].description
 
     def finish_template
       invoke :suspenders_customization
@@ -54,18 +59,19 @@ module Suspenders
       invoke :generate_deployment_default
       invoke :remove_config_comment_lines
       invoke :remove_routes_comment_lines
+      invoke :run_database_migrations
       invoke :outro
     end
 
     def customize_gemfile
       build :replace_gemfile, options[:path]
-      bundle_command 'install'
+      bundle_command "install"
     end
 
     def setup_database
-      say 'Setting up database'
+      say "Setting up database"
 
-      if 'postgresql' == options[:database]
+      if options[:database] == "postgresql"
         build :use_postgres_config_template
       end
 
@@ -73,7 +79,7 @@ module Suspenders
     end
 
     def setup_development_environment
-      say 'Setting up the development environment'
+      say "Setting up the development environment"
       build :configure_local_mail
       build :raise_on_missing_assets_in_test
       build :raise_on_delivery_errors
@@ -86,17 +92,17 @@ module Suspenders
     end
 
     def setup_production_environment
-      say 'Setting up the production environment'
+      say "Setting up the production environment"
       build :setup_asset_host
     end
 
     def setup_secret_token
-      say 'Moving secret token out of version control'
+      say "Moving secret token out of version control"
       build :setup_secret_token
     end
 
     def configure_app
-      say 'Configuring app'
+      say "Configuring app"
       build :configure_action_mailer
       build :configure_time_formats
       build :setup_default_rake_task
@@ -119,13 +125,13 @@ module Suspenders
 
     def create_github_repo
       if !options[:skip_git] && options[:github]
-        say 'Creating Github repo'
+        say "Creating Github repo"
         build :create_github_repo, options[:github]
       end
     end
 
     def copy_miscellaneous_files
-      say 'Copying miscellaneous support files'
+      say "Copying miscellaneous support files"
       build :copy_miscellaneous_files
     end
 
@@ -137,18 +143,21 @@ module Suspenders
       build :remove_routes_comment_lines
     end
 
+    def run_database_migrations
+      build :run_database_migrations
+    end
+
     def generate_default
-      run("spring stop")
+      run("spring stop > /dev/null 2>&1 || true")
+      generate("suspenders:runner")
       generate("suspenders:profiler")
       generate("suspenders:json")
       generate("suspenders:static")
-      generate("suspenders:stylesheet_base")
+      generate("suspenders:stylesheet_base") unless options[:api]
       generate("suspenders:testing")
       generate("suspenders:ci")
       generate("suspenders:js_driver")
-      unless options[:api]
-        generate("suspenders:forms")
-      end
+      generate("suspenders:forms") unless options[:api]
       generate("suspenders:db_optimizations")
       generate("suspenders:factories")
       generate("suspenders:lint")
@@ -156,8 +165,6 @@ module Suspenders
       generate("suspenders:analytics")
       generate("suspenders:inline_svg")
       generate("suspenders:advisories")
-      generate("suspenders:runner")
-      generate("suspenders:preloader")
     end
 
     def generate_deployment_default
@@ -176,12 +183,12 @@ module Suspenders
     end
 
     def outro
-      say 'Congratulations! You just pulled our suspenders.'
+      say "Congratulations! You just pulled our suspenders."
       say honeybadger_outro
     end
 
     def self.banner
-      "suspenders #{arguments.map(&:usage).join(' ')} [options]"
+      "suspenders #{arguments.map(&:usage).join(" ")} [options]"
     end
 
     protected

data/lib/suspenders/generators/base.rb

@@ -5,6 +5,7 @@ module Suspenders
   module Generators
     class Base < Rails::Generators::Base
       include Suspenders::Actions
+      include ExitOnFailure
 
       def self.default_source_root
         File.expand_path(File.join("..", "..", "..", "templates"), __dir__)
@@ -17,8 +18,8 @@ module Suspenders
           File.join(
             default_source_root,
             "descriptions",
-            "#{subclass.generator_name}.md",
-          ),
+            "#{subclass.generator_name}.md"
+          )
         )
 
         subclass.desc File.read(description_file)

data/lib/suspenders/generators/db_optimizations_generator.rb

@@ -3,7 +3,7 @@ require_relative "base"
 module Suspenders
   class DbOptimizationsGenerator < Generators::Base
     def add_bullet
-      gem "bullet", group: %i(development test)
+      gem "bullet", group: %i[development test]
       Bundler.with_unbundled_env { run "bundle install" }
     end
 
@@ -11,7 +11,7 @@ module Suspenders
       inject_template_into_file(
         "config/environments/development.rb",
         "partials/db_optimizations_configuration.rb",
-        after: /config.action_mailer.raise_delivery_errors = .*/,
+        after: /config.action_mailer.raise_delivery_errors = .*/
       )
     end
   end

data/lib/suspenders/generators/factories_generator.rb

@@ -3,7 +3,7 @@ require_relative "base"
 module Suspenders
   class FactoriesGenerator < Generators::Base
     def add_factory_bot
-      gem "factory_bot_rails", group: %i(development test)
+      gem "factory_bot_rails", group: %i[development test]
       Bundler.with_unbundled_env { run "bundle install" }
     end
 

data/lib/suspenders/generators/jobs_generator.rb

@@ -14,13 +14,13 @@ module Suspenders
     def initialize_active_job
       copy_file(
         "active_job.rb",
-        "config/initializers/active_job.rb",
+        "config/initializers/active_job.rb"
       )
     end
 
     def configure_active_job
       configure_application_file(
-        "config.active_job.queue_adapter = :delayed_job",
+        "config.active_job.queue_adapter = :delayed_job"
       )
       configure_environment "test", "config.active_job.queue_adapter = :inline"
     end
@@ -31,7 +31,7 @@ module Suspenders
       inject_into_file(
         "config/application.rb",
         "\n    #{config}",
-        before: "\n  end",
+        before: "\n  end"
       )
     end
   end

data/lib/suspenders/generators/js_driver_generator.rb

@@ -11,7 +11,7 @@ module Suspenders
       copy_file "chromedriver.rb", "spec/support/chromedriver.rb"
       copy_file(
         "capybara_silence_puma.rb",
-        "spec/support/capybara_silence_puma.rb",
+        "spec/support/capybara_silence_puma.rb"
       )
     end
   end

data/lib/suspenders/generators/json_generator.rb

@@ -6,5 +6,9 @@ module Suspenders
       gem "oj"
       Bundler.with_unbundled_env { run "bundle install" }
     end
+
+    def configure_oj
+      copy_file "oj.rb", "config/initializers/oj.rb"
+    end
   end
 end

data/lib/suspenders/generators/lint_generator.rb

@@ -5,5 +5,10 @@ module Suspenders
     def set_up_hound
       copy_file "hound.yml", ".hound.yml"
     end
+
+    def set_up_standard
+      gem "standard", group: :development
+      prepend_to_file("Rakefile", 'require "standard/rake"')
+    end
   end
 end

data/lib/suspenders/generators/production/compression_generator.rb

@@ -6,7 +6,7 @@ module Suspenders
       def add_rack_deflater
         configure_environment(
           :production,
-          %{config.middleware.use Rack::Deflater},
+          %(config.middleware.use Rack::Deflater)
         )
       end
     end

data/lib/suspenders/generators/production/email_generator.rb

@@ -7,14 +7,14 @@ module Suspenders
         copy_file "smtp.rb", "config/smtp.rb"
 
         prepend_file "config/environments/production.rb",
-          %{require Rails.root.join("config/smtp")\n}
+          %{require Rails.root.join("config/smtp")\n\n}
       end
 
       def use_smtp
         inject_template_into_file(
           "config/environments/production.rb",
           "partials/email_smtp.rb",
-          after: "config.action_mailer.perform_caching = false",
+          after: "config.action_mailer.perform_caching = false\n"
         )
       end
 
@@ -22,11 +22,11 @@ module Suspenders
         expand_json(
           "app.json",
           env: {
-            SMTP_ADDRESS: { required: true },
-            SMTP_DOMAIN: { required: true },
-            SMTP_PASSWORD: { required: true },
-            SMTP_USERNAME: { required: true },
-          },
+            SMTP_ADDRESS: {required: true},
+            SMTP_DOMAIN: {required: true},
+            SMTP_PASSWORD: {required: true},
+            SMTP_USERNAME: {required: true}
+          }
         )
       end
     end

data/lib/suspenders/generators/production/manifest_generator.rb

@@ -9,15 +9,15 @@ module Suspenders
           name: app_name.dasherize,
           scripts: {},
           env: {
-            APPLICATION_HOST: { required: true },
-            AUTO_MIGRATE_DB: { value: true },
-            EMAIL_RECIPIENTS: { required: true },
-            HEROKU_APP_NAME: { required: true },
-            HEROKU_PARENT_APP_NAME: { required: true },
-            RACK_ENV: { required: true },
-            SECRET_KEY_BASE: { generator: "secret" },
+            APPLICATION_HOST: {required: true},
+            AUTO_MIGRATE_DB: {value: true},
+            EMAIL_RECIPIENTS: {required: true},
+            HEROKU_APP_NAME: {required: true},
+            HEROKU_PARENT_APP_NAME: {required: true},
+            RACK_ENV: {required: true},
+            SECRET_KEY_BASE: {generator: "secret"}
           },
-          addons: ["heroku-postgresql"],
+          addons: ["heroku-postgresql"]
         )
       end
     end

data/lib/suspenders/generators/production/single_redirect.rb

@@ -7,7 +7,7 @@ module Suspenders
         inject_into_file(
           "config/environments/production.rb",
           %{\n  config.middleware.use Rack::CanonicalHost, ENV.fetch("APPLICATION_HOST")},
-          before: "\nend",
+          before: "\nend"
         )
       end
     end

data/lib/suspenders/generators/production/timeout_generator.rb

@@ -9,13 +9,13 @@ module Suspenders
       end
 
       def configure_rack_timeout
-        append_file ".env", rack_timeout_config
+        append_file ".sample.env", rack_timeout_config
       end
 
       private
 
       def rack_timeout_config
-        %{RACK_TIMEOUT_SERVICE_TIMEOUT=10}
+        %(RACK_TIMEOUT_SERVICE_TIMEOUT=10)
       end
     end
   end

data/lib/suspenders/generators/profiler_generator.rb

@@ -3,12 +3,12 @@ require_relative "base"
 module Suspenders
   class ProfilerGenerator < Generators::Base
     def augment_default_env
-      append_to_file ".env", "RACK_MINI_PROFILER=0\n"
+      append_to_file ".sample.env", "RACK_MINI_PROFILER=0\n"
     rescue Errno::ENOENT
-      create_file ".env", "RACK_MINI_PROFILER=0\n"
+      create_file ".sample.env", "RACK_MINI_PROFILER=0\n"
     rescue Thor::Error => e
       if e.message.match?(/does not appear to exist/)
-        create_file ".env", "RACK_MINI_PROFILER=0\n"
+        create_file ".sample.env", "RACK_MINI_PROFILER=0\n"
       else
         raise
       end
@@ -24,7 +24,7 @@ module Suspenders
         "rack_mini_profiler.rb",
         "config/initializers/rack_mini_profiler.rb",
         force: false,
-        skip: true,
+        skip: true
       )
     end