suspenders 1.49.0 → 1.54.0

data/lib/suspenders/generators/advisories_generator.rb

@@ -0,0 +1,19 @@
+require_relative "base"
+
+module Suspenders
+  class AdvisoriesGenerator < Generators::Base
+    def bundler_audit_gem
+      gem "bundler-audit",
+          require: false,
+          group: %i[development test],
+          git: "https://github.com/rubysec/bundler-audit.git",
+          branch: "0.7.0"
+      Bundler.with_clean_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

@@ -1,12 +1,7 @@
-require "rails/generators"
+require_relative "base"
 
 module Suspenders
-  class AnalyticsGenerator < Rails::Generators::Base
-    source_root File.expand_path(
-      File.join("..", "..", "..", "templates"),
-      File.dirname(__FILE__),
-    )
-
+  class AnalyticsGenerator < Generators::Base
     def install_partial
       copy_file "_analytics.html.erb",
         "app/views/application/_analytics.html.erb"

data/lib/suspenders/generators/app_generator.rb

@@ -47,17 +47,11 @@ 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_local_heroku_setup
       invoke :create_heroku_apps
-      invoke :generate_production_default
+      invoke :generate_deployment_default
       invoke :remove_config_comment_lines
       invoke :remove_routes_comment_lines
       invoke :outro
@@ -93,8 +87,6 @@ module Suspenders
 
     def setup_production_environment
       say 'Setting up the production environment'
-      build :enable_rack_canonical_host
-      build :enable_rack_deflater
       build :setup_asset_host
     end
 
@@ -108,16 +100,6 @@ module Suspenders
       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_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
@@ -129,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
@@ -141,34 +124,11 @@ module Suspenders
       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
@@ -179,6 +139,8 @@ module Suspenders
 
     def generate_default
       run("spring stop")
+      generate("suspenders:profiler")
+      generate("suspenders:json")
       generate("suspenders:static")
       generate("suspenders:stylesheet_base")
       generate("suspenders:testing")
@@ -192,13 +154,25 @@ module Suspenders
       generate("suspenders:lint")
       generate("suspenders:jobs")
       generate("suspenders:analytics")
-      generate("suspenders:views")
+      generate("suspenders:inline_svg")
+      generate("suspenders:advisories")
+      generate("suspenders:runner")
+      generate("suspenders:preloader")
     end
 
-    def generate_production_default
+    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")
+      generate("suspenders:production:deployment")
+      generate("suspenders:production:manifest")
+    end
+
+    def generate_views
+      generate("suspenders:views")
     end
 
     def outro

data/lib/suspenders/generators/base.rb

@@ -0,0 +1,59 @@
+require "rails/generators"
+require_relative "../actions"
+
+module Suspenders
+  module Generators
+    class Base < Rails::Generators::Base
+      include Suspenders::Actions
+
+      def self.default_source_root
+        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.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
+end

data/lib/suspenders/generators/ci_generator.rb

@@ -1,26 +1,32 @@
-require "rails/generators"
+require_relative "base"
 
 module Suspenders
-  class CiGenerator < Rails::Generators::Base
-    source_root File.expand_path(
-      File.join("..", "..", "..", "templates"),
-      File.dirname(__FILE__))
+  class CiGenerator < Generators::Base
+    def simplecov_gem
+      gem "simplecov", require: false, group: [:test]
+      Bundler.with_clean_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

@@ -1,30 +1,18 @@
-require "rails/generators"
+require_relative "base"
 
 module Suspenders
-  class DbOptimizationsGenerator < Rails::Generators::Base
+  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(
+      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

@@ -1,12 +1,7 @@
-require "rails/generators"
+require_relative "base"
 
 module Suspenders
-  class FactoriesGenerator < Rails::Generators::Base
-    source_root File.expand_path(
-      File.join("..", "..", "..", "templates"),
-      File.dirname(__FILE__),
-    )
-
+  class FactoriesGenerator < Generators::Base
     def add_factory_bot
       gem "factory_bot_rails", group: %i(development test)
       Bundler.with_clean_env { run "bundle install" }

data/lib/suspenders/generators/forms_generator.rb

@@ -1,7 +1,7 @@
-require "rails/generators"
+require_relative "base"
 
 module Suspenders
-  class FormsGenerator < Rails::Generators::Base
+  class FormsGenerator < Generators::Base
     def add_simple_form
       gem "simple_form"
       Bundler.with_clean_env { run "bundle install" }

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_clean_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

@@ -1,17 +1,7 @@
-require "rails/generators"
-require_relative "../actions"
+require_relative "base"
 
 module Suspenders
-  class JobsGenerator < Rails::Generators::Base
-    include Suspenders::Actions
-
-    source_root(
-      File.expand_path(
-        File.join("..", "..", "..", "templates"),
-        File.dirname(__FILE__),
-      ),
-    )
-
+  class JobsGenerator < Generators::Base
     def add_jobs_gem
       gem "delayed_job_active_record"
       Bundler.with_clean_env { run "bundle install" }

data/lib/suspenders/generators/js_driver_generator.rb

@@ -1,20 +1,18 @@
-require "rails/generators"
+require_relative "base"
 
 module Suspenders
-  class JsDriverGenerator < Rails::Generators::Base
-    source_root File.expand_path(
-      File.join("..", "..", "..", "templates"),
-      File.dirname(__FILE__),
-    )
-
+  class JsDriverGenerator < Generators::Base
     def add_gems
-      gem "capybara-selenium", group: :test
-      gem "chromedriver-helper", group: :test
+      gem "webdrivers", group: :test
       Bundler.with_clean_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

data/lib/suspenders/generators/json_generator.rb

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

data/lib/suspenders/generators/lint_generator.rb

@@ -1,12 +1,7 @@
-require "rails/generators"
+require_relative "base"
 
 module Suspenders
-  class LintGenerator < Rails::Generators::Base
-    source_root File.expand_path(
-      File.join("..", "..", "..", "templates"),
-      File.dirname(__FILE__),
-    )
-
+  class LintGenerator < Generators::Base
     def set_up_hound
       copy_file "hound.yml", ".hound.yml"
     end

data/lib/suspenders/generators/preloader_generator.rb

@@ -0,0 +1,122 @@
+require_relative "base"
+
+module Suspenders
+  class PreloaderGenerator < Generators::Base
+    def spring_config
+      template "spring.rb", "config/spring.rb", force: false, skip: true
+    end
+
+    def spring_gem
+      always_gsub_file("Gemfile", /# Spring speeds up development.*/, "")
+
+      gem_group :development do
+        gem "spring"
+        gem "spring-watcher-listen", "~> 2.0.0"
+      end
+
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def cache_classes_test
+      action UncacheClasses.new(self, "config/environments/test.rb")
+    end
+
+    def spring_binstubs
+      action SpringBinstubs.new(self)
+    end
+
+    class SpringBinstubs
+      def initialize(base)
+        @base = base
+      end
+
+      def invoke!
+        Bundler.with_clean_env do
+          @base.send(:always_run, "spring binstub --all")
+        end
+      end
+
+      def revoke!
+        Bundler.with_clean_env do
+          @base.send(:always_run, "spring binstub --remove --all")
+        end
+      end
+    end
+
+    class UncacheClasses
+      def initialize(base, config_file)
+        @base = base
+        @config_file = config_file
+      end
+
+      def invoke!
+        @base.send(
+          :always_gsub_file,
+          @config_file,
+          "config.cache_classes = true",
+          "config.cache_classes = false",
+        )
+      end
+
+      def revoke!
+        @base.send(
+          :always_gsub_file,
+          @config_file,
+          "config.cache_classes = false",
+          "config.cache_classes = true",
+        )
+      end
+    end
+
+    protected
+
+    def always_run(command, with: nil, verbose: true, env: nil, capture: nil,
+                   abort_on_failure: nil)
+      destination = relative_to_original_destination_root(
+        destination_root,
+        false,
+      )
+      desc = "#{command} from #{destination.inspect}"
+
+      if with
+        desc = "#{File.basename(with.to_s)} #{desc}"
+        command = "#{with} #{command}"
+      end
+
+      say_status :run, desc, verbose
+
+      return if options[:pretend]
+
+      env_splat = [env] if env
+
+      if capture
+        result, status = Open3.capture2e(*env_splat, command.to_s)
+        success = status.success?
+      else
+        result = system(*env_splat, command.to_s)
+        success = result
+      end
+
+      if abort_on_failure.nil?
+        abort_on_failure = self.class.send(:exit_on_failure?)
+      end
+
+      if !success && abort_on_failure
+        abort
+      end
+
+      result
+    end
+
+    def always_gsub_file(path, flag, replacement, verbose: true)
+      path = File.expand_path(path, destination_root)
+      say_status :gsub, relative_to_original_destination_root(path), verbose
+
+      unless options[:pretend]
+        content = File.binread(path)
+        content.gsub!(flag, replacement)
+        File.open(path, "wb") { |file| file.write(content) }
+      end
+    end
+  end
+end