activerecord 1.0.0 → 3.0.0

data/lib/active_record/attribute_methods/before_type_cast.rb

@@ -0,0 +1,33 @@
+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
+        self.attribute_names.inject({}) do |attrs, name|
+          attrs[name] = read_attribute_before_type_cast(name)
+          attrs
+        end
+      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/dirty.rb

@@ -0,0 +1,95 @@
+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
+
+        superclass_delegating_accessor :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
+        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
+      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 && !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,50 @@
+module ActiveRecord
+  module AttributeMethods
+    module PrimaryKey
+      extend ActiveSupport::Concern
+
+      # Returns this record's primary key value wrapped in an Array
+      # or nil if the record is a new_record?
+      def to_key
+        new_record? ? nil : [ id ]
+      end
+
+      module ClassMethods
+        # 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
+          reset_primary_key
+        end
+
+        def reset_primary_key #:nodoc:
+          key = get_primary_key(base_class.name)
+          set_primary_key(key)
+          key
+        end
+
+        def get_primary_key(base_name) #:nodoc:
+          key = 'id'
+          case primary_key_prefix_type
+            when :table_name
+              key = base_name.to_s.foreign_key(false)
+            when :table_name_with_underscore
+              key = base_name.to_s.foreign_key
+          end
+          key
+        end
+
+        # Sets the name of the primary key column to use to the given value,
+        # or (if the value is nil or false) to the value returned by the given
+        # block.
+        #
+        #   class Project < ActiveRecord::Base
+        #     set_primary_key "sysid"
+        #   end
+        def set_primary_key(value = nil, &block)
+          define_attr_method :primary_key, value, &block
+        end
+        alias :primary_key= :set_primary_key
+      end
+    end
+  end
+end

data/lib/active_record/attribute_methods/query.rb

@@ -0,0 +1,39 @@
+require 'active_support/core_ext/object/blank'
+
+module ActiveRecord
+  module AttributeMethods
+    module Query
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_suffix "?"
+      end
+
+      def query_attribute(attr_name)
+        unless value = read_attribute(attr_name)
+          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)
+              !value.blank?
+            end
+          elsif column.number?
+            !value.zero?
+          else
+            !value.blank?
+          end
+        end
+      end
+
+      private
+        # Handle *? for method_missing.
+        def attribute?(attribute_name)
+          query_attribute(attribute_name)
+        end
+    end
+  end
+end

data/lib/active_record/attribute_methods/read.rb

@@ -0,0 +1,116 @@
+module ActiveRecord
+  module AttributeMethods
+    module Read
+      extend ActiveSupport::Concern
+
+      ATTRIBUTE_TYPES_CACHED_BY_DEFAULT = [:datetime, :timestamp, :time, :date]
+
+      included do
+        attribute_method_suffix ""
+
+        cattr_accessor :attribute_types_cached_by_default, :instance_writer => false
+        self.attribute_types_cached_by_default = ATTRIBUTE_TYPES_CACHED_BY_DEFAULT
+
+        # Undefine id so it can be used as an attribute name
+        undef_method(:id) if method_defined?(:id)
+      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)
+          attribute_names.each {|attr| cached_attributes << 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| attribute_types_cached_by_default.include?(c.type)}.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
+
+        protected
+          def define_method_attribute(attr_name)
+            if self.serialized_attributes[attr_name]
+              define_read_method_for_serialized_attribute(attr_name)
+            else
+              define_read_method(attr_name.to_sym, attr_name, columns_hash[attr_name])
+            end
+
+            if attr_name == primary_key && attr_name != "id"
+              define_read_method(:id, attr_name, columns_hash[attr_name])
+            end
+          end
+
+        private
+          # Define read method for serialized attribute.
+          def define_read_method_for_serialized_attribute(attr_name)
+            generated_attribute_methods.module_eval("def #{attr_name}; unserialize_attribute('#{attr_name}'); end", __FILE__, __LINE__)
+          end
+
+          # Define an attribute reader method.  Cope with nil column.
+          def define_read_method(symbol, attr_name, column)
+            cast_code = column.type_cast_code('v') if column
+            access_code = cast_code ? "(v=@attributes['#{attr_name}']) && #{cast_code}" : "@attributes['#{attr_name}']"
+
+            unless attr_name.to_s == self.primary_key.to_s
+              access_code = access_code.insert(0, "missing_attribute('#{attr_name}', caller) unless @attributes.has_key?('#{attr_name}'); ")
+            end
+
+            if cache_attribute?(attr_name)
+              access_code = "@attributes_cache['#{attr_name}'] ||= (#{access_code})"
+            end
+            generated_attribute_methods.module_eval("def #{symbol}; #{access_code}; end", __FILE__, __LINE__)
+          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)
+        attr_name = attr_name.to_s
+        attr_name = self.class.primary_key if attr_name == 'id'
+        if !(value = @attributes[attr_name]).nil?
+          if column = column_for_attribute(attr_name)
+            if unserializable_attribute?(attr_name, column)
+              unserialize_attribute(attr_name)
+            else
+              column.type_cast(value)
+            end
+          else
+            value
+          end
+        else
+          nil
+        end
+      end
+
+      # Returns true if the attribute is of a text column and marked for serialization.
+      def unserializable_attribute?(attr_name, column)
+        column.text? && self.class.serialized_attributes[attr_name]
+      end
+
+      # Returns the unserialized object of the attribute.
+      def unserialize_attribute(attr_name)
+        unserialized_object = object_from_yaml(@attributes[attr_name])
+
+        if unserialized_object.is_a?(self.class.serialized_attributes[attr_name]) || unserialized_object.nil?
+          @attributes.frozen? ? unserialized_object : @attributes[attr_name] = unserialized_object
+        else
+          raise SerializationTypeMismatch,
+            "#{attr_name} was supposed to be a #{self.class.serialized_attributes[attr_name]}, but was a #{unserialized_object.class.to_s}"
+        end
+      end
+
+      private
+        def attribute(attribute_name)
+          read_attribute(attribute_name)
+        end
+    end
+  end
+end

data/lib/active_record/attribute_methods/time_zone_conversion.rb

@@ -0,0 +1,61 @@
+module ActiveRecord
+  module AttributeMethods
+    module TimeZoneConversion
+      extend ActiveSupport::Concern
+
+      included do
+        cattr_accessor :time_zone_aware_attributes, :instance_writer => false
+        self.time_zone_aware_attributes = false
+
+        class_inheritable_accessor :skip_time_zone_conversion_for_attributes, :instance_writer => false
+        self.skip_time_zone_conversion_for_attributes = []
+      end
+
+      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
+          # 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}(reload = false)
+                  cached = @attributes_cache['#{attr_name}']
+                  return cached if cached && !reload
+                  time = read_attribute('#{attr_name}')
+                  @attributes_cache['#{attr_name}'] = time.acts_like?(:time) ? time.in_time_zone : time
+                end
+              EOV
+              generated_attribute_methods.module_eval(method_body, __FILE__, line)
+            else
+              super
+            end
+          end
+
+          # Defined for all +datetime+ and +timestamp+ attributes when +time_zone_aware_attributes+ are enabled.
+          # This enhanced write method will automatically convert the time passed to it to the 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}=(time)
+                  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}, time)
+                end
+              EOV
+              generated_attribute_methods.module_eval(method_body, __FILE__, line)
+            else
+              super
+            end
+          end
+
+        private
+          def create_time_zone_conversion_attribute?(name, column)
+            time_zone_aware_attributes && !skip_time_zone_conversion_for_attributes.include?(name.to_sym) && [:datetime, :timestamp].include?(column.type)
+          end
+      end
+    end
+  end
+end

data/lib/active_record/attribute_methods/write.rb

@@ -0,0 +1,37 @@
+module ActiveRecord
+  module AttributeMethods
+    module Write
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_suffix "="
+      end
+
+      module ClassMethods
+        protected
+          def define_method_attribute=(attr_name)
+            generated_attribute_methods.module_eval("def #{attr_name}=(new_value); write_attribute('#{attr_name}', new_value); end", __FILE__, __LINE__)
+          end
+      end
+
+      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+. Empty strings
+      # 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'
+        @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
+        end
+      end
+
+      private
+        # Handle *= for method_missing.
+        def attribute=(attribute_name, value)
+          write_attribute(attribute_name, value)
+        end
+    end
+  end
+end

data/lib/active_record/attribute_methods.rb

@@ -0,0 +1,60 @@
+require 'active_support/core_ext/enumerable'
+
+module ActiveRecord
+  # = Active Record Attribute Methods
+  module AttributeMethods #:nodoc:
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    module ClassMethods
+      # Generates all the attribute related methods for columns in the database
+      # accessors, mutators and query methods.
+      def define_attribute_methods
+        super(columns_hash.keys)
+      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
+        @_defined_class_methods         ||= ancestors.first(ancestors.index(ActiveRecord::Base)).sum([]) { |m| m.public_instance_methods(false) | m.private_instance_methods(false) | m.protected_instance_methods(false) }.map {|m| m.to_s }.to_set
+        @@_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)
+      end
+
+      def defined_activerecord_methods
+        active_record = ActiveRecord::Base
+        super_klass   = ActiveRecord::Base.superclass
+        methods =  active_record.public_instance_methods - super_klass.public_instance_methods
+        methods += active_record.private_instance_methods - super_klass.private_instance_methods
+        methods += active_record.protected_instance_methods - super_klass.protected_instance_methods
+        methods.map {|m| m.to_s }.to_set
+      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?
+        self.class.define_attribute_methods
+        method_name = method_id.to_s
+        guard_private_attribute_method!(method_name, args)
+        send(method_id, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(*args)
+      self.class.define_attribute_methods
+      super
+    end
+
+    protected
+      def attribute_method?(attr_name)
+        attr_name == 'id' || attributes.include?(attr_name)
+      end
+  end
+end