suspenders 1.53.0 → 1.54.0

data/lib/suspenders/generators/base.rb

@@ -10,11 +10,50 @@ 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.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

@@ -2,21 +2,31 @@ require_relative "base"
 
 module Suspenders
   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

@@ -8,23 +8,11 @@ module Suspenders
     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/js_driver_generator.rb

@@ -3,8 +3,7 @@ require_relative "base"
 module Suspenders
   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
 

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

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

@@ -0,0 +1,14 @@
+require_relative "../base"
+
+module Suspenders
+  module Production
+    class CompressionGenerator < Generators::Base
+      def add_rack_deflater
+        configure_environment(
+          :production,
+          %{config.middleware.use Rack::Deflater},
+        )
+      end
+    end
+  end
+end

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

@@ -9,18 +9,7 @@ module Suspenders
       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
+        append_template_to_file "README.md", "partials/deployment_readme.md"
       end
     end
   end

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

@@ -11,14 +11,11 @@ module Suspenders
       end
 
       def use_smtp
-        config = <<-RUBY
-
-  config.action_mailer.delivery_method = :smtp
-  config.action_mailer.smtp_settings = SMTP_SETTINGS
-        RUBY
-
-        inject_into_file "config/environments/production.rb", config,
-          after: "config.action_mailer.perform_caching = false"
+        inject_template_into_file(
+          "config/environments/production.rb",
+          "partials/email_smtp.rb",
+          after: "config.action_mailer.perform_caching = false",
+        )
       end
 
       def env_vars

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

@@ -10,6 +10,7 @@ module Suspenders
           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 },

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

@@ -0,0 +1,15 @@
+require_relative "../base"
+
+module Suspenders
+  module Production
+    class SingleRedirect < Generators::Base
+      def add_rack_canonical_host
+        inject_into_file(
+          "config/environments/production.rb",
+          %{\n  config.middleware.use Rack::CanonicalHost, ENV.fetch("APPLICATION_HOST")},
+          before: "\nend",
+        )
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ module Suspenders
     class TimeoutGenerator < Generators::Base
       def add_gem
         gem "rack-timeout", group: :production
+        Bundler.with_clean_env { run "bundle install" }
       end
 
       def configure_rack_timeout

data/lib/suspenders/generators/profiler_generator.rb

@@ -0,0 +1,35 @@
+require_relative "base"
+
+module Suspenders
+  class ProfilerGenerator < Generators::Base
+    def augment_default_env
+      append_to_file ".env", "RACK_MINI_PROFILER=0\n"
+    rescue Errno::ENOENT
+      create_file ".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"
+      else
+        raise
+      end
+    end
+
+    def add_gem
+      gem "rack-mini-profiler", require: false
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_rack_mini_profiler
+      copy_file(
+        "rack_mini_profiler.rb",
+        "config/initializers/rack_mini_profiler.rb",
+        force: false,
+        skip: true,
+      )
+    end
+
+    def update_readme
+      append_template_to_file "README.md", "partials/profiler_readme.md"
+    end
+  end
+end

data/lib/suspenders/generators/runner_generator.rb

@@ -0,0 +1,48 @@
+require_relative "base"
+
+module Suspenders
+  class RunnerGenerator < Generators::Base
+    def procfile
+      copy_file "Procfile", "Procfile"
+    end
+
+    def sample_env
+      copy_file "sample_env", ".sample.env"
+    end
+
+    def copy_sample_env
+      if bin_setup_is_ruby?
+        inject_template_into_file(
+          "bin/setup",
+          "partials/runner_setup.rb",
+          before: %{  puts "\\n== Preparing database =="},
+        )
+      elsif bin_setup_mentions_ci?
+        inject_into_file(
+          "bin/setup",
+          %{  cp -i .sample.env .env\n},
+          after: %{if [ -z "$CI" ]; then\n},
+        )
+      else
+        append_to_file(
+          "bin/setup",
+          %{\nif [ -z "$CI" ]; then\n  cp -i .sample.env .env\nfi},
+        )
+      end
+    end
+
+    def update_readme
+      append_template_to_file "README.md", "partials/runner_readme.md"
+    end
+
+    private
+
+    def bin_setup_is_ruby?
+      File.read("bin/setup", 20).match?(%r{#!/usr/bin/env ruby})
+    end
+
+    def bin_setup_mentions_ci?
+      File.read("bin/setup").match?(/if \[ -z "\$CI" \]/)
+    end
+  end
+end

data/lib/suspenders/generators/staging/pull_requests_generator.rb

@@ -4,17 +4,9 @@ module Suspenders
   module Staging
     class PullRequestsGenerator < Generators::Base
       def configure_heroku_staging_pr_pipeline_host
-        config = <<-RUBY
-
-  if ENV.fetch("HEROKU_APP_NAME", "").include?("staging-pr-")
-    ENV["APPLICATION_HOST"] = ENV["HEROKU_APP_NAME"] + ".herokuapp.com"
-    ENV["ASSET_HOST"] = ENV["HEROKU_APP_NAME"] + ".herokuapp.com"
-  end
-        RUBY
-
-        inject_into_file(
+        inject_template_into_file(
           "config/environments/production.rb",
-          config,
+          "partials/pull_requests_config.rb",
           after: "Rails.application.configure do\n",
         )
       end