mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
c477d95604
Currently `ActiveModel::Model` is defined as the minimum API to talk with Action Pack and Action View. Its name suggests it can be included to create Active Record type models, but for creating models it's probably too minimal. For example it's very common to include ActiveModel::Attributes as well. By moving `ActiveModel::Model`'s implementation to a new `ActiveModel::API` we keep a definition of the minimum API to talk with Action Pack and Action View. For `ActiveModel::Model` we only need to include `ActiveModel::API`. This will allow adding more funcationality to `ActiveModel::Model` while keeping backwards compatibility. Co-authored-by: Nathaniel Watts <1141717+thewatts@users.noreply.github.com>
46 lines
1.3 KiB
Ruby
46 lines
1.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module ActiveModel
|
|
# == Active \Model \Basic \Model
|
|
#
|
|
# Allows implementing models similar to <tt>ActiveRecord::Base</tt>.
|
|
# Includes <tt>ActiveModel::API</tt> for the required interface for an
|
|
# object to interact with Action Pack and Action View, but can be
|
|
# extended with other functionalities.
|
|
#
|
|
# A minimal implementation could be:
|
|
#
|
|
# class Person
|
|
# include ActiveModel::Model
|
|
# attr_accessor :name, :age
|
|
# end
|
|
#
|
|
# person = Person.new(name: 'bob', age: '18')
|
|
# person.name # => "bob"
|
|
# person.age # => "18"
|
|
#
|
|
# If for some reason you need to run code on <tt>initialize</tt>, make
|
|
# sure you call +super+ if you want the attributes hash initialization to
|
|
# happen.
|
|
#
|
|
# class Person
|
|
# include ActiveModel::Model
|
|
# attr_accessor :id, :name, :omg
|
|
#
|
|
# def initialize(attributes={})
|
|
# super
|
|
# @omg ||= true
|
|
# end
|
|
# end
|
|
#
|
|
# person = Person.new(id: 1, name: 'bob')
|
|
# person.omg # => true
|
|
#
|
|
# For more detailed information on other functionalities available, please
|
|
# refer to the specific modules included in <tt>ActiveModel::Model</tt>
|
|
# (see below).
|
|
module Model
|
|
extend ActiveSupport::Concern
|
|
include ActiveModel::API
|
|
end
|
|
end
|