suspenders 1.52.0 → 1.55.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac150f675b3270f914eb84e55db71e6572b28739664d1deae487d5032ca15efb
-  data.tar.gz: 3fe1ff01eec2e5e65ec5d36fd9f3393d31ba293b1c03c05a459bcaa763b78695
+  metadata.gz: 61b9cb4553f3ffae97642ec3aa15c218be90a047c89c3ba0373fad360dd942fc
+  data.tar.gz: 962cf7626ca047b3a8e414ead6043476778717c5647dd0928efc5fd3b0b65ec6
 SHA512:
-  metadata.gz: c29d991bc59425305115fb9e8bb1f41cf7ed7fcd61db8ee47c138fabfc82ab03700bdc087cd2d9b9663550ec26610fef5dd91f089511428db8379bd03b4605d7
-  data.tar.gz: 168f752abb44cad62c016ce5c801cf0f72e891adee72910522c4498f832d558842e8dba055c703c44dcaf66d95dfafd790c8a74ee2c4b4b50ee193a2c211398f
+  metadata.gz: 8905a5aeafa593a8d81430529f5d7bbbe1a532d87da0c7039834aa84122113f817f1ff180c055929146a40c79b772254a5faf4625d4ec49c30bc48983d4c61a2
+  data.tar.gz: 39a8250d0f32c5d09990f786625e3864400e8a41ad27fffe44d69bf2d6365c8fe765db2b99eb40d17ecf9ef86daca7a02d851b0ed9f69f6aa927558787ff3894

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.6.6

data/.standard.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "templates/partials/db_optimizations_configuration.rb"

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
-rvm: 2.6.3
+rvm: 2.6.6
 cache: bundler
-sudo: false
 before_install:
+  - nvm install 13.12.0
   - git config --global user.name 'Travis CI'
   - git config --global user.email 'travis-ci@example.com'
   - gem update --system
-  - gem install bundler -v '< 2'
+  - gem install bundler
+  - bundler config --global disable_platform_warnings true
 install: bundle install
 notifications:
   email: false
+services:
+  - postgresql

data/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Contributing
 
-We love pull requests from everyone. By participating in this project, you agree
-to abide by the thoughtbot [code of conduct].
+We love pull requests from everyone. By participating in this project, you
+agree to abide by the thoughtbot [code of conduct].
 
 [code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
 
@@ -17,17 +17,15 @@ Make sure the tests pass:
 
     rake
 
-Make your change.
-Write tests.
-Follow our [style guide][style].
-Make the tests pass:
+Make your change. Write tests. Follow our [style guide][style]. Make the tests
+pass:
 
 [style]: https://github.com/thoughtbot/guides/tree/master/style
 
     rake
 
-Mention how your changes affect the project to other developers and users in the
-`NEWS.md` file.
+Mention how your changes affect the project to other developers and users in
+the `NEWS.md` file.
 
 Write a [good commit message][commit].
 Push to your fork.
@@ -36,19 +34,21 @@ Push to your fork.
 [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 [pr]: https://github.com/thoughtbot/suspenders/compare/
 
-If [Hound] catches style violations,
-fix them.
+If [Hound] catches style violations, fix them.
 
 [hound]: https://houndci.com
 
-Wait for us.
-We try to at least comment on pull requests within one business day.
-We may suggest changes.
+Wait for us. We try to at least comment on pull requests within one business
+day. We may suggest changes.
+
+## Generators
+
+All new contributions must be within the generator framework, as described in
+[our goals](GOALS.md).
 
 ## Versions
 
-To update the Ruby version,
-change `.ruby-version` and `.travis.yml`.
+To update the Ruby version, change `.ruby-version` and `.travis.yml`.
 
 If you see this error while running tests:
 

data/GOALS.md

@@ -0,0 +1,65 @@
+# Goals
+
+Suspenders is an opinionated platform for adding functionality to a Rails app.
+It encodes thoughtbot's opinions and decisions in tooling and best practices.
+
+We are transitioning to a library of generators. All new functionality must be
+in the form of a well-tested, self-contained generator that fits within the
+Suspenders framework.
+
+## History and transitions
+
+In the beginning suspenders was a git repo that we would clone then use as a
+template for starting a new Rails app.
+
+It then became a command-line tool that would generate a Rails app then modify
+the files in place. Over time, and with intention, most of the modifications
+were focused on modifying the Gemfile.
+
+This was identified as unscalable and we have been slowing been moving in a new
+direction: a library of generators.
+
+## The future
+
+The problem with a script that adds a bunch of gem requirements to the Gemfile
+is: what if you don't want all those gems? Suspenders adds gem requirements and
+then configures each one. On a typical project we would run Suspenders then
+spend the rest of the day un-doing the parts we don't want.
+
+In 2015, [PR #511], we discussed what we want: a gem that is a library of
+generators that we can run on demand. The ideal future workflow goes like this:
+
+[PR #511]: https://github.com/thoughtbot/suspenders/pull/511
+
+1. `rails new my-cool-project && cd my-cool-project`
+2. `echo "gem 'suspenders', group: :development" >> Gemfile && bundle`
+3. `rails g suspenders:ci`
+4. Repeat with other generators as needed.
+
+In this future you would use `rails new` as normal and instead add Suspenders
+as a development gem. This gives you access to opinionated generators for
+adding (and removing!) whole functionality, but on demand and with your
+knowledge.
+
+The generators are all named to generically describe what functionality they
+add. In this way we can change our opinions on the implementation without
+needing to know new generator names. For example, `suspenders:ci` could
+configure the app for CircleCI now, but down the road we may decide to switch
+everything to Jenkins; we could update the implementation of the generator
+without changing its name.
+
+## From here to there
+
+The transition looks like this:
+
+1. Introduce a `suspenders:all` generator that runs Suspenders against an
+   existing Rails app.
+2. Change the Suspenders program to create a Rails app, add Suspenders to the
+   Gemfile, and run `suspenders:all` inside of it.
+3. Slowly split functionality out from the "all" generator and into smaller,
+   well-tested, self-contained generators. The "all" generator invokes these
+   generators.
+4. Once that is completed -- once "all" _only_ calls other generators -- then
+   remove the Suspenders program and only distribute the gem.
+
+We are on step (3), and it's a big one. Come help out!

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/NEWS.md

@@ -1,3 +1,55 @@
+Unreleased
+
+1.55.1 (September 11, 2020)
+
+* Fixed: Missing newline in generated development config
+
+1.55.0 (July 15, 2020)
+
+* Changed: lint generator to install standard instead of RuboCop
+* Changed: profile generator and timeout generator to write to `.sample.env`
+  instead of `.env`
+
+1.54.1 (June 30, 2020)
+
+* Fixed: invalid Gemfile entry for bundler-audit
+* Fixed: Deprecation warning for `Bundler.with_clean_env`
+
+1.54.0 (June 24, 2020)
+
+* New generator: `suspenders:single_redirect` for setting up `Rack::CanonicalHost`
+* New generator: `suspenders:production:compression` for setting up `Rack::Deflater`
+* New generator: `suspenders:preloader` for managing spring
+* New generator: `suspenders:advisories` for installing bundler-audit
+* New generator: `suspenders:profiler` for setting up rack\_mini\_profiler
+* New generator: `suspenders:runner` for making an app runnable locally
+* Added: generator descriptions
+* Added: Heroku release phase for running database migrations
+* Added: automatic buildpack configuration for Heroku
+* Added: system test configuration to opt into JavaScript as needed
+* Added: spring-watcher-listen gem
+* Changed: from `chromedriver-helper` to `webdrivers`
+* Changed: replace `heroku join` calls with `heroku apps:info` in `bin/setup`
+* Changed: check environment instead of `DATABASE\_URL` in test helper
+* Fixed: `ExpandJson` merging
+* Fixed: spacing in the generated config file
+* Upgraded: bitters to version 2.x
+* Upgraded: bourbon to version 6.x
+* Upgraded: Ruby to version 2.6.6
+* Removed: neat gem
+* Removed: ctags configuration
+* Removed: custom placeholder directories
+* Removed: customization for error pages
+* Removed: custom Puma config
+
+1.53.0 (August 23, 2019)
+* Upgraded: Rails 6.0.
+* New generator: `suspenders:inline_svg` for setting up the inline_svg gem.
+* Changed: silence Puma's startup messages in JS specs.
+* Changed: improve chromedriver configuration.
+* Added: documentation for deploying to Heroku.
+* Fixed: indentation in production config file.
+
 1.52.0 (June 7, 2019)
 * Changed: Setup system tests instead of feature specs
 * Upgraded: Rails 5.2.3

data/README.md

@@ -37,8 +37,7 @@ It includes application gems like:
 * [Delayed Job](https://github.com/collectiveidea/delayed_job) for background
   processing
 * [High Voltage](https://github.com/thoughtbot/high_voltage) for static pages
-* [Honeybadger](https://honeybadger.io) for exception notification
-* [Neat](https://github.com/thoughtbot/neat) for semantic grids
+* [Honeybadger](https://www.honeybadger.io/?affiliate=A43uwl) for exception notification
 * [Normalize](https://necolas.github.io/normalize.css/) for resetting browser styles
 * [Oj](http://www.ohler.com/oj/)
 * [Postgres](https://github.com/ged/ruby-pg) for access to the Postgres database
@@ -53,7 +52,6 @@ It includes application gems like:
 * [Skylight](https://www.skylight.io/) for monitoring performance
 * [Title](https://github.com/calebthompson/title) for storing titles in
   translations
-* [Puma](https://github.com/puma/puma) to serve HTTP requests
 
 And development gems like:
 
@@ -117,6 +115,8 @@ Suspenders also comes with:
 
 ## Heroku
 
+Read the documentation on [deploying to Heroku][heroku deploy]
+
 You can optionally create Heroku staging and production apps:
 
     suspenders app --heroku true
@@ -131,6 +131,7 @@ This:
 * Schedules automated backups for 10AM UTC for both `staging` and `production`
 
 [Heroku Pipeline]: https://devcenter.heroku.com/articles/pipelines
+[heroku deploy]: https://github.com/thoughtbot/suspenders/blob/master/docs/heroku_deploy.md
 
 You can optionally specify alternate Heroku flags:
 
@@ -154,7 +155,7 @@ bypass this with the `--skip-git` option:
 You can optionally create a GitHub repository for the suspended Rails app. It
 requires that you have [Hub](https://github.com/github/hub) on your system:
 
-    curl https://hub.github.com/standalone -sLo ~/bin/hub && chmod +x ~/bin/hub
+    brew install hub # macOS, for other systems see https://github.com/github/hub#installation
     suspenders app --github organization/project
 
 This has the same effect as running:
@@ -222,6 +223,6 @@ See [our other projects][community].
 We are [available for hire][hire].
 
 [thoughtbot]: https://thoughtbot.com?utm_source=github
-[thoughtbot-logo]: http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg
+[thoughtbot-logo]: https://thoughtbot.com/brand_assets/93:44.svg
 [community]: https://thoughtbot.com/community?utm_source=github
 [hire]: https://thoughtbot.com?utm_source=github

data/Rakefile

@@ -1,8 +1,9 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:rspec)
 
-desc 'Run the test suite'
-task :default => :rspec
+desc "Run the test suite"
+task default: [:rspec, :standard]

data/docs/heroku_deploy.md

@@ -0,0 +1,19 @@
+# Deploying to Heroku
+
+## Setup
+
+Deploying to Heroku requires two additional steps:
+
+1. Set the following environment variables:
+
+- `ASSET_HOST`: `siteURL.herokuapp.com`
+- `APPLICATION_HOST`: `siteURL.herokuapp.com`
+- `SMTP_ADDRESS`: `smtp.example.com`
+- `SMTP_DOMAIN`: `example.com`
+- `SMTP_USERNAME`: `username`
+- `SMTP_PASSWORD`: `password`
+- `AUTO_MIGRATE_DB`: `true`
+
+## Execution
+
+- Use the `./bin/deploy` convention for deploying to Heroku

data/lib/suspenders.rb

@@ -1,4 +1,5 @@
 require "suspenders/version"
+require "suspenders/generators/advisories_generator"
 require "suspenders/generators/app_generator"
 require "suspenders/generators/static_generator"
 require "suspenders/generators/stylesheet_base_generator"
@@ -14,11 +15,17 @@ require "suspenders/generators/views_generator"
 require "suspenders/generators/js_driver_generator"
 require "suspenders/generators/json_generator"
 require "suspenders/generators/testing_generator"
+require "suspenders/generators/inline_svg_generator"
+require "suspenders/generators/preloader_generator"
+require "suspenders/generators/profiler_generator"
+require "suspenders/generators/runner_generator"
 require "suspenders/generators/production/force_tls_generator"
+require "suspenders/generators/production/compression_generator"
 require "suspenders/generators/production/email_generator"
 require "suspenders/generators/production/timeout_generator"
 require "suspenders/generators/production/deployment_generator"
 require "suspenders/generators/production/manifest_generator"
+require "suspenders/generators/production/single_redirect"
 require "suspenders/generators/staging/pull_requests_generator"
 require "suspenders/actions"
 require "suspenders/adapters/heroku"

data/lib/suspenders/actions.rb

@@ -39,7 +39,7 @@ module Suspenders
       end
 
       def invoke!
-        write_out { |existing_json| existing_json.merge(data) }
+        write_out { |existing_json| existing_json.deep_merge(data) }
       end
 
       def revoke!
@@ -60,7 +60,7 @@ module Suspenders
       end
 
       def existing_json
-        JSON.parse(IO.read(destination_file))
+        JSON.parse(IO.read(destination_file), symbolize_names: true)
       rescue Errno::ENOENT
         {}
       end

data/lib/suspenders/adapters/heroku.rb

@@ -7,8 +7,8 @@ module Suspenders
 
       def set_heroku_remotes
         remotes = <<~SHELL
-          #{command_to_join_heroku_app('staging')}
-          #{command_to_join_heroku_app('production')}
+          #{command_to_join_heroku_app("staging")}
+          #{command_to_join_heroku_app("production")}
 
           git config heroku.remote staging
         SHELL
@@ -29,28 +29,28 @@ module Suspenders
       end
 
       def set_heroku_rails_secrets
-        %w(staging production).each do |environment|
+        %w[staging production].each do |environment|
           run_toolbelt_command(
             "config:add SECRET_KEY_BASE=#{generate_secret}",
-            environment,
+            environment
           )
         end
       end
 
       def set_heroku_honeybadger_env
-        %w(staging production).each do |environment|
+        %w[staging production].each do |environment|
           run_toolbelt_command(
             "config:add HONEYBADGER_ENV=#{environment}",
-            environment,
+            environment
           )
         end
       end
 
       def set_heroku_backup_schedule
-        %w(staging production).each do |environment|
+        %w[staging production].each do |environment|
           run_toolbelt_command(
             "pg:backups:schedule DATABASE_URL --at '10:00 UTC'",
-            environment,
+            environment
           )
         end
       end
@@ -65,21 +65,34 @@ module Suspenders
         run_toolbelt_command(
           "pipelines:create #{heroku_app_name} \
             -a #{heroku_app_name}-staging --stage staging",
-          "staging",
+          "staging"
         )
 
         run_toolbelt_command(
           "pipelines:add #{heroku_app_name} \
             -a #{heroku_app_name}-production --stage production",
-          "production",
+          "production"
         )
       end
 
       def set_heroku_application_host
-        %w(staging production).each do |environment|
+        %w[staging production].each do |environment|
           run_toolbelt_command(
             "config:add APPLICATION_HOST=#{heroku_app_name}-#{environment}.herokuapp.com",
-            environment,
+            environment
+          )
+        end
+      end
+
+      def set_heroku_buildpacks
+        %w[staging production].each do |environment|
+          run_toolbelt_command(
+            "buildpacks:add --index 1 heroku/nodejs",
+            environment
+          )
+          run_toolbelt_command(
+            "buildpacks:add --index 2 heroku/ruby",
+            environment
           )
         end
       end
@@ -92,7 +105,7 @@ module Suspenders
         heroku_app_name = heroku_app_name_for(environment)
         <<~SHELL
 
-          if heroku join --app #{heroku_app_name} > /dev/null 2>&1; then
+          if heroku apps:info --app #{heroku_app_name} > /dev/null 2>&1; then
             git remote add #{environment} git@heroku.com:#{heroku_app_name}.git || true
             printf 'You are a collaborator on the "#{heroku_app_name}" Heroku app\n'
           else
@@ -115,7 +128,7 @@ module Suspenders
 
       def run_toolbelt_command(command, environment)
         app_builder.run(
-          "heroku #{command} --remote #{environment}",
+          "heroku #{command} --remote #{environment}"
         )
       end
     end