Основы Active Model
Это руководство познакомит вас со всем необходимым для начала использования классов моделей. Active Model позволяет хелперам Action Pack взаимодействовать с обычными объектами на чистом Ruby. Также Active Model помогает с созданием гибкой, настраиваемой ORM для использования вне фреймворка Rails.
После прочтение данного руководства, вы узнаете:
- Как ведет себя модель Active Record.
- Как работают колбэки и валидации.
- Как работают сериализаторы.
- Как Active Model интегрируется с фреймворком интернационализации Rails (i18n).
1. Что такое Active Model?
Библиотека Active Model содержит различные модули, используемые для разработки классов, которым необходимы некоторые особенности, присутствующие в Active Record. Некоторые из этих модулей описаны ниже.
1.1. Методы атрибутов
Модуль ActiveModel::AttributeMethods позволяет добавлять различные суффиксы и префиксы к методам класса. Для использования необходимо определить суффиксы, префиксы, а также к каким методам объекта они будут применяться.
class Person
include ActiveModel::AttributeMethods
attribute_method_prefix 'reset_'
attribute_method_suffix '_highest?'
define_attribute_methods 'age'
attr_accessor :age
private
def reset_attribute(attribute)
send("#{attribute}=", 0)
end
def attribute_highest?(attribute)
send(attribute) > 100
end
end
person = Person.new
person.age = 110
person.age_highest? # => true
person.reset_age # => 0
person.age_highest? # => false
1.2. Колбэки
Модуль ActiveModel::Callbacks дает Active Record возможность использования функций обратного вызова (колбэков). Это позволяет определять колбэки, вызываемые в определенное время. После определения колбэков можно обернуть их дополнительной функциональностью before, after и around, которые позволяют определить момент вызова колбэка "до", "после" и "до и после" вызова нужного метода.
class Person
extend ActiveModel::Callbacks
define_model_callbacks :update
before_update :reset_me
def update
run_callbacks(:update) do
# Этот метод вызывается при вызове у обьекта метода update.
end
end
def reset_me
# Этот метод вызывается при вызове у обьекта метода update, выполнение метода reset_me произойдет до вызова update, т.к он определен как колбэк before_update.
end
end
1.3. Преобразования
Если для класса определены методы persisted? и id, то можно добавить модуль ActiveModel::Conversion в этот класс и вызывать методы преобразования Rails на объектах этого класса.
class Person
include ActiveModel::Conversion
def persisted?
false
end
def id
nil
end
end
person = Person.new
person.to_model == person # => true
person.to_key # => nil
person.to_param # => nil
1.4. Грязный объект
Объект становится грязным после одного или нескольких изменений его атрибутов, и при этом он не был сохранен. ActiveModel::Dirty дает возможность проверить, был ли объект изменен или нет. Также имеются атрибуты на основе акцессор-методов. Представим, что имеется класс Person с атрибутами first_name и last_name:
class Person
include ActiveModel::Dirty
define_attribute_methods :first_name, :last_name
def first_name
@first_name
end
def first_name=(value)
first_name_will_change!
@first_name = value
end
def last_name
@last_name
end
def last_name=(value)
last_name_will_change!
@last_name = value
end
def save
# метод для сохранения изменений...
changes_applied
end
end
1.4.1. Запрашиваем у объекта список всех измененных атрибутов.
person = Person.new
person.changed? # => false
person.first_name = "First Name"
person.first_name # => "First Name"
# возвращает true, если хотя бы у одного из атрибутов есть несохраненное значение.
person.changed? # => true
# возвращает список атрибутов, которые были изменены до сохранения.
person.changed # => ["first_name"]
# возвращает хэш с измененными атрибутами вместе с их первоначальными значениями.
person.changed_attributes # => {"first_name"=>nil}
# возвращает хэш изменений с именами атрибутов в качестве ключей, и их значений как массива, который содержит старое и новое значение поля.
person.changes # => {"first_name"=>[nil, "First Name"]}
1.4.2. Атрибуты, основанные на акцессор-методах
Отслеживает, был ли атрибут изменен или нет.
# attr_name_changed? person.first_name # => "First Name" person.first_name_changed? # => true
Отслеживает предыдущее значение атрибута.
# акцессор attr_name_was person.first_name_was # => nil
Отслеживает старое и новое значение измененного атрибута. Возвращает массив, если изменяли, в противном случае nil.
# attr_name_change person.first_name_change # => [nil, "First Name"] person.last_name_change # => nil
1.5. Валидации
Модуль ActiveModel::Validations добавляет возможность проверять объекты, как в Active Record.
class Person
include ActiveModel::Validations
attr_accessor :name, :email, :token
validates :name, presence: true
validates_format_of :email, with: /\A([^\s]+)((?:[-a-z0-9]\.)[a-z]{2,})\z/i
validates! :token, presence: true
end
person = Person.new
person.token = "2b1f325"
person.valid? # => false
person.name = 'vishnu'
person.email = 'me'
person.valid? # => false
person.email = 'me@vishnuatrai.com'
person.valid? # => true
person.token = nil
person.valid? # => вызывается ActiveModel::StrictValidationFailed
1.6. Именование
ActiveModel::Naming добавляет ряд методов класса, упрощающие управление именованием и роутингом. Модуль определяет метод класса model_name, который определит несколько акцессоров с помощью методов ActiveSupport::Inflector.
class Person extend ActiveModel::Naming end Person.model_name.name # => "Person" Person.model_name.singular # => "person" Person.model_name.plural # => "people" Person.model_name.element # => "person" Person.model_name.human # => "Person" Person.model_name.collection # => "people" Person.model_name.param_key # => "person" Person.model_name.i18n_key # => :person Person.model_name.route_key # => "people" Person.model_name.singular_route_key # => "person"
1.7. Модель
ActiveModel::Model добавляет для класса возможность работать из коробки с Action Pack и Action View.
class EmailContact
include ActiveModel::Model
attr_accessor :name, :email, :message
validates :name, :email, :message, presence: true
def deliver
if valid?
# отправить электронную почту
end
end
end
При включении ActiveModel::Model вы получите несколько возможностей, таких как:
- интроспекция имени модели
- преобразования
- переводы
- валидации
Он также дает возможность инициализировать объект с помощью хэша атрибутов, подобно любому объекту Active Record.
email_contact = EmailContact.new(name: 'David',
email: 'david@example.com',
message: 'Hello World')
email_contact.name # => 'David'
email_contact.email # => 'david@example.com'
email_contact.valid? # => true
email_contact.persisted? # => false
Любой класс, включающий ActiveModel::Model, может быть использован с form_with, render и любыми другими методами хелпера Action View, точно так же, как и объекты Active Record.
1.8. Сериализация
ActiveModel::Serialization предоставляет базовую сериализацию для вашего объекта. Вам необходимо объявить хэш, содержащий атрибуты, которые вы хотите сериализовать. Атрибуты должны быть строками, не символами.
class Person
include ActiveModel::Serialization
attr_accessor :name
def attributes
{'name' => nil}
end
end
Теперь можно получить доступ к сериализованному хэшу вашего объекта с помощью метода serializable_hash.
person = Person.new
person.serializable_hash # => {"name"=>nil}
person.name = "Bob"
person.serializable_hash # => {"name"=>"Bob"}
1.8.1. ActiveModel::Serializers
Active Model также предоставляет модуль ActiveModel::Serializers::JSON для сериализации/десериализации JSON. Этот модуль автоматически подключает ранее обсужденный модуль ActiveModel::Serialization.
1.8.1.1. ActiveModel::Serializers::JSON
Для использования ActiveModel::Serializers::JSON необходимо только изменить модуль, который вы подключали, с ActiveModel::Serialization на ActiveModel::Serializers::JSON.
class Person
include ActiveModel::Serializers::JSON
attr_accessor :name
def attributes
{'name' => nil}
end
end
Метод as_json, подобно serializable_hash, предоставляет хэш, описывающий модель.
person = Person.new
person.as_json # => {"name"=>nil}
person.name = "Bob"
person.as_json # => {"name"=>"Bob"}
Также можно определить атрибуты для модели из строки JSON. Однако, в классе нужно определить метод attributes=:
class Person
include ActiveModel::Serializers::JSON
attr_accessor :name
def attributes=(hash)
hash.each do |key, value|
send("#{key}=", value)
end
end
def attributes
{'name' => nil}
end
end
Теперь есть возможность создавать экземпляры Person и устанавливать атрибуты с помощью from_json.
json = { name: 'Bob' }.to_json
person = Person.new
person.from_json(json) # => #<Person:0x00000100c773f0 @name="Bob">
person.name # => "Bob"
1.9. Перевод
ActiveModel::Translation предоставляет интеграцию между вашим объектом и фреймворком интернационализации Rails (i18n).
class Person extend ActiveModel::Translation end
С помощью метода human_attribute_name можно преобразовывать имена атрибутов в более удобочитаемый формат. Удобочитаемый формат определяется в вашем(-их) файле(-ах) локали.
- config/locales/app.pt-BR.yml
pt-BR:
activemodel:
attributes:
person:
name: 'Nome'
Person.human_attribute_name('name') # => "Nome"
1.10. Тесты совместимости
ActiveModel::Lint::Tests позволяет проверить, совместим ли объект с Active Model API.
app/models/person.rbclass Person include ActiveModel::Model end
test/models/person_test.rbrequire "test_helper" class PersonTest < ActiveSupport::TestCase include ActiveModel::Lint::Tests setup do @model = Person.new end end
$ bin/rails test Run options: --seed 14596 # Running: ...... Finished in 0.024899s, 240.9735 runs/s, 1204.8677 assertions/s. 6 runs, 30 assertions, 0 failures, 0 errors, 0 skips
Объекту не нужно реализовывать все API, чтобы работать с Action Pack. Этот модуль всего лишь предназначен для предоставления руководства в случае, если вы хотите все особенности из коробки.
1.11. Безопасный пароль
ActiveModel::SecurePassword предоставляет способ безопасно хранить любой пароль в зашифрованном виде. При включении этого модуля предоставляется метод класса has_secure_password, определяющий акцессор password с определенными валидациями на нем по умолчанию.
1.11.1. Требования
ActiveModel::SecurePassword зависит от bcrypt, поэтому включите этот гем в свой Gemfile для правильного использования ActiveModel::SecurePassword. Чтобы он работал, в модели должен быть акцессор с именем XXX_digest. Где XXX это имя атрибута желаемого пароля. Следующие валидации добавляются автоматически:
- Пароль должен существовать.
- Пароль должен совпадать с подтверждением (проверяется, если передан
XXX_confirmation). - Максимальная длина пароля 72 (требуется
bcrypt, от которого зависит ActiveModel::SecurePassword)
1.11.2. Примеры
class Person
include ActiveModel::SecurePassword
has_secure_password
has_secure_password :recovery_password, validations: false
attr_accessor :password_digest, :recovery_password_digest
end
person = Person.new
# Когда пароль пустой.
person.valid? # => false
# Когда подтверждение не совпадает с паролем.
person.password = 'aditya'
person.password_confirmation = 'nomatch'
person.valid? # => false
# Когда длина пароля превышает 72.
person.password = person.password_confirmation = 'a' * 100
person.valid? # => false
# Когда предоставлен только пароль без password_confirmation.
person.password = 'aditya'
person.valid? # => true
# Когда проходят все валидации.
person.password = person.password_confirmation = 'aditya'
person.valid? # => true
person.recovery_password = "42password"
person.authenticate('aditya') # => person
person.authenticate('notright') # => false
person.authenticate_password('aditya') # => person
person.authenticate_password('notright') # => false
person.authenticate_recovery_password('42password') # => person
person.authenticate_recovery_password('notright') # => false
person.password_digest # => "$2a$04$gF8RfZdoXHvyTjHhiU4ZsO.kQqV9oonYZu31PRE4hLQn3xM2qkpIy"
person.recovery_password_digest # => "$2a$04$iOfhwahFymCs5weB3BNH/uXkTG65HR.qpW.bNhEjFP3ftli3o5DQC"
Лицензия CC BY-SA 4.0
"Rails", "Ruby on Rails" и логотип Rails - торговые марки DHH