suspenders 1.55.1 → 20230113.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b9cb4553f3ffae97642ec3aa15c218be90a047c89c3ba0373fad360dd942fc
-  data.tar.gz: 962cf7626ca047b3a8e414ead6043476778717c5647dd0928efc5fd3b0b65ec6
+  metadata.gz: 606737b8d87f3fe7ccfae7c15d214df27de810600e1cb77873025d1af0f17f3d
+  data.tar.gz: 10ab96b1b4eb893b86cb9ddd40146fdb49c99d51fe03aecf579148ca7a6cbf46
 SHA512:
-  metadata.gz: 8905a5aeafa593a8d81430529f5d7bbbe1a532d87da0c7039834aa84122113f817f1ff180c055929146a40c79b772254a5faf4625d4ec49c30bc48983d4c61a2
-  data.tar.gz: 39a8250d0f32c5d09990f786625e3864400e8a41ad27fffe44d69bf2d6365c8fe765db2b99eb40d17ecf9ef86daca7a02d851b0ed9f69f6aa927558787ff3894
+  metadata.gz: 8d8f0be9c9c48c24cbd459575552dba6f3a93ad669472235e3e2a00bbe26c7cd114a798a527b8b0faeb226aaeb91bad8a98930502e82cf4e2995c90f40070d02
+  data.tar.gz: '08f52691df274a0187571d59020ca241a564ce442ac5b60427eb7a93087563fc3bb73b1719042ec957d38ed84071d0c06260a2cd18c2ca0124a7cbfd57e05ad1'

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.0.5

data/CONTRIBUTING.md

@@ -20,7 +20,7 @@ Make sure 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
+[style]: https://github.com/thoughtbot/guides/blob/main/ruby/README.md
 
     rake
 
@@ -48,7 +48,7 @@ All new contributions must be within the generator framework, as described in
 
 ## Versions
 
-To update the Ruby version, change `.ruby-version` and `.travis.yml`.
+To update the Ruby version, change `.ruby-version`.
 
 If you see this error while running tests:
 

data/NEWS.md

@@ -1,4 +1,44 @@
-Unreleased
+20230113.0 (January, 13, 2023)
+
+Support Rails 7 and Ruby 3. Introduce CalVer.
+
+* Upgraded: Ruby to 3.0.5
+* Upgraded: Supported Rails version to 7.0.0
+* Removed: Bourbon
+* Removed: Bitters
+* Removed: Autoprefixer Rails
+* Added: cssbundling-rails
+* Added: PostCSS Autoprefixer
+* Added: PostCSS Normalize
+
+1.56.1 (July 17, 2022)
+
+Fixes a critical error with the previous release
+
+* Run database migrations as the last step of bin/suspenders
+* Fix bundler error on bin/suspenders script
+
+1.56.0 (July 4, 2022)
+
+Maintenance release
+
+* Fixed: Make Suspenders fail if running with an unsupported Rails version
+* Added: Update default configuration to use request specs
+* Added: Add missing Errno::ECONNREFUSED to HTTP_ERRORS
+* Fixed: Drop use of git in gemspec
+* Fixed: Enforce bundler >= 2.1.0
+* Fixed: Make suspenders abort when something goes wrong
+* Fixed: Reliability and aesthetics of the config files comment stripper
+* Fixed: ActionMailer asset host in the production configuration
+* Added: Configure the oj gem (fast JSON parsing) when generating a new application
+* Fixed: Improve error message of the match_contents matcher
+* Fixed: Convert generator tests to unit tests thus speeding up the test suite
+* Removed: Preloader generator / spring
+* Added: Pull in DATABASE_URL env var explicitly in database.yml
+* Removed: Travis CI configuration
+* Upgraded: Ruby to version 2.7.4
+* Added: A GitHub Action for CI
+* Fixed: Run bin/suspenders in both CLI and tests against a fixed Rails version
 
 1.55.1 (September 11, 2020)
 

data/README.md

@@ -1,4 +1,7 @@
-# Suspenders [![Build Status](https://secure.travis-ci.org/thoughtbot/suspenders.svg?branch=master)](http://travis-ci.org/thoughtbot/suspenders) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
+# Suspenders
+
+[![Build Status](https://github.com/thoughtbot/suspenders/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/thoughtbot/suspenders/actions)
+[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
 
 Suspenders is the base Rails application used at
 [thoughtbot](https://thoughtbot.com/).
@@ -31,14 +34,10 @@ generated projectname/Gemfile.
 
 It includes application gems like:
 
-* [Autoprefixer Rails](https://github.com/ai/autoprefixer-rails) for CSS vendor prefixes
-* [Bourbon](https://github.com/thoughtbot/bourbon) for Sass mixins
-* [Bitters](https://github.com/thoughtbot/bitters) for scaffold application styles
-* [Delayed Job](https://github.com/collectiveidea/delayed_job) for background
+* [Sidekiq](https://github.com/mperham/sidekiq) for background
   processing
 * [High Voltage](https://github.com/thoughtbot/high_voltage) for static pages
 * [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
 * [Rack Canonical Host](https://github.com/tylerhunt/rack-canonical-host) to
@@ -64,8 +63,6 @@ And development gems like:
   unused eager loading
 * [Bundler Audit](https://github.com/rubysec/bundler-audit) for scanning the
   Gemfile for insecure dependencies based on published CVEs
-* [Spring](https://github.com/rails/spring) for fast Rails actions via
-  pre-loading
 * [Web Console](https://github.com/rails/web-console) for better debugging via
   in-browser IRB consoles.
 
@@ -74,6 +71,8 @@ And testing gems like:
 * [Capybara](https://github.com/jnicklas/capybara) and
   [Google Chromedriver]
   integration testing
+* [capybara_accessibility_audit](https://github.com/thoughtbot/capybara_accessibility_audit) and
+  [capybara_accessible_selectors](https://github.com/citizensadvice/capybara_accessible_selectors)
 * [Factory Bot](https://github.com/thoughtbot/factory_bot) for test data
 * [Formulaic](https://github.com/thoughtbot/formulaic) for integration testing
   HTML forms
@@ -102,6 +101,8 @@ Suspenders also comes with:
 * Configuration for [stylelint][stylelint]
 * The analytics adapter [Segment][segment] (and therefore config for Google
   Analytics, Intercom, Facebook Ads, Twitter Ads, etc.)
+* [PostCSS Autoprefixer][autoprefixer] for CSS vendor prefixes
+* [PostCSS Normalize][normalize] for resetting browser styles
 
 [setup]: https://robots.thoughtbot.com/bin-setup
 [compress]: https://robots.thoughtbot.com/content-compression-with-rack-deflater
@@ -112,6 +113,8 @@ Suspenders also comes with:
 [hound]: https://houndci.com
 [stylelint]: https://stylelint.io/
 [segment]: https://segment.com
+[autoprefixer]: https://github.com/postcss/autoprefixer
+[normalize]: https://github.com/csstools/postcss-normalize
 
 ## Heroku
 
@@ -162,14 +165,6 @@ This has the same effect as running:
 
     hub create organization/project
 
-## Spring
-
-Suspenders uses [spring](https://github.com/rails/spring) by default.
-It makes Rails applications load faster, but it might introduce confusing issues
-around stale code not being refreshed.
-If you think your application is running old code, run `spring stop`.
-And if you'd rather not use spring, add `DISABLE_SPRING=1` to your login file.
-
 ## Dependencies
 
 Suspenders requires the latest version of Ruby.
@@ -190,6 +185,8 @@ requires Google Chrome or Chromium.
 
 PostgreSQL needs to be installed and running for the `db:create` rake task.
 
+Redis needs to be installed and running for Sidekiq
+
 ## Issues
 
 If you have problems, please create a

data/bin/suspenders

@@ -4,14 +4,41 @@ require 'pathname'
 source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
 $LOAD_PATH << source_path
 
-require 'suspenders'
+activate_rails_version = ->(rails_version) do
+  rails_bin_path = Gem.activate_bin_path("railties", "rails", rails_version)
+  rails_path = File.expand_path("../..", rails_bin_path)
+  $LOAD_PATH.unshift(rails_path)
+end
+
+if str = ARGV.first
+  str = str.b[/\A_(.*)_\z/, 1]
+
+  if str && Gem::Version.correct?(str)
+    rails_version = str
+    ARGV.shift
+
+    begin
+      activate_rails_version.call(rails_version)
+    rescue Gem::GemNotFoundException
+      abort "Suspenders error: Unable to find Rails version #{rails_version}"
+    end
+  else
+    require "suspenders/version"
+
+    spec = Gem::Specification.find_by_name("rails", Suspenders::RAILS_VERSION)
+
+    activate_rails_version.call(spec.version.to_s)
+  end
+end
+
+require "suspenders"
 
 if ARGV.empty?
   puts "Please provide a path for the new application"
   puts
   puts "See --help for more info"
   exit 0
-elsif ['-v', '--version'].include? ARGV[0]
+elsif ["-v", "--version"].include? ARGV[0]
   puts Suspenders::VERSION
   exit 0
 end

data/docs/rails_7.md

@@ -0,0 +1,5 @@
+# Rails 7
+
+To create a new Rails 7 app with Suspenders, you need to have `node >= 14.6`.
+
+After the app is created, run the server with `bin/dev`.

data/lib/suspenders/actions/strip_comments_action.rb

@@ -0,0 +1,254 @@
+require "parser/current"
+
+module Suspenders
+  module Actions
+    class StripCommentsAction
+      class << self
+        def call(source)
+          parser = Parser::CurrentRuby.new
+
+          source
+            .then { |s| strip_comments(s, parser) }
+            .then { |s| strip_trailing_whitespace(s) }
+            .then { |s| strip_dup_newlines(s) }
+            .then { |s| strip_leading_scope_newlines(s, parser) }
+        end
+
+        private
+
+        def strip_comments(source, parser)
+          StripComments.call(source, parser.reset)
+        end
+
+        def strip_trailing_whitespace(source)
+          source.gsub(/[[:blank:]]+$/, "")
+        end
+
+        def strip_dup_newlines(source)
+          source.gsub(/\n{2,}/, "\n\n")
+        end
+
+        def strip_leading_scope_newlines(source, parser)
+          StripLeadingScopeNewlines.call(source, parser.reset)
+        end
+      end
+
+      # Strips full-line and inline comments from a buffer but does
+      # not remove whitespaces or newlines after the fact. Example
+      # input:
+      #
+      #     MyGem.application.configure do |config|
+      #       # Full-line comment
+      #       config.option1 = :value # Inline comment
+      #     end
+      #
+      # The output is:
+      #
+      #     MyGem.application.configure do |config|
+      #
+      #       config.option1 = :value
+      #     end
+      class StripComments
+        class << self
+          def call(source, parser)
+            buffer = Parser::Source::Buffer.new(nil, source: source)
+            rewriter = Parser::Source::TreeRewriter.new(buffer)
+
+            _, comments = parser.parse_with_comments(buffer)
+
+            comments.each do |comment|
+              strip_comment(comment, buffer, rewriter)
+            end
+
+            rewriter.process
+          end
+
+          private
+
+          def strip_comment(comment, buffer, rewriter)
+            expr = comment.location.expression
+
+            if full_line_comment?(expr)
+              expr = full_line_comment_expr(expr, buffer)
+            end
+
+            rewriter.remove(expr)
+          end
+
+          def full_line_comment_expr(expr, buffer)
+            pos = BackwardStringScanner.beginning_of_line_pos(expr, expr.begin_pos)
+
+            Parser::Source::Range.new(buffer, pos, expr.end_pos + 1)
+          end
+
+          def full_line_comment?(expr)
+            expr.source == expr.source_line.lstrip
+          end
+        end
+      end
+
+      # A tiny, non-stateful backward string scanner somewhat inspired
+      # by Ruby's StringScanner. Ruby's StringScanner is unable to
+      # seek backward on a string.
+      class BackwardStringScanner
+        def self.beginning_of_line_pos(expr, initial_pos)
+          skip_before(expr, initial_pos) { |char| char == "\n" }
+        end
+
+        def self.skip_before(expr, initial_pos, &block)
+          skip_until(expr, initial_pos, -1, &block)
+        end
+
+        def self.skip_until(expr, initial_pos, lookup_inc = 0)
+          pos = initial_pos
+
+          loop do
+            break if pos.zero?
+            char = expr.source_buffer.source[pos + lookup_inc]
+            break if yield(char)
+            pos -= 1
+          end
+
+          pos
+        end
+      end
+
+      # The intent of this class is purely aesthetic: remove leading
+      # newlines inside of code scopes like blocks and begin/end.
+      # Example input:
+      #
+      #     module MyGem
+      #
+      #       MyGem.application.configure do |config|
+      #
+      #         config.option1 = true
+      #
+      #         config.option2 = false
+      #       end
+      #     end
+      #
+      # The output is:
+      #
+      #     module MyGem
+      #       MyGem.application.configure do |config|
+      #         config.option1 = true
+      #
+      #         config.option2 = false
+      #       end
+      #     end
+      class StripLeadingScopeNewlines
+        def self.call(source, parser)
+          buffer = Parser::Source::Buffer.new(nil, source: source)
+          ast = parser.parse(buffer)
+
+          LeadingNewlineStripRewriter.new.rewrite(buffer, ast).lstrip
+        end
+
+        class LeadingNewlineStripRewriter < Parser::TreeRewriter
+          def on_module(node)
+            strip_newline_before(node.children[1])
+            strip_newline_after(node.children.last)
+
+            super
+          end
+
+          def on_class(node)
+            strip_newline_before(node.children[2])
+            strip_newline_after(node.children.last)
+
+            super
+          end
+
+          def on_begin(node)
+            handle_begin(node)
+
+            super
+          end
+
+          def on_kwbegin(node)
+            strip_newline_before(node.children[0])
+            strip_newline_after(node.children.last)
+
+            handle_begin(node)
+
+            super
+          end
+
+          def on_block(node)
+            strip_newline_before(node.children[2])
+            strip_newline_after(node.children.last)
+
+            super
+          end
+
+          private
+
+          def handle_begin(node)
+            strip_blank_lines_between_setter_calls(node.children)
+
+            node.children.each do |child_node|
+              send("on_#{child_node.type}", child_node)
+            end
+          end
+
+          def strip_blank_lines_between_setter_calls(children)
+            pairs = children.each_cons(2).to_a
+
+            pairs.each do |(node_before, node_after)|
+              if setter_call?(node_before) && setter_call?(node_after)
+                strip_newline_before(node_after)
+              end
+            end
+          end
+
+          def setter_call?(node)
+            node.children[1].to_s.end_with?("=")
+          end
+
+          def strip_newline_before(node)
+            return if node.nil?
+
+            expr = node.location.expression
+            end_pos = find_end_pos(expr, expr.begin_pos)
+            begin_pos = find_begin_pos(expr, end_pos)
+
+            strip_source_range(expr, begin_pos, end_pos)
+          end
+
+          def strip_newline_after(node)
+            return if node.nil?
+
+            expr = node.location.expression
+            source = expr.source_buffer.source
+
+            if source[expr.end_pos + 1] == "\n"
+              strip_source_range(expr, expr.end_pos, expr.end_pos + 1)
+            end
+          end
+
+          def find_end_pos(expr, begin_pos)
+            BackwardStringScanner.skip_until(expr, begin_pos) do |char|
+              char == "\n"
+            end
+          end
+
+          def find_begin_pos(expr, end_pos)
+            BackwardStringScanner.skip_before(expr, end_pos) do |char|
+              char != "\n" && char != " "
+            end
+          end
+
+          def strip_source_range(expr, begin_pos, end_pos)
+            remove(
+              Parser::Source::Range.new(
+                expr.source_buffer,
+                begin_pos,
+                end_pos
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/suspenders/actions.rb

@@ -6,7 +6,7 @@ module Suspenders
       unless contents.gsub!(find, replace)
         raise "#{find.inspect} not found in #{relative_path}"
       end
-      File.open(path, "w") { |file| file.write(contents) }
+      File.write(path, contents)
     end
 
     def action_mailer_host(rails_env, host)
@@ -31,6 +31,27 @@ module Suspenders
       action ExpandJson.new(destination_root, file, data)
     end
 
+    def gem(*args)
+      options = args.extract_options!
+      name, *versions = args
+
+      parts = [quote(name)]
+
+      if (versions = versions.any? ? versions : options.delete(:version))
+        versions = Array(versions)
+        versions.each do |version|
+          parts << quote(version)
+        end
+      end
+
+      parts << quote(options) unless options.empty?
+
+      str = []
+      str << indentation
+      str << "gem #{parts.join(", ")}"
+      append_file "Gemfile", %(\n#{str.join}\n), verbose: false
+    end
+
     class ExpandJson
       def initialize(destination_root, file, data)
         @destination_root = destination_root

data/lib/suspenders/app_builder.rb

@@ -75,13 +75,19 @@ module Suspenders
       run "chmod a+x bin/setup"
     end
 
+    def provide_yarn_script
+      template "bin_yarn", "bin/yarn", force: true
+      run "chmod a+x bin/yarn"
+    end
+
     def configure_generators
       config = <<-RUBY
 
     config.generators do |generate|
       generate.helper false
       generate.javascripts false
-      generate.request_specs false
+      generate.controller_specs false
+      generate.request_specs true
       generate.routing_specs false
       generate.stylesheets false
       generate.test_framework :rspec
@@ -99,13 +105,13 @@ module Suspenders
 
     def setup_asset_host
       replace_in_file "config/environments/production.rb",
-        "# config.action_controller.asset_host = 'http://assets.example.com'",
-        'config.action_controller.asset_host = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))'
+        %(# config.asset_host = "http://assets.example.com"),
+        'config.asset_host = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))'
 
       if File.exist?("config/initializers/assets.rb")
         replace_in_file "config/initializers/assets.rb",
-          "config.assets.version = '1.0'",
-          'config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'
+          %(Rails.application.config.assets.version = "1.0"),
+          'Rails.application.config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'
       end
 
       config = <<~EOD
@@ -134,10 +140,14 @@ module Suspenders
       bundle_command "exec rails db:create db:migrate"
     end
 
-    def replace_gemfile(path)
+    def run_database_migrations
+      bundle_command "exec rails db:migrate"
+    end
+
+    def replace_gemfile
       template "Gemfile.erb", "Gemfile", force: true do |content|
-        if path
-          content.gsub(%r{gem .suspenders.}) { |s| %(#{s}, path: "#{path}") }
+        if development_env?
+          content.gsub(%r{gem .suspenders.}) { |s| %(#{s}, path: "#{root_path}") }
         else
           content
         end
@@ -168,10 +178,12 @@ module Suspenders
       action_mailer_host "test", %("www.example.com")
       action_mailer_asset_host "test", %("http://www.example.com")
       action_mailer_host "production", %{ENV.fetch("APPLICATION_HOST")}
+      # rubocop:disable Lint/InterpolationCheck
       action_mailer_asset_host(
         "production",
-        %{ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))}
+        %q{"https://#{ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))}"}
       )
+      # rubocop:enable Lint/InterpolationCheck
     end
 
     def create_heroku_apps(flags)
@@ -203,15 +215,10 @@ module Suspenders
       ]
 
       config_files.each do |config_file|
-        path = File.join(destination_root, "config/#{config_file}")
-
-        accepted_content = File.readlines(path).reject { |line|
-          line =~ /^.*#.*$/ || line =~ /^$\n/
-        }
+        path = Pathname(destination_root).join("config", config_file)
+        source = Actions::StripCommentsAction.call(path.read)
 
-        File.open(path, "w") do |file|
-          accepted_content.each { |line| file.puts line }
-        end
+        path.write(source)
       end
     end
 
@@ -226,7 +233,7 @@ module Suspenders
         <<~EOS
           task(:default).clear
           task default: [:spec]
-          
+
           if defined? RSpec
             task(:spec).clear
             RSpec::Core::RakeTask.new(:spec) do |t|
@@ -239,8 +246,16 @@ module Suspenders
 
     private
 
+    def root_path
+      @root_path ||= Pathname(__dir__).join("..", "..").expand_path
+    end
+
+    def development_env?
+      root_path.join("suspenders.gemspec").exist?
+    end
+
     def raise_on_missing_translations_in(environment)
-      config = "config.action_view.raise_on_missing_translations = true"
+      config = "config.i18n.raise_on_missing_translations = true"
 
       uncomment_lines("config/environments/#{environment}.rb", config)
     end

data/lib/suspenders/exit_on_failure.rb

@@ -0,0 +1,19 @@
+require "active_support/concern"
+require "English"
+
+module Suspenders
+  module ExitOnFailure
+    extend ActiveSupport::Concern
+
+    def bundle_command(*)
+      super
+      exit(false) if $CHILD_STATUS.exitstatus.nonzero?
+    end
+
+    module ClassMethods
+      def exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/suspenders/generators/accessibility_generator.rb

@@ -0,0 +1,12 @@
+require_relative "base"
+
+module Suspenders
+  class AccessibilityGenerator < Generators::Base
+    def capybara_gems
+      gem "capybara_accessibility_audit", group: [:test]
+      gem "capybara_accessible_selectors", group: [:test],
+        github: "citizensadvice/capybara_accessible_selectors"
+      Bundler.with_unbundled_env { run "bundle install" }
+    end
+  end
+end

data/lib/suspenders/generators/advisories_generator.rb

@@ -3,7 +3,7 @@ require_relative "base"
 module Suspenders
   class AdvisoriesGenerator < Generators::Base
     def bundler_audit_gem
-      gem "bundler-audit", ">= 0.7.0", require: false, group: %i[development test]
+      gem "bundler-audit", ">= 0.7.0", require: false, group: [:development, :test]
       Bundler.with_unbundled_env { run "bundle install" }
     end