activemodel 4.2.0 → 6.1.0

data/lib/active_model/attribute_set/builder.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+require "active_model/attribute"
+
+module ActiveModel
+  class AttributeSet # :nodoc:
+    class Builder # :nodoc:
+      attr_reader :types, :default_attributes
+
+      def initialize(types, default_attributes = {})
+        @types = types
+        @default_attributes = default_attributes
+      end
+
+      def build_from_database(values = {}, additional_types = {})
+        LazyAttributeSet.new(values, types, additional_types, default_attributes)
+      end
+    end
+  end
+
+  class LazyAttributeSet < AttributeSet # :nodoc:
+    def initialize(values, types, additional_types, default_attributes, attributes = {})
+      super(attributes)
+      @values = values
+      @types = types
+      @additional_types = additional_types
+      @default_attributes = default_attributes
+      @casted_values = {}
+      @materialized = false
+    end
+
+    def key?(name)
+      (values.key?(name) || types.key?(name) || @attributes.key?(name)) && self[name].initialized?
+    end
+
+    def keys
+      keys = values.keys | types.keys | @attributes.keys
+      keys.keep_if { |name| self[name].initialized? }
+    end
+
+    def fetch_value(name, &block)
+      if attr = @attributes[name]
+        return attr.value(&block)
+      end
+
+      @casted_values.fetch(name) do
+        value_present = true
+        value = values.fetch(name) { value_present = false }
+
+        if value_present
+          type = additional_types.fetch(name, types[name])
+          @casted_values[name] = type.deserialize(value)
+        else
+          attr = default_attribute(name, value_present, value)
+          attr.value(&block)
+        end
+      end
+    end
+
+    protected
+      def attributes
+        unless @materialized
+          values.each_key { |key| self[key] }
+          types.each_key { |key| self[key] }
+          @materialized = true
+        end
+        @attributes
+      end
+
+    private
+      attr_reader :values, :types, :additional_types, :default_attributes
+
+      def default_attribute(
+        name,
+        value_present = true,
+        value = values.fetch(name) { value_present = false }
+      )
+        type = additional_types.fetch(name, types[name])
+
+        if value_present
+          @attributes[name] = Attribute.from_database(name, value, type, @casted_values[name])
+        elsif types.key?(name)
+          if attr = default_attributes[name]
+            @attributes[name] = attr.dup
+          else
+            @attributes[name] = Attribute.uninitialized(name, type)
+          end
+        else
+          Attribute.null(name)
+        end
+      end
+  end
+
+  class LazyAttributeHash # :nodoc:
+    delegate :transform_values, :each_value, :fetch, :except, to: :materialize
+
+    def initialize(types, values, additional_types, default_attributes, delegate_hash = {})
+      @types = types
+      @values = values
+      @additional_types = additional_types
+      @materialized = false
+      @delegate_hash = delegate_hash
+      @default_attributes = default_attributes
+    end
+
+    def key?(key)
+      delegate_hash.key?(key) || values.key?(key) || types.key?(key)
+    end
+
+    def [](key)
+      delegate_hash[key] || assign_default_value(key)
+    end
+
+    def []=(key, value)
+      delegate_hash[key] = value
+    end
+
+    def deep_dup
+      dup.tap do |copy|
+        copy.instance_variable_set(:@delegate_hash, delegate_hash.transform_values(&:dup))
+      end
+    end
+
+    def initialize_dup(_)
+      @delegate_hash = Hash[delegate_hash]
+      super
+    end
+
+    def each_key(&block)
+      keys = types.keys | values.keys | delegate_hash.keys
+      keys.each(&block)
+    end
+
+    def ==(other)
+      if other.is_a?(LazyAttributeHash)
+        materialize == other.materialize
+      else
+        materialize == other
+      end
+    end
+
+    def marshal_dump
+      [@types, @values, @additional_types, @default_attributes, @delegate_hash]
+    end
+
+    def marshal_load(values)
+      if values.is_a?(Hash)
+        ActiveSupport::Deprecation.warn(<<~MSG)
+          Marshalling load from legacy attributes format is deprecated and will be removed in Rails 6.2.
+        MSG
+        empty_hash = {}.freeze
+        initialize(empty_hash, empty_hash, empty_hash, empty_hash, values)
+        @materialized = true
+      else
+        initialize(*values)
+      end
+    end
+
+    protected
+      def materialize
+        unless @materialized
+          values.each_key { |key| self[key] }
+          types.each_key { |key| self[key] }
+          unless frozen?
+            @materialized = true
+          end
+        end
+        delegate_hash
+      end
+
+    private
+      attr_reader :types, :values, :additional_types, :delegate_hash, :default_attributes
+
+      def assign_default_value(name)
+        type = additional_types.fetch(name, types[name])
+        value_present = true
+        value = values.fetch(name) { value_present = false }
+
+        if value_present
+          delegate_hash[name] = Attribute.from_database(name, value, type)
+        elsif types.key?(name)
+          attr = default_attributes[name]
+          if attr
+            delegate_hash[name] = attr.dup
+          else
+            delegate_hash[name] = Attribute.uninitialized(name, type)
+          end
+        end
+      end
+  end
+end

data/lib/active_model/attribute_set/yaml_encoder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  class AttributeSet
+    # Attempts to do more intelligent YAML dumping of an
+    # ActiveModel::AttributeSet to reduce the size of the resulting string
+    class YAMLEncoder # :nodoc:
+      def initialize(default_types)
+        @default_types = default_types
+      end
+
+      def encode(attribute_set, coder)
+        coder["concise_attributes"] = attribute_set.each_value.map do |attr|
+          if attr.type.equal?(default_types[attr.name])
+            attr.with_type(nil)
+          else
+            attr
+          end
+        end
+      end
+
+      def decode(coder)
+        if coder["attributes"]
+          coder["attributes"]
+        else
+          attributes_hash = Hash[coder["concise_attributes"].map do |attr|
+            if attr.type.nil?
+              attr = attr.with_type(default_types[attr.name])
+            end
+            [attr.name, attr]
+          end]
+          AttributeSet.new(attributes_hash)
+        end
+      end
+
+      private
+        attr_reader :default_types
+    end
+  end
+end

data/lib/active_model/attribute_set.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/object/deep_dup"
+require "active_model/attribute_set/builder"
+require "active_model/attribute_set/yaml_encoder"
+
+module ActiveModel
+  class AttributeSet # :nodoc:
+    delegate :each_value, :fetch, :except, to: :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def [](name)
+      @attributes[name] || default_attribute(name)
+    end
+
+    def []=(name, value)
+      @attributes[name] = value
+    end
+
+    def values_before_type_cast
+      attributes.transform_values(&:value_before_type_cast)
+    end
+
+    def to_hash
+      keys.index_with { |name| self[name].value }
+    end
+    alias :to_h :to_hash
+
+    def key?(name)
+      attributes.key?(name) && self[name].initialized?
+    end
+
+    def keys
+      attributes.each_key.select { |name| self[name].initialized? }
+    end
+
+    def fetch_value(name, &block)
+      self[name].value(&block)
+    end
+
+    def write_from_database(name, value)
+      @attributes[name] = self[name].with_value_from_database(value)
+    end
+
+    def write_from_user(name, value)
+      raise FrozenError, "can't modify frozen attributes" if frozen?
+      @attributes[name] = self[name].with_value_from_user(value)
+      value
+    end
+
+    def write_cast_value(name, value)
+      @attributes[name] = self[name].with_cast_value(value)
+      value
+    end
+
+    def freeze
+      attributes.freeze
+      super
+    end
+
+    def deep_dup
+      AttributeSet.new(attributes.deep_dup)
+    end
+
+    def initialize_dup(_)
+      @attributes = @attributes.dup
+      super
+    end
+
+    def initialize_clone(_)
+      @attributes = @attributes.clone
+      super
+    end
+
+    def reset(key)
+      if key?(key)
+        write_from_database(key, nil)
+      end
+    end
+
+    def accessed
+      attributes.each_key.select { |name| self[name].has_been_read? }
+    end
+
+    def map(&block)
+      new_attributes = attributes.transform_values(&block)
+      AttributeSet.new(new_attributes)
+    end
+
+    def ==(other)
+      attributes == other.attributes
+    end
+
+    protected
+      attr_reader :attributes
+
+    private
+      def default_attribute(name)
+        Attribute.null(name)
+      end
+  end
+end

data/lib/active_model/attributes.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "active_model/attribute_set"
+require "active_model/attribute/user_provided_default"
+
+module ActiveModel
+  module Attributes #:nodoc:
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    included do
+      attribute_method_suffix "="
+      class_attribute :attribute_types, :_default_attributes, instance_accessor: false
+      self.attribute_types = Hash.new(Type.default_value)
+      self._default_attributes = AttributeSet.new({})
+    end
+
+    module ClassMethods
+      def attribute(name, type = Type::Value.new, **options)
+        name = name.to_s
+        if type.is_a?(Symbol)
+          type = ActiveModel::Type.lookup(type, **options.except(:default))
+        end
+        self.attribute_types = attribute_types.merge(name => type)
+        define_default_attribute(name, options.fetch(:default, NO_DEFAULT_PROVIDED), type)
+        define_attribute_method(name)
+      end
+
+      # Returns an array of attribute names as strings
+      #
+      #   class Person
+      #     include ActiveModel::Attributes
+      #
+      #     attribute :name, :string
+      #     attribute :age, :integer
+      #   end
+      #
+      #   Person.attribute_names
+      #   # => ["name", "age"]
+      def attribute_names
+        attribute_types.keys
+      end
+
+      private
+        def define_method_attribute=(name, owner:)
+          ActiveModel::AttributeMethods::AttrNames.define_attribute_accessor_method(
+            owner, name, writer: true,
+          ) do |temp_method_name, attr_name_expr|
+            owner <<
+              "def #{temp_method_name}(value)" <<
+              "  _write_attribute(#{attr_name_expr}, value)" <<
+              "end"
+          end
+        end
+
+        NO_DEFAULT_PROVIDED = Object.new # :nodoc:
+        private_constant :NO_DEFAULT_PROVIDED
+
+        def define_default_attribute(name, value, type)
+          self._default_attributes = _default_attributes.deep_dup
+          if value == NO_DEFAULT_PROVIDED
+            default_attribute = _default_attributes[name].with_type(type)
+          else
+            default_attribute = Attribute::UserProvidedDefault.new(
+              name,
+              value,
+              type,
+              _default_attributes.fetch(name.to_s) { nil },
+            )
+          end
+          _default_attributes[name] = default_attribute
+        end
+    end
+
+    def initialize(*)
+      @attributes = self.class._default_attributes.deep_dup
+      super
+    end
+
+    def initialize_dup(other) # :nodoc:
+      @attributes = @attributes.deep_dup
+      super
+    end
+
+    # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
+    #
+    #   class Person
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :name, :string
+    #     attribute :age, :integer
+    #   end
+    #
+    #   person = Person.new(name: 'Francesco', age: 22)
+    #   person.attributes
+    #   # => {"name"=>"Francesco", "age"=>22}
+    def attributes
+      @attributes.to_hash
+    end
+
+    # Returns an array of attribute names as strings
+    #
+    #   class Person
+    #     include ActiveModel::Attributes
+    #
+    #     attribute :name, :string
+    #     attribute :age, :integer
+    #   end
+    #
+    #   person = Person.new
+    #   person.attribute_names
+    #   # => ["name", "age"]
+    def attribute_names
+      @attributes.keys
+    end
+
+    def freeze
+      @attributes = @attributes.clone.freeze unless frozen?
+      super
+    end
+
+    private
+      def _write_attribute(attr_name, value)
+        @attributes.write_from_user(attr_name, value)
+      end
+      alias :attribute= :_write_attribute
+
+      def attribute(attr_name)
+        @attributes.fetch_value(attr_name)
+      end
+  end
+end

data/lib/active_model/callbacks.rb

@@ -1,4 +1,7 @@
-require 'active_support/core_ext/array/extract_options'
+# frozen_string_literal: true
+
+require "active_support/core_ext/array/extract_options"
+require "active_support/core_ext/hash/keys"
 
 module ActiveModel
   # == Active \Model \Callbacks
@@ -6,7 +9,7 @@ module ActiveModel
   # Provides an interface for any class to have Active Record like callbacks.
   #
   # Like the Active Record methods, the callback chain is aborted as soon as
-  # one of the methods in the chain returns +false+.
+  # one of the methods throws +:abort+.
   #
   # First, extend ActiveModel::Callbacks from the class you are creating:
   #
@@ -49,13 +52,16 @@ module ActiveModel
   #    puts 'block successfully called.'
   #  end
   #
-  # You can choose not to have all three callbacks by passing a hash to the
+  # You can choose to have only specific callbacks by passing a hash to the
   # +define_model_callbacks+ method.
   #
   #   define_model_callbacks :create, only: [:after, :before]
   #
   # Would only create the +after_create+ and +before_create+ callback methods in
   # your class.
+  #
+  # NOTE: Calling the same callback multiple times will overwrite previous callback definitions.
+  #
   module Callbacks
     def self.extended(base) #:nodoc:
       base.class_eval do
@@ -98,12 +104,11 @@ module ActiveModel
     #     end
     #   end
     #
-    # NOTE: +method_name+ passed to `define_model_callbacks` must not end with
-    # `!`, `?` or `=`.
+    # NOTE: +method_name+ passed to define_model_callbacks must not end with
+    # <tt>!</tt>, <tt>?</tt> or <tt>=</tt>.
     def define_model_callbacks(*callbacks)
       options = callbacks.extract_options!
       options = {
-        terminator: ->(_,result) { result == false },
         skip_after_callbacks_if_terminated: true,
         scope: [:kind, :name],
         only: [:before, :around, :after]
@@ -121,29 +126,30 @@ module ActiveModel
     end
 
     private
-
-    def _define_before_model_callback(klass, callback) #:nodoc:
-      klass.define_singleton_method("before_#{callback}") do |*args, &block|
-        set_callback(:"#{callback}", :before, *args, &block)
+      def _define_before_model_callback(klass, callback)
+        klass.define_singleton_method("before_#{callback}") do |*args, **options, &block|
+          options.assert_valid_keys(:if, :unless, :prepend)
+          set_callback(:"#{callback}", :before, *args, options, &block)
+        end
       end
-    end
 
-    def _define_around_model_callback(klass, callback) #:nodoc:
-      klass.define_singleton_method("around_#{callback}") do |*args, &block|
-        set_callback(:"#{callback}", :around, *args, &block)
+      def _define_around_model_callback(klass, callback)
+        klass.define_singleton_method("around_#{callback}") do |*args, **options, &block|
+          options.assert_valid_keys(:if, :unless, :prepend)
+          set_callback(:"#{callback}", :around, *args, options, &block)
+        end
       end
-    end
 
-    def _define_after_model_callback(klass, callback) #:nodoc:
-      klass.define_singleton_method("after_#{callback}") do |*args, &block|
-        options = args.extract_options!
-        options[:prepend] = true
-        conditional = ActiveSupport::Callbacks::Conditionals::Value.new { |v|
-          v != false
-        }
-        options[:if] = Array(options[:if]) << conditional
-        set_callback(:"#{callback}", :after, *(args << options), &block)
+      def _define_after_model_callback(klass, callback)
+        klass.define_singleton_method("after_#{callback}") do |*args, **options, &block|
+          options.assert_valid_keys(:if, :unless, :prepend)
+          options[:prepend] = true
+          conditional = ActiveSupport::Callbacks::Conditionals::Value.new { |v|
+            v != false
+          }
+          options[:if] = Array(options[:if]) << conditional
+          set_callback(:"#{callback}", :after, *args, options, &block)
+        end
       end
-    end
   end
 end

data/lib/active_model/conversion.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModel
   # == Active \Model \Conversion
   #
@@ -22,7 +24,7 @@ module ActiveModel
   module Conversion
     extend ActiveSupport::Concern
 
-    # If your object is already designed to implement all of the Active Model
+    # If your object is already designed to implement all of the \Active \Model
     # you can use the default <tt>:to_model</tt> implementation, which simply
     # returns +self+.
     #
@@ -33,22 +35,26 @@ module ActiveModel
     #   person = Person.new
     #   person.to_model == person # => true
     #
-    # If your model does not act like an Active Model object, then you should
+    # If your model does not act like an \Active \Model object, then you should
     # define <tt>:to_model</tt> yourself returning a proxy object that wraps
-    # your object with Active Model compliant methods.
+    # your object with \Active \Model compliant methods.
     def to_model
       self
     end
 
-    # Returns an Array of all key attributes if any is set, regardless if
-    # the object is persisted or not. Returns +nil+ if there are no key attributes.
+    # Returns an Array of all key attributes if any of the attributes is set, whether or not
+    # the object is persisted. Returns +nil+ if there are no key attributes.
     #
     #   class Person
     #     include ActiveModel::Conversion
     #     attr_accessor :id
+    #
+    #     def initialize(id)
+    #       @id = id
+    #     end
     #   end
     #
-    #   person = Person.create(id: 1)
+    #   person = Person.new(1)
     #   person.to_key # => [1]
     def to_key
       key = respond_to?(:id) && id
@@ -61,15 +67,20 @@ module ActiveModel
     #   class Person
     #     include ActiveModel::Conversion
     #     attr_accessor :id
+    #
+    #     def initialize(id)
+    #       @id = id
+    #     end
+    #
     #     def persisted?
     #       true
     #     end
     #   end
     #
-    #   person = Person.create(id: 1)
+    #   person = Person.new(1)
     #   person.to_param # => "1"
     def to_param
-      (persisted? && key = to_key) ? key.join('-') : nil
+      (persisted? && key = to_key) ? key.join("-") : nil
     end
 
     # Returns a +string+ identifying the path associated with the object.
@@ -92,7 +103,7 @@ module ActiveModel
         @_to_partial_path ||= begin
           element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
           collection = ActiveSupport::Inflector.tableize(name)
-          "#{collection}/#{element}".freeze
+          "#{collection}/#{element}"
         end
       end
     end