activerecord 3.1.9 → 3.2.12

data/lib/active_record/attribute_methods/serialization.rb

@@ -0,0 +1,102 @@
+module ActiveRecord
+  module AttributeMethods
+    module Serialization
+      extend ActiveSupport::Concern
+
+      included do
+        # Returns a hash of all the attributes that have been specified for serialization as
+        # keys and their class restriction as values.
+        class_attribute :serialized_attributes
+        self.serialized_attributes = {}
+      end
+
+      class Attribute < Struct.new(:coder, :value, :state)
+        def unserialized_value
+          state == :serialized ? unserialize : value
+        end
+
+        def serialized_value
+          state == :unserialized ? serialize : value
+        end
+
+        def unserialize
+          self.state = :unserialized
+          self.value = coder.load(value)
+        end
+
+        def serialize
+          self.state = :serialized
+          self.value = coder.dump(value)
+        end
+      end
+
+      module ClassMethods
+        # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
+        # then specify the name of that attribute using this method and it will be handled automatically.
+        # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
+        # class on retrieval or SerializationTypeMismatch will be raised.
+        #
+        # ==== Parameters
+        #
+        # * +attr_name+ - The field name that should be serialized.
+        # * +class_name+ - Optional, class name that the object type should be equal to.
+        #
+        # ==== Example
+        #   # Serialize a preferences attribute
+        #   class User < ActiveRecord::Base
+        #     serialize :preferences
+        #   end
+        def serialize(attr_name, class_name = Object)
+          coder = if [:load, :dump].all? { |x| class_name.respond_to?(x) }
+                    class_name
+                  else
+                    Coders::YAMLColumn.new(class_name)
+                  end
+
+          # merge new serialized attribute and create new hash to ensure that each class in inheritance hierarchy
+          # has its own hash of own serialized attributes
+          self.serialized_attributes = serialized_attributes.merge(attr_name.to_s => coder)
+        end
+
+        def initialize_attributes(attributes, options = {}) #:nodoc:
+          serialized = (options.delete(:serialized) { true }) ? :serialized : :unserialized
+          super(attributes, options)
+
+          serialized_attributes.each do |key, coder|
+            if attributes.key?(key)
+              attributes[key] = Attribute.new(coder, attributes[key], serialized)
+            end
+          end
+
+          attributes
+        end
+
+        private
+
+        def attribute_cast_code(attr_name)
+          if serialized_attributes.include?(attr_name)
+            "v.unserialized_value"
+          else
+            super
+          end
+        end
+      end
+
+      def type_cast_attribute_for_write(column, value)
+        if column && coder = self.class.serialized_attributes[column.name]
+          Attribute.new(coder, value, :unserialized)
+        else
+          super
+        end
+      end
+
+      def read_attribute_before_type_cast(attr_name)
+        if serialized_attributes.include?(attr_name)
+          super.unserialized_value
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_record/attribute_methods/time_zone_conversion.rb

@@ -16,21 +16,16 @@ module ActiveRecord
 
       module ClassMethods
         protected
-          # Defined for all +datetime+ and +timestamp+ attributes when +time_zone_aware_attributes+ are enabled.
-          # This enhanced read method automatically converts the UTC time stored in the database to the time
+          # The enhanced read method automatically converts the UTC time stored in the database to the time
           # zone stored in Time.zone.
-          def define_method_attribute(attr_name)
-            if create_time_zone_conversion_attribute?(attr_name, columns_hash[attr_name])
-              method_body, line = <<-EOV, __LINE__ + 1
-                def _#{attr_name}
-                  cached = @attributes_cache['#{attr_name}']
-                  return cached if cached
-                  time = _read_attribute('#{attr_name}')
-                  @attributes_cache['#{attr_name}'] = time.acts_like?(:time) ? time.in_time_zone : time
-                end
-                alias #{attr_name} _#{attr_name}
-              EOV
-              generated_attribute_methods.module_eval(method_body, __FILE__, line)
+          def attribute_cast_code(attr_name)
+            column = columns_hash[attr_name]
+
+            if create_time_zone_conversion_attribute?(attr_name, column)
+              typecast             = "v = #{super}"
+              time_zone_conversion = "v.acts_like?(:time) ? v.in_time_zone : v"
+
+              "((#{typecast}) && (#{time_zone_conversion}))"
             else
               super
             end
@@ -46,9 +41,14 @@ module ActiveRecord
                   unless time.acts_like?(:time)
                     time = time.is_a?(String) ? Time.zone.parse(time) : time.to_time rescue time
                   end
-                  time = time.in_time_zone rescue nil if time
-                  write_attribute(:#{attr_name}, original_time)
-                  @attributes_cache["#{attr_name}"] = time
+                  zoned_time   = time && time.in_time_zone rescue nil
+                  rounded_time = round_usec(zoned_time)
+                  rounded_value = round_usec(read_attribute("#{attr_name}"))
+                  if (rounded_value != rounded_time) || (!rounded_value && original_time)
+                    write_attribute("#{attr_name}", original_time)
+                    #{attr_name}_will_change!
+                    @attributes_cache["#{attr_name}"] = zoned_time
+                  end
                 end
               EOV
               generated_attribute_methods.module_eval(method_body, __FILE__, line)
@@ -62,6 +62,12 @@ module ActiveRecord
             time_zone_aware_attributes && !self.skip_time_zone_conversion_for_attributes.include?(name.to_sym) && column.type.in?([:datetime, :timestamp])
           end
       end
+
+      private
+      def round_usec(value)
+        return unless value
+        value.change(:usec => 0)
+      end
     end
   end
 end

data/lib/active_record/attribute_methods/write.rb

@@ -10,7 +10,7 @@ module ActiveRecord
       module ClassMethods
         protected
           def define_method_attribute=(attr_name)
-            if attr_name =~ ActiveModel::AttributeMethods::COMPILABLE_REGEXP
+            if attr_name =~ ActiveModel::AttributeMethods::NAME_COMPILABLE_REGEXP
               generated_attribute_methods.module_eval("def #{attr_name}=(new_value); write_attribute('#{attr_name}', new_value); end", __FILE__, __LINE__)
             else
               generated_attribute_methods.send(:define_method, "#{attr_name}=") do |new_value|
@@ -24,13 +24,18 @@ module ActiveRecord
       # for fixnum and float columns are turned into +nil+.
       def write_attribute(attr_name, value)
         attr_name = attr_name.to_s
-        attr_name = self.class.primary_key if attr_name == 'id'
+        attr_name = self.class.primary_key if attr_name == 'id' && self.class.primary_key
         @attributes_cache.delete(attr_name)
-        if (column = column_for_attribute(attr_name)) && column.number?
-          @attributes[attr_name] = convert_number_column_value(value)
-        else
-          @attributes[attr_name] = value
+        column = column_for_attribute(attr_name)
+
+        unless column || @attributes.has_key?(attr_name)
+          ActiveSupport::Deprecation.warn(
+            "You're trying to create an attribute `#{attr_name}'. Writing arbitrary " \
+            "attributes on a model is deprecated. Please just use `attr_writer` etc."
+          )
         end
+
+        @attributes[attr_name] = type_cast_attribute_for_write(column, value)
       end
       alias_method :raw_write_attribute, :write_attribute
 
@@ -39,6 +44,26 @@ module ActiveRecord
         def attribute=(attribute_name, value)
           write_attribute(attribute_name, value)
         end
+
+        def type_cast_attribute_for_write(column, value)
+          if column && column.number?
+            convert_number_column_value(value)
+          else
+            value
+          end
+        end
+
+        def convert_number_column_value(value)
+          if value == false
+            0
+          elsif value == true
+            1
+          elsif value.is_a?(String) && value.blank?
+            nil
+          else
+            value
+          end
+        end
     end
   end
 end

data/lib/active_record/attribute_methods.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/enumerable'
+require 'active_support/deprecation'
 
 module ActiveRecord
   # = Active Record Attribute Methods
@@ -6,69 +7,269 @@ module ActiveRecord
     extend ActiveSupport::Concern
     include ActiveModel::AttributeMethods
 
+    included do
+      include Read
+      include Write
+      include BeforeTypeCast
+      include Query
+      include PrimaryKey
+      include TimeZoneConversion
+      include Dirty
+      include Serialization
+      include DeprecatedUnderscoreRead
+
+      # 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)).
+      # (Alias for the protected read_attribute method).
+      def [](attr_name)
+        read_attribute(attr_name)
+      end
+
+      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
+      # (Alias for the protected write_attribute method).
+      def []=(attr_name, value)
+        write_attribute(attr_name, value)
+      end
+    end
+
     module ClassMethods
       # Generates all the attribute related methods for columns in the database
       # accessors, mutators and query methods.
       def define_attribute_methods
-        return if attribute_methods_generated?
-        super(column_names)
-        @attribute_methods_generated = true
+        unless defined?(@attribute_methods_mutex)
+          msg = "It looks like something (probably a gem/plugin) is overriding the " \
+                "ActiveRecord::Base.inherited method. It is important that this hook executes so " \
+                "that your models are set up correctly. A workaround has been added to stop this " \
+                "causing an error in 3.2, but future versions will simply not work if the hook is " \
+                "overridden. If you are using Kaminari, please upgrade as it is known to have had " \
+                "this problem.\n\n"
+          msg << "The following may help track down the problem:"
+
+          meth = method(:inherited)
+          if meth.respond_to?(:source_location)
+            msg << " #{meth.source_location.inspect}"
+          else
+            msg << " #{meth.inspect}"
+          end
+          msg << "\n\n"
+
+          ActiveSupport::Deprecation.warn(msg)
+
+          @attribute_methods_mutex = Mutex.new
+        end
+
+        # Use a mutex; we don't want two thread simaltaneously trying to define
+        # attribute methods.
+        @attribute_methods_mutex.synchronize do
+          return if attribute_methods_generated?
+          superclass.define_attribute_methods unless self == base_class
+          super(column_names)
+          column_names.each { |name| define_external_attribute_method(name) }
+          @attribute_methods_generated = true
+        end
       end
 
       def attribute_methods_generated?
         @attribute_methods_generated ||= false
       end
 
-      def undefine_attribute_methods(*args)
+      # We will define the methods as instance methods, but will call them as singleton
+      # methods. This allows us to use method_defined? to check if the method exists,
+      # which is fast and won't give any false positives from the ancestors (because
+      # there are no ancestors).
+      def generated_external_attribute_methods
+        @generated_external_attribute_methods ||= Module.new { extend self }
+      end
+
+      def undefine_attribute_methods
         super
         @attribute_methods_generated = false
       end
 
-      # Checks whether the method is defined in the model or any of its subclasses
-      # that also derive from Active Record. Raises DangerousAttributeError if the
-      # method is defined by Active Record though.
       def instance_method_already_implemented?(method_name)
-        method_name = method_name.to_s
-        index = ancestors.index(ActiveRecord::Base) || ancestors.length
-        @_defined_class_methods         ||= ancestors.first(index).map { |m|
-          m.instance_methods(false) | m.private_instance_methods(false)
-        }.flatten.map {|m| m.to_s }.to_set
+        if dangerous_attribute_method?(method_name)
+          raise DangerousAttributeError, "#{method_name} is defined by ActiveRecord"
+        end
+
+        if superclass == Base
+          super
+        else
+          # If B < A and A defines its own attribute method, then we don't want to overwrite that.
+          defined = method_defined_within?(method_name, superclass, superclass.generated_attribute_methods)
+          defined && !ActiveRecord::Base.method_defined?(method_name) || super
+        end
+      end
 
-        @@_defined_activerecord_methods ||= defined_activerecord_methods
-        raise DangerousAttributeError, "#{method_name} is defined by ActiveRecord" if @@_defined_activerecord_methods.include?(method_name)
-        @_defined_class_methods.include?(method_name)
+      # A method name is 'dangerous' if it is already defined by Active Record, but
+      # not by any ancestors. (So 'puts' is not dangerous but 'save' is.)
+      def dangerous_attribute_method?(name)
+        method_defined_within?(name, Base)
       end
 
-      def defined_activerecord_methods
-        active_record = ActiveRecord::Base
-        super_klass   = ActiveRecord::Base.superclass
-        methods = (active_record.instance_methods - super_klass.instance_methods) +
-                  (active_record.private_instance_methods - super_klass.private_instance_methods)
-        methods.map {|m| m.to_s }.to_set
+      def method_defined_within?(name, klass, sup = klass.superclass)
+        if klass.method_defined?(name) || klass.private_method_defined?(name)
+          if sup.method_defined?(name) || sup.private_method_defined?(name)
+            klass.instance_method(name).owner != sup.instance_method(name).owner
+          else
+            true
+          end
+        else
+          false
+        end
+      end
+
+      def attribute_method?(attribute)
+        super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
+      end
+
+      # Returns an array of column names as strings if it's not
+      # an abstract class and table exists.
+      # Otherwise it returns an empty array.
+      def attribute_names
+        @attribute_names ||= if !abstract_class? && table_exists?
+            column_names
+          else
+            []
+          end
       end
     end
 
-    def method_missing(method_id, *args, &block)
-      # If we haven't generated any methods yet, generate them, then
-      # see if we've created the method we're looking for.
-      if !self.class.attribute_methods_generated?
+    # If we haven't generated any methods yet, generate them, then
+    # see if we've created the method we're looking for.
+    def method_missing(method, *args, &block)
+      unless self.class.attribute_methods_generated?
         self.class.define_attribute_methods
-        method_name = method_id.to_s
-        guard_private_attribute_method!(method_name, args)
-        send(method_id, *args, &block)
+
+        if respond_to_without_attributes?(method)
+          send(method, *args, &block)
+        else
+          super
+        end
       else
         super
       end
     end
 
+    def attribute_missing(match, *args, &block)
+      if self.class.columns_hash[match.attr_name]
+        ActiveSupport::Deprecation.warn(
+          "The method `#{match.method_name}', matching the attribute `#{match.attr_name}' has " \
+          "dispatched through method_missing. This shouldn't happen, because `#{match.attr_name}' " \
+          "is a column of the table. If this error has happened through normal usage of Active " \
+          "Record (rather than through your own code or external libraries), please report it as " \
+          "a bug."
+        )
+      end
+
+      super
+    end
+
     def respond_to?(name, include_private = false)
       self.class.define_attribute_methods unless self.class.attribute_methods_generated?
       super
     end
 
+    # Returns true if the given attribute is in the attributes hash
+    def has_attribute?(attr_name)
+      @attributes.has_key?(attr_name.to_s)
+    end
+
+    # Returns an array of names for the attributes available on this object.
+    def attribute_names
+      @attributes.keys
+    end
+
+    # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
+    def attributes
+      attrs = {}
+      attribute_names.each { |name| attrs[name] = read_attribute(name) }
+      attrs
+    end
+
+    # Returns an <tt>#inspect</tt>-like string for the value of the
+    # attribute +attr_name+. String attributes are truncated upto 50
+    # characters, and Date and Time attributes are returned in the
+    # <tt>:db</tt> format. Other attributes return the value of
+    # <tt>#inspect</tt> without modification.
+    #
+    #   person = Person.create!(:name => "David Heinemeier Hansson " * 3)
+    #
+    #   person.attribute_for_inspect(:name)
+    #   # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
+    #
+    #   person.attribute_for_inspect(:created_at)
+    #   # => '"2009-01-12 04:48:57"'
+    def attribute_for_inspect(attr_name)
+      value = read_attribute(attr_name)
+
+      if value.is_a?(String) && value.length > 50
+        "#{value[0..50]}...".inspect
+      elsif value.is_a?(Date) || value.is_a?(Time)
+        %("#{value.to_s(:db)}")
+      else
+        value.inspect
+      end
+    end
+
+    # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
+    # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
+    def attribute_present?(attribute)
+      value = read_attribute(attribute)
+      !value.nil? && !(value.respond_to?(:empty?) && value.empty?)
+    end
+
+    # Returns the column object for the named attribute.
+    def column_for_attribute(name)
+      self.class.columns_hash[name.to_s]
+    end
+
     protected
-      def attribute_method?(attr_name)
-        attr_name == 'id' || (defined?(@attributes) && @attributes.include?(attr_name))
+
+    def clone_attributes(reader_method = :read_attribute, attributes = {})
+      attribute_names.each do |name|
+        attributes[name] = clone_attribute_value(reader_method, name)
       end
+      attributes
+    end
+
+    def clone_attribute_value(reader_method, attribute_name)
+      value = send(reader_method, attribute_name)
+      value.duplicable? ? value.clone : value
+    rescue TypeError, NoMethodError
+      value
+    end
+
+    # Returns a copy of the attributes hash where all the values have been safely quoted for use in
+    # an Arel insert/update method.
+    def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
+      attrs      = {}
+      klass      = self.class
+      arel_table = klass.arel_table
+
+      attribute_names.each do |name|
+        if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)
+
+          if include_readonly_attributes || !self.class.readonly_attributes.include?(name)
+
+            value = if klass.serialized_attributes.include?(name)
+                      @attributes[name].serialized_value
+                    else
+                      # FIXME: we need @attributes to be used consistently.
+                      # If the values stored in @attributes were already type
+                      # casted, this code could be simplified
+                      read_attribute(name)
+                    end
+
+            attrs[arel_table[name]] = value
+          end
+        end
+      end
+
+      attrs
+    end
+
+    def attribute_method?(attr_name)
+      attr_name == 'id' || (defined?(@attributes) && @attributes.include?(attr_name))
+    end
   end
 end

data/lib/active_record/autosave_association.rb

@@ -21,6 +21,21 @@ module ActiveRecord
   # Note that <tt>:autosave => false</tt> is not same as not declaring <tt>:autosave</tt>.
   # When the <tt>:autosave</tt> option is not present new associations are saved.
   #
+  # == Validation
+  #
+  # Children records are validated unless <tt>:validate</tt> is +false+.
+  #
+  # == Callbacks
+  #
+  # Association with autosave option defines several callbacks on your
+  # model (before_save, after_create, after_update). Please note that
+  # callbacks are executed in the order they were defined in
+  # model. You should avoid modyfing the association content, before
+  # autosave callbacks are executed. Placing your callbacks after
+  # associations is usually a good practice.
+  #
+  # == Examples
+  #
   # === One-to-one Example
   #
   #   class Post
@@ -109,10 +124,7 @@ module ActiveRecord
   # Now it _is_ removed from the database:
   #
   #   Comment.find_by_id(id).nil? # => true
-  #
-  # === Validation
-  #
-  # Children records are validated unless <tt>:validate</tt> is +false+.
+
   module AutosaveAssociation
     extend ActiveSupport::Concern
 
@@ -161,7 +173,7 @@ module ActiveRecord
       #
       # For performance reasons, we don't check whether to validate at runtime.
       # However the validation and callback methods are lazy and those methods
-      # get created when they are invoked for the very first time.  However,
+      # get created when they are invoked for the very first time. However,
       # this can change, for instance, when using nested attributes, which is
       # called _after_ the association has been defined. Since we don't want
       # the callbacks to get defined multiple times, there are guards that
@@ -264,7 +276,7 @@ module ActiveRecord
     # turned on for the association.
     def validate_single_association(reflection)
       association = association_instance_get(reflection.name)
-      record      = association && association.target
+      record      = association && association.reader
       association_valid?(reflection, record) if record
     end
 
@@ -320,25 +332,31 @@ module ActiveRecord
 
         if records = associated_records_to_validate_or_save(association, @new_record_before_save, autosave)
           begin
-          records.each do |record|
-            next if record.destroyed?
+            records_to_destroy = []
+
+            records.each do |record|
+              next if record.destroyed?
+
+              saved = true
+
+              if autosave && record.marked_for_destruction?
+                records_to_destroy << record
+              elsif autosave != false && (@new_record_before_save || record.new_record?)
+                if autosave
+                  saved = association.insert_record(record, false)
+                else
+                  association.insert_record(record) unless reflection.nested?
+                end
+              elsif autosave
+                saved = record.save(:validate => false)
+              end
 
-            saved = true
+              raise ActiveRecord::Rollback unless saved
+            end
 
-            if autosave && record.marked_for_destruction?
+            records_to_destroy.each do |record|
               association.proxy.destroy(record)
-            elsif autosave != false && (@new_record_before_save || record.new_record?)
-              if autosave
-                saved = association.insert_record(record, false)
-              else
-                association.insert_record(record)
-              end
-            elsif autosave
-              saved = record.save(:validate => false)
             end
-
-            raise ActiveRecord::Rollback unless saved
-          end
           rescue
             records.each {|x| IdentityMap.remove(x) } if IdentityMap.enabled?
             raise
@@ -370,7 +388,10 @@ module ActiveRecord
         else
           key = reflection.options[:primary_key] ? send(reflection.options[:primary_key]) : id
           if autosave != false && (new_record? || record.new_record? || record[reflection.foreign_key] != key || autosave)
-            record[reflection.foreign_key] = key
+            unless reflection.through_reflection
+              record[reflection.foreign_key] = key
+            end
+
             saved = record.save(:validate => !autosave)
             raise ActiveRecord::Rollback if !saved && autosave
             saved