activerecord 5.2.6.2 → 6.0.0.beta1

data/lib/active_record/gem_version.rb

@@ -7,10 +7,10 @@ module ActiveRecord
   end
 
   module VERSION
-    MAJOR = 5
-    MINOR = 2
-    TINY  = 6
-    PRE   = "2"
+    MAJOR = 6
+    MINOR = 0
+    TINY  = 0
+    PRE   = "beta1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_record/inheritance.rb

@@ -55,7 +55,11 @@ module ActiveRecord
         if has_attribute?(inheritance_column)
           subclass = subclass_from_attributes(attributes)
 
-          if subclass.nil? && base_class == self
+          if subclass.nil? && scope_attributes = current_scope&.scope_for_create
+            subclass = subclass_from_attributes(scope_attributes)
+          end
+
+          if subclass.nil? && base_class?
             subclass = subclass_from_attributes(column_defaults)
           end
         end
@@ -104,6 +108,12 @@ module ActiveRecord
         end
       end
 
+      # Returns whether the class is a base class.
+      # See #base_class for more information.
+      def base_class?
+        base_class == self
+      end
+
       # Set this to +true+ if this is an abstract class (see
       # <tt>abstract_class?</tt>).
       # If you are using inheritance with Active Record and don't want a class
@@ -170,7 +180,7 @@ module ActiveRecord
         # Returns the class type of the record using the current module as a prefix. So descendants of
         # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
         def compute_type(type_name)
-          if type_name.start_with?("::".freeze)
+          if type_name.start_with?("::")
             # If the type is prefixed with a scope operator then we assume that
             # the type_name is an absolute reference.
             ActiveSupport::Dependencies.constantize(type_name)

data/lib/active_record/integration.rb

@@ -20,7 +20,7 @@ module ActiveRecord
       # Indicates whether to use a stable #cache_key method that is accompanied
       # by a changing version in the #cache_version method.
       #
-      # This is +false+, by default until Rails 6.0.
+      # This is +true+, by default on Rails 5.2 and above.
       class_attribute :cache_versioning, instance_writer: false, default: false
     end
 
@@ -60,24 +60,15 @@ module ActiveRecord
     # the cache key will also include a version.
     #
     #   Product.cache_versioning = false
-    #   Person.find(5).cache_key  # => "people/5-20071224150000" (updated_at available)
-    def cache_key(*timestamp_names)
+    #   Product.find(5).cache_key  # => "products/5-20071224150000" (updated_at available)
+    def cache_key
       if new_record?
         "#{model_name.cache_key}/new"
       else
-        if cache_version && timestamp_names.none?
+        if cache_version
           "#{model_name.cache_key}/#{id}"
         else
-          timestamp = if timestamp_names.any?
-            ActiveSupport::Deprecation.warn(<<-MSG.squish)
-              Specifying a timestamp name for #cache_key has been deprecated in favor of
-              the explicit #cache_version method that can be overwritten.
-            MSG
-
-            max_updated_column_timestamp(timestamp_names)
-          else
-            max_updated_column_timestamp
-          end
+          timestamp = max_updated_column_timestamp
 
           if timestamp
             timestamp = timestamp.utc.to_s(cache_timestamp_format)
@@ -96,8 +87,19 @@ module ActiveRecord
     # Note, this method will return nil if ActiveRecord::Base.cache_versioning is set to
     # +false+ (which it is by default until Rails 6.0).
     def cache_version
-      if cache_versioning && timestamp = try(:updated_at)
-        timestamp.utc.to_s(:usec)
+      return unless cache_versioning
+
+      if has_attribute?("updated_at")
+        timestamp = updated_at_before_type_cast
+        if can_use_fast_cache_version?(timestamp)
+          raw_timestamp_to_cache_version(timestamp)
+        elsif timestamp = updated_at
+          timestamp.utc.to_s(cache_timestamp_format)
+        end
+      else
+        if self.class.has_attribute?("updated_at")
+          raise ActiveModel::MissingAttributeError, "missing attribute: updated_at"
+        end
       end
     end
 
@@ -151,5 +153,43 @@ module ActiveRecord
         end
       end
     end
+
+    private
+      # Detects if the value before type cast
+      # can be used to generate a cache_version.
+      #
+      # The fast cache version only works with a
+      # string value directly from the database.
+      #
+      # We also must check if the timestamp format has been changed
+      # or if the timezone is not set to UTC then
+      # we cannot apply our transformations correctly.
+      def can_use_fast_cache_version?(timestamp)
+        timestamp.is_a?(String) &&
+          cache_timestamp_format == :usec &&
+          default_timezone == :utc &&
+          !updated_at_came_from_user?
+      end
+
+      # Converts a raw database string to `:usec`
+      # format.
+      #
+      # Example:
+      #
+      #   timestamp = "2018-10-15 20:02:15.266505"
+      #   raw_timestamp_to_cache_version(timestamp)
+      #   # => "20181015200215266505"
+      #
+      # Postgres truncates trailing zeros,
+      # https://github.com/postgres/postgres/commit/3e1beda2cde3495f41290e1ece5d544525810214
+      # to account for this we pad the output with zeros
+      def raw_timestamp_to_cache_version(timestamp)
+        key = timestamp.delete("- :.")
+        if key.length < 20
+          key.ljust(20, "0")
+        else
+          key
+        end
+      end
   end
 end

data/lib/active_record/internal_metadata.rb

@@ -8,6 +8,10 @@ module ActiveRecord
   # as which environment migrations were run in.
   class InternalMetadata < ActiveRecord::Base # :nodoc:
     class << self
+      def _internal?
+        true
+      end
+
       def primary_key
         "key"
       end
@@ -17,7 +21,7 @@ module ActiveRecord
       end
 
       def []=(key, value)
-        find_or_initialize_by(key: key).update_attributes!(value: value)
+        find_or_initialize_by(key: key).update!(value: value)
       end
 
       def [](key)

data/lib/active_record/locking/optimistic.rb

@@ -61,7 +61,7 @@ module ActiveRecord
       end
 
       private
-        def _create_record(attribute_names = self.attribute_names, *)
+        def _create_record(attribute_names = self.attribute_names)
           if locking_enabled?
             # We always want to persist the locking version, even if we don't detect
             # a change from the default, since the database might have no default
@@ -165,7 +165,7 @@ module ActiveRecord
             def inherited(subclass)
               subclass.class_eval do
                 is_lock_column = ->(name, _) { lock_optimistically && name == locking_column }
-                decorate_matching_attribute_types(is_lock_column, :_optimistic_locking) do |type|
+                decorate_matching_attribute_types(is_lock_column, "_optimistic_locking") do |type|
                   LockingType.new(type)
                 end
               end

data/lib/active_record/locking/pessimistic.rb

@@ -14,9 +14,9 @@ module ActiveRecord
     # of your own such as 'LOCK IN SHARE MODE' or 'FOR UPDATE NOWAIT'. Example:
     #
     #   Account.transaction do
-    #     # select * from accounts where name = 'shugo' limit 1 for update
-    #     shugo = Account.where("name = 'shugo'").lock(true).first
-    #     yuko = Account.where("name = 'yuko'").lock(true).first
+    #     # select * from accounts where name = 'shugo' limit 1 for update nowait
+    #     shugo = Account.lock("FOR UPDATE NOWAIT").find_by(name: "shugo")
+    #     yuko = Account.lock("FOR UPDATE NOWAIT").find_by(name: "yuko")
     #     shugo.balance -= 100
     #     shugo.save!
     #     yuko.balance += 100

data/lib/active_record/log_subscriber.rb

@@ -4,6 +4,8 @@ module ActiveRecord
   class LogSubscriber < ActiveSupport::LogSubscriber
     IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN"]
 
+    class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new
+
     def self.runtime=(value)
       ActiveRecord::RuntimeRegistry.sql_runtime = value
     end
@@ -100,36 +102,15 @@ module ActiveRecord
       end
 
       def log_query_source
-        source_line, line_number = extract_callstack(caller_locations)
-
-        if source_line
-          if defined?(::Rails.root)
-            app_root = "#{::Rails.root.to_s}/".freeze
-            source_line = source_line.sub(app_root, "")
-          end
-
-          logger.debug("  ↳ #{ source_line }:#{ line_number }")
-        end
-      end
+        source = extract_query_source_location(caller)
 
-      def extract_callstack(callstack)
-        line = callstack.find do |frame|
-          frame.absolute_path && !ignored_callstack(frame.absolute_path)
+        if source
+          logger.debug("  ↳ #{source}")
         end
-
-        offending_line = line || callstack.first
-
-        [
-          offending_line.path,
-          offending_line.lineno
-        ]
       end
 
-      RAILS_GEM_ROOT = File.expand_path("../../..", __dir__) + "/"
-
-      def ignored_callstack(path)
-        path.start_with?(RAILS_GEM_ROOT) ||
-        path.start_with?(RbConfig::CONFIG["rubylibdir"])
+      def extract_query_source_location(locations)
+        backtrace_cleaner.clean(locations).first
       end
   end
 end

data/lib/active_record/migration/command_recorder.rb

@@ -85,7 +85,7 @@ module ActiveRecord
       # invert the +command+.
       def inverse_of(command, args, &block)
         method = :"invert_#{command}"
-        raise IrreversibleMigration, <<-MSG.strip_heredoc unless respond_to?(method, true)
+        raise IrreversibleMigration, <<~MSG unless respond_to?(method, true)
           This migration uses #{command}, which is not automatically reversible.
           To make the migration reversible you can either:
           1. Define #up and #down methods in place of the #change method.
@@ -108,11 +108,17 @@ module ActiveRecord
         yield delegate.update_table_definition(table_name, self)
       end
 
+      def replay(migration)
+        commands.each do |cmd, args, block|
+          migration.send(cmd, *args, &block)
+        end
+      end
+
       private
 
         module StraightReversions # :nodoc:
           private
-            { transaction:       :transaction,
+            {
               execute_block:     :execute_block,
               create_table:      :drop_table,
               create_join_table: :drop_join_table,
@@ -133,6 +139,17 @@ module ActiveRecord
 
         include StraightReversions
 
+        def invert_transaction(args)
+          sub_recorder = CommandRecorder.new(delegate)
+          sub_recorder.revert { yield }
+
+          invertions_proc = proc {
+            sub_recorder.replay(self)
+          }
+
+          [:transaction, args, invertions_proc]
+        end
+
         def invert_drop_table(args, &block)
           if args.size == 1 && block == nil
             raise ActiveRecord::IrreversibleMigration, "To avoid mistakes, drop_table is only reversible if given options or a block (can be empty)."
@@ -214,11 +231,24 @@ module ActiveRecord
         end
 
         def invert_remove_foreign_key(args)
-          from_table, to_table, remove_options = args
-          raise ActiveRecord::IrreversibleMigration, "remove_foreign_key is only reversible if given a second table" if to_table.nil? || to_table.is_a?(Hash)
+          from_table, options_or_to_table, options_or_nil = args
+
+          to_table = if options_or_to_table.is_a?(Hash)
+            options_or_to_table[:to_table]
+          else
+            options_or_to_table
+          end
+
+          remove_options = if options_or_to_table.is_a?(Hash)
+            options_or_to_table.except(:to_table)
+          else
+            options_or_nil
+          end
+
+          raise ActiveRecord::IrreversibleMigration, "remove_foreign_key is only reversible if given a second table" if to_table.nil?
 
           reversed_args = [from_table, to_table]
-          reversed_args << remove_options if remove_options
+          reversed_args << remove_options if remove_options.present?
 
           [:add_foreign_key, reversed_args]
         end

data/lib/active_record/migration/compatibility.rb

@@ -13,22 +13,42 @@ module ActiveRecord
         const_get(name)
       end
 
-      V5_2 = Current
+      V6_0 = Current
+
+      class V5_2 < V6_0
+        module CommandRecorder
+          def invert_transaction(args, &block)
+            [:transaction, args, block]
+          end
+        end
+
+        private
+
+          def command_recorder
+            recorder = super
+            class << recorder
+              prepend CommandRecorder
+            end
+            recorder
+          end
+      end
 
       class V5_1 < V5_2
         def change_column(table_name, column_name, type, options = {})
-          if connection.adapter_name == "PostgreSQL"
-            super(table_name, column_name, type, options.except(:default, :null, :comment))
-            connection.change_column_default(table_name, column_name, options[:default]) if options.key?(:default)
-            connection.change_column_null(table_name, column_name, options[:null], options[:default]) if options.key?(:null)
-            connection.change_column_comment(table_name, column_name, options[:comment]) if options.key?(:comment)
+          if adapter_name == "PostgreSQL"
+            clear_cache!
+            sql = connection.send(:change_column_sql, table_name, column_name, type, options)
+            execute "ALTER TABLE #{quote_table_name(table_name)} #{sql}"
+            change_column_default(table_name, column_name, options[:default]) if options.key?(:default)
+            change_column_null(table_name, column_name, options[:null], options[:default]) if options.key?(:null)
+            change_column_comment(table_name, column_name, options[:comment]) if options.key?(:comment)
           else
             super
           end
         end
 
         def create_table(table_name, options = {})
-          if connection.adapter_name == "Mysql2"
+          if adapter_name == "Mysql2"
             super(table_name, options: "ENGINE=InnoDB", **options)
           else
             super
@@ -50,13 +70,13 @@ module ActiveRecord
         end
 
         def create_table(table_name, options = {})
-          if connection.adapter_name == "PostgreSQL"
+          if adapter_name == "PostgreSQL"
             if options[:id] == :uuid && !options.key?(:default)
               options[:default] = "uuid_generate_v4()"
             end
           end
 
-          unless connection.adapter_name == "Mysql2" && options[:id] == :bigint
+          unless adapter_name == "Mysql2" && options[:id] == :bigint
             if [:integer, :bigint].include?(options[:id]) && !options.key?(:default)
               options[:default] = nil
             end
@@ -173,7 +193,7 @@ module ActiveRecord
             if options[:name].present?
               options[:name].to_s
             else
-              connection.index_name(table_name, column: column_names)
+              index_name(table_name, column: column_names)
             end
           super
         end
@@ -193,17 +213,15 @@ module ActiveRecord
           end
 
           def index_name_for_remove(table_name, options = {})
-            index_name = connection.index_name(table_name, options)
+            index_name = index_name(table_name, options)
 
-            unless connection.index_name_exists?(table_name, index_name)
+            unless index_name_exists?(table_name, index_name)
               if options.is_a?(Hash) && options.has_key?(:name)
                 options_without_column = options.dup
                 options_without_column.delete :column
-                index_name_without_column = connection.index_name(table_name, options_without_column)
+                index_name_without_column = index_name(table_name, options_without_column)
 
-                if connection.index_name_exists?(table_name, index_name_without_column)
-                  return index_name_without_column
-                end
+                return index_name_without_column if index_name_exists?(table_name, index_name_without_column)
               end
 
               raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' does not exist"

data/lib/active_record/migration.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "benchmark"
 require "set"
 require "zlib"
 require "active_support/core_ext/module/attribute_accessors"
@@ -22,7 +23,7 @@ module ActiveRecord
   #         t.string :zipcode
   #       end
   #
-  #       execute <<-SQL
+  #       execute <<~SQL
   #         ALTER TABLE distributors
   #           ADD CONSTRAINT zipchk
   #             CHECK (char_length(zipcode) = 5) NO INHERIT;
@@ -40,7 +41,7 @@ module ActiveRecord
   #        t.string :zipcode
   #      end
   #
-  #      execute <<-SQL
+  #      execute <<~SQL
   #        ALTER TABLE distributors
   #          ADD CONSTRAINT zipchk
   #            CHECK (char_length(zipcode) = 5) NO INHERIT;
@@ -48,7 +49,7 @@ module ActiveRecord
   #    end
   #
   #    def down
-  #      execute <<-SQL
+  #      execute <<~SQL
   #        ALTER TABLE distributors
   #          DROP CONSTRAINT zipchk
   #      SQL
@@ -67,7 +68,7 @@ module ActiveRecord
   #
   #       reversible do |dir|
   #         dir.up do
-  #           execute <<-SQL
+  #           execute <<~SQL
   #             ALTER TABLE distributors
   #               ADD CONSTRAINT zipchk
   #                 CHECK (char_length(zipcode) = 5) NO INHERIT;
@@ -75,7 +76,7 @@ module ActiveRecord
   #         end
   #
   #         dir.down do
-  #           execute <<-SQL
+  #           execute <<~SQL
   #             ALTER TABLE distributors
   #               DROP CONSTRAINT zipchk
   #           SQL
@@ -129,9 +130,9 @@ module ActiveRecord
   class PendingMigrationError < MigrationError#:nodoc:
     def initialize(message = nil)
       if !message && defined?(Rails.env)
-        super("Migrations are pending. To resolve this issue, run:\n\n        bin/rails db:migrate RAILS_ENV=#{::Rails.env}")
+        super("Migrations are pending. To resolve this issue, run:\n\n        rails db:migrate RAILS_ENV=#{::Rails.env}")
       elsif !message
-        super("Migrations are pending. To resolve this issue, run:\n\n        bin/rails db:migrate")
+        super("Migrations are pending. To resolve this issue, run:\n\n        rails db:migrate")
       else
         super
       end
@@ -139,8 +140,8 @@ module ActiveRecord
   end
 
   class ConcurrentMigrationError < MigrationError #:nodoc:
-    DEFAULT_MESSAGE = "Cannot run migrations because another migration process is currently running.".freeze
-    RELEASE_LOCK_FAILED_MESSAGE = "Failed to release advisory lock".freeze
+    DEFAULT_MESSAGE = "Cannot run migrations because another migration process is currently running."
+    RELEASE_LOCK_FAILED_MESSAGE = "Failed to release advisory lock"
 
     def initialize(message = DEFAULT_MESSAGE)
       super
@@ -149,7 +150,7 @@ module ActiveRecord
 
   class NoEnvironmentInSchemaError < MigrationError #:nodoc:
     def initialize
-      msg = "Environment data not found in the schema. To resolve this issue, run: \n\n        bin/rails db:environment:set"
+      msg = "Environment data not found in the schema. To resolve this issue, run: \n\n        rails db:environment:set"
       if defined?(Rails.env)
         super("#{msg} RAILS_ENV=#{::Rails.env}")
       else
@@ -160,7 +161,7 @@ module ActiveRecord
 
   class ProtectedEnvironmentError < ActiveRecordError #:nodoc:
     def initialize(env = "production")
-      msg = "You are attempting to run a destructive action against your '#{env}' database.\n".dup
+      msg = +"You are attempting to run a destructive action against your '#{env}' database.\n"
       msg << "If you are sure you want to continue, run the same command with the environment variable:\n"
       msg << "DISABLE_DATABASE_ENVIRONMENT_CHECK=1"
       super(msg)
@@ -169,10 +170,10 @@ module ActiveRecord
 
   class EnvironmentMismatchError < ActiveRecordError
     def initialize(current: nil, stored: nil)
-      msg =  "You are attempting to modify a database that was last run in `#{ stored }` environment.\n".dup
+      msg = +"You are attempting to modify a database that was last run in `#{ stored }` environment.\n"
       msg << "You are running in `#{ current }` environment. "
       msg << "If you are sure you want to continue, first set the environment using:\n\n"
-      msg << "        bin/rails db:environment:set"
+      msg << "        rails db:environment:set"
       if defined?(Rails.env)
         super("#{msg} RAILS_ENV=#{::Rails.env}\n\n")
       else
@@ -351,7 +352,7 @@ module ActiveRecord
   # <tt>rails db:migrate</tt>. This will update the database by running all of the
   # pending migrations, creating the <tt>schema_migrations</tt> table
   # (see "About the schema_migrations table" section below) if missing. It will also
-  # invoke the db:schema:dump task, which will update your db/schema.rb file
+  # invoke the db:schema:dump command, which will update your db/schema.rb file
   # to match the structure of your database.
   #
   # To roll the database back to a previous migration version, use
@@ -677,15 +678,13 @@ module ActiveRecord
         if connection.respond_to? :revert
           connection.revert { yield }
         else
-          recorder = CommandRecorder.new(connection)
+          recorder = command_recorder
           @connection = recorder
           suppress_messages do
             connection.revert { yield }
           end
           @connection = recorder.delegate
-          recorder.commands.each do |cmd, args, block|
-            send(cmd, *args, &block)
-          end
+          recorder.replay(self)
         end
       end
     end
@@ -830,10 +829,14 @@ module ActiveRecord
       write "== %s %s" % [text, "=" * length]
     end
 
+    # Takes a message argument and outputs it as is.
+    # A second boolean argument can be passed to specify whether to indent or not.
     def say(message, subitem = false)
       write "#{subitem ? "   ->" : "--"} #{message}"
     end
 
+    # Outputs text along with how long it took to run its block.
+    # If the block returns an integer it assumes it is the number of rows affected.
     def say_with_time(message)
       say(message)
       result = nil
@@ -843,6 +846,7 @@ module ActiveRecord
       result
     end
 
+    # Takes a block as an argument and suppresses any output generated by the block.
     def suppress_messages
       save, self.verbose = verbose, false
       yield
@@ -885,7 +889,7 @@ module ActiveRecord
         source_migrations.each do |migration|
           source = File.binread(migration.filename)
           inserted_comment = "# This migration comes from #{scope} (originally #{migration.version})\n"
-          magic_comments = "".dup
+          magic_comments = +""
           loop do
             # If we have a magic comment in the original migration,
             # insert our comment after the first newline(end of the magic comment line)
@@ -956,6 +960,10 @@ module ActiveRecord
           yield
         end
       end
+
+      def command_recorder
+        CommandRecorder.new(connection)
+      end
   end
 
   # MigrationProxy is used to defer loading of the actual migration classes
@@ -1079,10 +1087,6 @@ module ActiveRecord
       migrations.last || NullMigration.new
     end
 
-    def parse_migration_filename(filename) # :nodoc:
-      File.basename(filename).scan(Migration::MigrationFilenameRegexp).first
-    end
-
     def migrations
       migrations = migration_files.map do |file|
         version, name, scope = parse_migration_filename(file)
@@ -1114,11 +1118,6 @@ module ActiveRecord
       (db_list + file_list).sort_by { |_, version, _| version }
     end
 
-    def migration_files
-      paths = Array(migrations_paths)
-      Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
-    end
-
     def current_environment
       ActiveRecord::ConnectionHandling::DEFAULT_ENV.call
     end
@@ -1137,6 +1136,15 @@ module ActiveRecord
     end
 
     private
+      def migration_files
+        paths = Array(migrations_paths)
+        Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+      end
+
+      def parse_migration_filename(filename)
+        File.basename(filename).scan(Migration::MigrationFilenameRegexp).first
+      end
+
       def move(direction, steps)
         migrator = Migrator.new(direction, migrations)
 
@@ -1161,13 +1169,6 @@ module ActiveRecord
     class << self
       attr_accessor :migrations_paths
 
-      def migrations_path=(path)
-        ActiveSupport::Deprecation.warn \
-          "`ActiveRecord::Migrator.migrations_path=` is now deprecated and will be removed in Rails 6.0. " \
-          "You can set the `migrations_paths` on the `connection` instead through the `database.yml`."
-        self.migrations_paths = [path]
-      end
-
       # For cases where a table doesn't exist like loading from schema cache
       def current_version
         MigrationContext.new(migrations_paths).current_version
@@ -1293,7 +1294,7 @@ module ActiveRecord
           record_version_state_after_migrating(migration.version)
         end
       rescue => e
-        msg = "An error has occurred, ".dup
+        msg = +"An error has occurred, "
         msg << "this and " if use_transaction?(migration)
         msg << "all later migrations canceled:\n\n#{e}"
         raise StandardError, msg, e.backtrace
@@ -1351,7 +1352,7 @@ module ActiveRecord
       end
 
       def use_advisory_lock?
-        Base.connection.supports_advisory_locks?
+        Base.connection.advisory_locks_enabled?
       end
 
       def with_advisory_lock