suspenders 1.55.1 → 1.56.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b9cb4553f3ffae97642ec3aa15c218be90a047c89c3ba0373fad360dd942fc
-  data.tar.gz: 962cf7626ca047b3a8e414ead6043476778717c5647dd0928efc5fd3b0b65ec6
+  metadata.gz: 683a61a7377c93edb0f396688cd578f338bcdc5de7ffb28276165e1bb81edcc4
+  data.tar.gz: c5a8d3b44cd4c8f9277b0f7d4c223b034b4ae93d050830c3f8755eef1766814e
 SHA512:
-  metadata.gz: 8905a5aeafa593a8d81430529f5d7bbbe1a532d87da0c7039834aa84122113f817f1ff180c055929146a40c79b772254a5faf4625d4ec49c30bc48983d4c61a2
-  data.tar.gz: 39a8250d0f32c5d09990f786625e3864400e8a41ad27fffe44d69bf2d6365c8fe765db2b99eb40d17ecf9ef86daca7a02d851b0ed9f69f6aa927558787ff3894
+  metadata.gz: 7646058fca03e48da09e9a3a26ec4ca21f9e07a51ff2394f548b231c1b50d78ea514c27589473039ed9cb86e9fddb6614ca00bad68dbe19800590f56e6124c46
+  data.tar.gz: 67cffd8fa9c7fe841ec6595545bb200b38f500baef0036b9bf29be8c7950b59fb27ed8f2094933fd9d8b00760981a516bd17f6d5e83765290d0ba74fac44c73f

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.7.4

data/CONTRIBUTING.md

@@ -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,31 @@
-Unreleased
+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/).
@@ -64,8 +67,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.
 
@@ -162,14 +163,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.

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/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)

data/lib/suspenders/app_builder.rb

@@ -81,7 +81,8 @@ module Suspenders
     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
@@ -134,6 +135,10 @@ module Suspenders
       bundle_command "exec rails db:create db:migrate"
     end
 
+    def run_database_migrations
+      bundle_command "exec rails db:migrate"
+    end
+
     def replace_gemfile(path)
       template "Gemfile.erb", "Gemfile", force: true do |content|
         if path
@@ -168,10 +173,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 +210,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 +228,7 @@ module Suspenders
         <<~EOS
           task(:default).clear
           task default: [:spec]
-          
+
           if defined? RSpec
             task(:spec).clear
             RSpec::Core::RakeTask.new(:spec) do |t|

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/app_generator.rb

@@ -3,31 +3,33 @@ require "rails/generators/rails/app/app_generator"
 
 module Suspenders
   class AppGenerator < Rails::Generators::AppGenerator
+    include ExitOnFailure
+
     hide!
 
     class_option :database, type: :string, aliases: "-d", default: "postgresql",
-                            desc: "Configure for selected database (options: #{DATABASES.join("/")})"
+      desc: "Configure for selected database (options: #{DATABASES.join("/")})"
 
     class_option :heroku, type: :boolean, aliases: "-H", default: false,
-                          desc: "Create staging and production Heroku apps"
+      desc: "Create staging and production Heroku apps"
 
     class_option :heroku_flags, type: :string, default: "",
-                                desc: "Set extra Heroku flags"
+      desc: "Set extra Heroku flags"
 
     class_option :github, type: :string, default: nil,
-                          desc: "Create Github repository and add remote origin pointed to repo"
+      desc: "Create Github repository and add remote origin pointed to repo"
 
     class_option :version, type: :boolean, aliases: "-v", group: :suspenders,
-                           desc: "Show Suspenders version number and quit"
+      desc: "Show Suspenders version number and quit"
 
     class_option :help, type: :boolean, aliases: "-h", group: :suspenders,
-                        desc: "Show this help message and quit"
+      desc: "Show this help message and quit"
 
     class_option :path, type: :string, default: nil,
-                        desc: "Path to the gem"
+      desc: "Path to the gem"
 
     class_option :skip_test, type: :boolean, default: true,
-                             desc: "Skip Test Unit"
+      desc: "Skip Test Unit"
 
     class_option :skip_system_test,
       type: :boolean, default: true, desc: "Skip system test files"
@@ -35,6 +37,9 @@ module Suspenders
     class_option :skip_turbolinks,
       type: :boolean, default: true, desc: "Skip turbolinks gem"
 
+    class_option :skip_spring, type: :boolean, default: true,
+      desc: class_options[:skip_spring].description
+
     def finish_template
       invoke :suspenders_customization
       super
@@ -54,6 +59,7 @@ module Suspenders
       invoke :generate_deployment_default
       invoke :remove_config_comment_lines
       invoke :remove_routes_comment_lines
+      invoke :run_database_migrations
       invoke :outro
     end
 
@@ -137,19 +143,21 @@ module Suspenders
       build :remove_routes_comment_lines
     end
 
+    def run_database_migrations
+      build :run_database_migrations
+    end
+
     def generate_default
-      run("spring stop")
+      run("spring stop > /dev/null 2>&1 || true")
       generate("suspenders:runner")
       generate("suspenders:profiler")
       generate("suspenders:json")
       generate("suspenders:static")
-      generate("suspenders:stylesheet_base")
+      generate("suspenders:stylesheet_base") unless options[:api]
       generate("suspenders:testing")
       generate("suspenders:ci")
       generate("suspenders:js_driver")
-      unless options[:api]
-        generate("suspenders:forms")
-      end
+      generate("suspenders:forms") unless options[:api]
       generate("suspenders:db_optimizations")
       generate("suspenders:factories")
       generate("suspenders:lint")
@@ -157,7 +165,6 @@ module Suspenders
       generate("suspenders:analytics")
       generate("suspenders:inline_svg")
       generate("suspenders:advisories")
-      generate("suspenders:preloader")
     end
 
     def generate_deployment_default

data/lib/suspenders/generators/base.rb

@@ -5,6 +5,7 @@ module Suspenders
   module Generators
     class Base < Rails::Generators::Base
       include Suspenders::Actions
+      include ExitOnFailure
 
       def self.default_source_root
         File.expand_path(File.join("..", "..", "..", "templates"), __dir__)

data/lib/suspenders/generators/json_generator.rb

@@ -6,5 +6,9 @@ module Suspenders
       gem "oj"
       Bundler.with_unbundled_env { run "bundle install" }
     end
+
+    def configure_oj
+      copy_file "oj.rb", "config/initializers/oj.rb"
+    end
   end
 end

data/lib/suspenders/generators/production/email_generator.rb

@@ -7,14 +7,14 @@ module Suspenders
         copy_file "smtp.rb", "config/smtp.rb"
 
         prepend_file "config/environments/production.rb",
-          %{require Rails.root.join("config/smtp")\n}
+          %{require Rails.root.join("config/smtp")\n\n}
       end
 
       def use_smtp
         inject_template_into_file(
           "config/environments/production.rb",
           "partials/email_smtp.rb",
-          after: "config.action_mailer.perform_caching = false"
+          after: "config.action_mailer.perform_caching = false\n"
         )
       end
 

data/lib/suspenders/generators/testing_generator.rb

@@ -3,8 +3,7 @@ require_relative "base"
 module Suspenders
   class TestingGenerator < Generators::Base
     def add_testing_gems
-      gem "spring-commands-rspec", group: :development
-      gem "rspec-rails", "~> 3.6", group: %i[development test]
+      gem "rspec-rails", "~> 5.1", group: %i[development test]
       gem "shoulda-matchers", group: :test
 
       Bundler.with_unbundled_env { run "bundle install" }

data/lib/suspenders/version.rb

@@ -4,5 +4,5 @@ module Suspenders
     .read("#{File.dirname(__FILE__)}/../../.ruby-version")
     .strip
     .freeze
-  VERSION = "1.55.1".freeze
+  VERSION = "1.56.1".freeze
 end

data/lib/suspenders.rb

@@ -1,4 +1,5 @@
 require "suspenders/version"
+require "suspenders/exit_on_failure"
 require "suspenders/generators/advisories_generator"
 require "suspenders/generators/app_generator"
 require "suspenders/generators/static_generator"
@@ -16,7 +17,6 @@ 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"
@@ -28,5 +28,6 @@ require "suspenders/generators/production/manifest_generator"
 require "suspenders/generators/production/single_redirect"
 require "suspenders/generators/staging/pull_requests_generator"
 require "suspenders/actions"
+require "suspenders/actions/strip_comments_action"
 require "suspenders/adapters/heroku"
 require "suspenders/app_builder"

data/templates/descriptions/testing.md

@@ -6,4 +6,4 @@ Set up the project for an in-depth test-driven development workflow.
 - 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.
+- Install and configure RSpec and shoulda-matchers.

data/templates/errors.rb

@@ -12,6 +12,7 @@ HTTP_ERRORS = [
   EOFError,
   Errno::ECONNRESET,
   Errno::EINVAL,
+  Errno::ECONNREFUSED,
   Net::HTTPBadResponse,
   Net::HTTPHeaderSyntaxError,
   Net::ProtocolError,

data/templates/oj.rb

@@ -0,0 +1,3 @@
+require "oj"
+
+Oj.optimize_rails