activemodel 7.0.8.1 → 7.2.2.1

data/lib/active_model/type/helpers/numeric.rb

@@ -8,6 +8,10 @@ module ActiveModel
           cast(value)
         end
 
+        def serialize_cast_value(value)
+          value
+        end
+
         def cast(value)
           # Checks whether the value is numeric. Spaceship operator
           # will return nil if value is not numeric.
@@ -38,7 +42,8 @@ module ActiveModel
           end
 
           def number_to_non_number?(old_value, new_value_before_type_cast)
-            old_value != nil && non_numeric_string?(new_value_before_type_cast.to_s)
+            old_value != nil && !new_value_before_type_cast.is_a?(::Numeric) &&
+              non_numeric_string?(new_value_before_type_cast.to_s)
           end
 
           def non_numeric_string?(value)

data/lib/active_model/type/helpers/time_value.rb

@@ -7,7 +7,7 @@ module ActiveModel
   module Type
     module Helpers # :nodoc: all
       module TimeValue
-        def serialize(value)
+        def serialize_cast_value(value)
           value = apply_seconds_precision(value)
 
           if value.acts_like?(:time)
@@ -69,20 +69,57 @@ module ActiveModel
             \z
           /x
 
-          def fast_string_to_time(string)
-            return unless ISO_DATETIME =~ string
-
-            usec = $7.to_i
-            usec_len = $7&.length
-            if usec_len&.< 6
-              usec *= 10**(6 - usec_len)
+          if RUBY_VERSION >= "3.2"
+            if Time.new(2000, 1, 1, 0, 0, 0, "-00:00").yday != 1 # Early 3.2.x had a bug
+              # BUG: Wrapping the Time object with Time.at because Time.new with `in:` in Ruby 3.2.0
+              # used to return an invalid Time object
+              # see: https://bugs.ruby-lang.org/issues/19292
+              def fast_string_to_time(string)
+                return unless string.include?("-") #  Time.new("1234") # => 1234-01-01 00:00:00
+
+                if is_utc?
+                  ::Time.at(::Time.new(string, in: "UTC"))
+                else
+                  ::Time.new(string)
+                end
+              rescue ArgumentError
+                nil
+              end
+            else
+              def fast_string_to_time(string)
+                return unless string.include?("-") #  Time.new("1234") # => 1234-01-01 00:00:00
+
+                if is_utc?
+                  ::Time.new(string, in: "UTC")
+                else
+                  ::Time.new(string)
+                end
+              rescue ArgumentError
+                nil
+              end
             end
-
-            if $8
-              offset = $8 == "Z" ? 0 : $8.to_i * 3600 + $9.to_i * 60
+          else
+            def fast_string_to_time(string)
+              return unless ISO_DATETIME =~ string
+
+              usec = $7.to_i
+              usec_len = $7&.length
+              if usec_len&.< 6
+                usec *= 10**(6 - usec_len)
+              end
+
+              if $8
+                offset = \
+                  if $8 == "Z"
+                    0
+                  else
+                    offset_h, offset_m = $8.to_i, $9.to_i
+                    offset_h.to_i * 3600 + (offset_h.negative? ? -1 : 1) * offset_m * 60
+                  end
+              end
+
+              new_time($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i, usec, offset)
             end
-
-            new_time($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i, usec, offset)
           end
       end
     end

data/lib/active_model/type/helpers/timezone.rb

@@ -7,7 +7,11 @@ module ActiveModel
     module Helpers # :nodoc: all
       module Timezone
         def is_utc?
-          ::Time.zone_default.nil? || ::Time.zone_default.match?("UTC")
+          if default = ::Time.zone_default
+            default.name == "UTC"
+          else
+            true
+          end
         end
 
         def default_timezone

data/lib/active_model/type/immutable_string.rb

@@ -2,7 +2,39 @@
 
 module ActiveModel
   module Type
-    class ImmutableString < Value # :nodoc:
+    # = Active Model \ImmutableString \Type
+    #
+    # Attribute type to represent immutable strings. It casts incoming values to
+    # frozen strings.
+    #
+    #   class Person
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :name, :immutable_string
+    #   end
+    #
+    #   person = Person.new
+    #   person.name = 1
+    #
+    #   person.name # => "1"
+    #   person.name.frozen? # => true
+    #
+    # Values are coerced to strings using their +to_s+ method. Boolean values
+    # are treated differently, however: +true+ will be cast to <tt>"t"</tt> and
+    # +false+ will be cast to <tt>"f"</tt>. These strings can be customized when
+    # declaring an attribute:
+    #
+    #   class Person
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :active, :immutable_string, true: "aye", false: "nay"
+    #   end
+    #
+    #   person = Person.new
+    #   person.active = true
+    #
+    #   person.active # => "aye"
+    class ImmutableString < Value
       def initialize(**args)
         @true  = -(args.delete(:true)&.to_s  || "t")
         @false = -(args.delete(:false)&.to_s || "f")
@@ -22,6 +54,10 @@ module ActiveModel
         end
       end
 
+      def serialize_cast_value(value) # :nodoc:
+        value
+      end
+
       private
         def cast_value(value)
           case value

data/lib/active_model/type/integer.rb

@@ -2,7 +2,46 @@
 
 module ActiveModel
   module Type
-    class Integer < Value # :nodoc:
+    # = Active Model \Integer \Type
+    #
+    # Attribute type for integer representation. This type is registered under
+    # the +:integer+ key.
+    #
+    #   class Person
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :age, :integer
+    #   end
+    #
+    # Values are cast using their +to_i+ method, except for blank strings, which
+    # are cast to +nil+. If a +to_i+ method is not defined or raises an error,
+    # the value will be cast to +nil+.
+    #
+    #   person = Person.new
+    #
+    #   person.age = "18"
+    #   person.age # => 18
+    #
+    #   person.age = ""
+    #   person.age # => nil
+    #
+    #   person.age = :not_an_integer
+    #   person.age # => nil (because Symbol does not define #to_i)
+    #
+    # Serialization also works under the same principle. Non-numeric strings are
+    # serialized as +nil+, for example.
+    #
+    # Serialization also validates that the integer can be stored using a
+    # limited number of bytes. If it cannot, an ActiveModel::RangeError will be
+    # raised. The default limit is 4 bytes, and can be customized when declaring
+    # an attribute:
+    #
+    #   class Person
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :age, :integer, limit: 6
+    #   end
+    class Integer < Value
       include Helpers::Numeric
 
       # Column storage size in bytes.
@@ -28,6 +67,10 @@ module ActiveModel
         ensure_in_range(super)
       end
 
+      def serialize_cast_value(value) # :nodoc:
+        ensure_in_range(value)
+      end
+
       def serializable?(value)
         cast_value = cast(value)
         in_range?(cast_value) || begin

data/lib/active_model/type/registry.rb

@@ -20,16 +20,15 @@ module ActiveModel
         registrations[type_name] = block
       end
 
-      def lookup(symbol, *args)
+      def lookup(symbol, ...)
         registration = registrations[symbol]
 
         if registration
-          registration.call(symbol, *args)
+          registration.call(symbol, ...)
         else
           raise ArgumentError, "Unknown type #{symbol.inspect}"
         end
       end
-      ruby2_keywords(:lookup)
 
       private
         attr_reader :registrations

data/lib/active_model/type/serialize_cast_value.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Type
+    module SerializeCastValue # :nodoc:
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def serialize_cast_value_compatible?
+          return @serialize_cast_value_compatible if defined?(@serialize_cast_value_compatible)
+          @serialize_cast_value_compatible = ancestors.index(instance_method(:serialize_cast_value).owner) <= ancestors.index(instance_method(:serialize).owner)
+        end
+      end
+
+      module DefaultImplementation
+        def serialize_cast_value(value)
+          value
+        end
+      end
+
+      def self.included(klass)
+        klass.include DefaultImplementation unless klass.method_defined?(:serialize_cast_value)
+      end
+
+      def self.serialize(type, value)
+        # Using `type.equal?(type.itself_if_...)` is a performant way to also
+        # ensure that `type` is not just a DelegateClass instance (e.g.
+        # ActiveRecord::Type::Serialized) unintentionally delegating
+        # SerializeCastValue methods.
+        if type.equal?((type.itself_if_serialize_cast_value_compatible rescue nil))
+          type.serialize_cast_value(value)
+        else
+          type.serialize(value)
+        end
+      end
+
+      def itself_if_serialize_cast_value_compatible
+        self if self.class.serialize_cast_value_compatible?
+      end
+
+      def initialize(...)
+        super
+        self.class.serialize_cast_value_compatible? # eagerly compute
+      end
+    end
+  end
+end

data/lib/active_model/type/string.rb

@@ -4,7 +4,15 @@ require "active_model/type/immutable_string"
 
 module ActiveModel
   module Type
-    class String < ImmutableString # :nodoc:
+    # = Active Model \String \Type
+    #
+    # Attribute type for strings. It is registered under the +:string+ key.
+    #
+    # This class is a specialization of ActiveModel::Type::ImmutableString. It
+    # performs coercion in the same way, and can be configured in the same way.
+    # However, it accounts for mutable strings, so dirty tracking can properly
+    # check if a string has changed.
+    class String < ImmutableString
       def changed_in_place?(raw_old_value, new_value)
         if new_value.is_a?(::String)
           raw_old_value != new_value

data/lib/active_model/type/time.rb

@@ -2,12 +2,45 @@
 
 module ActiveModel
   module Type
-    class Time < Value # :nodoc:
+    # = Active Model \Time \Type
+    #
+    # Attribute type for time of day representation. It is registered under the
+    # +:time+ key.
+    #
+    #   class Event
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :start, :time
+    #   end
+    #
+    # String values are parsed using the ISO 8601 datetime format, but are
+    # normalized to have a date of 2000-01-01 and be in the UTC time zone.
+    #
+    #   event = Event.new
+    #   event.start = "2004-10-25T01:23:45-06:00"
+    #
+    #   event.start.class # => Time
+    #   event.start       # => 2000-01-01 07:23:45 UTC
+    #
+    # Partial time-only formats are also accepted.
+    #
+    #   event.start = "00:01:02+03:00"
+    #   event.start # => 1999-12-31 21:01:02 UTC
+    #
+    # The degree of sub-second precision can be customized when declaring an
+    # attribute:
+    #
+    #   class Event
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :start, :time, precision: 4
+    #   end
+    class Time < Value
       include Helpers::Timezone
-      include Helpers::TimeValue
       include Helpers::AcceptsMultiparameterTime.new(
         defaults: { 1 => 2000, 2 => 1, 3 => 1, 4 => 0, 5 => 0 }
       )
+      include Helpers::TimeValue
 
       def type
         :time
@@ -19,8 +52,12 @@ module ActiveModel
         case value
         when ::String
           value = "2000-01-01 #{value}"
-          time_hash = ::Date._parse(value)
-          return if time_hash[:hour].nil?
+          time_hash = begin
+            ::Date._parse(value)
+          rescue ArgumentError
+          end
+
+          return if time_hash.nil? || time_hash[:hour].nil?
         when ::Time
           value = value.change(year: 2000, day: 1, month: 1)
         end
@@ -31,13 +68,17 @@ module ActiveModel
       private
         def cast_value(value)
           return apply_seconds_precision(value) unless value.is_a?(::String)
-          return if value.empty?
+          return if value.blank?
 
           dummy_time_value = value.sub(/\A\d{4}-\d\d-\d\d(?:T|\s)|/, "2000-01-01 ")
 
           fast_string_to_time(dummy_time_value) || begin
-            time_hash = ::Date._parse(dummy_time_value)
-            return if time_hash[:hour].nil?
+            time_hash = begin
+              ::Date._parse(dummy_time_value)
+            rescue ArgumentError
+            end
+
+            return if time_hash.nil? || time_hash[:hour].nil?
             new_time(*time_hash.values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction, :offset))
           end
         end

data/lib/active_model/type/value.rb

@@ -2,10 +2,20 @@
 
 module ActiveModel
   module Type
+    # = Active Model \Value \Type
+    #
+    # The base class for all attribute types. This class also serves as the
+    # default type for attributes that do not specify a type.
     class Value
+      include SerializeCastValue
       attr_reader :precision, :scale, :limit
 
+      # Initializes a type with three basic configuration settings: precision,
+      # limit, and scale. The Value base class does not define behavior for
+      # these settings. It uses them for equality comparison and hash key
+      # generation only.
       def initialize(precision: nil, limit: nil, scale: nil)
+        super()
         @precision = precision
         @scale = scale
         @limit = limit
@@ -19,7 +29,9 @@ module ActiveModel
         true
       end
 
-      def type # :nodoc:
+      # Returns the unique type name as a Symbol. Subclasses should override
+      # this method.
+      def type
       end
 
       # Converts a value from database input to the appropriate ruby type. The
@@ -129,6 +141,10 @@ module ActiveModel
         false
       end
 
+      def as_json(*)
+        raise NoMethodError
+      end
+
       private
         # Convenience method for types which do not need separate type casting
         # behavior for user and database inputs. Called by Value#cast for

data/lib/active_model/type.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_model/type/helpers"
+require "active_model/type/serialize_cast_value"
 require "active_model/type/value"
 
 require "active_model/type/big_integer"

data/lib/active_model/validations/absence.rb

@@ -11,7 +11,7 @@ module ActiveModel
 
     module HelperMethods
       # Validates that the specified attributes are blank (as defined by
-      # Object#present?). Happens by default on save.
+      # Object#present?).
       #
       #   class Person < ActiveRecord::Base
       #     validates_absence_of :first_name

data/lib/active_model/validations/acceptance.rb

@@ -90,7 +90,7 @@ module ActiveModel
       #
       # If the database column does not exist, the +terms_of_service+ attribute
       # is entirely virtual. This check is performed only if +terms_of_service+
-      # is not +nil+ and by default on save.
+      # is not +nil+.
       #
       # Configuration options:
       # * <tt>:message</tt> - A custom error message (default is: "must be

data/lib/active_model/validations/callbacks.rb

@@ -2,12 +2,12 @@
 
 module ActiveModel
   module Validations
-    # == Active \Model \Validation \Callbacks
+    # = Active \Model \Validation \Callbacks
     #
-    # Provides an interface for any class to have +before_validation+ and
-    # +after_validation+ callbacks.
+    # Provides an interface for any class to have ClassMethods#before_validation and
+    # ClassMethods#after_validation callbacks.
     #
-    # First, include ActiveModel::Validations::Callbacks from the class you are
+    # First, include +ActiveModel::Validations::Callbacks+ from the class you are
     # creating:
     #
     #   class MyModel
@@ -101,7 +101,7 @@ module ActiveModel
               options[:on] = Array(options[:on])
               options[:if] = [
                 ->(o) {
-                  !(options[:on] & Array(o.validation_context)).empty?
+                  options[:on].intersect?(Array(o.validation_context))
                 },
                 *options[:if]
               ]

data/lib/active_model/validations/clusivity.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require "active_model/validations/resolve_value"
 require "active_support/core_ext/range"
 
 module ActiveModel
   module Validations
     module Clusivity # :nodoc:
+      include ResolveValue
+
       ERROR_MESSAGE = "An object with the method #include? or a proc, lambda or symbol is required, " \
                       "and must be supplied as the :in (or :within) option of the configuration hash"
 
@@ -16,13 +19,7 @@ module ActiveModel
 
     private
       def include?(record, value)
-        members = if delimiter.respond_to?(:call)
-          delimiter.call(record)
-        elsif delimiter.respond_to?(:to_sym)
-          record.send(delimiter)
-        else
-          delimiter
-        end
+        members = resolve_value(record, delimiter)
 
         if value.is_a?(Array)
           value.all? { |v| members.public_send(inclusion_method(members), v) }
@@ -42,7 +39,7 @@ module ActiveModel
       # or DateTime ranges.
       def inclusion_method(enumerable)
         if enumerable.is_a? Range
-          case enumerable.first
+          case enumerable.begin || enumerable.end
           when Numeric, Time, DateTime, Date
             :cover?
           else

data/lib/active_model/validations/comparability.rb

@@ -7,17 +7,6 @@ module ActiveModel
         equal_to: :==, less_than: :<, less_than_or_equal_to: :<=,
         other_than: :!= }.freeze
 
-      def option_value(record, option_value)
-        case option_value
-        when Proc
-          option_value.call(record)
-        when Symbol
-          record.send(option_value)
-        else
-          option_value
-        end
-      end
-
       def error_options(value, option_value)
         options.except(*COMPARE_CHECKS.keys).merge!(
           count: option_value,

data/lib/active_model/validations/comparison.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 require "active_model/validations/comparability"
+require "active_model/validations/resolve_value"
 
 module ActiveModel
   module Validations
     class ComparisonValidator < EachValidator # :nodoc:
       include Comparability
+      include ResolveValue
 
       def check_validity!
-        unless (options.keys & COMPARE_CHECKS.keys).any?
+        unless options.keys.intersect?(COMPARE_CHECKS.keys)
           raise ArgumentError, "Expected one of :greater_than, :greater_than_or_equal_to, "\
           ":equal_to, :less_than, :less_than_or_equal_to, or :other_than option to be supplied."
         end
@@ -16,7 +18,7 @@ module ActiveModel
 
       def validate_each(record, attr_name, value)
         options.slice(*COMPARE_CHECKS.keys).each do |option, raw_option_value|
-          option_value = option_value(record, raw_option_value)
+          option_value = resolve_value(record, raw_option_value)
 
           if value.nil? || value.blank?
             return record.errors.add(attr_name, :blank, **error_options(value, option_value))
@@ -42,17 +44,23 @@ module ActiveModel
       # Configuration options:
       # * <tt>:message</tt> - A custom error message (default is: "failed comparison").
       # * <tt>:greater_than</tt> - Specifies the value must be greater than the
-      #   supplied value.
+      #   supplied value. The default error message for this option is _"must be
+      #   greater than %{count}"_.
       # * <tt>:greater_than_or_equal_to</tt> - Specifies the value must be
-      #   greater than or equal to the supplied value.
+      #   greater than or equal to the supplied value. The default error message
+      #   for this option is _"must be greater than or equal to %{count}"_.
       # * <tt>:equal_to</tt> - Specifies the value must be equal to the supplied
-      #   value.
+      #   value. The default error message for this option is _"must be equal to
+      #   %{count}"_.
       # * <tt>:less_than</tt> - Specifies the value must be less than the
-      #   supplied value.
+      #   supplied value. The default error message for this option is _"must be
+      #   less than %{count}"_.
       # * <tt>:less_than_or_equal_to</tt> - Specifies the value must be less
-      #   than or equal to the supplied value.
+      #   than or equal to the supplied value. The default error message for
+      #   this option is _"must be less than or equal to %{count}"_.
       # * <tt>:other_than</tt> - Specifies the value must not be equal to the
-      #   supplied value.
+      #   supplied value. The default error message for this option is _"must be
+      #   other than %{count}"_.
       #
       # There is also a list of default options supported by every validator:
       # +:if+, +:unless+, +:on+, +:allow_nil+, +:allow_blank+, and +:strict+ .

data/lib/active_model/validations/format.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
+require "active_model/validations/resolve_value"
+
 module ActiveModel
   module Validations
     class FormatValidator < EachValidator # :nodoc:
+      include ResolveValue
+
       def validate_each(record, attribute, value)
         if options[:with]
-          regexp = option_call(record, :with)
+          regexp = resolve_value(record, options[:with])
           record_error(record, attribute, :with, value) unless regexp.match?(value.to_s)
         elsif options[:without]
-          regexp = option_call(record, :without)
+          regexp = resolve_value(record, options[:without])
           record_error(record, attribute, :without, value) if regexp.match?(value.to_s)
         end
       end
@@ -23,11 +27,6 @@ module ActiveModel
       end
 
       private
-        def option_call(record, name)
-          option = options[name]
-          option.respond_to?(:call) ? option.call(record) : option
-        end
-
         def record_error(record, attribute, name, value)
           record.errors.add(attribute, :invalid, **options.except(name).merge!(value: value))
         end