railties 7.0.8.2 → 7.1.0.beta1

data/lib/rails/source_annotation_extractor.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "ripper"
+
 module Rails
-  # Implements the logic behind <tt>Rails::Command::NotesCommand</tt>. See <tt>rails notes --help</tt> for usage information.
+  # Implements the logic behind +Rails::Command::NotesCommand+. See <tt>rails notes --help</tt> for usage information.
   #
   # Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
   # represent the line where the annotation lives, its tag, and its text. Note
@@ -11,6 +13,44 @@ module Rails
   # start with the tag optionally followed by a colon. Everything up to the end
   # of the line (or closing ERB comment tag) is considered to be their text.
   class SourceAnnotationExtractor
+    # Wraps a regular expression that will be tested against each of the source
+    # file's comments.
+    class ParserExtractor < Struct.new(:pattern)
+      class Parser < Ripper
+        attr_reader :comments, :pattern
+
+        def initialize(source, pattern:)
+          super(source)
+          @pattern = pattern
+          @comments = []
+        end
+
+        def on_comment(value)
+          @comments << Annotation.new(lineno, $1, $2) if value =~ pattern
+        end
+      end
+
+      def annotations(file)
+        contents = File.read(file, encoding: Encoding::BINARY)
+        parser = Parser.new(contents, pattern: pattern).tap(&:parse)
+        parser.error? ? [] : parser.comments
+      end
+    end
+
+    # Wraps a regular expression that will iterate through a file's lines and
+    # test each one for the given pattern.
+    class PatternExtractor < Struct.new(:pattern)
+      def annotations(file)
+        lineno = 0
+
+        File.readlines(file, encoding: Encoding::BINARY).inject([]) do |list, line|
+          lineno += 1
+          next list unless line =~ pattern
+          list << Annotation.new(lineno, $1, $2)
+        end
+      end
+    end
+
     class Annotation < Struct.new(:line, :tag, :text)
       def self.directories
         @@directories ||= %w(app config db lib test)
@@ -42,9 +82,21 @@ module Rails
         extensions[/\.(#{exts.join("|")})$/] = block
       end
 
-      register_extensions("builder", "rb", "rake", "yml", "yaml", "ruby") { |tag| /#\s*(#{tag}):?\s*(.*)$/ }
-      register_extensions("css", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
-      register_extensions("erb") { |tag| /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/ }
+      register_extensions("builder", "rb", "rake", "ruby") do |tag|
+        ParserExtractor.new(/#\s*(#{tag}):?\s*(.*)$/)
+      end
+
+      register_extensions("yml", "yaml") do |tag|
+        PatternExtractor.new(/#\s*(#{tag}):?\s*(.*)$/)
+      end
+
+      register_extensions("css", "js") do |tag|
+        PatternExtractor.new(/\/\/\s*(#{tag}):?\s*(.*)$/)
+      end
+
+      register_extensions("erb") do |tag|
+        PatternExtractor.new(/<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/)
+      end
 
       # Returns a representation of the annotation that looks like this:
       #
@@ -111,7 +163,17 @@ module Rails
 
           if extension
             pattern = extension.last.call(tag)
-            results.update(extract_annotations_from(item, pattern)) if pattern
+
+            # In case a user-defined pattern returns nothing for the given set
+            # of tags, we exit early.
+            next unless pattern
+
+            # If a user-defined pattern returns a regular expression, we will
+            # wrap it in a PatternExtractor to keep the same API.
+            pattern = PatternExtractor.new(pattern) if pattern.is_a?(Regexp)
+
+            annotations = pattern.annotations(item)
+            results.update(item => annotations) if annotations.any?
           end
         end
       end
@@ -119,19 +181,6 @@ module Rails
       results
     end
 
-    # If +file+ is the filename of a file that contains annotations this method returns
-    # a hash with a single entry that maps +file+ to an array of its annotations.
-    # Otherwise it returns an empty hash.
-    def extract_annotations_from(file, pattern)
-      lineno = 0
-      result = File.readlines(file, encoding: Encoding::BINARY).inject([]) do |list, line|
-        lineno += 1
-        next list unless line =~ pattern
-        list << Annotation.new(lineno, $1, $2)
-      end
-      result.empty? ? {} : { file => result }
-    end
-
     # Prints the mapping from filenames to annotations in +results+ ordered by filename.
     # The +options+ hash is passed to each annotation's +to_s+.
     def display(results, options = {})

data/lib/rails/tasks/engine.rake

@@ -18,7 +18,7 @@ task "load_app" do
   task environment: "app:environment"
 
   if !defined?(ENGINE_ROOT) || !ENGINE_ROOT
-    ENGINE_ROOT = find_engine_path(APP_RAKEFILE)
+    ENGINE_ROOT = find_engine_path(Pathname.new(APP_RAKEFILE))
   end
 end
 
@@ -43,17 +43,17 @@ namespace :db do
   app_task "create"
   app_task "create:all"
 
-  desc "Drops the database for the current Rails.env (use db:drop:all to drop all databases)"
+  desc "Drop the database for the current Rails.env (use db:drop:all to drop all databases)"
   app_task "drop"
   app_task "drop:all"
 
   desc "Load fixtures into the current environment's database."
   app_task "fixtures:load"
 
-  desc "Rolls the schema back to the previous version (specify steps w/ STEP=n)."
+  desc "Roll the schema back to the previous version (specify steps w/ STEP=n)."
   app_task "rollback"
 
-  desc "Creates a database schema file (either db/schema.rb or db/structure.sql, depending on `config.active_record.schema_format`)"
+  desc "Create a database schema file (either db/schema.rb or db/structure.sql, depending on `config.active_record.schema_format`)"
   app_task "schema:dump"
 
   desc "Load a schema.rb file into the database"
@@ -65,7 +65,7 @@ namespace :db do
   desc "Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the database first)"
   app_task "setup"
 
-  desc "Retrieves the current schema version number"
+  desc "Retrieve the current schema version number"
   app_task "version"
 
   # desc 'Load the test schema'
@@ -73,12 +73,12 @@ namespace :db do
 end
 
 def find_engine_path(path)
-  return File.expand_path(Dir.pwd) if path == "/"
+  return File.expand_path(Dir.pwd) if path.root?
 
   if Rails::Engine.find(path)
-    path
+    path.to_s
   else
-    find_engine_path(File.expand_path("..", path))
+    find_engine_path(path.join(".."))
   end
 end
 

data/lib/rails/tasks/framework.rake

@@ -2,17 +2,15 @@
 
 namespace :app do
   desc "Update configs and some other initially generated files (or use just update:configs or update:bin)"
-  task update: [ "update:configs", "update:bin", "update:db", "update:active_storage", "update:upgrade_guide_info" ]
+  task update: [ "update:configs", "update:bin", "update:active_storage", "update:upgrade_guide_info" ]
 
-  desc "Applies the template supplied by LOCATION=(/path/to/template) or URL"
+  desc "Apply the template supplied by LOCATION=(/path/to/template) or URL"
   task template: :environment do
     template = ENV["LOCATION"]
     raise "No LOCATION value given. Please set LOCATION either as path to a file or a URL" if template.blank?
-    template = File.expand_path(template) unless %r{\A[A-Za-z][A-Za-z0-9+\-.]*://}.match?(template)
     require "rails/generators"
     require "rails/generators/rails/app/app_generator"
-    generator = Rails::Generators::AppGenerator.new [Rails.root], {}, { destination_root: Rails.root }
-    generator.apply template, verbose: false
+    Rails::Generators::AppGenerator.apply_rails_template(template, Rails.root)
   end
 
   namespace :templates do
@@ -46,15 +44,11 @@ namespace :app do
       Rails::AppUpdater.invoke_from_app_generator :update_config_files
     end
 
-    # desc "Adds new executables to the application bin/ directory"
+    # desc "Add new executables to the application bin/ directory"
     task :bin do
       Rails::AppUpdater.invoke_from_app_generator :update_bin_files
     end
 
-    task :db do
-      Rails::AppUpdater.invoke_from_app_generator :update_db_schema
-    end
-
     task :active_storage do
       Rails::AppUpdater.invoke_from_app_generator :update_active_storage
     end

data/lib/rails/tasks/log.rake

@@ -7,7 +7,7 @@ namespace :log do
   #   - defaults to all environments log files i.e. 'development,test,production'
   #   - ENV['LOGS']=all truncates all files i.e. log/*.log
   #   - ENV['LOGS']='test,development' truncates only specified files
-  desc "Truncates all/specified *.log files in log/ to zero bytes (specify which logs with LOGS=test,development)"
+  desc "Truncate all/specified *.log files in log/ to zero bytes (specify which logs with LOGS=test,development)"
   task :clear do
     log_files.each do |file|
       clear_log_file(file)

data/lib/rails/tasks/misc.rake

@@ -1,16 +1,5 @@
 # frozen_string_literal: true
 
-desc "Generate a cryptographically secure secret key (this is typically used to generate a secret for cookie sessions)."
-task :secret do
-  require "securerandom"
-  puts SecureRandom.hex(64)
-end
-
-desc "List versions of all Rails frameworks and the environment"
-task about: :environment do
-  puts Rails::Info
-end
-
 namespace :time do
   desc "List all time zones, list by two-letter country code (`bin/rails time:zones[US]`), or list by UTC offset (`bin/rails time:zones[-8]`)"
   task :zones, :country_or_offset do |t, args|
@@ -28,17 +17,17 @@ namespace :time do
   end
 
   namespace :zones do
-    # desc 'Displays all time zones, also available: time:zones:us, time:zones:local -- filter with OFFSET parameter, e.g., OFFSET=-6'
+    # desc 'Display all time zones, also available: time:zones:us, time:zones:local -- filter with OFFSET parameter, e.g., OFFSET=-6'
     task :all do
       build_time_zone_list ActiveSupport::TimeZone.all
     end
 
-    # desc 'Displays names of US time zones recognized by the Rails TimeZone class, grouped by offset. Results can be filtered with optional OFFSET parameter, e.g., OFFSET=-6'
+    # desc 'Display names of US time zones recognized by the Rails TimeZone class, grouped by offset. Results can be filtered with optional OFFSET parameter, e.g., OFFSET=-6'
     task :us do
       build_time_zone_list ActiveSupport::TimeZone.us_zones
     end
 
-    # desc 'Displays names of time zones recognized by the Rails TimeZone class with the same offset as the system local time'
+    # desc 'Display names of time zones recognized by the Rails TimeZone class with the same offset as the system local time'
     task :local do
       require "active_support"
       require "active_support/time"

data/lib/rails/tasks/statistics.rake

@@ -26,12 +26,13 @@ STATS_DIRECTORIES ||= [
   %w(Channel\ tests     test/channels),
   %w(Integration\ tests test/integration),
   %w(System\ tests      test/system),
-].collect do |name, dir|
-  [ name, "#{File.dirname(Rake.application.rakefile_location)}/#{dir}" ]
-end.select { |name, dir| File.directory?(dir) }
+]
 
 desc "Report code statistics (KLOCs, etc) from the application or engine"
 task :stats do
   require "rails/code_statistics"
-  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+  stat_directories = STATS_DIRECTORIES.collect do |name, dir|
+    [ name, "#{File.dirname(Rake.application.rakefile_location)}/#{dir}" ]
+  end.select { |name, dir| File.directory?(dir) }
+  CodeStatistics.new(*stat_directories).to_s
 end

data/lib/rails/tasks/tmp.rake

@@ -11,32 +11,32 @@ namespace :tmp do
 
   tmp_dirs.each { |d| directory d }
 
-  desc "Creates tmp directories for cache, sockets, and pids"
+  desc "Create tmp directories for cache, sockets, and pids"
   task create: tmp_dirs
 
   namespace :cache do
-    # desc "Clears all files and directories in tmp/cache"
+    # desc "Clear all files and directories in tmp/cache"
     task :clear do
       rm_rf Dir["tmp/cache/[^.]*"], verbose: false
     end
   end
 
   namespace :sockets do
-    # desc "Clears all files in tmp/sockets"
+    # desc "Clear all files in tmp/sockets"
     task :clear do
       rm Dir["tmp/sockets/[^.]*"], verbose: false
     end
   end
 
   namespace :pids do
-    # desc "Clears all files in tmp/pids"
+    # desc "Clear all files in tmp/pids"
     task :clear do
       rm Dir["tmp/pids/[^.]*"], verbose: false
     end
   end
 
   namespace :screenshots do
-    # desc "Clears all files in tmp/screenshots"
+    # desc "Clear all files in tmp/screenshots"
     task :clear do
       rm Dir["tmp/screenshots/[^.]*"], verbose: false
     end

data/lib/rails/tasks/zeitwerk.rake

@@ -33,7 +33,7 @@ report = ->(not_checked) do
 end
 
 namespace :zeitwerk do
-  desc "Checks project structure for Zeitwerk compatibility"
+  desc "Check project structure for Zeitwerk compatibility"
   task check: :environment do
     begin
       eager_load[]

data/lib/rails/tasks.rb

@@ -6,9 +6,7 @@ require "rake"
 %w(
   framework
   log
-  middleware
   misc
-  restart
   tmp
   yarn
   zeitwerk

data/lib/rails/templates/rails/mailers/email.html.erb

@@ -80,6 +80,11 @@
       <dd id="cc"><%= @email.header['cc'] %></dd>
     <% end %>
 
+    <% if @email.bcc %>
+      <dt>BCC:</dt>
+      <dd id="bcc"><%= @email.header['bcc'] %></dd>
+    <% end %>
+
     <dt>Date:</dt>
     <dd id="date"><%= Time.current.rfc2822 %></dd>
 
@@ -120,6 +125,26 @@
         </select>
       </dd>
     <% end %>
+
+    <% unless @email.header_fields.nil? || @email.header_fields.empty? %>
+      <dt>Headers:</dt>
+      <dd>
+        <details>
+          <summary>Show all headers</summary>
+          <table>
+          <% @email.header_fields.each do |field| %>
+            <tr>
+              <td align="right" style="color: #7f7f7f"><%= field.name %>:</td>
+              <td><%= field.value %></td>
+            </tr>
+          <% end %>
+          </table>
+        </details>
+      </dd>
+    <% end %>
+
+    <dt>EML File:</dt>
+    <dd><%= link_to "Download", action: :download %></dd>
   </dl>
 </header>
 

data/lib/rails/templates/rails/mailers/index.html.erb

@@ -1,8 +1,15 @@
-<% @previews.each do |preview| %>
-<h3><%= link_to preview.preview_name.titleize, url_for(controller: "rails/mailers", action: "preview", path: preview.preview_name) %></h3>
-<ul>
-<% preview.emails.each do |email| %>
-<li><%= link_to email, url_for(controller: "rails/mailers", action: "preview", path: "#{preview.preview_name}/#{email}") %></li>
-<% end %>
-</ul>
+<h1><%= @page_title %></h1>
+
+<% if @previews.any? %>
+  <% @previews.each do |preview| %>
+  <h3><%= link_to preview.preview_name.titleize, url_for(controller: "rails/mailers", action: "preview", path: preview.preview_name) %></h3>
+  <ul>
+  <% preview.emails.each do |email| %>
+  <li><%= link_to email, url_for(controller: "rails/mailers", action: "preview", path: "#{preview.preview_name}/#{email}") %></li>
+  <% end %>
+  </ul>
+  <% end %>
+<% else %>
+  <p>You have not defined any Action Mailer Previews.</p>
+  <p>Read <%= link_to "Action Mailer Basics", "https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails" %> to learn how to define your first.</p>
 <% end %>

data/lib/rails/templates/rails/mailers/mailer.html.erb

@@ -1,6 +1,12 @@
-<h3><%= @preview.preview_name.titleize %></h3>
-<ul>
-<% @preview.emails.each do |email| %>
-<li><%= link_to email, url_for(controller: "rails/mailers", action: "preview", path: "#{@preview.preview_name}/#{email}") %></li>
+<h1><%= @page_title %></h1>
+
+<% if @preview.emails.any? %>
+  <ul>
+  <% @preview.emails.each do |email| %>
+  <li><%= link_to email, url_for(controller: "rails/mailers", action: "preview", path: "#{@preview.preview_name}/#{email}") %></li>
+  <% end %>
+  </ul>
+<% else %>
+  <p>You have not defined any actions for <%= @preview %>.</p>
+  <p>Read <%= link_to "Action Mailer Basics", "https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails" %> to learn how to define your first.</p>
 <% end %>
-</ul>

data/lib/rails/templates/rails/welcome/index.html.erb

@@ -50,6 +50,7 @@
       border-radius: 100%;
       display: flex;
       transition: background 0.25s cubic-bezier(0.33, 1, 0.68, 1);
+      filter: drop-shadow(0 20px 13px rgb(0 0 0 / 0.03)) drop-shadow(0 8px 5px rgb(0 0 0 / 0.08));
     }
 
     nav a:hover {

data/lib/rails/test_help.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :enddoc:
+
 # Make double-sure the RAILS_ENV is not set to production,
 # so fixtures aren't loaded into that environment
 abort("Abort testing: Your Rails environment is running in production mode!") if Rails.env.production?
@@ -24,12 +26,12 @@ if defined?(ActiveRecord::Base)
     include ActiveRecord::TestDatabases
     include ActiveRecord::TestFixtures
 
-    self.fixture_path = "#{Rails.root}/test/fixtures/"
-    self.file_fixture_path = fixture_path + "files"
+    self.fixture_paths << "#{Rails.root}/test/fixtures/"
+    self.file_fixture_path = "#{Rails.root}/test/fixtures/files"
   end
 
   ActiveSupport.on_load(:action_dispatch_integration_test) do
-    self.fixture_path = ActiveSupport::TestCase.fixture_path
+    self.fixture_paths += ActiveSupport::TestCase.fixture_paths
   end
 else
   ActiveSupport.on_load(:active_support_test_case) do
@@ -37,17 +39,15 @@ else
   end
 end
 
-# :enddoc:
-
 ActiveSupport.on_load(:action_controller_test_case) do
-  def before_setup # :nodoc:
+  def before_setup
     @routes = Rails.application.routes
     super
   end
 end
 
 ActiveSupport.on_load(:action_dispatch_integration_test) do
-  def before_setup # :nodoc:
+  def before_setup
     @routes = Rails.application.routes
     super
   end

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,7 @@ 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 record(result)
       super
@@ -52,7 +52,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

data/lib/rails/test_unit/runner.rb

@@ -1,14 +1,17 @@
 # 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 Runner
+      TEST_FOLDERS = [:models, :helpers, :channels, :controllers, :mailers, :integration, :jobs, :mailboxes]
+      PATH_ARGUMENT_PATTERN = %r"^(?!/.+/$)[.\w]*[/\\]"
       mattr_reader :filters, default: []
 
       class << self
@@ -30,9 +33,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 +46,14 @@ module Rails
         end
 
         def load_tests(argv)
-          tests = list_tests(argv)
+          patterns = extract_filters(argv)
+          tests = list_tests(patterns)
           tests.to_a.each { |path| require File.expand_path(path) }
         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 +65,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
@@ -89,16 +95,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 +156,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 +178,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