activerecord 3.2.22.5 → 4.2.11.3

data/lib/active_record/type/hash_lookup_type_map.rb

@@ -0,0 +1,23 @@
+module ActiveRecord
+  module Type
+    class HashLookupTypeMap < TypeMap # :nodoc:
+      def alias_type(type, alias_type)
+        register_type(type) { |_, *args| lookup(alias_type, *args) }
+      end
+
+      def key?(key)
+        @mapping.key?(key)
+      end
+
+      def keys
+        @mapping.keys
+      end
+
+      private
+
+      def perform_fetch(type, *args, &block)
+        @mapping.fetch(type, block).call(type, *args)
+      end
+    end
+  end
+end

data/lib/active_record/type/integer.rb

@@ -0,0 +1,59 @@
+module ActiveRecord
+  module Type
+    class Integer < Value # :nodoc:
+      include Numeric
+
+      def initialize(*)
+        super
+        @range = min_value...max_value
+      end
+
+      def type
+        :integer
+      end
+
+      def type_cast_from_database(value)
+        return if value.nil?
+        value.to_i
+      end
+
+      def type_cast_for_database(value)
+        result = type_cast(value)
+        if result
+          ensure_in_range(result)
+        end
+        result
+      end
+
+      protected
+
+      attr_reader :range
+
+      private
+
+      def cast_value(value)
+        case value
+        when true then 1
+        when false then 0
+        else
+          value.to_i rescue nil
+        end
+      end
+
+      def ensure_in_range(value)
+        unless range.cover?(value)
+          raise RangeError, "#{value} is out of range for #{self.class} with limit #{limit || 4}"
+        end
+      end
+
+      def max_value
+        limit = self.limit || 4
+        1 << (limit * 8 - 1) # 8 bits per byte with one bit for sign
+      end
+
+      def min_value
+        -max_value
+      end
+    end
+  end
+end

data/lib/active_record/type/mutable.rb

@@ -0,0 +1,16 @@
+module ActiveRecord
+  module Type
+    module Mutable # :nodoc:
+      def type_cast_from_user(value)
+        type_cast_from_database(type_cast_for_database(value))
+      end
+
+      # +raw_old_value+ will be the `_before_type_cast` version of the
+      # value (likely a string). +new_value+ will be the current, type
+      # cast value.
+      def changed_in_place?(raw_old_value, new_value)
+        raw_old_value != type_cast_for_database(new_value)
+      end
+    end
+  end
+end

data/lib/active_record/type/numeric.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  module Type
+    module Numeric # :nodoc:
+      def number?
+        true
+      end
+
+      def type_cast(value)
+        value = case value
+                when true then 1
+                when false then 0
+                when ::String then value.presence
+                else value
+                end
+        super(value)
+      end
+
+      def changed?(old_value, _new_value, new_value_before_type_cast) # :nodoc:
+        super || number_to_non_number?(old_value, new_value_before_type_cast)
+      end
+
+      private
+
+      def number_to_non_number?(old_value, new_value_before_type_cast)
+        old_value != nil && non_numeric_string?(new_value_before_type_cast)
+      end
+
+      def non_numeric_string?(value)
+        # 'wibble'.to_i will give zero, we want to make sure
+        # that we aren't marking int zero to string zero as
+        # changed.
+        value.to_s !~ /\A-?\d+\.?\d*\z/
+      end
+    end
+  end
+end

data/lib/active_record/type/serialized.rb

@@ -0,0 +1,62 @@
+module ActiveRecord
+  module Type
+    class Serialized < DelegateClass(Type::Value) # :nodoc:
+      include Mutable
+      include Decorator
+
+      attr_reader :subtype, :coder
+
+      def initialize(subtype, coder)
+        @subtype = subtype
+        @coder = coder
+        super(subtype)
+      end
+
+      def type_cast_from_database(value)
+        if default_value?(value)
+          value
+        else
+          coder.load(super)
+        end
+      end
+
+      def type_cast_for_database(value)
+        return if value.nil?
+        unless default_value?(value)
+          super coder.dump(value)
+        end
+      end
+
+      def inspect
+        Kernel.instance_method(:inspect).bind(self).call
+      end
+
+      def changed_in_place?(raw_old_value, value)
+        return false if value.nil?
+        raw_new_value = type_cast_for_database(value)
+        raw_old_value.nil? != raw_new_value.nil? ||
+          subtype.changed_in_place?(raw_old_value, raw_new_value)
+      end
+
+      def accessor
+        ActiveRecord::Store::IndifferentHashAccessor
+      end
+
+      def init_with(coder)
+        @coder = coder['coder']
+        super
+      end
+
+      def encode_with(coder)
+        coder['coder'] = @coder
+        super
+      end
+
+      private
+
+      def default_value?(value)
+        value == coder.load(nil)
+      end
+    end
+  end
+end

data/lib/active_record/type/string.rb

@@ -0,0 +1,40 @@
+module ActiveRecord
+  module Type
+    class String < Value # :nodoc:
+      def type
+        :string
+      end
+
+      def changed_in_place?(raw_old_value, new_value)
+        if new_value.is_a?(::String)
+          raw_old_value != new_value
+        end
+      end
+
+      def type_cast_for_database(value)
+        case value
+        when ::Numeric, ActiveSupport::Duration then value.to_s
+        when ::String then ::String.new(value)
+        when true then "t"
+        when false then "f"
+        else super
+        end
+      end
+
+      def text?
+        true
+      end
+
+      private
+
+      def cast_value(value)
+        case value
+        when true then "t"
+        when false then "f"
+        # String.new is slightly faster than dup
+        else ::String.new(value.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/type/text.rb

@@ -0,0 +1,11 @@
+require 'active_record/type/string'
+
+module ActiveRecord
+  module Type
+    class Text < String # :nodoc:
+      def type
+        :text
+      end
+    end
+  end
+end

data/lib/active_record/type/time.rb

@@ -0,0 +1,26 @@
+module ActiveRecord
+  module Type
+    class Time < Value # :nodoc:
+      include TimeValue
+
+      def type
+        :time
+      end
+
+      private
+
+      def cast_value(value)
+        return value unless value.is_a?(::String)
+        return if value.empty?
+
+        dummy_time_value = "2000-01-01 #{value}"
+
+        fast_string_to_time(dummy_time_value) || begin
+          time_hash = ::Date._parse(dummy_time_value)
+          return if time_hash[:hour].nil?
+          new_time(*time_hash.values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction))
+        end
+      end
+    end
+  end
+end

data/lib/active_record/type/time_value.rb

@@ -0,0 +1,38 @@
+module ActiveRecord
+  module Type
+    module TimeValue # :nodoc:
+      def klass
+        ::Time
+      end
+
+      def type_cast_for_schema(value)
+        "'#{value.to_s(:db)}'"
+      end
+
+      private
+
+      def new_time(year, mon, mday, hour, min, sec, microsec, offset = nil)
+        # Treat 0000-00-00 00:00:00 as nil.
+        return if year.nil? || (year == 0 && mon == 0 && mday == 0)
+
+        if offset
+          time = ::Time.utc(year, mon, mday, hour, min, sec, microsec) rescue nil
+          return unless time
+
+          time -= offset
+          Base.default_timezone == :utc ? time : time.getlocal
+        else
+          ::Time.public_send(Base.default_timezone, year, mon, mday, hour, min, sec, microsec) rescue nil
+        end
+      end
+
+      # Doesn't handle time zones.
+      def fast_string_to_time(string)
+        if string =~ ConnectionAdapters::Column::Format::ISO_DATETIME
+          microsec = ($7.to_r * 1_000_000).to_i
+          new_time $1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i, microsec
+        end
+      end
+    end
+  end
+end

data/lib/active_record/type/type_map.rb

@@ -0,0 +1,64 @@
+require 'thread_safe'
+
+module ActiveRecord
+  module Type
+    class TypeMap # :nodoc:
+      def initialize
+        @mapping = {}
+        @cache = ThreadSafe::Cache.new do |h, key|
+          h.fetch_or_store(key, ThreadSafe::Cache.new)
+        end
+      end
+
+      def lookup(lookup_key, *args)
+        fetch(lookup_key, *args) { default_value }
+      end
+
+      def fetch(lookup_key, *args, &block)
+        @cache[lookup_key].fetch_or_store(args) do
+          perform_fetch(lookup_key, *args, &block)
+        end
+      end
+
+      def register_type(key, value = nil, &block)
+        raise ::ArgumentError unless value || block
+        @cache.clear
+
+        if block
+          @mapping[key] = block
+        else
+          @mapping[key] = proc { value }
+        end
+      end
+
+      def alias_type(key, target_key)
+        register_type(key) do |sql_type, *args|
+          metadata = sql_type[/\(.*\)/, 0]
+          lookup("#{target_key}#{metadata}", *args)
+        end
+      end
+
+      def clear
+        @mapping.clear
+      end
+
+      private
+
+      def perform_fetch(lookup_key, *args)
+        matching_pair = @mapping.reverse_each.detect do |key, _|
+          key === lookup_key
+        end
+
+        if matching_pair
+          matching_pair.last.call(lookup_key, *args)
+        else
+          yield lookup_key, *args
+        end
+      end
+
+      def default_value
+        @default_value ||= Value.new
+      end
+    end
+  end
+end

data/lib/active_record/type/unsigned_integer.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module Type
+    class UnsignedInteger < Integer # :nodoc:
+      private
+
+      def max_value
+        super * 2
+      end
+
+      def min_value
+        0
+      end
+    end
+  end
+end

data/lib/active_record/type/value.rb

@@ -0,0 +1,110 @@
+module ActiveRecord
+  module Type
+    class Value # :nodoc:
+      attr_reader :precision, :scale, :limit
+
+      # Valid options are +precision+, +scale+, and +limit+. They are only
+      # used when dumping schema.
+      def initialize(options = {})
+        options.assert_valid_keys(:precision, :scale, :limit)
+        @precision = options[:precision]
+        @scale = options[:scale]
+        @limit = options[:limit]
+      end
+
+      # The simplified type that this object represents. Returns a symbol such
+      # as +:string+ or +:integer+
+      def type; end
+
+      # Type casts a string from the database into the appropriate ruby type.
+      # Classes which do not need separate type casting behavior for database
+      # and user provided values should override +cast_value+ instead.
+      def type_cast_from_database(value)
+        type_cast(value)
+      end
+
+      # Type casts a value from user input (e.g. from a setter). This value may
+      # be a string from the form builder, or an already type cast value
+      # provided manually to a setter.
+      #
+      # Classes which do not need separate type casting behavior for database
+      # and user provided values should override +type_cast+ or +cast_value+
+      # instead.
+      def type_cast_from_user(value)
+        type_cast(value)
+      end
+
+      # Cast a value from the ruby type to a type that the database knows how
+      # to understand. The returned value from this method should be a
+      # +String+, +Numeric+, +Date+, +Time+, +Symbol+, +true+, +false+, or
+      # +nil+
+      def type_cast_for_database(value)
+        value
+      end
+
+      # Type cast a value for schema dumping. This method is private, as we are
+      # hoping to remove it entirely.
+      def type_cast_for_schema(value) # :nodoc:
+        value.inspect
+      end
+
+      # These predicates are not documented, as I need to look further into
+      # their use, and see if they can be removed entirely.
+      def text? # :nodoc:
+        false
+      end
+
+      def number? # :nodoc:
+        false
+      end
+
+      def binary? # :nodoc:
+        false
+      end
+
+      def klass # :nodoc:
+      end
+
+      # Determines whether a value has changed for dirty checking. +old_value+
+      # and +new_value+ will always be type-cast. Types should not need to
+      # override this method.
+      def changed?(old_value, new_value, _new_value_before_type_cast)
+        old_value != new_value
+      end
+
+      # Determines whether the mutable value has been modified since it was
+      # read. Returns +false+ by default. This method should not be overridden
+      # directly. Types which return a mutable value should include
+      # +Type::Mutable+, which will define this method.
+      def changed_in_place?(*)
+        false
+      end
+
+      def ==(other)
+        self.class == other.class &&
+          precision == other.precision &&
+          scale == other.scale &&
+          limit == other.limit
+      end
+      alias eql? ==
+
+      def hash
+        [self.class, precision, scale, limit].hash
+      end
+
+      private
+
+      def type_cast(value)
+        cast_value(value) unless value.nil?
+      end
+
+      # Convenience method for types which do not need separate type casting
+      # behavior for user and database inputs. Called by
+      # `type_cast_from_database` and `type_cast_from_user` for all values
+      # except `nil`.
+      def cast_value(value) # :doc:
+        value
+      end
+    end
+  end
+end

data/lib/active_record/type.rb

@@ -0,0 +1,23 @@
+require 'active_record/type/decorator'
+require 'active_record/type/mutable'
+require 'active_record/type/numeric'
+require 'active_record/type/time_value'
+require 'active_record/type/value'
+
+require 'active_record/type/big_integer'
+require 'active_record/type/binary'
+require 'active_record/type/boolean'
+require 'active_record/type/date'
+require 'active_record/type/date_time'
+require 'active_record/type/decimal'
+require 'active_record/type/decimal_without_scale'
+require 'active_record/type/float'
+require 'active_record/type/integer'
+require 'active_record/type/serialized'
+require 'active_record/type/string'
+require 'active_record/type/text'
+require 'active_record/type/time'
+require 'active_record/type/unsigned_integer'
+
+require 'active_record/type/type_map'
+require 'active_record/type/hash_lookup_type_map'

data/lib/active_record/validations/associated.rb

@@ -1,6 +1,6 @@
 module ActiveRecord
   module Validations
-    class AssociatedValidator < ActiveModel::EachValidator
+    class AssociatedValidator < ActiveModel::EachValidator #:nodoc:
       def validate_each(record, attribute, value)
         if Array.wrap(value).reject {|r| r.marked_for_destruction? || r.valid?}.any?
           record.errors.add(attribute, :invalid, options.merge(:value => value))
@@ -9,7 +9,8 @@ module ActiveRecord
     end
 
     module ClassMethods
-      # Validates whether the associated object or objects are all valid themselves. Works with any kind of association.
+      # Validates whether the associated object or objects are all valid.
+      # Works with any kind of association.
       #
       #   class Book < ActiveRecord::Base
       #     has_many :pages
@@ -18,23 +19,30 @@ module ActiveRecord
       #     validates_associated :pages, :library
       #   end
       #
-      # WARNING: This validation must not be used on both ends of an association. Doing so will lead to a circular dependency and cause infinite recursion.
+      # WARNING: This validation must not be used on both ends of an association.
+      # Doing so will lead to a circular dependency and cause infinite recursion.
       #
-      # NOTE: This validation will not fail if the association hasn't been assigned. If you want to
-      # ensure that the association is both present and guaranteed to be valid, you also need to
-      # use +validates_presence_of+.
+      # NOTE: This validation will not fail if the association hasn't been
+      # assigned. If you want to ensure that the association is both present and
+      # guaranteed to be valid, you also need to use +validates_presence_of+.
       #
       # Configuration options:
-      # * <tt>:message</tt> - A custom error message (default is: "is invalid")
-      # * <tt>:on</tt> - Specifies when this validation is active. Runs in all
-      #   validation contexts by default (+nil+), other options are <tt>:create</tt>
-      #   and <tt>:update</tt>.
-      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine if the validation should
-      #   occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>). The
-      #   method, proc or string should return or evaluate to a true or false value.
-      # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine if the validation should
-      #   not occur (e.g. <tt>:unless => :skip_validation</tt>, or <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>). The
-      #   method, proc or string should return or evaluate to a true or false value.
+      #
+      # * <tt>:message</tt> - A custom error message (default is: "is invalid").
+      # * <tt>:on</tt> - Specifies the contexts where this validation is active.
+      #   Runs in all validation contexts by default (nil). You can pass a symbol
+      #   or an array of symbols. (e.g. <tt>on: :create</tt> or
+      #   <tt>on: :custom_validation_context</tt> or
+      #   <tt>on: [:create, :custom_validation_context]</tt>)
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
+      #   if the validation should occur (e.g. <tt>if: :allow_validation</tt>,
+      #   or <tt>if: Proc.new { |user| user.signup_step > 2 }</tt>). The method,
+      #   proc or string should return or evaluate to a +true+ or +false+ value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to
+      #   determine if the validation should not occur (e.g. <tt>unless: :skip_validation</tt>,
+      #   or <tt>unless: Proc.new { |user| user.signup_step <= 2 }</tt>). The
+      #   method, proc or string should return or evaluate to a +true+ or +false+
+      #   value.
       def validates_associated(*attr_names)
         validates_with AssociatedValidator, _merge_attributes(attr_names)
       end

data/lib/active_record/validations/presence.rb

@@ -0,0 +1,67 @@
+module ActiveRecord
+  module Validations
+    class PresenceValidator < ActiveModel::Validations::PresenceValidator # :nodoc:
+      def validate(record)
+        super
+        attributes.each do |attribute|
+          next unless record.class._reflect_on_association(attribute)
+          associated_records = Array.wrap(record.send(attribute))
+
+          # Superclass validates presence. Ensure present records aren't about to be destroyed.
+          if associated_records.present? && associated_records.all? { |r| r.marked_for_destruction? }
+            record.errors.add(attribute, :blank, options)
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      # Validates that the specified attributes are not blank (as defined by
+      # Object#blank?), and, if the attribute is an association, that the
+      # associated object is not marked for destruction. Happens by default
+      # on save.
+      #
+      #   class Person < ActiveRecord::Base
+      #     has_one :face
+      #     validates_presence_of :face
+      #   end
+      #
+      # The face attribute must be in the object and it cannot be blank or marked
+      # for destruction.
+      #
+      # If you want to validate the presence of a boolean field (where the real values
+      # are true and false), you will want to use
+      # <tt>validates_inclusion_of :field_name, in: [true, false]</tt>.
+      #
+      # This is due to the way Object#blank? handles boolean values:
+      # <tt>false.blank? # => true</tt>.
+      #
+      # This validator defers to the ActiveModel validation for presence, adding the
+      # check to see that an associated object is not marked for destruction. This
+      # prevents the parent object from validating successfully and saving, which then
+      # deletes the associated object, thus putting the parent object into an invalid
+      # state.
+      #
+      # Configuration options:
+      # * <tt>:message</tt> - A custom error message (default is: "can't be blank").
+      # * <tt>:on</tt> - Specifies the contexts where this validation is active.
+      #   Runs in all validation contexts by default (nil). You can pass a symbol
+      #   or an array of symbols. (e.g. <tt>on: :create</tt> or
+      #   <tt>on: :custom_validation_context</tt> or
+      #   <tt>on: [:create, :custom_validation_context]</tt>)
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine if
+      #   the validation should occur (e.g. <tt>if: :allow_validation</tt>, or
+      #   <tt>if: Proc.new { |user| user.signup_step > 2 }</tt>). The method, proc
+      #   or string should return or evaluate to a +true+ or +false+ value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine
+      #   if the validation should not occur (e.g. <tt>unless: :skip_validation</tt>,
+      #   or <tt>unless: Proc.new { |user| user.signup_step <= 2 }</tt>). The method,
+      #   proc or string should return or evaluate to a +true+ or +false+ value.
+      # * <tt>:strict</tt> - Specifies whether validation should be strict.
+      #   See <tt>ActiveModel::Validation#validates!</tt> for more information.
+      def validates_presence_of(*attr_names)
+        validates_with PresenceValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end