omg-activemodel 8.0.0.alpha1

data/lib/active_model/attributes.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  # = Active \Model \Attributes
+  #
+  # The Attributes module allows models to define attributes beyond simple Ruby
+  # readers and writers. Similar to Active Record attributes, which are
+  # typically inferred from the database schema, Active Model Attributes are
+  # aware of data types, can have default values, and can handle casting and
+  # serialization.
+  #
+  # To use Attributes, include the module in your model class and define your
+  # attributes using the +attribute+ macro. It accepts a name, a type, a default
+  # value, and any other options supported by the attribute type.
+  #
+  # ==== Examples
+  #
+  #   class Person
+  #     include ActiveModel::Attributes
+  #
+  #     attribute :name, :string
+  #     attribute :active, :boolean, default: true
+  #   end
+  #
+  #   person = Person.new
+  #   person.name = "Volmer"
+  #
+  #   person.name # => "Volmer"
+  #   person.active # => true
+  module Attributes
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeRegistration
+    include ActiveModel::AttributeMethods
+
+    included do
+      attribute_method_suffix "=", parameters: "value"
+    end
+
+    module ClassMethods
+      ##
+      # :call-seq: attribute(name, cast_type = nil, default: nil, **options)
+      #
+      # Defines a model attribute. In addition to the attribute name, a cast
+      # type and default value may be specified, as well as any options
+      # supported by the given cast type.
+      #
+      #   class Person
+      #     include ActiveModel::Attributes
+      #
+      #     attribute :name, :string
+      #     attribute :active, :boolean, default: true
+      #   end
+      #
+      #   person = Person.new
+      #   person.name = "Volmer"
+      #
+      #   person.name   # => "Volmer"
+      #   person.active # => true
+      def attribute(name, ...)
+        super
+        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
+
+      ##
+      # :method: type_for_attribute
+      # :call-seq: type_for_attribute(attribute_name, &block)
+      #
+      # Returns the type of the specified attribute after applying any
+      # modifiers. This method is the only valid source of information for
+      # anything related to the types of a model's attributes. The return value
+      # of this method will implement the interface described by
+      # ActiveModel::Type::Value (though the object itself may not subclass it).
+      #--
+      # Implemented by ActiveModel::AttributeRegistration::ClassMethods#type_for_attribute.
+
+      ##
+      private
+        def define_method_attribute=(canonical_name, owner:, as: canonical_name)
+          ActiveModel::AttributeMethods::AttrNames.define_attribute_accessor_method(
+            owner, canonical_name, writer: true,
+          ) do |temp_method_name, attr_name_expr|
+            owner.define_cached_method(temp_method_name, as: "#{as}=", namespace: :active_model) do |batch|
+              batch <<
+                "def #{temp_method_name}(value)" <<
+                "  _write_attribute(#{attr_name_expr}, value)" <<
+                "end"
+            end
+          end
+        end
+    end
+
+    def initialize(*) # :nodoc:
+      @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
+    #   person.name = "Francesco"
+    #   person.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 # :nodoc:
+      @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

@@ -0,0 +1,155 @@
+# 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: Defining 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 :initialize, 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,121 @@
+# 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
+
+    included do
+      ##
+      # :singleton-method:
+      #
+      # Accepts a string that will be used as a delimiter of object's key values in the `to_param` method.
+      class_attribute :param_delimiter, instance_reader: false, default: "-"
+    end
+
+    # 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 ? Array(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.all?) ? key.join(self.class.param_delimiter) : 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 ||= if respond_to?(:model_name)
+          "#{model_name.collection}/#{model_name.element}"
+        else
+          element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
+          collection = ActiveSupport::Inflector.tableize(name)
+          "#{collection}/#{element}"
+        end
+      end
+    end
+  end
+end

data/lib/active_model/deprecator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  def self.deprecator # :nodoc:
+    @deprecator ||= ActiveSupport::Deprecation.new
+  end
+end