activerecord 3.2.19 → 5.0.0

data/lib/active_record/attribute_methods/dirty.rb

@@ -1,110 +1,150 @@
-require 'active_support/core_ext/class/attribute'
-require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_record/attribute_mutation_tracker'
 
 module ActiveRecord
   module AttributeMethods
-    module Dirty
+    module Dirty # :nodoc:
       extend ActiveSupport::Concern
+
       include ActiveModel::Dirty
-      include AttributeMethods::Write
 
       included do
         if self < ::ActiveRecord::Timestamp
           raise "You cannot include Dirty after Timestamp"
         end
 
-        class_attribute :partial_updates
-        self.partial_updates = true
+        class_attribute :partial_writes, instance_writer: false
+        self.partial_writes = true
       end
 
       # Attempts to +save+ the record and clears changed attributes if successful.
-      def save(*) #:nodoc:
+      def save(*)
         if status = super
-          @previously_changed = changes
-          @changed_attributes.clear
-        elsif IdentityMap.enabled?
-          IdentityMap.remove(self)
+          changes_applied
         end
         status
       end
 
       # Attempts to <tt>save!</tt> the record and clears changed attributes if successful.
-      def save!(*) #:nodoc:
+      def save!(*)
         super.tap do
-          @previously_changed = changes
-          @changed_attributes.clear
+          changes_applied
         end
-      rescue
-        IdentityMap.remove(self) if IdentityMap.enabled?
-        raise
       end
 
       # <tt>reload</tt> the record and clears changed attributes.
-      def reload(*) #:nodoc:
+      def reload(*)
         super.tap do
-          @previously_changed.clear
-          @changed_attributes.clear
+          @mutation_tracker = nil
+          @previous_mutation_tracker = nil
+          @changed_attributes = HashWithIndifferentAccess.new
         end
       end
 
-    private
-      # Wrap write_attribute to remember original attribute value.
-      def write_attribute(attr, value)
-        attr = attr.to_s
-
-        # The attribute already has an unsaved change.
-        if attribute_changed?(attr)
-          old = @changed_attributes[attr]
-          @changed_attributes.delete(attr) unless _field_changed?(attr, old, value)
-        else
-          old = clone_attribute_value(:read_attribute, attr)
-          # Save Time objects as TimeWithZone if time_zone_aware_attributes == true
-          old = old.in_time_zone if clone_with_time_zone_conversion_attribute?(attr, old)
-          @changed_attributes[attr] = old if _field_changed?(attr, old, value)
+      def initialize_dup(other) # :nodoc:
+        super
+        @attributes = self.class._default_attributes.map do |attr|
+          attr.with_value_from_user(@attributes.fetch_value(attr.name))
         end
+        @mutation_tracker = nil
+      end
+
+      def changes_applied
+        @previous_mutation_tracker = mutation_tracker
+        @changed_attributes = HashWithIndifferentAccess.new
+        store_original_attributes
+      end
+
+      def clear_changes_information
+        @previous_mutation_tracker = nil
+        @changed_attributes = HashWithIndifferentAccess.new
+        store_original_attributes
+      end
 
-        # Carry on.
-        super(attr, value)
+      def raw_write_attribute(attr_name, *)
+        result = super
+        clear_attribute_change(attr_name)
+        result
       end
 
-      def update(*)
-        if partial_updates?
-          # Serialized attributes should always be written in case they've been
-          # changed in place.
-          super(changed | (attributes.keys & self.class.serialized_attributes.keys))
+      def clear_attribute_changes(attr_names)
+        super
+        attr_names.each do |attr_name|
+          clear_attribute_change(attr_name)
+        end
+      end
+
+      def changed_attributes
+        # This should only be set by methods which will call changed_attributes
+        # multiple times when it is known that the computed value cannot change.
+        if defined?(@cached_changed_attributes)
+          @cached_changed_attributes
         else
+          super.reverse_merge(mutation_tracker.changed_values).freeze
+        end
+      end
+
+      def changes
+        cache_changed_attributes do
           super
         end
       end
 
-      def _field_changed?(attr, old, value)
-        if column = column_for_attribute(attr)
-          if column.number? && (changes_from_nil_to_empty_string?(column, old, value) ||
-                                changes_from_zero_to_string?(old, value))
-            value = nil
-          else
-            value = column.type_cast(value)
-          end
+      def previous_changes
+        previous_mutation_tracker.changes
+      end
+
+      def attribute_changed_in_place?(attr_name)
+        mutation_tracker.changed_in_place?(attr_name)
+      end
+
+      private
+
+      def mutation_tracker
+        unless defined?(@mutation_tracker)
+          @mutation_tracker = nil
         end
+        @mutation_tracker ||= AttributeMutationTracker.new(@attributes)
+      end
+
+      def changes_include?(attr_name)
+        super || mutation_tracker.changed?(attr_name)
+      end
+
+      def clear_attribute_change(attr_name)
+        mutation_tracker.forget_change(attr_name)
+      end
+
+      def _update_record(*)
+        partial_writes? ? super(keys_for_partial_write) : super
+      end
+
+      def _create_record(*)
+        partial_writes? ? super(keys_for_partial_write) : super
+      end
+
+      def keys_for_partial_write
+        changed & self.class.column_names
+      end
 
-        old != value
+      def store_original_attributes
+        @attributes = @attributes.map(&:forgetting_assignment)
+        @mutation_tracker = nil
       end
 
-      def clone_with_time_zone_conversion_attribute?(attr, old)
-        old.class.name == "Time" && time_zone_aware_attributes && !self.skip_time_zone_conversion_for_attributes.include?(attr.to_sym)
+      def previous_mutation_tracker
+        @previous_mutation_tracker ||= NullMutationTracker.instance
       end
 
-      def changes_from_nil_to_empty_string?(column, old, value)
-        # For nullable numeric columns, NULL gets stored in database for blank (i.e. '') values.
-        # Hence we don't record it as a change if the value changes from nil to ''.
-        # If an old value of 0 is set to '' we want this to get changed to nil as otherwise it'll
-        # be typecast back to 0 (''.to_i => 0)
-        column.null && (old.nil? || old == 0) && value.blank?
+      def cache_changed_attributes
+        @cached_changed_attributes = changed_attributes
+        yield
+      ensure
+        clear_changed_attributes_cache
       end
 
-      def changes_from_zero_to_string?(old, value)
-        # For columns with old 0 and value non-empty string
-        old == 0 && value.is_a?(String) && value.present? && value != '0'
+      def clear_changed_attributes_cache
+        remove_instance_variable(:@cached_changed_attributes) if defined?(@cached_changed_attributes)
       end
     end
   end

data/lib/active_record/attribute_methods/primary_key.rb

@@ -1,56 +1,81 @@
+require 'set'
+
 module ActiveRecord
   module AttributeMethods
     module PrimaryKey
       extend ActiveSupport::Concern
 
-      # Returns this record's primary key value wrapped in an Array if one is available
+      # Returns this record's primary key value wrapped in an array if one is
+      # available.
       def to_key
+        sync_with_transaction_state
         key = self.id
         [key] if key
       end
 
-      # Returns the primary key value
+      # Returns the primary key value.
       def id
-        read_attribute(self.class.primary_key)
+        if pk = self.class.primary_key
+          sync_with_transaction_state
+          _read_attribute(pk)
+        end
       end
 
-      # Sets the primary key value
+      # Sets the primary key value.
       def id=(value)
-        write_attribute(self.class.primary_key, value)
+        sync_with_transaction_state
+        write_attribute(self.class.primary_key, value) if self.class.primary_key
       end
 
-      # Queries the primary key value
+      # Queries the primary key value.
       def id?
+        sync_with_transaction_state
         query_attribute(self.class.primary_key)
       end
 
+      # Returns the primary key value before type cast.
+      def id_before_type_cast
+        sync_with_transaction_state
+        read_attribute_before_type_cast(self.class.primary_key)
+      end
+
+      # Returns the primary key previous value.
+      def id_was
+        sync_with_transaction_state
+        attribute_was(self.class.primary_key)
+      end
+
+      protected
+
+      def attribute_method?(attr_name)
+        attr_name == 'id' || super
+      end
+
       module ClassMethods
         def define_method_attribute(attr_name)
           super
 
           if attr_name == primary_key && attr_name != 'id'
             generated_attribute_methods.send(:alias_method, :id, primary_key)
-            generated_external_attribute_methods.module_eval <<-CODE, __FILE__, __LINE__
-              def id(v, attributes, attributes_cache, attr_name)
-                attr_name = '#{primary_key}'
-                send(attr_name, attributes[attr_name], attributes, attributes_cache, attr_name)
-              end
-            CODE
           end
         end
 
+        ID_ATTRIBUTE_METHODS = %w(id id= id? id_before_type_cast id_was).to_set
+
         def dangerous_attribute_method?(method_name)
-          super && !['id', 'id=', 'id?'].include?(method_name)
+          super && !ID_ATTRIBUTE_METHODS.include?(method_name)
         end
 
-        # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
-        # primary_key_prefix_type setting, though.
+        # Defines the primary key field -- can be overridden in subclasses.
+        # Overwriting will negate any effect of the +primary_key_prefix_type+
+        # setting, though.
         def primary_key
           @primary_key = reset_primary_key unless defined? @primary_key
           @primary_key
         end
 
-        # Returns a quoted version of the primary key name, used to construct SQL statements.
+        # Returns a quoted version of the primary key name, used to construct
+        # SQL statements.
         def quoted_primary_key
           @quoted_primary_key ||= connection.quote_column_name(primary_key)
         end
@@ -64,49 +89,38 @@ module ActiveRecord
         end
 
         def get_primary_key(base_name) #:nodoc:
-          return 'id' unless base_name && !base_name.blank?
-
-          case primary_key_prefix_type
-          when :table_name
+          if base_name && primary_key_prefix_type == :table_name
             base_name.foreign_key(false)
-          when :table_name_with_underscore
+          elsif base_name && primary_key_prefix_type == :table_name_with_underscore
             base_name.foreign_key
           else
             if ActiveRecord::Base != self && table_exists?
-              connection.schema_cache.primary_keys[table_name]
+              connection.schema_cache.primary_keys(table_name)
             else
               'id'
             end
           end
         end
 
-        def original_primary_key #:nodoc:
-          deprecated_original_property_getter :primary_key
-        end
-
         # Sets the name of the primary key column.
         #
         #   class Project < ActiveRecord::Base
-        #     self.primary_key = "sysid"
+        #     self.primary_key = 'sysid'
         #   end
         #
-        # You can also define the primary_key method yourself:
+        # You can also define the #primary_key method yourself:
         #
         #   class Project < ActiveRecord::Base
         #     def self.primary_key
-        #       "foo_" + super
+        #       'foo_' + super
         #     end
         #   end
+        #
         #   Project.primary_key # => "foo_id"
         def primary_key=(value)
-          @original_primary_key = @primary_key if defined?(@primary_key)
-          @primary_key          = value && value.to_s
-          @quoted_primary_key   = nil
-        end
-
-        def set_primary_key(value = nil, &block) #:nodoc:
-          deprecated_property_setter :primary_key, value, block
+          @primary_key        = value && value.to_s
           @quoted_primary_key = nil
+          @attributes_builder = nil
         end
       end
     end

data/lib/active_record/attribute_methods/query.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/object/blank'
-
 module ActiveRecord
   module AttributeMethods
     module Query
@@ -10,18 +8,21 @@ module ActiveRecord
       end
 
       def query_attribute(attr_name)
-        unless value = read_attribute(attr_name)
-          false
+        value = self[attr_name]
+
+        case value
+        when true        then true
+        when false, nil  then false
         else
           column = self.class.columns_hash[attr_name]
           if column.nil?
             if Numeric === value || value !~ /[^0-9]/
               !value.to_i.zero?
             else
-              return false if ActiveRecord::ConnectionAdapters::Column::FALSE_VALUES.include?(value)
+              return false if ActiveModel::Type::Boolean::FALSE_VALUES.include?(value)
               !value.blank?
             end
-          elsif column.number?
+          elsif value.respond_to?(:zero?)
             !value.zero?
           else
             !value.blank?

data/lib/active_record/attribute_methods/read.rb

@@ -3,134 +3,73 @@ module ActiveRecord
     module Read
       extend ActiveSupport::Concern
 
-      ATTRIBUTE_TYPES_CACHED_BY_DEFAULT = [:datetime, :timestamp, :time, :date]
-
-      included do
-        cattr_accessor :attribute_types_cached_by_default, :instance_writer => false
-        self.attribute_types_cached_by_default = ATTRIBUTE_TYPES_CACHED_BY_DEFAULT
-      end
-
       module ClassMethods
-        # +cache_attributes+ allows you to declare which converted attribute values should
-        # be cached. Usually caching only pays off for attributes with expensive conversion
-        # methods, like time related columns (e.g. +created_at+, +updated_at+).
-        def cache_attributes(*attribute_names)
-          cached_attributes.merge attribute_names.map { |attr| attr.to_s }
-        end
-
-        # Returns the attributes which are cached. By default time related columns
-        # with datatype <tt>:datetime, :timestamp, :time, :date</tt> are cached.
-        def cached_attributes
-          @cached_attributes ||= columns.select { |c| cacheable_column?(c) }.map { |col| col.name }.to_set
-        end
-
-        # Returns +true+ if the provided attribute is being cached.
-        def cache_attribute?(attr_name)
-          cached_attributes.include?(attr_name)
-        end
-
-        def undefine_attribute_methods
-          generated_external_attribute_methods.module_eval do
-            instance_methods.each { |m| undef_method(m) }
-          end
-
-          super
-        end
-
-        def type_cast_attribute(attr_name, attributes, cache = {}) #:nodoc:
-          return unless attr_name
-          attr_name = attr_name.to_s
-
-          if generated_external_attribute_methods.method_defined?(attr_name)
-            if attributes.has_key?(attr_name) || attr_name == 'id'
-              generated_external_attribute_methods.send(attr_name, attributes[attr_name], attributes, cache, attr_name)
-            end
-          elsif !attribute_methods_generated?
-            # If we haven't generated the caster methods yet, do that and
-            # then try again
-            define_attribute_methods
-            type_cast_attribute(attr_name, attributes, cache)
-          else
-            # If we get here, the attribute has no associated DB column, so
-            # just return it verbatim.
-            attributes[attr_name]
-          end
-        end
-
         protected
-          # We want to generate the methods via module_eval rather than define_method,
-          # because define_method is slower on dispatch and uses more memory (because it
-          # creates a closure).
-          #
-          # But sometimes the database might return columns with characters that are not
-          # allowed in normal method names (like 'my_column(omg)'. So to work around this
-          # we first define with the __temp__ identifier, and then use alias method to
-          # rename it to what we want.
-          def define_method_attribute(attr_name)
-            generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
-              def __temp__
-                #{internal_attribute_access_code(attr_name, attribute_cast_code(attr_name))}
-              end
-              alias_method '#{attr_name}', :__temp__
-              undef_method :__temp__
-            STR
-          end
-
-        private
 
-          def define_external_attribute_method(attr_name)
-            generated_external_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
-              def __temp__(v, attributes, attributes_cache, attr_name)
-                #{external_attribute_access_code(attr_name, attribute_cast_code(attr_name))}
-              end
-              alias_method '#{attr_name}', :__temp__
-              undef_method :__temp__
-            STR
-          end
-
-          def cacheable_column?(column)
-            attribute_types_cached_by_default.include?(column.type)
-          end
-
-          def internal_attribute_access_code(attr_name, cast_code)
-            access_code = "(v=@attributes[attr_name]) && #{cast_code}"
-
-            unless attr_name == primary_key
-              access_code.insert(0, "missing_attribute(attr_name, caller) unless @attributes.has_key?(attr_name); ")
+        # We want to generate the methods via module_eval rather than
+        # define_method, because define_method is slower on dispatch.
+        # Evaluating many similar methods may use more memory as the instruction
+        # sequences are duplicated and cached (in MRI).  define_method may
+        # be slower on dispatch, but if you're careful about the closure
+        # created, then define_method will consume much less memory.
+        #
+        # But sometimes the database might return columns with
+        # characters that are not allowed in normal method names (like
+        # 'my_column(omg)'. So to work around this we first define with
+        # the __temp__ identifier, and then use alias method to rename
+        # it to what we want.
+        #
+        # We are also defining a constant to hold the frozen string of
+        # the attribute name. Using a constant means that we do not have
+        # to allocate an object on each call to the attribute method.
+        # Making it frozen means that it doesn't get duped when used to
+        # key the @attributes in read_attribute.
+        def define_method_attribute(name)
+          safe_name = name.unpack('h*'.freeze).first
+          temp_method = "__temp__#{safe_name}"
+
+          ActiveRecord::AttributeMethods::AttrNames.set_name_cache safe_name, name
+
+          generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+            def #{temp_method}
+              name = ::ActiveRecord::AttributeMethods::AttrNames::ATTR_#{safe_name}
+              _read_attribute(name) { |n| missing_attribute(n, caller) }
             end
+          STR
 
-            if cache_attribute?(attr_name)
-              access_code = "@attributes_cache[attr_name] ||= (#{access_code})"
-            end
-
-            "attr_name = '#{attr_name}'; #{access_code}"
-          end
-
-          def external_attribute_access_code(attr_name, cast_code)
-            access_code = "v && #{cast_code}"
-
-            if cache_attribute?(attr_name)
-              access_code = "attributes_cache[attr_name] ||= (#{access_code})"
-            end
-
-            access_code
-          end
-
-          def attribute_cast_code(attr_name)
-            columns_hash[attr_name].type_cast_code('v')
+          generated_attribute_methods.module_eval do
+            alias_method name, temp_method
+            undef_method temp_method
           end
+        end
       end
 
-      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
-      # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
-      def read_attribute(attr_name)
-        self.class.type_cast_attribute(attr_name, @attributes, @attributes_cache)
+      # Returns the value of the attribute identified by <tt>attr_name</tt> after
+      # it has been typecast (for example, "2004-12-12" in a date column is cast
+      # to a date object, like Date.new(2004, 12, 12)).
+      def read_attribute(attr_name, &block)
+        name = attr_name.to_s
+        name = self.class.primary_key if name == 'id'.freeze
+        _read_attribute(name, &block)
       end
 
-      private
-        def attribute(attribute_name)
-          read_attribute(attribute_name)
+      # This method exists to avoid the expensive primary_key check internally, without
+      # breaking compatibility with the read_attribute API
+      if defined?(JRUBY_VERSION)
+        # This form is significantly faster on JRuby, and this is one of our biggest hotspots.
+        # https://github.com/jruby/jruby/pull/2562
+        def _read_attribute(attr_name, &block) # :nodoc
+          @attributes.fetch_value(attr_name.to_s, &block)
         end
+      else
+        def _read_attribute(attr_name) # :nodoc:
+          @attributes.fetch_value(attr_name.to_s) { |n| yield n if block_given? }
+        end
+      end
+
+      alias :attribute :_read_attribute
+      private :attribute
+
     end
   end
 end