suspenders 1.53.0 → 1.54.0

data/spec/features/production/manifest_spec.rb

@@ -8,6 +8,7 @@ RSpec.describe "suspenders:production:manifest", type: :generator do
       name: SuspendersTestHelpers::APP_NAME.dasherize,
       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 },
@@ -24,6 +25,7 @@ RSpec.describe "suspenders:production:manifest", type: :generator do
       name: SuspendersTestHelpers::APP_NAME.dasherize,
       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/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(".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(".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/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/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/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
@@ -135,6 +125,19 @@ module SuspendersTestHelpers
     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)
     had_key = ENV.has_key?(name)
     prior = ENV[name]

data/suspenders.gemspec

@@ -28,9 +28,8 @@ rush to build something amazing; don't use it if you like missing deadlines.
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.version = Suspenders::VERSION
 
-  s.add_dependency 'bitters', '~> 1.7'
+  s.add_dependency 'bitters', '>= 2.0.4'
   s.add_dependency 'rails', Suspenders::RAILS_VERSION
 
   s.add_development_dependency 'rspec', '~> 3.2'
-  s.add_development_dependency 'rack-timeout'
 end

data/templates/Gemfile.erb

@@ -19,22 +19,18 @@ gem "rails", "<%= Suspenders::RAILS_VERSION %>"
 gem "recipient_interceptor"
 gem "sassc-rails"
 gem "skylight"
-gem "sprockets", ">= 3.0.0"
+gem "sprockets", "< 4"
 gem "title"
 gem "tzinfo-data", platforms: [:mingw, :x64_mingw, :mswin, :jruby]
 gem "webpacker"
 
 group :development do
   gem "listen"
-  gem "rack-mini-profiler", require: false
-  gem "spring"
   gem "web-console"
 end
 
 group :development, :test do
   gem "awesome_print"
-  gem "bundler-audit", ">= 0.5.0", require: false
-  gem "dotenv-rails"
   gem "pry-byebug"
   gem "pry-rails"
 end
@@ -42,7 +38,6 @@ end
 group :test do
   gem "formulaic"
   gem "launchy"
-  gem "simplecov", require: false
   gem "timecop"
   gem "webmock"
 end

data/templates/application.scss

@@ -3,6 +3,5 @@
 @import "normalize.css/normalize";
 
 @import "bourbon";
-@import "neat";
 
 @import "base/base";

data/templates/bin_auto_migrate

@@ -0,0 +1,5 @@
+ set -e
+
+ if [ -n "$AUTO_MIGRATE_DB" ]; then
+   bundle exec rake db:migrate
+ fi

data/templates/bin_deploy

@@ -8,5 +8,3 @@ branch="$(git symbolic-ref HEAD --short)"
 target="${1:-staging}"
 
 git push "$target" "$branch:master"
-heroku run rails db:migrate --exit-code --remote "$target"
-heroku restart --remote "$target"

data/templates/bin_setup

@@ -24,5 +24,5 @@ if [ ! -d .git/safe ] && echo $PATH | grep .git/safe > /dev/null; then
 fi
 
 # Only if this isn't CI
-# if [ -z "$CI" ]; then
-# fi
+if [ -z "$CI" ]; then
+fi

data/templates/bin_setup_review_app.erb

@@ -17,6 +17,5 @@ heroku pg:backups:capture --app $PARENT_APP_NAME
 URL=`heroku pg:backups public-url --app $PARENT_APP_NAME`
 
 heroku pg:backups restore $URL DATABASE_URL --confirm $APP_NAME --app $APP_NAME
-heroku run rails db:migrate --exit-code --app $APP_NAME
 heroku ps:scale worker=1 --app $APP_NAME
 heroku restart --app $APP_NAME

data/templates/chromedriver.rb

@@ -15,3 +15,13 @@ Capybara.register_driver :headless_chrome do |app|
 end
 
 Capybara.javascript_driver = :headless_chrome
+
+RSpec.configure do |config|
+  config.before(:each, type: :system) do
+    driven_by :rack_test
+  end
+
+  config.before(:each, type: :system, js: true) do
+    driven_by Capybara.javascript_driver
+  end
+end

data/templates/descriptions/advisories.md

@@ -0,0 +1,5 @@
+Show security advisories during development.
+
+Uses the `bundler-audit` gem and rake task to update the local security
+database and show any relevant issues with the app's dependencies. This happens
+on every test run and interaction with `bin/rake` and `bin/rails`.

data/templates/descriptions/analytics.md

@@ -0,0 +1,4 @@
+Work with a user analytics service.
+
+Add the JavaScript for connecting to Segment to a partial and, if possible,
+include that partial on every page.

data/templates/descriptions/ci.md

@@ -0,0 +1,4 @@
+Prepare the app for running tests on a continuous integration service.
+
+Sets up a CircleCI configuration using `bin/setup` to initialize the app and
+`rake` to run the tests. Use SimpleCov for code coverage metrics on CI.

data/templates/descriptions/compression.md

@@ -0,0 +1,4 @@
+Compress HTTP requests at the Rails layer.
+
+This uses `Rack::Deflater`, and is done at the app layer instead of at the Web
+server layer.

data/templates/descriptions/db_optimizations.md

@@ -0,0 +1,2 @@
+Get database performance insights as you develop. This installs and configures
+Bullet.

data/templates/descriptions/deployment.md

@@ -0,0 +1,5 @@
+Script and document the deployment.
+
+This adds a `bin/deploy` script, to be called like `deploy staging` or
+`deploy production`, along with updates to the README.md describing how to use
+it.

data/templates/descriptions/email.md

@@ -0,0 +1,9 @@
+Configure the app for email.
+
+Set the app up with SMTP in production. This expects the following environment
+variables to be set:
+
+- `SMTP_ADDRESS`
+- `SMTP_DOMAIN`
+- `SMTP_PASSWORD`
+- `SMTP_USERNAME`

data/templates/descriptions/factories.md

@@ -0,0 +1,12 @@
+Build test data with clarity and ease.
+
+This uses FactoryBot to help you define dummy and test data for your test
+suite. The `create`, `build`, and `build_stubbed` class methods are directly
+available to all tests.
+
+We recommend putting FactoryBot definitions in one `spec/factories.rb` file, at
+least until it grows unwieldy. This helps reduce confusion around circular
+dependencies and makes it easy to jump between definitions.
+
+Outside of the tests, the `dev:prime` rake task can be used to insert initial
+development data into the database. You can use FactoryBot here, too.

data/templates/descriptions/force_tls.md

@@ -0,0 +1 @@
+Redirect users to the HTTPS URL on the production Web site.

data/templates/descriptions/forms.md

@@ -0,0 +1 @@
+Make forms easier to make with form helpers. This mostly involves SimpleForm.

data/templates/descriptions/inline_svg.md

@@ -0,0 +1,2 @@
+Render SVG images inline, as a potential performance improvement for the
+viewer.

data/templates/descriptions/jobs.md

@@ -0,0 +1,3 @@
+Set up our favorite job runner.
+
+Currently we like DelayedJob. Run all tests inline by default.

data/templates/descriptions/js_driver.md

@@ -0,0 +1,4 @@
+Set up the test suite for running JavaScript tests.
+
+This uses the latest and greatest JavaScript test runner -- currently,
+chromedriver. It comes with a headless mode and a headful/debugging mode.

data/templates/descriptions/json.md

@@ -0,0 +1 @@
+Use the fastest JSON parser available.

data/templates/descriptions/lint.md

@@ -0,0 +1,3 @@
+Prepare the app for style linting.
+
+This sets up your app to use Hound with a default Hound configuration.

data/templates/descriptions/manifest.md

@@ -0,0 +1,2 @@
+Write the AppManifest (`app.json`) document with all the environment variables
+we require.

data/templates/descriptions/preloader.md

@@ -0,0 +1,3 @@
+Speed up your Rails development flow with a preloader.
+
+This installs Spring, including the Spring binstubs.

data/templates/descriptions/profiler.md

@@ -0,0 +1,7 @@
+Show runtime profiling for your Rails app as you develop it.
+
+This uses the `rack-mini-profiler` gem to show a speed badge on every page.
+This is controlled by the `RACK_MINI_PROFILER` environment variable which
+defaults to `0` in the `.sample.env`. Set it to `1` to enable profiling.
+
+Updates your README.md to explain this environment variable.

data/templates/descriptions/pull_requests.md

@@ -0,0 +1,4 @@
+Create a staging environment for each pull request.
+
+This glues Heroku review apps to GitHub pull requests, populating the database
+from the generic staging environment on a low-scale review app.

data/templates/descriptions/runner.md

@@ -0,0 +1,10 @@
+Set up the app to run locally with ease.
+
+Use Puma and the Rails jobs runner to run the app. This can be done via either
+`heroku local` or any Foreman-compatible project runner (e.g. `foreman start`).
+
+Configure your app using `.env`. Installs a basic `.sample.env` that is meant
+to be checked into git and used as a template for your `.env`. The `bin/setup`
+script is modified to safely copy `.sample.env` to `.env` for you.
+
+Document all of this in the README.