suspenders 1.53.0 → 1.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aa31ed704361dcb4c7c5dae040f6000a65e958f436038df81a74fa719ccdd47
-  data.tar.gz: ceb17403f61961694b1b08298c4100188c26d1d64abc6b5db0f97216f7a9093e
+  metadata.gz: 2389cebef8ac193b9632f09376e8dd6d736a523335da8bf23a26e746fc0c208a
+  data.tar.gz: d2f55bd0ed92869ab361f6316c7a4da22f4dc09ace0d08a8116b8cde9cfe10fd
 SHA512:
-  metadata.gz: 54d43d08ed81085648996f38127d960bffa732ae61735e40bfd19de93f5593b7e71a9bdc5c42e69f20410eaa0f8d79fcface14285158494510d9f231c422b45d
-  data.tar.gz: '083ab7ad3e0a0a473d78f01e5d542ac15462a2965d0179b56dcd98b7ab32ff62d504251e359e907a5ac0e333eb3eb1127e4f0dfc2bbe265422f9ddd6aeb674c0'
+  metadata.gz: 41478b2123c847c22ce82024138a86d699985d5cb749c59caac67f5777919d05ad97f8eaca0d5054dd48afd69b3325946138102475113ec5a38c6bb7d1385220
+  data.tar.gz: f0f6c6f77792d2857cd47e6a004f7815a994cac4015819bc14297978e2d33992c4bd68b0a20f12f83c1fb8204038da3f13ac5abfe5cbc1f5be94b24a39729499

data/.ruby-version

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

data/.travis.yml

@@ -1,12 +1,13 @@
 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

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/NEWS.md

@@ -1,3 +1,32 @@
+Unreleased
+
+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.

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:
 
@@ -225,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/docs/heroku_deploy.md

@@ -4,11 +4,7 @@
 
 Deploying to Heroku requires two additional steps:
 
-1. Manually add buildpacks `node.js` and `ruby` (in that order) to your Heroku
-   app. This is necessary because build order is important and Heroku's
-   auto-detection will add them in the wrong order.
-
-2. Set the following environment variables:
+1. Set the following environment variables:
 
 - `ASSET_HOST`: `siteURL.herokuapp.com`
 - `APPLICATION_HOST`: `siteURL.herokuapp.com`
@@ -16,6 +12,7 @@ Deploying to Heroku requires two additional steps:
 - `SMTP_DOMAIN`: `example.com`
 - `SMTP_USERNAME`: `username`
 - `SMTP_PASSWORD`: `password`
+- `AUTO_MIGRATE_DB`: `true`
 
 ## Execution
 

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"
@@ -15,11 +16,16 @@ 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

@@ -84,6 +84,19 @@ module Suspenders
         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
+
       private
 
       attr_reader :app_builder
@@ -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

data/lib/suspenders/app_builder.rb

@@ -15,6 +15,7 @@ module Suspenders
       :set_heroku_honeybadger_env,
       :set_heroku_rails_secrets,
       :set_heroku_remotes,
+      :set_heroku_buildpacks,
     )
 
     def readme
@@ -96,18 +97,6 @@ module Suspenders
       copy_file "email.rb", "config/initializers/email.rb"
     end
 
-    def enable_rack_canonical_host
-      config = <<-RUBY
-config.middleware.use Rack::CanonicalHost, ENV.fetch("APPLICATION_HOST")
-      RUBY
-
-      configure_environment "production", config
-    end
-
-    def enable_rack_deflater
-      configure_environment "production", "config.middleware.use Rack::Deflater"
-    end
-
     def setup_asset_host
       replace_in_file 'config/environments/production.rb',
         "# config.action_controller.asset_host = 'http://assets.example.com'",
@@ -185,82 +174,25 @@ config.public_file_server.headers = {
       )
     end
 
-    def replace_default_puma_configuration
-      copy_file "puma.rb", "config/puma.rb", force: true
-    end
-
-    def set_up_forego
-      copy_file "Procfile", "Procfile"
-    end
-
-    def setup_default_directories
-      [
-        'app/views/pages',
-        'spec/lib',
-        'spec/controllers',
-        'spec/helpers',
-        'spec/support/matchers',
-        'spec/support/mixins',
-        'spec/support/shared_examples'
-      ].each do |dir|
-        empty_directory_with_keep_file dir
-      end
-    end
-
-    def copy_dotfiles
-      directory("dotfiles", ".")
-    end
-
     def create_heroku_apps(flags)
       create_staging_heroku_app(flags)
       create_production_heroku_app(flags)
     end
 
     def configure_automatic_deployment
-      deploy_command = <<-YML.strip_heredoc
-      deployment:
-        staging:
-          branch: master
-          commands:
-            - bin/deploy staging
-      YML
-
-      append_file "circle.yml", deploy_command
+      append_file "Procfile", "release: bin/auto_migrate\n"
+      copy_file "bin_auto_migrate", "bin/auto_migrate"
     end
 
     def create_github_repo(repo_name)
       run "hub create #{repo_name}"
     end
 
-    def setup_bundler_audit
-      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
-      append_file "Rakefile", %{\ntask default: "bundle:audit"\n}
-    end
-
-    def setup_spring
-      bundle_command "exec spring binstub --all"
-    end
-
     def copy_miscellaneous_files
       copy_file "errors.rb", "config/initializers/errors.rb"
       copy_file "json_encoding.rb", "config/initializers/json_encoding.rb"
     end
 
-    def customize_error_pages
-      meta_tags =<<-EOS
-  <meta charset="utf-8" />
-  <meta name="viewport" content="initial-scale=1" />
-      EOS
-
-      %w(500 404 422).each do |page|
-        path = "public/#{page}.html"
-        if File.exist?(path)
-          inject_into_file path, meta_tags, after: "<head>\n"
-          replace_in_file path, /<!--.+-->\n/, ''
-        end
-      end
-    end
-
     def remove_config_comment_lines
       config_files = [
         "application.rb",

data/lib/suspenders/generators/advisories_generator.rb

@@ -0,0 +1,19 @@
+require_relative "base"
+
+module Suspenders
+  class AdvisoriesGenerator < Generators::Base
+    def bundler_audit_gem
+      gem "bundler-audit",
+          require: false,
+          group: %i[development test],
+          git: "https://github.com/rubysec/bundler-audit.git",
+          branch: "0.7.0"
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def rake_task
+      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
+      append_file "Rakefile", %{\ntask default: "bundle:audit"\n}
+    end
+  end
+end

data/lib/suspenders/generators/app_generator.rb

@@ -47,14 +47,9 @@ module Suspenders
       invoke :setup_secret_token
       invoke :configure_app
       invoke :copy_miscellaneous_files
-      invoke :customize_error_pages
-      invoke :setup_dotfiles
       invoke :setup_database
       invoke :create_github_repo
-      invoke :setup_bundler_audit
-      invoke :setup_spring
       invoke :generate_default
-      invoke :setup_default_directories
       invoke :create_heroku_apps
       invoke :generate_deployment_default
       invoke :remove_config_comment_lines
@@ -92,8 +87,6 @@ module Suspenders
 
     def setup_production_environment
       say 'Setting up the production environment'
-      build :enable_rack_canonical_host
-      build :enable_rack_deflater
       build :setup_asset_host
     end
 
@@ -107,9 +100,6 @@ module Suspenders
       build :configure_action_mailer
       build :configure_time_formats
       build :setup_default_rake_task
-      build :replace_default_puma_configuration
-      build :set_up_forego
-      build :setup_rack_mini_profiler
     end
 
     def create_heroku_apps
@@ -121,6 +111,7 @@ module Suspenders
         build :set_heroku_application_host
         build :set_heroku_honeybadger_env
         build :set_heroku_backup_schedule
+        build :set_heroku_buildpacks
         build :create_heroku_pipeline
         build :configure_automatic_deployment
       end
@@ -133,34 +124,11 @@ module Suspenders
       end
     end
 
-    def setup_dotfiles
-      build :copy_dotfiles
-    end
-
-    def setup_default_directories
-      build :setup_default_directories
-    end
-
-    def setup_bundler_audit
-      say "Setting up bundler-audit"
-      build :setup_bundler_audit
-    end
-
-    def setup_spring
-      say "Springifying binstubs"
-      build :setup_spring
-    end
-
     def copy_miscellaneous_files
       say 'Copying miscellaneous support files'
       build :copy_miscellaneous_files
     end
 
-    def customize_error_pages
-      say 'Customizing the 500/404/422 pages'
-      build :customize_error_pages
-    end
-
     def remove_config_comment_lines
       build :remove_config_comment_lines
     end
@@ -171,6 +139,7 @@ module Suspenders
 
     def generate_default
       run("spring stop")
+      generate("suspenders:profiler")
       generate("suspenders:json")
       generate("suspenders:static")
       generate("suspenders:stylesheet_base")
@@ -186,10 +155,15 @@ module Suspenders
       generate("suspenders:jobs")
       generate("suspenders:analytics")
       generate("suspenders:inline_svg")
+      generate("suspenders:advisories")
+      generate("suspenders:runner")
+      generate("suspenders:preloader")
     end
 
     def generate_deployment_default
       generate("suspenders:staging:pull_requests")
+      generate("suspenders:production:single_redirect")
+      generate("suspenders:production:compression")
       generate("suspenders:production:force_tls")
       generate("suspenders:production:email")
       generate("suspenders:production:timeout")