suspenders 1.49.0 → 1.54.0

data/templates/_javascript.html.erb

@@ -1,10 +1,3 @@
-<%= javascript_include_tag :application %>
+<%= javascript_pack_tag :application %>
 
 <%= yield :javascript %>
-
-<% if Rails.env.test? %>
-  <%= javascript_tag do %>
-    $.fx.off = true;
-    $.ajaxSetup({ async: false });
-  <% end %>
-<% 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/capybara_silence_puma.rb

@@ -0,0 +1 @@
+Capybara.server = :puma, { Silent: true }

data/templates/chromedriver.rb

@@ -5,13 +5,23 @@ Capybara.register_driver :chrome do |app|
 end
 
 Capybara.register_driver :headless_chrome do |app|
-  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-    chromeOptions: { args: %w(headless disable-gpu) },
-  )
+  options = ::Selenium::WebDriver::Chrome::Options.new
+  options.headless!
+  options.add_argument "--window-size=1680,1050"
 
   Capybara::Selenium::Driver.new app,
     browser: :chrome,
-    desired_capabilities: capabilities
+    options: options
 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.

data/templates/descriptions/single_redirect.md

@@ -0,0 +1 @@
+Canonicalize the URL by configuring the `Rack::CanonicalHost` middleware.

data/templates/descriptions/static.md

@@ -0,0 +1,5 @@
+Easily add static pages to your dynamic Rails app.
+
+Files placed in the `app/views/pages` directory are rendered using the standard
+Rails view renderer and accessible at `/pages/:view_name`, via the
+`high_voltage` gem.

data/templates/descriptions/stylelint.md

@@ -0,0 +1,3 @@
+Enable stylesheet linting.
+
+This configures the stylelint tool to work locally and integrated with Hound.

data/templates/descriptions/stylesheet_base.md

@@ -0,0 +1,4 @@
+Set up the basic tools needed for the thoughtbot design system.
+
+This integrates the Bourbon library of Scss mixins with Normalize.css as a
+reset, then re-styles it by bringing Bitters into your project.

data/templates/descriptions/testing.md

@@ -0,0 +1,9 @@
+Set up the project for an in-depth test-driven development workflow.
+
+- Maintain the test DB schema.
+- Clear mail deliveries between tests.
+- Import i18n helpers for use in tests.
+- Prepare for system tests in `spec/system`.
+- Integrate Formulaic for easier form testing.
+- RSpec infers the file type based on the directory name.
+- Install and configure RSpec and shoulda-matchers, with Spring integration.

data/templates/descriptions/timeout.md

@@ -0,0 +1,4 @@
+Kill Rack requests that last too long.
+
+This adds the `rack-timeout` gem and configures it to kill the connection after
+10 seconds.

data/templates/descriptions/views.md

@@ -0,0 +1,8 @@
+View templates for flash, JavaScript, and CSS.
+
+- Disable CSS animations in tests.
+- Run JavaScript when the page has loaded.
+- Use the `title` gem for controlling the page title via i18n.
+- Insert one-off JavaScript into a `:javascript` content block.
+- Creates the directory for storing generic, application-level partials.
+- Render user-facing partials (alert, error, notice, success) on all pages.

data/templates/factory_bot_rspec.rb

@@ -1,3 +1,5 @@
+FactoryBot.use_parent_strategy = true
+
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
 end

data/templates/hound.yml

@@ -10,5 +10,7 @@ ruby:
   # config_file: .ruby-style.yml
   enabled: true
 scss:
-  # config_file: .scss-style.yml
+  enabled: false
+stylelint:
+  # config_file: .stylelintrc.json
   enabled: true

data/templates/inline_svg.rb

@@ -0,0 +1,3 @@
+InlineSvg.configure do |config|
+  config.raise_on_file_not_found = true
+end

data/templates/partials/ci_simplecov.rb

@@ -0,0 +1,16 @@
+if ENV.fetch("COVERAGE", false)
+  require "simplecov"
+
+  if ENV["CIRCLE_ARTIFACTS"]
+    dir = File.join(ENV["CIRCLE_ARTIFACTS"], "coverage")
+    SimpleCov.coverage_dir(dir)
+  end
+
+
+  SimpleCov.start "rails"
+
+  if defined?(Spring) && ENV["DISABLE_SPRING"].to_i == 1
+    Rails.application.eager_load!
+  end
+end
+

data/templates/partials/db_optimizations_configuration.rb

@@ -0,0 +1,7 @@
+
+
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+  end

data/templates/partials/deployment_readme.md

@@ -0,0 +1,8 @@
+
+## Deploying
+
+If you have previously run the `./bin/setup` script,
+you can deploy to staging and production with:
+
+    % ./bin/deploy staging
+    % ./bin/deploy production

data/templates/partials/email_smtp.rb

@@ -0,0 +1,3 @@
+
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = SMTP_SETTINGS

data/templates/partials/profiler_readme.md

@@ -0,0 +1,8 @@
+
+## Profiler
+
+The [rack-mini-profiler] gem can be enabled by setting
+`RACK_MINI_PROFILER=1` in the environment. This will display a speed
+badge on every page.
+
+[rack-mini-profiler]: https://github.com/MiniProfiler/rack-mini-profiler

data/templates/partials/pull_requests_config.rb

@@ -0,0 +1,5 @@
+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
+

data/templates/partials/runner_readme.md

@@ -0,0 +1,31 @@
+## Configuration
+
+Environment variables during local development are handled by the node-foreman
+project runner. To provide environment variables, create a `.env` file at the
+root of the project. In that file provide the environment variables listed in
+`.sample.env`. The `bin/setup` script does this for you, but be careful about
+overwriting your existing `.env` file.
+
+`app.json` also contains a list of environment variables that are required for
+the application. The `.sample.env` file provides either non-secret vars that
+can be copied directly into your own `.env` file or instructions on where to
+obtain secret values.
+
+During development add any new environment variables needed by the application
+to both `.sample.env` and `app.json`, providing either **public** default
+values or brief instructions on where secret values may be found.
+
+Do not commit the `.env` file to the git repo.
+
+## Running the Application
+
+Use the `heroku local` runner to run the app locally as it would run on Heroku.
+This uses the node-forman runner, which reads from the `Procfile` file.
+
+```sh
+heroku local
+```
+
+Once the server is started the application is reachable at
+`http://localhost:3000`.
+

data/templates/partials/runner_setup.rb

@@ -0,0 +1,3 @@
+puts "\n== Copying sample env =="
+system! 'cp -i .sample.env .env'
+

data/templates/rack_mini_profiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if ENV["RACK_MINI_PROFILER"].to_i > 0
   require "rack-mini-profiler"
 

data/templates/rails_helper.rb

@@ -1,19 +1,22 @@
 ENV["RACK_ENV"] = "test"
 
 require File.expand_path("../../config/environment", __FILE__)
-abort("DATABASE_URL environment variable is set") if ENV["DATABASE_URL"]
+
+if Rails.env.production?
+  abort("The Rails environment is running in production mode!")
+end
 
 require "rspec/rails"
 
 Dir[Rails.root.join("spec/support/**/*.rb")].sort.each { |file| require file }
 
-module Features
-  # Extend this module in spec/support/features/*.rb
+module SystemTestHelper
+  # Extend this module in spec/support/system/*.rb
   include Formulaic::Dsl
 end
 
 RSpec.configure do |config|
-  config.include Features, type: :feature
+  config.include SystemTestHelper, type: :system
   config.infer_base_class_for_anonymous_controllers = false
   config.infer_spec_type_from_file_location!
   config.use_transactional_fixtures = true

data/templates/{dotfiles/.env → sample_env}

@@ -3,9 +3,7 @@ ASSET_HOST=localhost:3000
 APPLICATION_HOST=localhost:3000
 PORT=3000
 RACK_ENV=development
-RACK_MINI_PROFILER=0
 SECRET_KEY_BASE=development_secret
-EXECJS_RUNTIME=Node
 SMTP_ADDRESS=smtp.example.com
 SMTP_DOMAIN=example.com
 SMTP_PASSWORD=password

data/templates/spec_helper.rb

@@ -1,9 +1,3 @@
-if ENV.fetch("COVERAGE", false)
-  require "simplecov"
-
-  SimpleCov.start "rails"
-end
-
 require "webmock/rspec"
 require "timecop"
 
@@ -22,7 +16,10 @@ RSpec.configure do |config|
   config.order = :random
 end
 
-WebMock.disable_net_connect!(allow_localhost: true)
+WebMock.disable_net_connect!(
+  allow_localhost: true,
+  allow: "chromedriver.storage.googleapis.com",
+)
 
 # Only allow Timecop with block syntax
 Timecop.safe_mode = true

data/templates/spring.rb

@@ -0,0 +1,6 @@
+Spring.watch(
+  ".ruby-version",
+  ".rbenv-vars",
+  "tmp/restart.txt",
+  "tmp/caching-dev.txt",
+)