activemodel 6.0.0

data/lib/active_model/attributes.rb

@@ -0,0 +1,138 @@
+# 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)
+          ActiveModel::AttributeMethods::AttrNames.define_attribute_accessor_method(
+            generated_attribute_methods, name, writer: true,
+          ) do |temp_method_name, attr_name_expr|
+            generated_attribute_methods.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{temp_method_name}(value)
+                name = #{attr_name_expr}
+                write_attribute(name, value)
+              end
+            RUBY
+          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
+
+    # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
+    #
+    #   class Person
+    #     include ActiveModel::Model
+    #     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
+
+    private
+
+      def write_attribute(attr_name, value)
+        name = attr_name.to_s
+        name = self.class.attribute_aliases[name] || name
+
+        @attributes.write_from_user(name, value)
+        value
+      end
+
+      def attribute(attr_name)
+        name = attr_name.to_s
+        name = self.class.attribute_aliases[name] || name
+
+        @attributes.fetch_value(name)
+      end
+
+      # Dispatch target for <tt>*=</tt> attribute methods.
+      def attribute=(attribute_name, value)
+        write_attribute(attribute_name, value)
+      end
+  end
+end

data/lib/active_model/callbacks.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/array/extract_options"
+require "active_support/core_ext/hash/keys"
+
+module ActiveModel
+  # == Active \Model \Callbacks
+  #
+  # 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 throws +:abort+.
+  #
+  # First, extend ActiveModel::Callbacks from the class you are creating:
+  #
+  #   class MyModel
+  #     extend ActiveModel::Callbacks
+  #   end
+  #
+  # Then define a list of methods that you want callbacks attached to:
+  #
+  #   define_model_callbacks :create, :update
+  #
+  # This will provide all three standard callbacks (before, around and after)
+  # for both the <tt>:create</tt> and <tt>:update</tt> methods. To implement,
+  # you need to wrap the methods you want callbacks on in a block so that the
+  # callbacks get a chance to fire:
+  #
+  #   def create
+  #     run_callbacks :create do
+  #       # Your create action methods here
+  #     end
+  #   end
+  #
+  # Then in your class, you can use the +before_create+, +after_create+ and
+  # +around_create+ methods, just as you would in an Active Record model.
+  #
+  #   before_create :action_before_create
+  #
+  #   def action_before_create
+  #     # Your code here
+  #   end
+  #
+  # When defining an around callback remember to yield to the block, otherwise
+  # it won't be executed:
+  #
+  #  around_create :log_status
+  #
+  #  def log_status
+  #    puts 'going to call the block...'
+  #    yield
+  #    puts 'block successfully called.'
+  #  end
+  #
+  # 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
+        include ActiveSupport::Callbacks
+      end
+    end
+
+    # define_model_callbacks accepts the same options +define_callbacks+ does,
+    # in case you want to overwrite a default. Besides that, it also accepts an
+    # <tt>:only</tt> option, where you can choose if you want all types (before,
+    # around or after) or just some.
+    #
+    #   define_model_callbacks :initializer, only: :after
+    #
+    # Note, the <tt>only: <type></tt> hash will apply to all callbacks defined
+    # on that method call. To get around this you can call the define_model_callbacks
+    # method as many times as you need.
+    #
+    #   define_model_callbacks :create,  only: :after
+    #   define_model_callbacks :update,  only: :before
+    #   define_model_callbacks :destroy, only: :around
+    #
+    # Would create +after_create+, +before_update+ and +around_destroy+ methods
+    # only.
+    #
+    # You can pass in a class to before_<type>, after_<type> and around_<type>,
+    # in which case the callback will call that class's <action>_<type> method
+    # passing the object that the callback is being called on.
+    #
+    #   class MyModel
+    #     extend ActiveModel::Callbacks
+    #     define_model_callbacks :create
+    #
+    #     before_create AnotherClass
+    #   end
+    #
+    #   class AnotherClass
+    #     def self.before_create( obj )
+    #       # obj is the MyModel instance that the callback is being called on
+    #     end
+    #   end
+    #
+    # 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 = {
+        skip_after_callbacks_if_terminated: true,
+        scope: [:kind, :name],
+        only: [:before, :around, :after]
+      }.merge!(options)
+
+      types = Array(options.delete(:only))
+
+      callbacks.each do |callback|
+        define_callbacks(callback, options)
+
+        types.each do |type|
+          send("_define_#{type}_model_callback", self, callback)
+        end
+      end
+    end
+
+    private
+
+      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
+
+      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
+
+      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

data/lib/active_model/conversion.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  # == Active \Model \Conversion
+  #
+  # Handles default conversions: to_model, to_key, to_param, and to_partial_path.
+  #
+  # Let's take for example this non-persisted object.
+  #
+  #   class ContactMessage
+  #     include ActiveModel::Conversion
+  #
+  #     # ContactMessage are never persisted in the DB
+  #     def persisted?
+  #       false
+  #     end
+  #   end
+  #
+  #   cm = ContactMessage.new
+  #   cm.to_model == cm  # => true
+  #   cm.to_key          # => nil
+  #   cm.to_param        # => nil
+  #   cm.to_partial_path # => "contact_messages/contact_message"
+  module Conversion
+    extend ActiveSupport::Concern
+
+    # 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+.
+    #
+    #   class Person
+    #     include ActiveModel::Conversion
+    #   end
+    #
+    #   person = Person.new
+    #   person.to_model == person # => true
+    #
+    # 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.
+    def to_model
+      self
+    end
+
+    # 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.new(1)
+    #   person.to_key # => [1]
+    def to_key
+      key = respond_to?(:id) && id
+      key ? [key] : nil
+    end
+
+    # Returns a +string+ representing the object's key suitable for use in URLs,
+    # or +nil+ if <tt>persisted?</tt> is +false+.
+    #
+    #   class Person
+    #     include ActiveModel::Conversion
+    #     attr_accessor :id
+    #
+    #     def initialize(id)
+    #       @id = id
+    #     end
+    #
+    #     def persisted?
+    #       true
+    #     end
+    #   end
+    #
+    #   person = Person.new(1)
+    #   person.to_param # => "1"
+    def to_param
+      (persisted? && key = to_key) ? key.join("-") : nil
+    end
+
+    # Returns a +string+ identifying the path associated with the object.
+    # ActionPack uses this to find a suitable partial to represent the object.
+    #
+    #   class Person
+    #     include ActiveModel::Conversion
+    #   end
+    #
+    #   person = Person.new
+    #   person.to_partial_path # => "people/person"
+    def to_partial_path
+      self.class._to_partial_path
+    end
+
+    module ClassMethods #:nodoc:
+      # Provide a class level cache for #to_partial_path. This is an
+      # internal method and should not be accessed directly.
+      def _to_partial_path #:nodoc:
+        @_to_partial_path ||= begin
+          element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
+          collection = ActiveSupport::Inflector.tableize(name)
+          "#{collection}/#{element}"
+        end
+      end
+    end
+  end
+end

data/lib/active_model/dirty.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+require "active_model/attribute_mutation_tracker"
+
+module ActiveModel
+  # == Active \Model \Dirty
+  #
+  # Provides a way to track changes in your object in the same way as
+  # Active Record does.
+  #
+  # The requirements for implementing ActiveModel::Dirty are:
+  #
+  # * <tt>include ActiveModel::Dirty</tt> in your object.
+  # * Call <tt>define_attribute_methods</tt> passing each method you want to
+  #   track.
+  # * Call <tt>[attr_name]_will_change!</tt> before each change to the tracked
+  #   attribute.
+  # * Call <tt>changes_applied</tt> after the changes are persisted.
+  # * Call <tt>clear_changes_information</tt> when you want to reset the changes
+  #   information.
+  # * Call <tt>restore_attributes</tt> when you want to restore previous data.
+  #
+  # A minimal implementation could be:
+  #
+  #   class Person
+  #     include ActiveModel::Dirty
+  #
+  #     define_attribute_methods :name
+  #
+  #     def initialize
+  #       @name = nil
+  #     end
+  #
+  #     def name
+  #       @name
+  #     end
+  #
+  #     def name=(val)
+  #       name_will_change! unless val == @name
+  #       @name = val
+  #     end
+  #
+  #     def save
+  #       # do persistence work
+  #
+  #       changes_applied
+  #     end
+  #
+  #     def reload!
+  #       # get the values from the persistence layer
+  #
+  #       clear_changes_information
+  #     end
+  #
+  #     def rollback!
+  #       restore_attributes
+  #     end
+  #   end
+  #
+  # A newly instantiated +Person+ object is unchanged:
+  #
+  #   person = Person.new
+  #   person.changed? # => false
+  #
+  # Change the name:
+  #
+  #   person.name = 'Bob'
+  #   person.changed?       # => true
+  #   person.name_changed?  # => true
+  #   person.name_changed?(from: nil, to: "Bob") # => true
+  #   person.name_was       # => nil
+  #   person.name_change    # => [nil, "Bob"]
+  #   person.name = 'Bill'
+  #   person.name_change    # => [nil, "Bill"]
+  #
+  # Save the changes:
+  #
+  #   person.save
+  #   person.changed?      # => false
+  #   person.name_changed? # => false
+  #
+  # Reset the changes:
+  #
+  #   person.previous_changes         # => {"name" => [nil, "Bill"]}
+  #   person.name_previously_changed? # => true
+  #   person.name_previous_change     # => [nil, "Bill"]
+  #   person.reload!
+  #   person.previous_changes         # => {}
+  #
+  # Rollback the changes:
+  #
+  #   person.name = "Uncle Bob"
+  #   person.rollback!
+  #   person.name          # => "Bill"
+  #   person.name_changed? # => false
+  #
+  # Assigning the same value leaves the attribute unchanged:
+  #
+  #   person.name = 'Bill'
+  #   person.name_changed? # => false
+  #   person.name_change   # => nil
+  #
+  # Which attributes have changed?
+  #
+  #   person.name = 'Bob'
+  #   person.changed # => ["name"]
+  #   person.changes # => {"name" => ["Bill", "Bob"]}
+  #
+  # If an attribute is modified in-place then make use of
+  # <tt>[attribute_name]_will_change!</tt> to mark that the attribute is changing.
+  # Otherwise \Active \Model can't track changes to in-place attributes. Note
+  # that Active Record can detect in-place modifications automatically. You do
+  # not need to call <tt>[attribute_name]_will_change!</tt> on Active Record models.
+  #
+  #   person.name_will_change!
+  #   person.name_change # => ["Bill", "Bill"]
+  #   person.name << 'y'
+  #   person.name_change # => ["Bill", "Billy"]
+  module Dirty
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    included do
+      attribute_method_suffix "_changed?", "_change", "_will_change!", "_was"
+      attribute_method_suffix "_previously_changed?", "_previous_change"
+      attribute_method_affix prefix: "restore_", suffix: "!"
+    end
+
+    def initialize_dup(other) # :nodoc:
+      super
+      if self.class.respond_to?(:_default_attributes)
+        @attributes = self.class._default_attributes.map do |attr|
+          attr.with_value_from_user(@attributes.fetch_value(attr.name))
+        end
+      end
+      @mutations_from_database = nil
+    end
+
+    # Clears dirty data and moves +changes+ to +previously_changed+ and
+    # +mutations_from_database+ to +mutations_before_last_save+ respectively.
+    def changes_applied
+      unless defined?(@attributes)
+        mutations_from_database.finalize_changes
+      end
+      @mutations_before_last_save = mutations_from_database
+      forget_attribute_assignments
+      @mutations_from_database = nil
+    end
+
+    # Returns +true+ if any of the attributes has unsaved changes, +false+ otherwise.
+    #
+    #   person.changed? # => false
+    #   person.name = 'bob'
+    #   person.changed? # => true
+    def changed?
+      mutations_from_database.any_changes?
+    end
+
+    # Returns an array with the name of the attributes with unsaved changes.
+    #
+    #   person.changed # => []
+    #   person.name = 'bob'
+    #   person.changed # => ["name"]
+    def changed
+      mutations_from_database.changed_attribute_names
+    end
+
+    # Dispatch target for <tt>*_changed?</tt> attribute methods.
+    def attribute_changed?(attr_name, **options) # :nodoc:
+      mutations_from_database.changed?(attr_name.to_s, options)
+    end
+
+    # Dispatch target for <tt>*_was</tt> attribute methods.
+    def attribute_was(attr_name) # :nodoc:
+      mutations_from_database.original_value(attr_name.to_s)
+    end
+
+    # Dispatch target for <tt>*_previously_changed?</tt> attribute methods.
+    def attribute_previously_changed?(attr_name) # :nodoc:
+      mutations_before_last_save.changed?(attr_name.to_s)
+    end
+
+    # Restore all previous data of the provided attributes.
+    def restore_attributes(attr_names = changed)
+      attr_names.each { |attr_name| restore_attribute!(attr_name) }
+    end
+
+    # Clears all dirty data: current changes and previous changes.
+    def clear_changes_information
+      @mutations_before_last_save = nil
+      forget_attribute_assignments
+      @mutations_from_database = nil
+    end
+
+    def clear_attribute_changes(attr_names)
+      attr_names.each do |attr_name|
+        clear_attribute_change(attr_name)
+      end
+    end
+
+    # Returns a hash of the attributes with unsaved changes indicating their original
+    # values like <tt>attr => original value</tt>.
+    #
+    #   person.name # => "bob"
+    #   person.name = 'robert'
+    #   person.changed_attributes # => {"name" => "bob"}
+    def changed_attributes
+      mutations_from_database.changed_values
+    end
+
+    # Returns a hash of changed attributes indicating their original
+    # and new values like <tt>attr => [original value, new value]</tt>.
+    #
+    #   person.changes # => {}
+    #   person.name = 'bob'
+    #   person.changes # => { "name" => ["bill", "bob"] }
+    def changes
+      mutations_from_database.changes
+    end
+
+    # Returns a hash of attributes that were changed before the model was saved.
+    #
+    #   person.name # => "bob"
+    #   person.name = 'robert'
+    #   person.save
+    #   person.previous_changes # => {"name" => ["bob", "robert"]}
+    def previous_changes
+      mutations_before_last_save.changes
+    end
+
+    def attribute_changed_in_place?(attr_name) # :nodoc:
+      mutations_from_database.changed_in_place?(attr_name.to_s)
+    end
+
+    private
+      def clear_attribute_change(attr_name)
+        mutations_from_database.forget_change(attr_name.to_s)
+      end
+
+      def mutations_from_database
+        @mutations_from_database ||= if defined?(@attributes)
+          ActiveModel::AttributeMutationTracker.new(@attributes)
+        else
+          ActiveModel::ForcedMutationTracker.new(self)
+        end
+      end
+
+      def forget_attribute_assignments
+        @attributes = @attributes.map(&:forgetting_assignment) if defined?(@attributes)
+      end
+
+      def mutations_before_last_save
+        @mutations_before_last_save ||= ActiveModel::NullMutationTracker.instance
+      end
+
+      # Dispatch target for <tt>*_change</tt> attribute methods.
+      def attribute_change(attr_name)
+        mutations_from_database.change_to_attribute(attr_name.to_s)
+      end
+
+      # Dispatch target for <tt>*_previous_change</tt> attribute methods.
+      def attribute_previous_change(attr_name)
+        mutations_before_last_save.change_to_attribute(attr_name.to_s)
+      end
+
+      # Dispatch target for <tt>*_will_change!</tt> attribute methods.
+      def attribute_will_change!(attr_name)
+        mutations_from_database.force_change(attr_name.to_s)
+      end
+
+      # Dispatch target for <tt>restore_*!</tt> attribute methods.
+      def restore_attribute!(attr_name)
+        attr_name = attr_name.to_s
+        if attribute_changed?(attr_name)
+          __send__("#{attr_name}=", attribute_was(attr_name))
+          clear_attribute_change(attr_name)
+        end
+      end
+  end
+end