railties 7.0.8 → 7.2.0

data/lib/rails/test_unit/line_filtering.rb

@@ -5,7 +5,7 @@ require "rails/test_unit/runner"
 module Rails
   module LineFiltering # :nodoc:
     def run(reporter, options = {})
-      options[:filter] = Rails::TestUnit::Runner.compose_filter(self, options[:filter])
+      options = options.merge(filter: Rails::TestUnit::Runner.compose_filter(self, options[:filter]))
 
       super
     end

data/lib/rails/test_unit/reporter.rb

@@ -6,7 +6,14 @@ require "minitest"
 module Rails
   class TestUnitReporter < Minitest::StatisticsReporter
     class_attribute :app_root
-    class_attribute :executable, default: "rails test"
+    class_attribute :executable, default: "bin/rails test"
+
+    def prerecord(test_class, test_name)
+      super
+      if options[:verbose]
+        io.print "%s#%s = " % [test_class.name, test_name]
+      end
+    end
 
     def record(result)
       super
@@ -52,7 +59,11 @@ module Rails
     end
 
     def relative_path_for(file)
-      file.sub(/^#{app_root}\/?/, "")
+      if app_root
+        file.sub(/^#{app_root}\/?/, "")
+      else
+        file
+      end
     end
 
     private
@@ -65,8 +76,7 @@ module Rails
       end
 
       def format_line(result)
-        klass = result.respond_to?(:klass) ? result.klass : result.class
-        "%s#%s = %.2f s = %s" % [klass, result.name, result.time, result.result_code]
+        "%.2f s = %s" % [result.time, result.result_code]
       end
 
       def format_rerun_snippet(result)

data/lib/rails/test_unit/runner.rb

@@ -1,14 +1,26 @@
 # frozen_string_literal: true
 
 require "shellwords"
-require "method_source"
 require "rake/file_list"
 require "active_support"
 require "active_support/core_ext/module/attribute_accessors"
+require "active_support/core_ext/range"
+require "rails/test_unit/test_parser"
 
 module Rails
   module TestUnit
+    class InvalidTestError < StandardError
+      def initialize(path, suggestion)
+        super(<<~MESSAGE.squish)
+          Could not load test file: #{path}.
+          #{suggestion}
+        MESSAGE
+      end
+    end
+
     class Runner
+      TEST_FOLDERS = [:models, :helpers, :channels, :controllers, :mailers, :integration, :jobs, :mailboxes]
+      PATH_ARGUMENT_PATTERN = %r"^(?!/.+/$)[.\w]*[/\\]"
       mattr_reader :filters, default: []
 
       class << self
@@ -30,9 +42,9 @@ module Rails
           $VERBOSE = argv.delete_at(w_index) if w_index
         end
 
-        def rake_run(argv = [])
+        def run_from_rake(test_command, argv = [])
           # Ensure the tests run during the Rake Task action, not when the process exits
-          success = system("rails", "test", *argv, *Shellwords.split(ENV["TESTOPTS"] || ""))
+          success = system("rails", test_command, *argv, *Shellwords.split(ENV["TESTOPTS"] || ""))
           success || exit(false)
         end
 
@@ -43,11 +55,29 @@ module Rails
         end
 
         def load_tests(argv)
-          tests = list_tests(argv)
-          tests.to_a.each { |path| require File.expand_path(path) }
+          patterns = extract_filters(argv)
+          tests = list_tests(patterns)
+          tests.to_a.each do |path|
+            abs_path = File.expand_path(path)
+            require abs_path
+          rescue LoadError => exception
+            if exception.path == abs_path
+              all_tests = list_tests([default_test_glob])
+              corrections = DidYouMean::SpellChecker.new(dictionary: all_tests).correct(path)
+
+              if corrections.empty?
+                raise exception
+              end
+              raise InvalidTestError.new(path, DidYouMean::Formatter.message_for(corrections))
+            else
+              raise
+            end
+          end
         end
 
         def compose_filter(runnable, filter)
+          filter = normalize_declarative_test_filter(filter)
+
           if filters.any? { |_, lines| lines.any? }
             CompositeFilter.new(runnable, filter, filters)
           else
@@ -59,11 +89,11 @@ module Rails
           def extract_filters(argv)
             # Extract absolute and relative paths but skip -n /.*/ regexp filters.
             argv.filter_map do |path|
-              next unless path_argument?(path) && !regexp_filter?(path)
+              next unless path_argument?(path)
 
               path = path.tr("\\", "/")
               case
-              when /(:\d+)+$/.match?(path)
+              when /(:\d+(-\d+)?)+$/.match?(path)
                 file, *lines = path.split(":")
                 filters << [ file, lines ]
                 file
@@ -81,7 +111,7 @@ module Rails
           end
 
           def default_test_exclude_glob
-            ENV["DEFAULT_TEST_EXCLUDE"] || "test/{system,dummy}/**/*_test.rb"
+            ENV["DEFAULT_TEST_EXCLUDE"] || "test/{system,dummy,fixtures}/**/*_test.rb"
           end
 
           def regexp_filter?(arg)
@@ -89,16 +119,27 @@ module Rails
           end
 
           def path_argument?(arg)
-            %r"^[/\\]?\w+[/\\]".match?(arg)
+            PATH_ARGUMENT_PATTERN.match?(arg)
           end
 
-          def list_tests(argv)
-            patterns = extract_filters(argv)
-
+          def list_tests(patterns)
             tests = Rake::FileList[patterns.any? ? patterns : default_test_glob]
             tests.exclude(default_test_exclude_glob) if patterns.empty?
             tests
           end
+
+          def normalize_declarative_test_filter(filter)
+            if filter.is_a?(String)
+              if regexp_filter?(filter)
+                # Minitest::Spec::DSL#it does not replace whitespace in method
+                # names, so match unmodified method names as well.
+                filter = filter.gsub(/\s+/, "_").delete_suffix("/") + "|" + filter.delete_prefix("/")
+              elsif !filter.start_with?("test_")
+                filter = "test_#{filter.gsub(/\s+/, "_")}"
+              end
+            end
+            filter
+          end
       end
     end
 
@@ -139,17 +180,21 @@ module Rails
     end
 
     class Filter # :nodoc:
-      def initialize(runnable, file, line)
+      def initialize(runnable, file, line_or_range)
         @runnable, @file = runnable, File.expand_path(file)
-        @line = line.to_i if line
+        if line_or_range
+          first, last = line_or_range.split("-").map(&:to_i)
+          last ||= first
+          @line_range = Range.new(first, last)
+        end
       end
 
       def ===(method)
         return unless @runnable.method_defined?(method)
 
-        if @line
+        if @line_range
           test_file, test_range = definition_for(@runnable.instance_method(method))
-          test_file == @file && test_range.include?(@line)
+          test_file == @file && @line_range.overlaps?(test_range)
         else
           @runnable.instance_method(method).source_location.first == @file
         end
@@ -157,10 +202,7 @@ module Rails
 
       private
         def definition_for(method)
-          file, start_line = method.source_location
-          end_line = method.source.count("\n") + start_line - 1
-
-          return file, start_line..end_line
+          TestParser.definition_for(method)
         end
     end
   end

data/lib/rails/test_unit/test_parser.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+begin
+  require "prism"
+rescue LoadError
+  # If Prism isn't available (because of using an older Ruby version) then we'll
+  # define a fallback parser using ripper.
+end
+
+if defined?(Prism)
+  module Rails
+    module TestUnit
+      # Parse a test file to extract the line ranges of all tests in both
+      # method-style (def test_foo) and declarative-style (test "foo" do)
+      module TestParser
+        # Helper to translate a method object into the path and line range where
+        # the method was defined.
+        def self.definition_for(method)
+          filepath, start_line = method.source_location
+          queue = [Prism.parse_file(filepath).value]
+
+          while (node = queue.shift)
+            case node.type
+            when :def_node
+              if node.location.start_line == start_line
+                return [filepath, start_line..node.location.end_line]
+              end
+            when :call_node
+              if node.location.start_line == start_line
+                return [filepath, start_line..node.location.end_line]
+              end
+            end
+
+            queue.concat(node.compact_child_nodes)
+          end
+
+          nil
+        end
+      end
+    end
+  end
+
+  # If we have Prism, then we don't need to define the fallback parser using
+  # ripper.
+  return
+end
+
+require "ripper"
+
+module Rails
+  module TestUnit
+    # Parse a test file to extract the line ranges of all tests in both
+    # method-style (def test_foo) and declarative-style (test "foo" do)
+    class TestParser < Ripper # :nodoc:
+      # Helper to translate a method object into the path and line range where
+      # the method was defined.
+      def self.definition_for(method_obj)
+        path, begin_line = method_obj.source_location
+        begins_to_ends = new(File.read(path), path).parse
+        return unless end_line = begins_to_ends[begin_line]
+        [path, (begin_line..end_line)]
+      end
+
+      def initialize(*)
+        # A hash mapping the 1-indexed line numbers that tests start on to where they end.
+        @begins_to_ends = {}
+        super
+      end
+
+      def parse
+        super
+        @begins_to_ends
+      end
+
+      # method test e.g. `def test_some_description`
+      # This event's first argument gets the `ident` node containing the method
+      # name, which we have overridden to return the line number of the ident
+      # instead.
+      def on_def(begin_line, *)
+        @begins_to_ends[begin_line] = lineno
+      end
+
+      # Everything past this point is to support declarative tests, which
+      # require more work to get right because of the many different ways
+      # methods can be invoked in ruby, all of which are parsed differently.
+      #
+      # The approach is just to store the current line number when the
+      # "test" method is called and pass it up the tree so it's available at
+      # the point when we also know the line where the associated block ends.
+
+      def on_method_add_block(begin_line, end_line)
+        if begin_line && end_line
+          @begins_to_ends[begin_line] = end_line
+        end
+      end
+
+      def on_command_call(*, begin_lineno, _args)
+        begin_lineno
+      end
+
+      def first_arg(arg, *)
+        arg
+      end
+
+      def just_lineno(*)
+        lineno
+      end
+
+      alias on_method_add_arg first_arg
+      alias on_command first_arg
+      alias on_stmts_add first_arg
+      alias on_arg_paren first_arg
+      alias on_bodystmt first_arg
+
+      alias on_ident just_lineno
+      alias on_do_block just_lineno
+      alias on_stmts_new just_lineno
+      alias on_brace_block just_lineno
+
+      def on_args_new
+        []
+      end
+
+      def on_args_add(parts, part)
+        parts << part
+      end
+
+      def on_args_add_block(args, *rest)
+        args.first
+      end
+    end
+  end
+end

data/lib/rails/test_unit/testing.rake

@@ -1,18 +1,13 @@
 # frozen_string_literal: true
 
-gem "minitest"
 require "minitest"
 require "rails/test_unit/runner"
 
 task default: :test
 
-desc "Runs all tests in test folder except system ones"
+desc "Run all tests in test folder except system ones"
 task :test do
-  if ENV.key?("TEST")
-    Rails::TestUnit::Runner.rake_run([ENV["TEST"]])
-  else
-    Rails::TestUnit::Runner.rake_run
-  end
+  Rails::TestUnit::Runner.run_from_rake("test", Array(ENV["TEST"]))
 end
 
 namespace :test do
@@ -23,37 +18,22 @@ namespace :test do
 
   task run: %w[test]
 
-  desc "Run tests quickly, but also reset db"
+  desc "Reset the database and run `bin/rails test`"
   task :db do
     success = system({ "RAILS_ENV" => ENV.fetch("RAILS_ENV", "test") }, "rake", "db:test:prepare", "test")
     success || exit(false)
   end
 
-  ["models", "helpers", "channels", "controllers", "mailers", "integration", "jobs", "mailboxes"].each do |name|
-    task name => "test:prepare" do
-      Rails::TestUnit::Runner.rake_run(["test/#{name}"])
+  [
+    *Rails::TestUnit::Runner::TEST_FOLDERS,
+    :all,
+    :generators,
+    :units,
+    :functionals,
+    :system,
+  ].each do |name|
+    task name do
+      Rails::TestUnit::Runner.run_from_rake("test:#{name}")
     end
   end
-
-  desc "Runs all tests, including system tests"
-  task all: "test:prepare" do
-    Rails::TestUnit::Runner.rake_run(["test/**/*_test.rb"])
-  end
-
-  task generators: "test:prepare" do
-    Rails::TestUnit::Runner.rake_run(["test/lib/generators"])
-  end
-
-  task units: "test:prepare" do
-    Rails::TestUnit::Runner.rake_run(["test/models", "test/helpers", "test/unit"])
-  end
-
-  task functionals: "test:prepare" do
-    Rails::TestUnit::Runner.rake_run(["test/controllers", "test/mailers", "test/functional"])
-  end
-
-  desc "Run system tests only"
-  task system: "test:prepare" do
-    Rails::TestUnit::Runner.rake_run(["test/system"])
-  end
 end

data/lib/rails/testing/maintain_test_schema.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+if defined?(ActiveRecord::Base)
+  begin
+    ActiveRecord::Migration.maintain_test_schema!
+  rescue ActiveRecord::PendingMigrationError => e
+    puts e.to_s.strip
+    exit 1
+  end
+
+  if Rails.configuration.eager_load
+    ActiveRecord::Base.descendants.each do |model|
+      model.load_schema if !model.abstract_class? && model.table_exists?
+    end
+  end
+end

data/lib/rails/version.rb

@@ -3,7 +3,7 @@
 require_relative "gem_version"
 
 module Rails
-  # Returns the currently loaded version of Rails as a string.
+  # Returns the currently loaded version of \Rails as a string.
   def self.version
     VERSION::STRING
   end

data/lib/rails/zeitwerk_checker.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# The actual (private) implementation of the Rake task zeitwerk:check.
+class Rails::ZeitwerkChecker # :nodoc:
+  def self.check
+    Zeitwerk::Loader.eager_load_all
+
+    autoloaded = ActiveSupport::Dependencies.autoload_paths + ActiveSupport::Dependencies.autoload_once_paths
+    eager_loaded = ActiveSupport::Dependencies._eager_load_paths.to_a
+
+    unchecked = autoloaded - eager_loaded
+    unchecked.select! { |dir| Dir.exist?(dir) && !Dir.empty?(dir)  }
+    unchecked
+  end
+end

data/lib/rails.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "rails/ruby_version_check"
-
 require "pathname"
 
 require "active_support"
@@ -10,8 +8,10 @@ require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/array/extract_options"
 require "active_support/core_ext/object/blank"
 
-require "rails/application"
 require "rails/version"
+require "rails/deprecator"
+require "rails/application"
+require "rails/backtrace_cleaner"
 
 require "active_support/railtie"
 require "action_dispatch/railtie"
@@ -22,6 +22,7 @@ silence_warnings do
   Encoding.default_internal = Encoding::UTF_8
 end
 
+# :include: ../README.rdoc
 module Rails
   extend ActiveSupport::Autoload
   extend ActiveSupport::Benchmarkable
@@ -31,6 +32,11 @@ module Rails
   autoload :MailersController
   autoload :WelcomeController
 
+  eager_autoload do
+    autoload :HealthController
+    autoload :PwaController
+  end
+
   class << self
     @application = @app_class = nil
 
@@ -42,20 +48,16 @@ module Rails
 
     delegate :initialize!, :initialized?, to: :application
 
-    # The Configuration instance used to configure the Rails environment
+    # The Configuration instance used to configure the \Rails environment
     def configuration
       application.config
     end
 
     def backtrace_cleaner
-      @backtrace_cleaner ||= begin
-        # Relies on Active Support, so we have to lazy load to postpone definition until Active Support has been loaded
-        require "rails/backtrace_cleaner"
-        Rails::BacktraceCleaner.new
-      end
+      @backtrace_cleaner ||= Rails::BacktraceCleaner.new
     end
 
-    # Returns a Pathname object of the current Rails project,
+    # Returns a Pathname object of the current \Rails project,
     # otherwise it returns +nil+ if there is no project:
     #
     #   Rails.root
@@ -64,23 +66,24 @@ module Rails
       application && application.config.root
     end
 
-    # Returns the current Rails environment.
+    # Returns the current \Rails environment.
     #
     #   Rails.env # => "development"
     #   Rails.env.development? # => true
     #   Rails.env.production? # => false
+    #   Rails.env.local? # => true              true for "development" and "test", false for anything else
     def env
       @_env ||= ActiveSupport::EnvironmentInquirer.new(ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development")
     end
 
-    # Sets the Rails environment.
+    # Sets the \Rails environment.
     #
     #   Rails.env = "staging" # => "staging"
     def env=(environment)
       @_env = ActiveSupport::EnvironmentInquirer.new(environment)
     end
 
-    # Returns the ActiveSupport::ErrorReporter of the current Rails project,
+    # Returns the ActiveSupport::ErrorReporter of the current \Rails project,
     # otherwise it returns +nil+ if there is no project.
     #
     #   Rails.error.handle(IOError) do
@@ -88,12 +91,12 @@ module Rails
     #   end
     #   Rails.error.report(error)
     def error
-      application && application.executor.error_reporter
+      ActiveSupport.error_reporter
     end
 
-    # Returns all Rails groups for loading based on:
+    # Returns all \Rails groups for loading based on:
     #
-    # * The Rails environment;
+    # * The \Rails environment;
     # * The environment variable RAILS_GROUPS;
     # * The optional envs given as argument and the hash with group dependencies;
     #
@@ -112,7 +115,7 @@ module Rails
     end
 
     # Returns a Pathname object of the public folder of the current
-    # Rails project, otherwise it returns +nil+ if there is no project:
+    # \Rails project, otherwise it returns +nil+ if there is no project:
     #
     #   Rails.public_path
     #     # => #<Pathname:/Users/someuser/some/path/project/public>