suspenders 1.52.0 → 1.55.1

data/spec/features/production/compression_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe "suspenders:production:compression", type: :generator do
+  context "generate" do
+    it "adds Rack::Deflater to the middleware" do
+      with_app { generate("suspenders:production:compression") }
+
+      expect("config/environments/production.rb").to match_contents(
+        %r{config.middleware.use Rack::Deflater}
+      )
+    end
+  end
+
+  context "destroy" do
+    it "removes Rack::Deflater to the middleware" do
+      with_app { destroy("suspenders:production:compression") }
+
+      expect("config/environments/production.rb").not_to match_contents(
+        %r{Rack::Deflater}
+      )
+    end
+  end
+end

data/spec/features/production/email_spec.rb

@@ -15,11 +15,11 @@ RSpec.describe "suspenders:production:email", type: :generator do
 
     expect("app.json").to contain_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
 
@@ -37,11 +37,11 @@ RSpec.describe "suspenders:production:email", type: :generator do
 
     expect("app.json").not_to contain_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/spec/features/production/manifest_spec.rb

@@ -7,13 +7,14 @@ RSpec.describe "suspenders:production:manifest", type: :generator do
     expect("app.json").to contain_json(
       name: SuspendersTestHelpers::APP_NAME.dasherize,
       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"}
+      }
     )
   end
 
@@ -23,13 +24,14 @@ RSpec.describe "suspenders:production:manifest", type: :generator do
     expect("app.json").not_to contain_json(
       name: SuspendersTestHelpers::APP_NAME.dasherize,
       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"}
+      }
     )
   end
 end

data/spec/features/production/single_redirect_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+RSpec.describe "suspenders:production:single_redirect", type: :generator do
+  context "generate" do
+    it "adds Rack::CanonicalHost to the production middleware" do
+      with_app { generate("suspenders:production:single_redirect") }
+      middleware_canonical_host = %r{config.middleware.use Rack::CanonicalHost, ENV.fetch\("APPLICATION_HOST"\)}
+
+      expect("config/environments/production.rb").to match_contents(
+        middleware_canonical_host
+      )
+    end
+  end
+
+  context "destroy" do
+    it "removes Rack::CanonicalHost from the production middleware" do
+      with_app { destroy("suspenders:production:single_redirect") }
+      middleware_canonical_host = %r{config.middleware.use Rack::CanonicalHost, ENV.fetch\("APPLICATION_HOST"\)}
+
+      expect("config/environments/production.rb").not_to match_contents(
+        middleware_canonical_host
+      )
+    end
+  end
+end

data/spec/features/profiler_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+RSpec.describe "suspenders:profiler", type: :generator do
+  it "sets up rack-min-profiler" do
+    with_app { generate("suspenders:profiler") }
+
+    expect("config/initializers/rack_mini_profiler.rb").to \
+      match_contents(/Rack::MiniProfilerRails.initialize/)
+    expect("Gemfile").to match_contents(/rack-mini-profiler/)
+    expect(".sample.env").to match_contents(/RACK_MINI_PROFILER=0/)
+  end
+
+  it "removes rack-min-profiler" do
+    with_app { destroy("suspenders:profiler") }
+
+    expect("config/initializers/rack_mini_profiler.rb").not_to exist_as_a_file
+    expect("Gemfile").not_to match_contents(/rack-mini-profiler/)
+    expect(".sample.env").not_to exist_as_a_file
+  end
+end

data/spec/features/runner_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+RSpec.describe "suspenders:runner", type: :generator do
+  it "configures the app for running" do
+    with_app { generate("suspenders:runner") }
+
+    expect("Procfile").to exist_as_a_file
+    expect(".sample.env").to exist_as_a_file
+    expect("bin/setup").to match_contents(/\.sample\.env/)
+    expect("README.md").to match_contents(/\.sample\.env/)
+  end
+
+  it "removes custom app running configuration" do
+    with_app { destroy("suspenders:runner") }
+
+    expect("README.md").not_to match_contents(/\.sample\.env/)
+    expect("bin/setup").not_to match_contents(/\.sample\.env/)
+    expect(".sample.env").not_to exist_as_a_file
+    expect("Procfile").not_to exist_as_a_file
+  end
+
+  it "configures the app with a shell script bin/setup" do
+    with_app do
+      copy_file "bin_setup", "bin/setup"
+      generate("suspenders:runner")
+    end
+
+    expect("bin/setup").to match_contents(/\.sample\.env/)
+  end
+end

data/spec/features/staging/pull_requests_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe "suspenders:staging:pull_requests", type: :generators do
+RSpec.describe "suspenders:staging:pull_requests", type: :generator do
   it "generates the configuration for Heroku pipeline review apps" do
     with_app { generate("suspenders:staging:pull_requests") }
 

data/spec/features/static_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+RSpec.describe "suspenders:static", type: :generator do
+  it "adds the gem and pages directory" do
+    with_app { generate("suspenders:static") }
+
+    expect("Gemfile").to match_contents(/high_voltage/)
+    expect("app/views/pages/.keep").to exist_as_a_file
+  end
+
+  it "removes the gem and pages directory" do
+    with_app { destroy("suspenders:static") }
+
+    expect("app/views/pages/.keep").not_to exist_as_a_file
+    expect("Gemfile").not_to match_contents(/high_voltage/)
+  end
+end

data/spec/features/stylelint_spec.rb

@@ -5,8 +5,8 @@ RSpec.describe "suspenders:stylelint", type: :generator do
     it "creates .stylelintrc.json" do
       with_app { generate("suspenders:stylelint") }
 
-      expect(".stylelintrc.json").
-        to match_contents(%r{"extends": "@thoughtbot/stylelint-config"})
+      expect(".stylelintrc.json")
+        .to match_contents(%r{"extends": "@thoughtbot/stylelint-config"})
     end
 
     it "adds stylelint and @thoughtbot/stylelint-config to the package.json" do
@@ -21,7 +21,7 @@ RSpec.describe "suspenders:stylelint", type: :generator do
       with_app { generate("suspenders:stylelint") }
 
       expect(".hound.yml").to(
-        match_contents(/^  config_file: \.stylelintrc\.json/),
+        match_contents(/^  config_file: \.stylelintrc\.json/)
       )
     end
   end
@@ -43,8 +43,8 @@ RSpec.describe "suspenders:stylelint", type: :generator do
       end
 
       expect("package.json").not_to match_contents(/stylelint/)
-      expect("package.json").
-        not_to match_contents(%r{@thoughtbot/stylelint-config})
+      expect("package.json")
+        .not_to match_contents(%r{@thoughtbot/stylelint-config})
     end
 
     it "comments in the hound config_file option" do
@@ -53,8 +53,8 @@ RSpec.describe "suspenders:stylelint", type: :generator do
         destroy("suspenders:stylelint")
       end
 
-      expect(".hound.yml").
-        to match_contents(/^  # config_file: \.stylelintrc\.json/)
+      expect(".hound.yml")
+        .to match_contents(/^  # config_file: \.stylelintrc\.json/)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
-require 'bundler/setup'
+require "bundler/setup"
 
 Bundler.require(:default, :test)
 
-require (Pathname.new(__FILE__).dirname + '../lib/suspenders').expand_path
+require (Pathname.new(__FILE__).dirname + "../lib/suspenders").expand_path
 
-Dir['./spec/support/**/*.rb'].each { |file| require file }
+Dir["./spec/support/**/*.rb"].sort.each { |file| require file }
 
 RSpec.configure do |config|
   config.include SuspendersTestHelpers

data/spec/support/contain_json_matcher.rb

@@ -4,21 +4,27 @@ require "json"
 
 RSpec::Matchers.define :contain_json do
   match do
-    sub_json = expected
-    filename = actual
+    @sub_json = expected
+    @filename = actual
 
-    filepath = File.join(project_path, filename)
-    json = JSON.parse(IO.read(filepath), symbolize_names: true)
-    sub_json <= json
+    @filepath = File.join(project_path, @filename)
+    @json = JSON.parse(IO.read(@filepath), symbolize_names: true)
+
+    subhash?(@sub_json, @json)
   end
 
   failure_message do
-    sub_json = expected
-    filename = actual
+    "in #{@filename}, expected to find\n#{@sub_json.inspect}\n" \
+      "in\n#{@json.inspect}"
+  end
 
-    filepath = File.join(project_path, filename)
-    json = JSON.parse(IO.read(filepath), symbolize_names: true)
+  private
 
-    "in #{filename}, expected to find\n#{sub_json.inspect}\nin\n#{json.inspect}"
+  def subhash?(inner, outer)
+    if inner.is_a?(Hash) && outer.is_a?(Hash)
+      inner.all? { |key, value| subhash?(value, outer[key]) }
+    else
+      inner == outer
+    end
   end
 end

data/spec/support/fake_github.rb

@@ -1,13 +1,13 @@
 class FakeGithub
-  RECORDER = File.expand_path(File.join('..', '..', 'tmp', 'hub_commands'), File.dirname(__FILE__))
+  RECORDER = File.expand_path(File.join("..", "..", "tmp", "hub_commands"), File.dirname(__FILE__))
 
   def initialize(args)
     @args = args
   end
 
   def run!
-    File.open(RECORDER, 'a') do |file|
-      file.write @args.join(' ')
+    File.open(RECORDER, "a") do |file|
+      file.write @args.join(" ")
     end
   end
 

data/spec/support/fake_heroku.rb

@@ -1,5 +1,5 @@
 class FakeHeroku
-  RECORDER = File.expand_path(File.join('..', '..', 'tmp', 'heroku_commands'), File.dirname(__FILE__))
+  RECORDER = File.expand_path(File.join("..", "..", "tmp", "heroku_commands"), File.dirname(__FILE__))
 
   def initialize(args)
     @args = args
@@ -9,8 +9,8 @@ class FakeHeroku
     if @args.first == "help"
       puts "pipelines      #  manage collections of apps in pipelines"
     end
-    File.open(RECORDER, 'a') do |file|
-      file.puts @args.join(' ')
+    File.open(RECORDER, "a") do |file|
+      file.puts @args.join(" ")
     end
   end
 
@@ -19,7 +19,7 @@ class FakeHeroku
   end
 
   def self.has_gem_included?(project_path, gem_name)
-    gemfile = File.open(File.join(project_path, 'Gemfile'), 'a')
+    gemfile = File.open(File.join(project_path, "Gemfile"), "a")
 
     File.foreach(gemfile).any? do |line|
       line.match(/#{Regexp.quote(gem_name)}/)
@@ -30,10 +30,10 @@ class FakeHeroku
     app_name = "#{SuspendersTestHelpers::APP_NAME.dasherize}-#{environment}"
 
     command = if flags
-                "create #{app_name} #{flags} --remote #{environment}\n"
-              else
-                "create #{app_name} --remote #{environment}\n"
-              end
+      "create #{app_name} #{flags} --remote #{environment}\n"
+    else
+      "create #{app_name} --remote #{environment}\n"
+    end
 
     File.foreach(RECORDER).any? { |line| line == command }
   end

data/spec/support/project_files.rb

@@ -10,4 +10,16 @@ module ProjectFiles
     path = File.join(project_path, filename)
     FileUtils.rm_rf(path)
   end
+
+  def copy_file(from_in_templates, to_in_project)
+    destination = File.join(project_path, to_in_project)
+    destination_dirname = File.dirname(destination)
+
+    FileUtils.mkdir_p(destination_dirname)
+
+    FileUtils.cp(
+      File.join(root_path, "templates", from_in_templates),
+      destination
+    )
+  end
 end

data/spec/support/rails_template.rb

@@ -0,0 +1 @@
+gem "suspenders", path: File.expand_path("../..", __dir__)

data/spec/support/suspenders.rb

@@ -19,10 +19,7 @@ module SuspendersTestHelpers
       end
 
       Dir.chdir(APP_NAME) do
-        with_env("HOME", tmp_path) do
-          debug `git add .`
-          debug `git commit -m 'Initial commit'`
-        end
+        commit_all
       end
     end
   end
@@ -41,18 +38,11 @@ module SuspendersTestHelpers
       add_fakes_to_path
 
       with_revision_for_honeybadger do
-        debug `#{system_rails_bin} new #{APP_NAME}`
+        debug `#{system_rails_bin} new #{APP_NAME} -m #{rails_template_path}`
       end
 
       Dir.chdir(APP_NAME) do
-        File.open("Gemfile", "a") do |file|
-          file.puts %{gem "suspenders", path: #{root_path.inspect}}
-        end
-
-        with_env("HOME", tmp_path) do
-          debug `git add .`
-          debug `git commit -m 'Initial commit'`
-        end
+        commit_all
       end
     end
   end
@@ -98,7 +88,7 @@ module SuspendersTestHelpers
   end
 
   def add_fakes_to_path
-    ENV["PATH"] = "#{support_bin}:#{ENV['PATH']}"
+    ENV["PATH"] = "#{support_bin}:#{ENV["PATH"]}"
   end
 
   def project_path
@@ -116,7 +106,7 @@ module SuspendersTestHelpers
   end
 
   def suspenders_bin
-    File.join(root_path, 'bin', 'suspenders')
+    File.join(root_path, "bin", "suspenders")
   end
 
   def system_rails_bin
@@ -132,7 +122,20 @@ module SuspendersTestHelpers
   end
 
   def root_path
-    File.expand_path('../../../', __FILE__)
+    File.expand_path("../../../", __FILE__)
+  end
+
+  def rails_template_path
+    File.join(root_path, "spec", "support", "rails_template.rb")
+  end
+
+  def commit_all
+    with_env("HOME", tmp_path) do
+      debug `git config user.email suspenders@example.com`
+      debug `git config user.name "Suspenders Boy"`
+      debug `git add .`
+      debug `git commit -m 'Initial commit'`
+    end
   end
 
   def with_env(name, new_value)
@@ -141,7 +144,6 @@ module SuspendersTestHelpers
     ENV[name] = new_value.to_s
 
     yield
-
   ensure
     ENV.delete(name)
 
@@ -158,7 +160,7 @@ module SuspendersTestHelpers
 
   def run_in_tmp
     Dir.chdir(tmp_path) do
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         yield
       end
     end
@@ -166,7 +168,7 @@ module SuspendersTestHelpers
 
   def run_in_project
     Dir.chdir(project_path) do
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         yield
       end
     end