activerecord 7.1.0 → 7.1.3

data/lib/active_record/fixtures.rb

@@ -268,6 +268,8 @@ module ActiveRecord
   #     name: Reginald the Pirate
   #     monkey_id: 1
   #
+  # <code></code>
+  #
   #   ### in monkeys.yml
   #
   #   george:
@@ -285,6 +287,8 @@ module ActiveRecord
   #     name: Reginald the Pirate
   #     monkey: george
   #
+  # <code></code>
+  #
   #   ### in monkeys.yml
   #
   #   george:
@@ -306,6 +310,8 @@ module ActiveRecord
   #
   #   belongs_to :eater, polymorphic: true
   #
+  # <code></code>
+  #
   #   ### in fruits.yml
   #
   #   apple:
@@ -331,6 +337,8 @@ module ActiveRecord
   #     id: 1
   #     name: George the Monkey
   #
+  # <code></code>
+  #
   #   ### in fruits.yml
   #
   #   apple:
@@ -345,6 +353,8 @@ module ActiveRecord
   #     id: 3
   #     name: grape
   #
+  # <code></code>
+  #
   #   ### in fruits_monkeys.yml
   #
   #   apple_george:
@@ -368,6 +378,8 @@ module ActiveRecord
   #     name: George the Monkey
   #     fruits: apple, orange, grape
   #
+  # <code></code>
+  #
   #   ### in fruits.yml
   #
   #   apple:
@@ -467,6 +479,8 @@ module ActiveRecord
   #     belongs_to :author
   #   end
   #
+  # <code></code>
+  #
   #   # books.yml
   #   alices_adventure_in_wonderland:
   #     author_id: <%= ActiveRecord::FixtureSet.identify(:lewis_carroll) %>
@@ -482,6 +496,8 @@ module ActiveRecord
   #     belongs_to :book, query_constraints: [:author_id, :book_id]
   #   end
   #
+  # <code></code>
+  #
   #   # book_orders.yml
   #   alices_adventure_in_wonderland_in_books:
   #     author: lewis_carroll

data/lib/active_record/future_result.rb

@@ -48,6 +48,7 @@ module ActiveRecord
     Canceled = Class.new(ActiveRecordError)
 
     delegate :empty?, :to_a, to: :result
+    delegate_missing_to :result
 
     attr_reader :lock_wait
 

data/lib/active_record/gem_version.rb

@@ -9,7 +9,7 @@ module ActiveRecord
   module VERSION
     MAJOR = 7
     MINOR = 1
-    TINY  = 0
+    TINY  = 3
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/active_record/insert_all.rb

@@ -23,8 +23,6 @@ module ActiveRecord
         @keys = @inserts.first.keys
       end
 
-      configure_on_duplicate_update_logic
-
       if model.scope_attributes?
         @scope_attributes = model.scope_attributes
         @keys |= @scope_attributes.keys
@@ -35,8 +33,8 @@ module ActiveRecord
       @returning = false if @returning == []
 
       @unique_by = find_unique_index_for(@unique_by)
-      @on_duplicate = :skip if @on_duplicate == :update && updatable_columns.empty?
 
+      configure_on_duplicate_update_logic
       ensure_valid_options_for_connection!
     end
 
@@ -135,6 +133,8 @@ module ActiveRecord
         elsif custom_update_sql_provided?
           @update_sql = on_duplicate
           @on_duplicate = :update
+        elsif @on_duplicate == :update && updatable_columns.empty?
+          @on_duplicate = :skip
         end
       end
 

data/lib/active_record/internal_metadata.rb

@@ -10,7 +10,7 @@ module ActiveRecord
   # This is enabled by default. To disable this functionality set
   # `use_metadata_table` to false in your database configuration.
   class InternalMetadata # :nodoc:
-    class NullInternalMetadata
+    class NullInternalMetadata # :nodoc:
     end
 
     attr_reader :connection, :arel_table
@@ -64,6 +64,8 @@ module ActiveRecord
     end
 
     def create_table_and_set_flags(environment, schema_sha1 = nil)
+      return unless enabled?
+
       create_table
       update_or_create_entry(:environment, environment)
       update_or_create_entry(:schema_sha1, schema_sha1) if schema_sha1

data/lib/active_record/middleware/database_selector.rb

@@ -24,7 +24,7 @@ module ActiveRecord
     # To use the DatabaseSelector in your application with default settings,
     # run the provided generator.
     #
-    #   bin/rails g active_record:multi_db
+    #   $ bin/rails g active_record:multi_db
     #
     # This will create a file named +config/initializers/multi_db.rb+ with the
     # following contents:

data/lib/active_record/migration/command_recorder.rb

@@ -206,7 +206,10 @@ module ActiveRecord
         end
 
         def invert_rename_table(args)
-          [:rename_table, args.reverse]
+          old_name, new_name, options = args
+          args = [new_name, old_name]
+          args << options if options
+          [:rename_table, args]
         end
 
         def invert_remove_column(args)

data/lib/active_record/migration/compatibility.rb

@@ -61,8 +61,10 @@ module ActiveRecord
               column_name.is_a?(String) && /\W/.match?(column_name)
             end
         end
+
         module TableDefinition
           include LegacyIndexName
+
           def column(name, type, **options)
             options[:_skip_validate_options] = true
             super
@@ -95,6 +97,12 @@ module ActiveRecord
           super
         end
 
+        def add_reference(table_name, ref_name, **options)
+          options[:_skip_validate_options] = true
+          super
+        end
+        alias :add_belongs_to :add_reference
+
         def create_table(table_name, **options)
           options[:_uses_legacy_table_name] = true
           options[:_skip_validate_options] = true

data/lib/active_record/migration/pending_migration_connection.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  class PendingMigrationConnection # :nodoc:
+    def self.establish_temporary_connection(db_config, &block)
+      pool = ActiveRecord::Base.connection_handler.establish_connection(db_config, owner_name: self)
+
+      yield pool.connection
+    ensure
+      ActiveRecord::Base.connection_handler.remove_connection_pool(self.name)
+    end
+
+    def self.primary_class?
+      false
+    end
+
+    def self.current_preventing_writes
+      false
+    end
+  end
+end

data/lib/active_record/migration.rb

@@ -7,6 +7,7 @@ require "active_support/core_ext/array/access"
 require "active_support/core_ext/enumerable"
 require "active_support/core_ext/module/attribute_accessors"
 require "active_support/actionable_error"
+require "active_record/migration/pending_migration_connection"
 
 module ActiveRecord
   class MigrationError < ActiveRecordError # :nodoc:
@@ -370,7 +371,8 @@ module ActiveRecord
   # The \Rails package has several tools to help create and apply migrations.
   #
   # To generate a new migration, you can use
-  #   bin/rails generate migration MyNewMigration
+  #
+  #   $ bin/rails generate migration MyNewMigration
   #
   # where MyNewMigration is the name of your migration. The generator will
   # create an empty migration file <tt>timestamp_my_new_migration.rb</tt>
@@ -379,7 +381,7 @@ module ActiveRecord
   #
   # There is a special syntactic shortcut to generate migrations that add fields to a table.
   #
-  #   bin/rails generate migration add_fieldname_to_tablename fieldname:string
+  #   $ bin/rails generate migration add_fieldname_to_tablename fieldname:string
   #
   # This will generate the file <tt>timestamp_add_fieldname_to_tablename.rb</tt>, which will look like this:
   #   class AddFieldnameToTablename < ActiveRecord::Migration[7.1]
@@ -768,9 +770,11 @@ module ActiveRecord
         def pending_migrations
           pending_migrations = []
 
-          ActiveRecord::Tasks::DatabaseTasks.with_temporary_connection_for_each(env: env) do |connection|
-            if pending = connection.migration_context.open.pending_migrations
-              pending_migrations << pending
+          ActiveRecord::Base.configurations.configs_for(env_name: env).each do |db_config|
+            ActiveRecord::PendingMigrationConnection.establish_temporary_connection(db_config) do |conn|
+              if pending = conn.migration_context.open.pending_migrations
+                pending_migrations << pending
+              end
             end
           end
 

data/lib/active_record/model_schema.rb

@@ -284,8 +284,10 @@ module ActiveRecord
 
       # Computes the table name, (re)sets it internally, and returns it.
       def reset_table_name # :nodoc:
-        self.table_name = if abstract_class?
-          superclass == Base ? nil : superclass.table_name
+        self.table_name = if self == Base
+          nil
+        elsif abstract_class?
+          superclass.table_name
         elsif superclass.abstract_class?
           superclass.table_name || compute_table_name
         else
@@ -467,7 +469,7 @@ module ActiveRecord
       end
 
       # Returns the column object for the named attribute.
-      # Returns an +ActiveRecord::ConnectionAdapters::NullColumn+ if the
+      # Returns an ActiveRecord::ConnectionAdapters::NullColumn if the
       # named attribute does not exist.
       #
       #   class Person < ActiveRecord::Base
@@ -627,8 +629,6 @@ module ActiveRecord
             )
             alias_attribute :id_value, :id if name == "id"
           end
-
-          super
         end
 
         # Guesses the table name, but does not decorate it with prefix and suffix information.

data/lib/active_record/nested_attributes.rb

@@ -283,13 +283,11 @@ module ActiveRecord
     #
     # === Creating forms with nested attributes
     #
-    # Use ActionView::Helpers::FormHelper#fields_for to create form elements
-    # for updating or destroying nested attributes.
+    # Use ActionView::Helpers::FormHelper#fields_for to create form elements for
+    # nested attributes.
     #
-    # === Testing
-    #
-    # If you are using ActionView::Helpers::FormHelper#fields_for, your integration
-    # tests should replicate the HTML structure it provides. For example;
+    # Integration test params should reflect the structure of the form. For
+    # example:
     #
     #   post members_path, params: {
     #     member: {
@@ -309,7 +307,7 @@ module ActiveRecord
       # [:allow_destroy]
       #   If true, destroys any members from the attributes hash with a
       #   <tt>_destroy</tt> key and a value that evaluates to +true+
-      #   (e.g. 1, '1', true, or 'true'). This option is off by default.
+      #   (e.g. 1, '1', true, or 'true'). This option is false by default.
       # [:reject_if]
       #   Allows you to specify a Proc or a Symbol pointing to a method
       #   that checks whether a record should be built for a certain attribute
@@ -334,11 +332,11 @@ module ActiveRecord
       #   nested attributes are going to be used when an associated record already
       #   exists. In general, an existing record may either be updated with the
       #   new set of attribute values or be replaced by a wholly new record
-      #   containing those values. By default the +:update_only+ option is +false+
+      #   containing those values. By default the +:update_only+ option is false
       #   and the nested attributes are used to update the existing record only
       #   if they include the record's <tt>:id</tt> value. Otherwise a new
       #   record will be instantiated and used to replace the existing one.
-      #   However if the +:update_only+ option is +true+, the nested attributes
+      #   However if the +:update_only+ option is true, the nested attributes
       #   are used to update the record's attributes always, regardless of
       #   whether the <tt>:id</tt> is present. The option is ignored for collection
       #   associations.

data/lib/active_record/normalization.rb

@@ -49,6 +49,14 @@ module ActiveRecord # :nodoc:
       # By default, the normalization will not be applied to +nil+ values. This
       # behavior can be changed with the +:apply_to_nil+ option.
       #
+      # Be aware that if your app was created before Rails 7.1, and your app
+      # marshals instances of the targeted model (for example, when caching),
+      # then you should set ActiveRecord.marshalling_format_version to +7.1+ or
+      # higher via either <tt>config.load_defaults 7.1</tt> or
+      # <tt>config.active_record.marshalling_format_version = 7.1</tt>.
+      # Otherwise, +Marshal+ may attempt to serialize the normalization +Proc+
+      # and raise +TypeError+.
+      #
       # ==== Options
       #
       # * +:with+ - Any callable object that accepts the attribute's value as

data/lib/active_record/persistence.rb

@@ -115,7 +115,7 @@ module ActiveRecord
       # ==== Options
       #
       # [:returning]
-      #   (PostgreSQL only) An array of attributes to return for all successfully
+      #   (PostgreSQL and SQLite3 only) An array of attributes to return for all successfully
       #   inserted records, which by default is the primary key.
       #   Pass <tt>returning: %w[ id name ]</tt> for both id and name
       #   or <tt>returning: false</tt> to omit the underlying <tt>RETURNING</tt> SQL
@@ -205,7 +205,7 @@ module ActiveRecord
       # ==== Options
       #
       # [:returning]
-      #   (PostgreSQL only) An array of attributes to return for all successfully
+      #   (PostgreSQL and SQLite3 only) An array of attributes to return for all successfully
       #   inserted records, which by default is the primary key.
       #   Pass <tt>returning: %w[ id name ]</tt> for both id and name
       #   or <tt>returning: false</tt> to omit the underlying <tt>RETURNING</tt> SQL
@@ -271,7 +271,7 @@ module ActiveRecord
       # ==== Options
       #
       # [:returning]
-      #   (PostgreSQL only) An array of attributes to return for all successfully
+      #   (PostgreSQL and SQLite3 only) An array of attributes to return for all successfully
       #   inserted records, which by default is the primary key.
       #   Pass <tt>returning: %w[ id name ]</tt> for both id and name
       #   or <tt>returning: false</tt> to omit the underlying <tt>RETURNING</tt> SQL
@@ -1076,6 +1076,7 @@ module ActiveRecord
       end
 
       @association_cache = fresh_object.instance_variable_get(:@association_cache)
+      @association_cache.each_value { |association| association.owner = self }
       @attributes = fresh_object.instance_variable_get(:@attributes)
       @new_record = false
       @previously_new_record = false

data/lib/active_record/promise.rb

@@ -31,7 +31,7 @@ module ActiveRecord
     # Returns a new +ActiveRecord::Promise+ that will apply the passed block
     # when the value is accessed:
     #
-    #   Post.async_pluck(:title).then { |title| title.upcase }.value
+    #   Post.async_pick(:title).then { |title| title.upcase }.value
     #   # => "POST TITLE"
     def then(&block)
       Promise.new(@future_result, @block ? @block >> block : block)

data/lib/active_record/railtie.rb

@@ -398,7 +398,7 @@ To keep using the current cache store, you can turn off cache versioning entirel
       end
 
       ActiveSupport.on_load(:active_record_fixture_set) do
-        # Encrypt active record fixtures
+        # Encrypt Active Record fixtures
         if ActiveRecord::Encryption.config.encrypt_fixtures
           ActiveRecord::Fixture.prepend ActiveRecord::Encryption::EncryptedFixtures
         end

data/lib/active_record/railties/controller_runtime.rb

@@ -37,9 +37,10 @@ module ActiveRecord
             db_rt_before_render = ActiveRecord::RuntimeRegistry.reset
             self.db_runtime = (db_runtime || 0) + db_rt_before_render
             runtime = super
+            queries_rt = ActiveRecord::RuntimeRegistry.sql_runtime - ActiveRecord::RuntimeRegistry.async_sql_runtime
             db_rt_after_render = ActiveRecord::RuntimeRegistry.reset
             self.db_runtime += db_rt_after_render
-            runtime - db_rt_after_render
+            runtime - queries_rt
           else
             super
           end

data/lib/active_record/railties/databases.rake

@@ -195,7 +195,7 @@ db_namespace = namespace :db do
 
     namespace :up do
       ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
-        desc 'Run the "up" on #{name} database for a given migration VERSION.'
+        desc "Run the \"up\" on #{name} database for a given migration VERSION."
         task name => :load_config do
           raise "VERSION is required" if !ENV["VERSION"] || ENV["VERSION"].empty?
 
@@ -204,7 +204,7 @@ db_namespace = namespace :db do
             conn.migration_context.run(:up, ActiveRecord::Tasks::DatabaseTasks.target_version)
           end
 
-          db_namespace["_dump"].invoke
+          db_namespace["_dump:#{name}"].invoke
         end
       end
     end
@@ -226,7 +226,7 @@ db_namespace = namespace :db do
 
     namespace :down do
       ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
-        desc 'Run the "down" on #{name} database for a given migration VERSION.'
+        desc "Run the \"down\" on #{name} database for a given migration VERSION."
         task name => :load_config do
           raise "VERSION is required" if !ENV["VERSION"] || ENV["VERSION"].empty?
 
@@ -235,7 +235,7 @@ db_namespace = namespace :db do
             conn.migration_context.run(:down, ActiveRecord::Tasks::DatabaseTasks.target_version)
           end
 
-          db_namespace["_dump"].invoke
+          db_namespace["_dump:#{name}"].invoke
         end
       end
     end
@@ -269,7 +269,7 @@ db_namespace = namespace :db do
           conn.migration_context.rollback(step)
         end
 
-        db_namespace["_dump"].invoke
+        db_namespace["_dump:#{name}"].invoke
       end
     end
   end

data/lib/active_record/reflection.rb

@@ -382,6 +382,7 @@ module ActiveRecord
         @klass         = options[:anonymous_class]
         @plural_name   = active_record.pluralize_table_names ?
                             name.to_s.pluralize : name.to_s
+        validate_reflection!
       end
 
       def autosave=(autosave)
@@ -433,6 +434,17 @@ module ActiveRecord
         def derive_class_name
           name.to_s.camelize
         end
+
+        def validate_reflection!
+          return unless options[:foreign_key].is_a?(Array)
+
+          message = <<~MSG.squish
+            Passing #{options[:foreign_key]} array to :foreign_key option
+            on the #{active_record}##{name} association is not supported.
+            Use the query_constraints: #{options[:foreign_key]} option instead to represent a composite foreign key.
+          MSG
+          raise ArgumentError, message
+        end
     end
 
     # Holds all the metadata about an aggregation as it was specified in the
@@ -858,7 +870,7 @@ module ActiveRecord
       def association_primary_key(klass = nil)
         if primary_key = options[:primary_key]
           @association_primary_key ||= -primary_key.to_s
-        elsif !polymorphic? && ((klass || self.klass).has_query_constraints? || options[:query_constraints])
+        elsif (klass || self.klass).has_query_constraints? || options[:query_constraints]
           (klass || self.klass).composite_query_constraints_list
         elsif (klass || self.klass).composite_primary_key?
           # If klass has composite primary key of shape [:<tenant_key>, :id], infer primary_key as :id

data/lib/active_record/relation/calculations.rb

@@ -81,6 +81,16 @@ module ActiveRecord
     #
     # Note: not all valid {Relation#select}[rdoc-ref:QueryMethods#select] expressions are valid #count expressions. The specifics differ
     # between databases. In invalid cases, an error from the database is thrown.
+    #
+    # When given a block, loads all records in the relation, if the relation
+    # hasn't been loaded yet. Calls the block with each record in the relation.
+    # Returns the number of records for which the block returns a truthy value.
+    #
+    #   Person.count { |person| person.age > 21 }
+    #   # => counts the number of people older that 21
+    #
+    # Note: If there are a lot of records in the relation, loading all records
+    # could result in performance issues.
     def count(column_name = nil)
       if block_given?
         unless column_name.nil?
@@ -93,7 +103,8 @@ module ActiveRecord
       end
     end
 
-    # Same as <tt>#count</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #count, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_count(column_name = nil)
       async.count(column_name)
     end
@@ -106,7 +117,8 @@ module ActiveRecord
       calculate(:average, column_name)
     end
 
-    # Same as <tt>#average</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #average, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_average(column_name)
       async.average(column_name)
     end
@@ -120,7 +132,8 @@ module ActiveRecord
       calculate(:minimum, column_name)
     end
 
-    # Same as <tt>#minimum</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #minimum, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_minimum(column_name)
       async.minimum(column_name)
     end
@@ -134,7 +147,8 @@ module ActiveRecord
       calculate(:maximum, column_name)
     end
 
-    # Same as <tt>#maximum</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #maximum, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_maximum(column_name)
       async.maximum(column_name)
     end
@@ -144,6 +158,17 @@ module ActiveRecord
     # #calculate for examples with options.
     #
     #   Person.sum(:age) # => 4562
+    #
+    # When given a block, loads all records in the relation, if the relation
+    # hasn't been loaded yet. Calls the block with each record in the relation.
+    # Returns the sum of +initial_value_or_column+ and the block return
+    # values:
+    #
+    #   Person.sum { |person| person.age } # => 4562
+    #   Person.sum(1000) { |person| person.age } # => 5562
+    #
+    # Note: If there are a lot of records in the relation, loading all records
+    # could result in performance issues.
     def sum(initial_value_or_column = 0, &block)
       if block_given?
         map(&block).sum(initial_value_or_column)
@@ -152,7 +177,8 @@ module ActiveRecord
       end
     end
 
-    # Same as <tt>#sum</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #sum, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_sum(identity_or_column = nil)
       async.sum(identity_or_column)
     end
@@ -255,7 +281,13 @@ module ActiveRecord
     #
     # See also #ids.
     def pluck(*column_names)
-      return [] if @none
+      if @none
+        if @async
+          return Promise::Complete.new([])
+        else
+          return []
+        end
+      end
 
       if loaded? && all_attributes?(column_names)
         result = records.pluck(*column_names)
@@ -287,7 +319,8 @@ module ActiveRecord
       end
     end
 
-    # Same as <tt>#pluck</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #pluck, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_pluck(*column_names)
       async.pluck(*column_names)
     end
@@ -315,7 +348,8 @@ module ActiveRecord
       limit(1).pluck(*column_names).then(&:first)
     end
 
-    # Same as <tt>#pick</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #pick, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_pick(*column_names)
       async.pick(*column_names)
     end
@@ -358,7 +392,8 @@ module ActiveRecord
       result.then { |result| type_cast_pluck_values(result, columns) }
     end
 
-    # Same as <tt>#ids</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
+    # Same as #ids, but performs the query asynchronously and returns an
+    # ActiveRecord::Promise.
     def async_ids
       async.ids
     end

data/lib/active_record/relation/delegation.rb

@@ -102,7 +102,7 @@ module ActiveRecord
              :to_sentence, :to_fs, :to_formatted_s, :as_json,
              :shuffle, :split, :slice, :index, :rindex, to: :records
 
-    delegate :primary_key, :connection, to: :klass
+    delegate :primary_key, :connection, :transaction, to: :klass
 
     module ClassSpecificRelation # :nodoc:
       extend ActiveSupport::Concern

data/lib/active_record/relation/query_methods.rb

@@ -588,7 +588,7 @@ module ActiveRecord
     #   User.order(Arel.sql('end_date - start_date'))
     #   # SELECT "users".* FROM "users" ORDER BY end_date - start_date
     #
-    # Custom query syntax, like JSON columns for Postgres, is supported in this way.
+    # Custom query syntax, like JSON columns for PostgreSQL, is supported in this way.
     #
     #   User.order(Arel.sql("payload->>'kind'"))
     #   # SELECT "users".* FROM "users" ORDER BY payload->>'kind'