railties 6.1.6 → 7.1.2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2004-2022 David Heinemeier Hansson
+Copyright (c) David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/RDOC_MAIN.md

@@ -0,0 +1,99 @@
+# Welcome to \Rails
+
+## What's \Rails?
+
+\Rails is a web-application framework that includes everything needed to
+create database-backed web applications according to the
+[Model-View-Controller (MVC)](https://en.wikipedia.org/wiki/Model-view-controller)
+pattern.
+
+Understanding the MVC pattern is key to understanding \Rails. MVC divides your
+application into three layers: Model, View, and Controller, each with a specific responsibility.
+
+## Model layer
+
+The _**Model layer**_ represents the domain model (such as Account, Product,
+Person, Post, etc.) and encapsulates the business logic specific to
+your application. In \Rails, database-backed model classes are derived from
+`ActiveRecord::Base`. [Active Record](files/activerecord/README.rdoc) allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods.
+Although most \Rails models are backed by a database, models can also be ordinary
+Ruby classes, or Ruby classes that implement a set of interfaces as provided by
+the [Active Model](files/activemodel/README.rdoc) module.
+
+## View layer
+
+The _**View layer**_ is composed of "templates" that are responsible for providing
+appropriate representations of your application's resources. Templates can
+come in a variety of formats, but most view templates are HTML with embedded
+Ruby code (\ERB files). Views are typically rendered to generate a controller response
+or to generate the body of an email. In \Rails, View generation is handled by [Action View](files/actionview/README.rdoc).
+
+## Controller layer
+
+The _**Controller layer**_ is responsible for handling incoming HTTP requests and
+providing a suitable response. Usually, this means returning HTML, but \Rails controllers
+can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers load and
+manipulate models, and render view templates in order to generate the appropriate HTTP response.
+In \Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and
+controller classes are derived from `ActionController::Base`. Action Dispatch and Action Controller
+are bundled together in [Action Pack](files/actionpack/README.rdoc).
+
+## Frameworks and libraries
+
+[Active Record](files/activerecord/README.rdoc), [Active Model](files/activemodel/README.rdoc), [Action Pack](files/actionpack/README.rdoc), and [Action View](files/actionview/README.rdoc) can each be used independently outside \Rails.
+
+In addition to that, \Rails also comes with:
+
+- [Action Mailer](files/actionmailer/README.rdoc), a library to generate and send emails
+- [Action Mailbox](files/actionmailbox/README.md), a library to receive emails within a \Rails application
+- [Active Job](files/activejob/README.md), a framework for declaring jobs and making them run on a variety of queuing backends
+- [Action Cable](files/actioncable/README.md), a framework to integrate WebSockets with a \Rails application
+- [Active Storage](files/activestorage/README.md), a library to attach cloud and local files to \Rails applications
+- [Action Text](files/actiontext/README.md), a library to handle rich text content
+- [Active Support](files/activesupport/README.rdoc), a collection of utility classes and standard library extensions that are useful for \Rails, and may also be used independently outside \Rails
+
+## Getting Started
+
+1.  Install \Rails at the command prompt if you haven't yet:
+
+        $ gem install rails
+
+2.  At the command prompt, create a new \Rails application:
+
+        $ rails new myapp
+
+    where "myapp" is the application name.
+
+3.  Change directory to `myapp` and start the web server:
+
+        $ cd myapp
+        $ bin/rails server
+
+    Run with `--help` or `-h` for options.
+
+4.  Go to `http://localhost:3000` and you'll see the \Rails bootscreen with your
+    \Rails and Ruby versions.
+
+5.  Follow the guidelines to start developing your application. You may find the
+    following resources handy:
+
+    * [Getting Started with Rails](https://guides.rubyonrails.org/getting_started.html)
+    * [Ruby on Rails Guides](https://guides.rubyonrails.org)
+    * [The API Documentation](https://api.rubyonrails.org)
+
+## Contributing
+
+We encourage you to contribute to Ruby on \Rails! Please check out the
+[Contributing to Ruby on Rails guide](https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html) for guidelines about how to proceed. [Join us!](https://contributors.rubyonrails.org)
+
+Trying to report a possible security vulnerability in \Rails? Please
+check out our [security policy](https://rubyonrails.org/security) for
+guidelines about how to proceed.
+
+Everyone interacting in \Rails and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the \Rails [code of conduct](https://rubyonrails.org/conduct).
+
+## License
+
+Ruby on \Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/README.rdoc

@@ -1,13 +1,12 @@
-= Railties -- Gluing the Engine to the Rails
+= Railties -- Gluing the Engine to the \Rails
 
 Railties is responsible for gluing all frameworks together. Overall, it:
 
-* handles the bootstrapping process for a Rails application;
+* handles the bootstrapping process for a \Rails application;
 
 * manages the +rails+ command line interface;
 
-* and provides the Rails generators core.
-
+* and provides the \Rails generators core.
 
 == Download
 
@@ -15,7 +14,7 @@ The latest version of Railties can be installed with RubyGems:
 
 * gem install railties
 
-Source code can be downloaded as part of the Rails project on GitHub
+Source code can be downloaded as part of the \Rails project on GitHub
 
 * https://github.com/rails/rails/tree/main/railties
 
@@ -31,7 +30,7 @@ API documentation is at
 
 * https://api.rubyonrails.org
 
-Bug reports can be filed for the Ruby on Rails project here:
+Bug reports can be filed for the Ruby on \Rails project here:
 
 * https://github.com/rails/rails/issues
 

data/lib/minitest/rails_plugin.rb

@@ -25,6 +25,46 @@ module Minitest
     end
   end
 
+  class ProfileReporter < StatisticsReporter
+    def initialize(io = $stdout, options = {})
+      super
+      @results = []
+      @count = options[:profile]
+    end
+
+    def record(result)
+      @results << result
+    end
+
+    def report
+      total_time = @results.sum(&:time)
+
+      @results.sort! { |a, b| b.time <=> a.time }
+      slow_results = @results.take(@count)
+      slow_tests_total_time = slow_results.sum(&:time)
+
+      ratio = (total_time == 0) ? 0.0 : (slow_tests_total_time / total_time) * 100
+
+      io.puts("\nTop %d slowest tests (%.2f seconds, %.1f%% of total time):\n" % [slow_results.size, slow_tests_total_time, ratio])
+      slow_results.each do |result|
+        io.puts("  %s\n    %.4f seconds %s\n" % [result.location, result.time, source_location(result)])
+      end
+      io.puts("\n")
+    end
+
+    private
+      def source_location(result)
+        filename, line = result.source_location
+        return "" unless filename
+
+        pwd = Dir.pwd
+        if filename.start_with?(pwd)
+          filename = Pathname.new(filename).relative_path_from(pwd)
+        end
+        "#{filename}:#{line}"
+      end
+  end
+
   def self.plugin_rails_options(opts, options)
     ::Rails::TestUnit::Runner.attach_before_load_options(opts)
 
@@ -44,12 +84,30 @@ module Minitest
       options[:color] = value
     end
 
+    opts.on("--profile [COUNT]", "Enable profiling of tests and list the slowest test cases (default: 10)") do |value|
+      default_count = 10
+
+      if value.nil?
+        count = default_count
+      else
+        count = Integer(value, exception: false)
+        if count.nil?
+          warn("Non integer specified as profile count, separate " \
+               "your path from options with -- e.g. " \
+               "`bin/test --profile -- #{value}`")
+          count = default_count
+        end
+      end
+
+      options[:profile] = count
+    end
+
     options[:color] = true
     options[:output_inline] = true
   end
 
   # Owes great inspiration to test runner trailblazers like RSpec,
-  # minitest-reporters, maxitest and others.
+  # minitest-reporters, maxitest, and others.
   def self.plugin_rails_init(options)
     unless options[:full_backtrace] || ENV["BACKTRACE"]
       # Plugin can run without Rails loaded, check before filtering.
@@ -67,6 +125,11 @@ module Minitest
     if reporter.reporters.reject! { |reporter| reporter.kind_of?(ProgressReporter) }
       reporter << ::Rails::TestUnitReporter.new(options[:io], options)
     end
+
+    # Add slowest tests reporter at the end.
+    if options[:profile]
+      reporter << ProfileReporter.new(options[:io], options)
+    end
   end
 
   # Backwards compatibility with Rails 5.0 generated plugin test scripts

data/lib/rails/all.rb

@@ -15,7 +15,6 @@ require "rails"
   action_mailbox/engine
   action_text/engine
   rails/test_unit/railtie
-  sprockets/railtie
 ).each do |railtie|
   begin
     require railtie

data/lib/rails/api/task.rb

@@ -10,6 +10,7 @@ module Rails
         "activesupport" => {
           include: %w(
             README.rdoc
+            lib/active_support.rb
             lib/active_support/**/*.rb
           )
         },
@@ -17,6 +18,7 @@ module Rails
         "activerecord" => {
           include: %w(
             README.rdoc
+            lib/active_record.rb
             lib/active_record/**/*.rb
             lib/arel.rb
           )
@@ -25,6 +27,7 @@ module Rails
         "activemodel" => {
           include: %w(
             README.rdoc
+            lib/active_model.rb
             lib/active_model/**/*.rb
           )
         },
@@ -33,7 +36,9 @@ module Rails
           include: %w(
             README.rdoc
             lib/abstract_controller/**/*.rb
+            lib/action_controller.rb
             lib/action_controller/**/*.rb
+            lib/action_dispatch.rb
             lib/action_dispatch/**/*.rb
           )
         },
@@ -41,6 +46,7 @@ module Rails
         "actionview" => {
           include: %w(
             README.rdoc
+            lib/action_view.rb
             lib/action_view/**/*.rb
           ),
           exclude: "lib/action_view/vendor/*"
@@ -49,6 +55,7 @@ module Rails
         "actionmailer" => {
           include: %w(
             README.rdoc
+            lib/action_mailer.rb
             lib/action_mailer/**/*.rb
           )
         },
@@ -56,6 +63,7 @@ module Rails
         "activejob" => {
           include: %w(
             README.md
+            lib/active_job.rb
             lib/active_job/**/*.rb
           )
         },
@@ -63,6 +71,7 @@ module Rails
         "actioncable" => {
           include: %w(
             README.md
+            lib/action_cable.rb
             lib/action_cable/**/*.rb
           )
         },
@@ -71,6 +80,7 @@ module Rails
           include: %w(
             README.md
             app/**/active_storage/**/*.rb
+            lib/active_storage.rb
             lib/active_storage/**/*.rb
           )
         },
@@ -79,6 +89,7 @@ module Rails
           include: %w(
             README.md
             app/**/action_mailbox/**/*.rb
+            lib/action_mailbox.rb
             lib/action_mailbox/**/*.rb
           )
         },
@@ -87,6 +98,7 @@ module Rails
           include: %w(
             README.md
             app/**/action_text/**/*.rb
+            lib/action_text.rb
             lib/action_text/**/*.rb
           )
         },
@@ -150,8 +162,8 @@ module Rails
 
         # Only generate documentation for files that have been
         # changed since the API was generated.
-        if Dir.exist?("doc/rdoc") && !ENV["ALL"]
-          last_generation = DateTime.rfc2822(File.open("doc/rdoc/created.rid", &:readline))
+        if Dir.exist?(api_dir) && !ENV["ALL"]
+          last_generation = DateTime.rfc2822(File.open("#{api_dir}/created.rid", &:readline))
 
           rdoc_files.keep_if do |file|
             File.mtime(file).to_datetime > last_generation
@@ -162,13 +174,16 @@ module Rails
         end
       end
 
-      def setup_horo_variables
+      # These variables are used by the sdoc template
+      def setup_horo_variables # :nodoc:
         ENV["HORO_PROJECT_NAME"]    = "Ruby on Rails"
         ENV["HORO_PROJECT_VERSION"] = rails_version
+        ENV["HORO_BADGE_VERSION"]   = badge_version
+        ENV["HORO_CANONICAL_URL"]   = canonical_url
       end
 
       def api_main
-        component_root_dir("railties") + "/RDOC_MAIN.rdoc"
+        component_root_dir("railties") + "/RDOC_MAIN.md"
       end
     end
 
@@ -191,12 +206,28 @@ module Rails
       def rails_version
         "main@#{`git rev-parse HEAD`[0, 7]}"
       end
+
+      def badge_version
+        "edge"
+      end
+
+      def canonical_url
+        "https://edgeapi.rubyonrails.org"
+      end
     end
 
     class StableTask < RepoTask
       def rails_version
         File.read("RAILS_VERSION").strip
       end
+
+      def badge_version
+        "v#{rails_version}"
+      end
+
+      def canonical_url
+        "https://api.rubyonrails.org/#{badge_version}"
+      end
     end
   end
 end

data/lib/rails/app_updater.rb

@@ -13,7 +13,7 @@ module Rails
       def app_generator
         @app_generator ||= begin
           gen = Rails::Generators::AppGenerator.new ["rails"], generator_options, destination_root: Rails.root
-          File.exist?(Rails.root.join("config", "application.rb")) ? gen.send(:app_const) : gen.send(:valid_const?)
+          gen.send(:valid_const?) unless File.exist?(Rails.root.join("config", "application.rb"))
           gen
         end
       end
@@ -21,15 +21,18 @@ module Rails
       private
         def generator_options
           options = { api: !!Rails.application.config.api_only, update: true }
-          options[:skip_javascript] = !File.exist?(Rails.root.join("bin", "yarn"))
+          options[:name]                = Rails.application.class.name.chomp("::Application").underscore
+          options[:skip_active_job]     = !defined?(ActiveJob::Railtie)
           options[:skip_active_record]  = !defined?(ActiveRecord::Railtie)
-          options[:skip_active_storage] = !defined?(ActiveStorage::Engine) || !defined?(ActiveRecord::Railtie)
+          options[:skip_active_storage] = !defined?(ActiveStorage::Engine)
           options[:skip_action_mailer]  = !defined?(ActionMailer::Railtie)
+          options[:skip_action_mailbox] = !defined?(ActionMailbox::Engine)
+          options[:skip_action_text]    = !defined?(ActionText::Engine)
           options[:skip_action_cable]   = !defined?(ActionCable::Engine)
-          options[:skip_sprockets]      = !defined?(Sprockets::Railtie)
-          options[:skip_puma]           = !defined?(Puma)
+          options[:skip_test]           = !defined?(Rails::TestUnitRailtie)
+          options[:skip_system_test]    = Rails.application.config.generators.system_tests.nil?
+          options[:skip_asset_pipeline] = !defined?(Sprockets::Railtie) && !defined?(Propshaft::Railtie)
           options[:skip_bootsnap]       = !defined?(Bootsnap)
-          options[:skip_spring]         = !defined?(Spring)
           options
         end
     end

data/lib/rails/application/bootstrap.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require "set"
 require "active_support/notifications"
 require "active_support/dependencies"
 require "active_support/descendants_tracker"
@@ -27,14 +28,18 @@ module Rails
               * production - set it to true
 
           INFO
-          config.eager_load = config.cache_classes
+          config.eager_load = !config.reloading_enabled?
         end
       end
 
       # Initialize the logger early in the stack in case we need to log some deprecation.
       initializer :initialize_logger, group: :all do
         Rails.logger ||= config.logger || begin
-          logger = ActiveSupport::Logger.new(config.default_log_file)
+          logger = if config.log_file_size
+            ActiveSupport::Logger.new(config.default_log_file, 1, config.log_file_size)
+          else
+            ActiveSupport::Logger.new(config.default_log_file)
+          end
           logger.formatter = config.log_formatter
           logger = ActiveSupport::TaggedLogging.new(logger)
           logger
@@ -44,17 +49,29 @@ module Rails
           logger.level = ActiveSupport::Logger::WARN
           logger.warn(
             "Rails Error: Unable to access log file. Please ensure that #{path} exists and is writable " \
-            "(ie, make it writable for user and group: chmod 0664 #{path}). " \
+            "(i.e. make it writable for user and group: chmod 0664 #{path}). " \
             "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
           )
           logger
         end
 
-        Rails.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase)
+        unless Rails.logger.is_a?(ActiveSupport::BroadcastLogger)
+          Rails.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase)
+          broadcast_logger = ActiveSupport::BroadcastLogger.new(Rails.logger)
+          broadcast_logger.formatter = Rails.logger.formatter
+          Rails.logger = broadcast_logger
+        end
+
+        unless config.consider_all_requests_local
+          Rails.error.logger = Rails.logger
+        end
       end
 
       # Initialize cache early in the stack so railties can make use of it.
       initializer :initialize_cache, group: :all do
+        cache_format_version = config.active_support.delete(:cache_format_version)
+        ActiveSupport.cache_format_version = cache_format_version if cache_format_version
+
         unless Rails.cache
           Rails.cache = ActiveSupport::Cache.lookup_store(*config.cache_store)
 
@@ -64,9 +81,26 @@ module Rails
         end
       end
 
-      # Sets the dependency loading mechanism.
-      initializer :initialize_dependency_mechanism, group: :all do
-        ActiveSupport::Dependencies.mechanism = config.cache_classes ? :require : :load
+      # We setup the once autoloader this early so that engines and applications
+      # are able to autoload from these paths during initialization.
+      initializer :setup_once_autoloader, after: :set_eager_load_paths, before: :bootstrap_hook do
+        autoloader = Rails.autoloaders.once
+
+        # Normally empty, but if the user already defined some, we won't
+        # override them. Important if there are custom namespaces associated.
+        already_configured_dirs = Set.new(autoloader.dirs)
+
+        ActiveSupport::Dependencies.autoload_once_paths.freeze
+        ActiveSupport::Dependencies.autoload_once_paths.uniq.each do |path|
+          # Zeitwerk only accepts existing directories in `push_dir`.
+          next unless File.directory?(path)
+          next if already_configured_dirs.member?(path.to_s)
+
+          autoloader.push_dir(path)
+          autoloader.do_not_eager_load(path) unless ActiveSupport::Dependencies.eager_load?(path)
+        end
+
+        autoloader.setup
       end
 
       initializer :bootstrap_hook, group: :all do |app|