railties 7.0.8.7 → 7.2.2.1

data/lib/rails/railtie.rb

@@ -7,34 +7,34 @@ require "active_support/core_ext/module/introspection"
 require "active_support/core_ext/module/delegation"
 
 module Rails
-  # <tt>Rails::Railtie</tt> is the core of the Rails framework and provides
-  # several hooks to extend Rails and/or modify the initialization process.
+  # +Rails::Railtie+ is the core of the \Rails framework and provides
+  # several hooks to extend \Rails and/or modify the initialization process.
   #
-  # Every major component of Rails (Action Mailer, Action Controller, Active
+  # Every major component of \Rails (Action Mailer, Action Controller, Active
   # Record, etc.) implements a railtie. Each of them is responsible for their
-  # own initialization. This makes Rails itself absent of any component hooks,
-  # allowing other components to be used in place of any of the Rails defaults.
+  # own initialization. This makes \Rails itself absent of any component hooks,
+  # allowing other components to be used in place of any of the \Rails defaults.
   #
-  # Developing a Rails extension does _not_ require implementing a railtie, but
-  # if you need to interact with the Rails framework during or after boot, then
+  # Developing a \Rails extension does _not_ require implementing a railtie, but
+  # if you need to interact with the \Rails framework during or after boot, then
   # a railtie is needed.
   #
   # For example, an extension doing any of the following would need a railtie:
   #
   # * creating initializers
-  # * configuring a Rails framework for the application, like setting a generator
+  # * configuring a \Rails framework for the application, like setting a generator
   # * adding <tt>config.*</tt> keys to the environment
   # * setting up a subscriber with ActiveSupport::Notifications
   # * adding Rake tasks
   #
   # == Creating a Railtie
   #
-  # To extend Rails using a railtie, create a subclass of <tt>Rails::Railtie</tt>.
-  # This class must be loaded during the Rails boot process, and is conventionally
-  # called <tt>MyNamespace::Railtie</tt>.
+  # To extend \Rails using a railtie, create a subclass of +Rails::Railtie+.
+  # This class must be loaded during the \Rails boot process, and is conventionally
+  # called +MyNamespace::Railtie+.
   #
   # The following example demonstrates an extension which can be used with or
-  # without Rails.
+  # without \Rails.
   #
   #   # lib/my_gem/railtie.rb
   #   module MyGem
@@ -47,11 +47,11 @@ module Rails
   #
   # == Initializers
   #
-  # To add an initialization step to the Rails boot process from your railtie, just
+  # To add an initialization step to the \Rails boot process from your railtie, just
   # define the initialization code with the +initializer+ macro:
   #
-  #   class MyRailtie < Rails::Railtie
-  #     initializer "my_railtie.configure_rails_initialization" do
+  #   class MyGem::Railtie < Rails::Railtie
+  #     initializer "my_gem.configure_rails_initialization" do
   #       # some initialization behavior
   #     end
   #   end
@@ -59,9 +59,9 @@ module Rails
   # If specified, the block can also receive the application object, in case you
   # need to access some application-specific configuration, like middleware:
   #
-  #   class MyRailtie < Rails::Railtie
-  #     initializer "my_railtie.configure_rails_initialization" do |app|
-  #       app.middleware.use MyRailtie::Middleware
+  #   class MyGem::Railtie < Rails::Railtie
+  #     initializer "my_gem.configure_rails_initialization" do |app|
+  #       app.middleware.use MyGem::Middleware
   #     end
   #   end
   #
@@ -74,53 +74,53 @@ module Rails
   # Railties can access a config object which contains configuration shared by all
   # railties and the application:
   #
-  #   class MyRailtie < Rails::Railtie
+  #   class MyGem::Railtie < Rails::Railtie
   #     # Customize the ORM
-  #     config.app_generators.orm :my_railtie_orm
+  #     config.app_generators.orm :my_gem_orm
   #
   #     # Add a to_prepare block which is executed once in production
   #     # and before each request in development.
   #     config.to_prepare do
-  #       MyRailtie.setup!
+  #       MyGem.setup!
   #     end
   #   end
   #
   # == Loading Rake Tasks and Generators
   #
-  # If your railtie has Rake tasks, you can tell Rails to load them through the method
+  # If your railtie has Rake tasks, you can tell \Rails to load them through the method
   # +rake_tasks+:
   #
-  #   class MyRailtie < Rails::Railtie
+  #   class MyGem::Railtie < Rails::Railtie
   #     rake_tasks do
-  #       load "path/to/my_railtie.tasks"
+  #       load "path/to/my_gem.tasks"
   #     end
   #   end
   #
-  # By default, Rails loads generators from your load path. However, if you want to place
+  # By default, \Rails loads generators from your load path. However, if you want to place
   # your generators at a different location, you can specify in your railtie a block which
   # will load them during normal generators lookup:
   #
-  #   class MyRailtie < Rails::Railtie
+  #   class MyGem::Railtie < Rails::Railtie
   #     generators do
-  #       require "path/to/my_railtie_generator"
+  #       require "path/to/my_gem_generator"
   #     end
   #   end
   #
   # Since filenames on the load path are shared across gems, be sure that files you load
   # through a railtie have unique names.
   #
-  # == Run another program when the Rails server starts
+  # == Run another program when the \Rails server starts
   #
-  # In development, it's very usual to have to run another process next to the Rails Server. In example
+  # In development, it's very usual to have to run another process next to the \Rails Server. In example
   # you might want to start the Webpack or React server. Or maybe you need to run your job scheduler process
   # like Sidekiq. This is usually done by opening a new shell and running the program from here.
   #
-  # Rails allow you to specify a +server+ block which will get called when a Rails server starts.
+  # \Rails allow you to specify a +server+ block which will get called when a \Rails server starts.
   # This way, your users don't need to remember to have to open a new shell and run another program, making
   # this less confusing for everyone.
   # It can be used like this:
   #
-  #   class MyRailtie < Rails::Railtie
+  #   class MyGem::Railtie < Rails::Railtie
   #     server do
   #       WebpackServer.start
   #     end
@@ -221,14 +221,13 @@ module Rails
 
         # If the class method does not have a method, then send the method call
         # to the Railtie instance.
-        def method_missing(name, *args, &block)
+        def method_missing(name, ...)
           if !abstract_railtie? && instance.respond_to?(name)
-            instance.public_send(name, *args, &block)
+            instance.public_send(name, ...)
           else
             super
           end
         end
-        ruby2_keywords(:method_missing)
 
         # receives an instance variable identifier, set the variable value if is
         # blank and append given block to value, which will be used later in

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

@@ -1,18 +1,13 @@
 # frozen_string_literal: true
 
 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" ]
-
-  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
@@ -36,31 +31,4 @@ namespace :app do
       end
     end
   end
-
-  namespace :update do
-    require "rails/app_updater"
-
-    # desc "Update config files from your current rails install"
-    task :configs do
-      Rails::AppUpdater.invoke_from_app_generator :create_boot_file
-      Rails::AppUpdater.invoke_from_app_generator :update_config_files
-    end
-
-    # desc "Adds 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
-
-    task :upgrade_guide_info do
-      Rails::AppUpdater.invoke_from_app_generator :display_upgrade_guide_info
-    end
-  end
 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

@@ -7,36 +7,36 @@ namespace :tmp do
   tmp_dirs = [ "tmp/cache",
                "tmp/sockets",
                "tmp/pids",
-               "tmp/cache/assets" ]
+             ]
 
   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

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
-eager_load = ->() do
-  puts "Hold on, I am eager loading the application."
-  Zeitwerk::Loader.eager_load_all
-end
+require "rails/zeitwerk_checker"
 
-report_not_checked = ->(not_checked) do
+report_unchecked = ->(unchecked) do
   puts
   puts <<~EOS
     WARNING: The following directories will only be checked if you configure
@@ -13,7 +10,7 @@ report_not_checked = ->(not_checked) do
   EOS
   puts
 
-  not_checked.each { |dir| puts "  #{dir}" }
+  unchecked.each { |dir| puts "  #{dir}" }
   puts
 
   puts <<~EOS
@@ -23,39 +20,22 @@ report_not_checked = ->(not_checked) do
   puts
 end
 
-report = ->(not_checked) do
-  if not_checked.any?
-    report_not_checked[not_checked]
-    puts "Otherwise, all is good!"
-  else
-    puts "All is good!"
-  end
-end
-
 namespace :zeitwerk do
-  desc "Checks project structure for Zeitwerk compatibility"
+  desc "Check project structure for Zeitwerk compatibility"
   task check: :environment do
+    puts "Hold on, I am eager loading the application."
+
     begin
-      eager_load[]
-    rescue NameError => e
-      if e.message =~ /expected file .*? to define constant [\w:]+/
-        abort $&.sub(/expected file #{Regexp.escape(Rails.root.to_s)}./, "expected file ")
-      else
-        raise
-      end
+      unchecked = Rails::ZeitwerkChecker.check
+    rescue Zeitwerk::NameError => e
+      abort e.message.sub(/#{Regexp.escape(Rails.root.to_s)}./, "")
     end
 
-    require "active_support/core_ext/object/try"
-    eager_load_paths = Rails.configuration.eager_load_namespaces.filter_map do |eln|
-      # Quick regression fix for 6.0.3 to support namespaces that do not have
-      # eager load paths, like the recently added i18n. I'll rewrite this task.
-      eln.try(:config).try(:eager_load_paths)
-    end.flatten
-
-    not_checked = ActiveSupport::Dependencies.autoload_paths - eager_load_paths
-    not_checked.select! { |dir| Dir.exist?(dir) }
-    not_checked.reject! { |dir| Dir.empty?(dir) }
-
-    report[not_checked]
+    if unchecked.empty?
+      puts "All is good!"
+    else
+      report_unchecked[unchecked]
+      puts "Otherwise, all is good!"
+    end
   end
 end

data/lib/rails/tasks.rb

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

data/lib/rails/templates/layouts/application.html.erb

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="en">
+<html>
 <head>
   <meta charset="utf-8" />
   <title><%= @page_title %></title>