suspenders 1.51.0 → 1.55.0

data/lib/suspenders/generators/advisories_generator.rb

@@ -0,0 +1,15 @@
+require_relative "base"
+
+module Suspenders
+  class AdvisoriesGenerator < Generators::Base
+    def bundler_audit_gem
+      gem "bundler-audit", ">= 0.7.0", require: false, group: %i[development test]
+      Bundler.with_unbundled_env { run "bundle install" }
+    end
+
+    def rake_task
+      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
+      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,39 +1,39 @@
-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
     hide!
 
     class_option :database, type: :string, aliases: "-d", default: "postgresql",
-      desc: "Configure for selected database (options: #{DATABASES.join("/")})"
+                            desc: "Configure for selected database (options: #{DATABASES.join("/")})"
 
     class_option :heroku, type: :boolean, aliases: "-H", default: false,
-      desc: "Create staging and production Heroku apps"
+                          desc: "Create staging and production Heroku apps"
 
     class_option :heroku_flags, type: :string, default: "",
-      desc: "Set extra Heroku flags"
+                                desc: "Set extra Heroku flags"
 
     class_option :github, type: :string, default: nil,
-      desc: "Create Github repository and add remote origin pointed to repo"
+                          desc: "Create Github repository and add remote origin pointed to repo"
 
     class_option :version, type: :boolean, aliases: "-v", group: :suspenders,
-      desc: "Show Suspenders version number and quit"
+                           desc: "Show Suspenders version number and quit"
 
-    class_option :help, type: :boolean, aliases: '-h', group: :suspenders,
-      desc: "Show this help message and quit"
+    class_option :help, type: :boolean, aliases: "-h", group: :suspenders,
+                        desc: "Show this help message and quit"
 
     class_option :path, type: :string, default: nil,
-      desc: "Path to the gem"
+                        desc: "Path to the gem"
 
     class_option :skip_test, type: :boolean, default: true,
-      desc: "Skip Test Unit"
+                             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"
 
     def finish_template
       invoke :suspenders_customization
@@ -47,14 +47,9 @@ module Suspenders
       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
@@ -64,13 +59,13 @@ module Suspenders
 
     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
 
@@ -78,7 +73,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
@@ -91,25 +86,20 @@ module Suspenders
     end
 
     def setup_production_environment
-      say 'Setting up the production environment'
-      build :enable_rack_canonical_host
-      build :enable_rack_deflater
+      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
-      build :replace_default_puma_configuration
-      build :set_up_forego
-      build :setup_rack_mini_profiler
     end
 
     def create_heroku_apps
@@ -121,6 +111,7 @@ module Suspenders
         build :set_heroku_application_host
         build :set_heroku_honeybadger_env
         build :set_heroku_backup_schedule
+        build :set_heroku_buildpacks
         build :create_heroku_pipeline
         build :configure_automatic_deployment
       end
@@ -128,39 +119,16 @@ 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 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'
+      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
@@ -171,6 +139,8 @@ module Suspenders
 
     def generate_default
       run("spring stop")
+      generate("suspenders:runner")
+      generate("suspenders:profiler")
       generate("suspenders:json")
       generate("suspenders:static")
       generate("suspenders:stylesheet_base")
@@ -185,11 +155,15 @@ module Suspenders
       generate("suspenders:lint")
       generate("suspenders:jobs")
       generate("suspenders:analytics")
-      generate("suspenders:views")
+      generate("suspenders:inline_svg")
+      generate("suspenders:advisories")
+      generate("suspenders:preloader")
     end
 
     def generate_deployment_default
       generate("suspenders:staging:pull_requests")
+      generate("suspenders:production:single_redirect")
+      generate("suspenders:production:compression")
       generate("suspenders:production:force_tls")
       generate("suspenders:production:email")
       generate("suspenders:production:timeout")
@@ -197,13 +171,17 @@ module Suspenders
       generate("suspenders:production:manifest")
     end
 
+    def generate_views
+      generate("suspenders:views")
+    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

@@ -10,10 +10,49 @@ module Suspenders
         File.expand_path(File.join("..", "..", "..", "templates"), __dir__)
       end
 
+      def self.inherited(subclass)
+        super
+
+        description_file = File.expand_path(
+          File.join(
+            default_source_root,
+            "descriptions",
+            "#{subclass.generator_name}.md"
+          )
+        )
+
+        subclass.desc File.read(description_file)
+      rescue Errno::ENOENT
+      end
+
       private
 
       def app_name
-        Rails.app_class.parent_name.demodulize.underscore.dasherize
+        Rails.app_class.module_parent_name.demodulize.underscore.dasherize
+      end
+
+      def empty_directory_with_keep_file(destination)
+        empty_directory(destination, {})
+        keep_file(destination)
+      end
+
+      def keep_file(destination)
+        create_file(File.join(destination, ".keep"))
+      end
+
+      def append_template_to_file(destination, source, *args)
+        partial = File.expand_path(find_in_source_paths(source))
+        append_to_file(destination, File.read(partial, *args))
+      end
+
+      def prepend_template_to_file(destination, source, *args)
+        partial = File.expand_path(find_in_source_paths(source))
+        prepend_to_file(destination, File.read(partial, *args))
+      end
+
+      def inject_template_into_file(destination, source, *args)
+        partial = File.expand_path(find_in_source_paths(source))
+        inject_into_file(destination, File.read(partial), *args)
       end
     end
   end

data/lib/suspenders/generators/ci_generator.rb

@@ -2,21 +2,31 @@ require_relative "base"
 
 module Suspenders
   class CiGenerator < Generators::Base
+    def simplecov_gem
+      gem "simplecov", require: false, group: [:test]
+      Bundler.with_unbundled_env { run "bundle install" }
+    end
+
     def simplecov_test_integration
-      inject_into_file "spec/spec_helper.rb", before: 'SimpleCov.start "rails"' do
-        <<-RUBY
+      prepend_template_to_file(test_helper_file, "partials/ci_simplecov.rb")
+    end
 
-  if ENV["CIRCLE_ARTIFACTS"]
-    dir = File.join(ENV["CIRCLE_ARTIFACTS"], "coverage")
-    SimpleCov.coverage_dir(dir)
-  end
+    def configure_ci
+      template "circle.yml.erb", "circle.yml"
+    end
+
+    private
 
-        RUBY
+    def test_helper_file
+      if using_rspec?
+        "spec/spec_helper.rb"
+      else
+        "test/test_helper.rb"
       end
     end
 
-    def configure_ci
-      template "circle.yml.erb", "circle.yml"
+    def using_rspec?
+      File.exist?("spec/spec_helper.rb")
     end
   end
 end

data/lib/suspenders/generators/db_optimizations_generator.rb

@@ -3,28 +3,16 @@ require_relative "base"
 module Suspenders
   class DbOptimizationsGenerator < Generators::Base
     def add_bullet
-      gem "bullet", group: %i(development test)
-      Bundler.with_clean_env { run "bundle install" }
+      gem "bullet", group: %i[development test]
+      Bundler.with_unbundled_env { run "bundle install" }
     end
 
     def configure_bullet
-      inject_into_file(
+      inject_template_into_file(
         "config/environments/development.rb",
-        configuration,
-        after: "config.action_mailer.raise_delivery_errors = true\n",
+        "partials/db_optimizations_configuration.rb",
+        after: /config.action_mailer.raise_delivery_errors = .*/
       )
     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/suspenders/generators/factories_generator.rb

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

data/lib/suspenders/generators/forms_generator.rb

@@ -4,7 +4,7 @@ module Suspenders
   class FormsGenerator < Generators::Base
     def add_simple_form
       gem "simple_form"
-      Bundler.with_clean_env { run "bundle install" }
+      Bundler.with_unbundled_env { run "bundle install" }
     end
 
     def configure_simple_form

data/lib/suspenders/generators/inline_svg_generator.rb

@@ -0,0 +1,14 @@
+require_relative "base"
+
+module Suspenders
+  class InlineSvgGenerator < Generators::Base
+    def add_inline_svg
+      gem "inline_svg"
+      Bundler.with_unbundled_env { run "bundle install" }
+    end
+
+    def configure_inline_svg
+      copy_file "inline_svg.rb", "config/initializers/inline_svg.rb"
+    end
+  end
+end

data/lib/suspenders/generators/jobs_generator.rb

@@ -4,7 +4,7 @@ module Suspenders
   class JobsGenerator < Generators::Base
     def add_jobs_gem
       gem "delayed_job_active_record"
-      Bundler.with_clean_env { run "bundle install" }
+      Bundler.with_unbundled_env { run "bundle install" }
     end
 
     def configure_background_jobs_for_rspec
@@ -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

@@ -3,13 +3,16 @@ require_relative "base"
 module Suspenders
   class JsDriverGenerator < Generators::Base
     def add_gems
-      gem "capybara-selenium", group: :test
-      gem "chromedriver-helper", group: :test
-      Bundler.with_clean_env { run "bundle install" }
+      gem "webdrivers", group: :test
+      Bundler.with_unbundled_env { run "bundle install" }
     end
 
-    def configure_chromedriver
+    def configure_capybara
       copy_file "chromedriver.rb", "spec/support/chromedriver.rb"
+      copy_file(
+        "capybara_silence_puma.rb",
+        "spec/support/capybara_silence_puma.rb"
+      )
     end
   end
 end