railties 6.1.6 → 7.1.2

data/lib/rails/railtie/configuration.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails/configuration"
-require "active_support/core_ext/symbol/starts_ends_with"
 
 module Rails
   class Railtie
@@ -11,7 +10,7 @@ module Rails
       end
 
       # Expose the eager_load_namespaces at "module" level for convenience.
-      def self.eager_load_namespaces #:nodoc:
+      def self.eager_load_namespaces # :nodoc:
         @@eager_load_namespaces ||= []
       end
 
@@ -72,6 +71,11 @@ module Rails
         ActiveSupport.on_load(:after_initialize, yield: true, &block)
       end
 
+      # Called after application routes have been loaded.
+      def after_routes_loaded(&block)
+        ActiveSupport.on_load(:after_routes_loaded, yield: true, &block)
+      end
+
       # Array of callbacks defined by #to_prepare.
       def to_prepare_blocks
         @@to_prepare_blocks ||= []
@@ -88,9 +92,17 @@ module Rails
       end
 
     private
+      def actual_method?(key)
+        !@@options.key?(key) && respond_to?(key)
+      end
+
       def method_missing(name, *args, &blk)
         if name.end_with?("=")
-          @@options[:"#{name[0..-2]}"] = args.first
+          key = name[0..-2].to_sym
+          if actual_method?(key)
+            raise NoMethodError.new("Cannot assign to `#{key}`, it is a configuration method")
+          end
+          @@options[key] = args.first
         elsif @@options.key?(name)
           @@options[name]
         else

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 <tt>ActiveSupport::Notifications</tt>
+  # * 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,7 +47,7 @@ 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
@@ -87,7 +87,7 @@ module Rails
   #
   # == 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
@@ -96,7 +96,7 @@ module Rails
   #     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:
   #
@@ -109,13 +109,13 @@ module Rails
   # 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:
@@ -129,7 +129,7 @@ module Rails
   # == Application and Engine
   #
   # An engine is nothing more than a railtie with some initializers already set. And since
-  # <tt>Rails::Application</tt> is an engine, the same configuration described here can be
+  # Rails::Application is an engine, the same configuration described here can be
   # used in both.
   #
   # Be sure to look at the documentation of those specific classes for more information.
@@ -146,7 +146,7 @@ module Rails
       delegate :config, to: :instance
 
       def subclasses
-        super.reject(&:abstract_railtie?)
+        super.reject(&:abstract_railtie?).sort
       end
 
       def rake_tasks(&blk)
@@ -191,25 +191,44 @@ module Rails
         instance.configure(&block)
       end
 
+      def <=>(other) # :nodoc:
+        load_index <=> other.load_index
+      end
+
+      def inherited(subclass)
+        subclass.increment_load_index
+        super
+      end
+
+      protected
+        attr_reader :load_index
+
+        def increment_load_index
+          @@load_counter ||= 0
+          @load_index = (@@load_counter += 1)
+        end
+
       private
         def generate_railtie_name(string)
           ActiveSupport::Inflector.underscore(string).tr("/", "_")
         end
 
         def respond_to_missing?(name, _)
+          return super if abstract_railtie?
+
           instance.respond_to?(name) || super
         end
 
         # If the class method does not have a method, then send the method call
         # to the Railtie instance.
         def method_missing(name, *args, &block)
-          if instance.respond_to?(name)
+          if !abstract_railtie? && instance.respond_to?(name)
             instance.public_send(name, *args, &block)
           else
             super
           end
         end
-        ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
+        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
@@ -224,13 +243,17 @@ module Rails
 
     delegate :railtie_name, to: :class
 
-    def initialize #:nodoc:
+    def initialize # :nodoc:
       if self.class.abstract_railtie?
         raise "#{self.class.name} is abstract, you cannot instantiate it directly."
       end
     end
 
-    def configure(&block) #:nodoc:
+    def inspect # :nodoc:
+      "#<#{self.class.name}>"
+    end
+
+    def configure(&block) # :nodoc:
       instance_eval(&block)
     end
 
@@ -241,29 +264,29 @@ module Rails
       @config ||= Railtie::Configuration.new
     end
 
-    def railtie_namespace #:nodoc:
+    def railtie_namespace # :nodoc:
       @railtie_namespace ||= self.class.module_parents.detect { |n| n.respond_to?(:railtie_namespace) }
     end
 
     protected
-      def run_console_blocks(app) #:nodoc:
+      def run_console_blocks(app) # :nodoc:
         each_registered_block(:console) { |block| block.call(app) }
       end
 
-      def run_generators_blocks(app) #:nodoc:
+      def run_generators_blocks(app) # :nodoc:
         each_registered_block(:generators) { |block| block.call(app) }
       end
 
-      def run_runner_blocks(app) #:nodoc:
+      def run_runner_blocks(app) # :nodoc:
         each_registered_block(:runner) { |block| block.call(app) }
       end
 
-      def run_tasks_blocks(app) #:nodoc:
+      def run_tasks_blocks(app) # :nodoc:
         extend Rake::DSL
         each_registered_block(:rake_tasks) { |block| instance_exec(app, &block) }
       end
 
-      def run_server_blocks(app) #:nodoc:
+      def run_server_blocks(app) # :nodoc:
         each_registered_block(:server) { |block| block.call(app) }
       end
 

data/lib/rails/ruby_version_check.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5.0") && RUBY_ENGINE == "ruby"
+# :stopdoc:
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.7.0") && RUBY_ENGINE == "ruby"
   desc = defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : "ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE})"
   abort <<-end_message
 
-    Rails 6 requires Ruby 2.5.0 or newer.
+    Rails 7 requires Ruby 2.7.0 or newer.
 
     You're running
       #{desc}
 
-    Please upgrade to Ruby 2.5.0 or newer to continue.
+    Please upgrade to Ruby 2.7.0 or newer to continue.
 
   end_message
 end

data/lib/rails/secrets.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "tempfile"
 require "active_support/message_encryptor"
 
 module Rails
@@ -87,17 +88,18 @@ module Rails
         end
 
         def writing(contents)
-          tmp_file = "#{File.basename(path)}.#{Process.pid}"
-          tmp_path = File.join(Dir.tmpdir, tmp_file)
-          IO.binwrite(tmp_path, contents)
+          file_name = "#{File.basename(path)}.#{Process.pid}"
 
-          yield tmp_path
+          Tempfile.create(["", "-" + file_name]) do |tmp_file|
+            tmp_path = Pathname.new(tmp_file)
+            tmp_path.binwrite contents
 
-          updated_contents = IO.binread(tmp_path)
+            yield tmp_path
 
-          write(updated_contents) if updated_contents != contents
-        ensure
-          FileUtils.rm(tmp_path) if File.exist?(tmp_path)
+            updated_contents = tmp_path.binread
+
+            write(updated_contents) if updated_contents != contents
+          end
         end
 
         def encryptor

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:
       #
@@ -70,7 +122,7 @@ module Rails
     #
     # If +options+ has a <tt>:tag</tt> flag, it will be passed to each annotation's +to_s+.
     #
-    # See <tt>#find_in</tt> for a list of file extensions that will be taken into account.
+    # See SourceAnnotationExtractor#find_in for a list of file extensions that will be taken into account.
     #
     # This class method is the single entry point for the <tt>rails notes</tt> command.
     def self.enumerate(tag = nil, options = {})
@@ -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

@@ -4,15 +4,13 @@ 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: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
@@ -22,7 +20,7 @@ namespace :app do
       project_templates = "#{Rails.root}/lib/templates"
 
       default_templates = { "erb"   => %w{controller mailer scaffold},
-                            "rails" => %w{controller helper scaffold_controller assets} }
+                            "rails" => %w{controller helper scaffold_controller} }
 
       default_templates.each do |type, names|
         local_template_type_dir = File.join(project_templates, type)
@@ -46,7 +44,7 @@ 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
@@ -59,10 +57,4 @@ namespace :app do
       Rails::AppUpdater.invoke_from_app_generator :display_upgrade_guide_info
     end
   end
-
-  namespace :binstub do
-    task :yarn do
-      Rails::AppUpdater.invoke_from_app_generator :update_bin_yarn
-    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

@@ -11,25 +11,28 @@ STATS_DIRECTORIES ||= [
   %w(Mailers            app/mailers),
   %w(Mailboxes          app/mailboxes),
   %w(Channels           app/channels),
+  %w(Views              app/views),
   %w(JavaScripts        app/assets/javascripts),
+  %w(Stylesheets        app/assets/stylesheets),
   %w(JavaScript         app/javascript),
   %w(Libraries          lib/),
   %w(APIs               app/apis),
   %w(Controller\ tests  test/controllers),
   %w(Helper\ tests      test/helpers),
+  %w(Job\ tests         test/jobs),
   %w(Model\ tests       test/models),
   %w(Mailer\ tests      test/mailers),
   %w(Mailbox\ tests     test/mailboxes),
   %w(Channel\ tests     test/channels),
-  %w(Job\ tests         test/jobs),
   %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