suspenders 1.51.0 → 1.55.0

data/lib/suspenders/generators/json_generator.rb

@@ -4,7 +4,7 @@ module Suspenders
   class JsonGenerator < Generators::Base
     def add_oj
       gem "oj"
-      Bundler.with_clean_env { run "bundle install" }
+      Bundler.with_unbundled_env { run "bundle install" }
     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/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_unbundled_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_unbundled_env do
+          @base.send(:always_run, "spring binstub --all")
+        end
+      end
+
+      def revoke!
+        Bundler.with_unbundled_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,25 +11,22 @@ 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,
+        inject_template_into_file(
+          "config/environments/production.rb",
+          "partials/email_smtp.rb",
           after: "config.action_mailer.perform_caching = false"
+        )
       end
 
       def env_vars
         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,14 +9,15 @@ module Suspenders
           name: app_name.dasherize,
           scripts: {},
           env: {
-            APPLICATION_HOST: { required: 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

@@ -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,16 +5,17 @@ module Suspenders
     class TimeoutGenerator < Generators::Base
       def add_gem
         gem "rack-timeout", group: :production
+        Bundler.with_unbundled_env { run "bundle install" }
       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

@@ -0,0 +1,35 @@
+require_relative "base"
+
+module Suspenders
+  class ProfilerGenerator < Generators::Base
+    def augment_default_env
+      append_to_file ".sample.env", "RACK_MINI_PROFILER=0\n"
+    rescue Errno::ENOENT
+      create_file ".sample.env", "RACK_MINI_PROFILER=0\n"
+    rescue Thor::Error => e
+      if e.message.match?(/does not appear to exist/)
+        create_file ".sample.env", "RACK_MINI_PROFILER=0\n"
+      else
+        raise
+      end
+    end
+
+    def add_gem
+      gem "rack-mini-profiler", require: false
+      Bundler.with_unbundled_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,18 +4,10 @@ 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,
-          after: "Rails.application.configure do\n",
+          "partials/pull_requests_config.rb",
+          after: "Rails.application.configure do\n"
         )
       end
 
@@ -23,7 +15,7 @@ module Suspenders
         template(
           "bin_setup_review_app.erb",
           "bin/setup_review_app",
-          force: true,
+          force: true
         )
 
         run "chmod a+x bin/setup_review_app"

data/lib/suspenders/generators/static_generator.rb

@@ -4,7 +4,11 @@ module Suspenders
   class StaticGenerator < Generators::Base
     def add_high_voltage
       gem "high_voltage"
-      Bundler.with_clean_env { run "bundle install" }
+      Bundler.with_unbundled_env { run "bundle install" }
+    end
+
+    def make_placeholder_directory
+      empty_directory_with_keep_file "app/views/pages"
     end
   end
 end

data/lib/suspenders/generators/stylelint_generator.rb

@@ -26,7 +26,8 @@ module Suspenders
         @base.invoke @generator
       end
 
-      def revoke!; end
+      def revoke!
+      end
     end
 
     class ToggleComments

data/lib/suspenders/generators/stylesheet_base_generator.rb

@@ -3,23 +3,22 @@ require_relative "base"
 module Suspenders
   class StylesheetBaseGenerator < Generators::Base
     def add_stylesheet_gems
-      gem "bourbon", ">= 5.0.1"
-      gem "neat", ">= 3.0.1"
-      Bundler.with_clean_env { run "bundle install" }
+      gem "bourbon", ">= 6.0.0"
+      Bundler.with_unbundled_env { run "bundle install" }
+    end
+
+    def remove_prior_config
+      remove_file "app/assets/stylesheets/application.css"
     end
 
     def add_css_config
       copy_file(
         "application.scss",
         "app/assets/stylesheets/application.scss",
-        force: true,
+        force: true
       )
     end
 
-    def remove_prior_config
-      remove_file "app/assets/stylesheets/application.css"
-    end
-
     def install_bitters
       run "bitters install --path app/assets/stylesheets"
     end