sskirby-activerecord 3.2.1

data/lib/active_record/attribute_methods.rb

@@ -0,0 +1,272 @@
+require 'active_support/core_ext/enumerable'
+require 'active_support/deprecation'
+
+module ActiveRecord
+  # = Active Record Attribute Methods
+  module AttributeMethods #:nodoc:
+    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
+        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)
+          @attribute_methods_generated = true
+        end
+      end
+
+      def attribute_methods_generated?
+        @attribute_methods_generated ||= false
+      end
+
+      # 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
+
+      def instance_method_already_implemented?(method_name)
+        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
+
+      # 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 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
+
+    # 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
+
+        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
+      Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
+    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 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/attribute_methods/before_type_cast.rb

@@ -0,0 +1,31 @@
+module ActiveRecord
+  module AttributeMethods
+    module BeforeTypeCast
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_suffix "_before_type_cast"
+      end
+
+      def read_attribute_before_type_cast(attr_name)
+        @attributes[attr_name]
+      end
+
+      # Returns a hash of attributes before typecasting and deserialization.
+      def attributes_before_type_cast
+        @attributes
+      end
+
+      private
+
+      # Handle *_before_type_cast for method_missing.
+      def attribute_before_type_cast(attribute_name)
+        if attribute_name == 'id'
+          read_attribute_before_type_cast(self.class.primary_key)
+        else
+          read_attribute_before_type_cast(attribute_name)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/attribute_methods/deprecated_underscore_read.rb

@@ -0,0 +1,32 @@
+require 'active_support/concern'
+require 'active_support/deprecation'
+
+module ActiveRecord
+  module AttributeMethods
+    module DeprecatedUnderscoreRead
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_prefix "_"
+      end
+
+      module ClassMethods
+        protected
+
+        def define_method__attribute(attr_name)
+          # Do nothing, let it hit method missing instead.
+        end
+      end
+
+      protected
+
+      def _attribute(attr_name)
+        ActiveSupport::Deprecation.warn(
+          "You have called '_#{attr_name}'. This is deprecated. Please use " \
+          "either '#{attr_name}' or read_attribute('#{attr_name}')."
+        )
+        read_attribute(attr_name)
+      end
+    end
+  end
+end

data/lib/active_record/attribute_methods/dirty.rb

@@ -0,0 +1,101 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/object/blank'
+
+module ActiveRecord
+  module AttributeMethods
+    module Dirty
+      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
+      end
+
+      # Attempts to +save+ the record and clears changed attributes if successful.
+      def save(*) #:nodoc:
+        if status = super
+          @previously_changed = changes
+          @changed_attributes.clear
+        elsif IdentityMap.enabled?
+          IdentityMap.remove(self)
+        end
+        status
+      end
+
+      # Attempts to <tt>save!</tt> the record and clears changed attributes if successful.
+      def save!(*) #:nodoc:
+        super.tap do
+          @previously_changed = changes
+          @changed_attributes.clear
+        end
+      rescue
+        IdentityMap.remove(self) if IdentityMap.enabled?
+        raise
+      end
+
+      # <tt>reload</tt> the record and clears changed attributes.
+      def reload(*) #:nodoc:
+        super.tap do
+          @previously_changed.clear
+          @changed_attributes.clear
+        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)
+        end
+
+        # Carry on.
+        super(attr, value)
+      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))
+        else
+          super
+        end
+      end
+
+      def field_changed?(attr, old, value)
+        if column = column_for_attribute(attr)
+          if column.number? && column.null && (old.nil? || old == 0) && value.blank?
+            # 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)
+            value = nil
+          else
+            value = column.type_cast(value)
+          end
+        end
+
+        old != value
+      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)
+      end
+    end
+  end
+end

data/lib/active_record/attribute_methods/primary_key.rb

@@ -0,0 +1,114 @@
+module ActiveRecord
+  module AttributeMethods
+    module PrimaryKey
+      extend ActiveSupport::Concern
+
+      # Returns this record's primary key value wrapped in an Array if one is available
+      def to_key
+        key = self.id
+        [key] if key
+      end
+
+      # Returns the primary key value
+      def id
+        read_attribute(self.class.primary_key)
+      end
+
+      # Sets the primary key value
+      def id=(value)
+        write_attribute(self.class.primary_key, value)
+      end
+
+      # Queries the primary key value
+      def id?
+        query_attribute(self.class.primary_key)
+      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
+
+        def dangerous_attribute_method?(method_name)
+          super && !['id', 'id=', 'id?'].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.
+        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.
+        def quoted_primary_key
+          @quoted_primary_key ||= connection.quote_column_name(primary_key)
+        end
+
+        def reset_primary_key #:nodoc:
+          if self == base_class
+            self.primary_key = get_primary_key(base_class.name)
+          else
+            self.primary_key = base_class.primary_key
+          end
+        end
+
+        def get_primary_key(base_name) #:nodoc:
+          return 'id' unless base_name && !base_name.blank?
+
+          case primary_key_prefix_type
+          when :table_name
+            base_name.foreign_key(false)
+          when :table_name_with_underscore
+            base_name.foreign_key
+          else
+            if ActiveRecord::Base != self && table_exists?
+              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"
+        #   end
+        #
+        # You can also define the primary_key method yourself:
+        #
+        #   class Project < ActiveRecord::Base
+        #     def self.primary_key
+        #       "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
+          @quoted_primary_key = nil
+        end
+      end
+    end
+  end
+end