модуль ActiveModel::Dirty
Активный Модель Изменённый
Предоставляет способ отслеживать изменения в объекте так же, как это делает Active Record.
Требования к реализации ActiveModel::Dirty:
-
include ActiveModel::Dirtyв вашем объекте. -
Вызов
define_attribute_methods, передавая каждый метод, который вы хотите отслеживать. -
Вызов
[attr_name]_will_change!перед каждым изменением отслеживаемого атрибута. -
Вызов
changes_appliedпосле сохранения изменений. -
Вызов
clear_changes_informationпри необходимости сброса информации о изменениях. -
Вызов
restore_attributesпри необходимости восстановления предыдущих данных.
Минимальная реализация может быть:
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
Новый экземпляр Person объекта не изменён:
person = Person.new person.changed? # => false
Изменение имени:
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"]
Сохранение изменений:
person.save person.changed? # => false person.name_changed? # => false
Сброс изменений:
person.previous_changes # => {"name" => [nil, "Bill"]}
person.name_previously_changed? # => true
person.name_previous_change # => [nil, "Bill"]
person.reload!
person.previous_changes # => {}
Откат изменений:
person.name = "Uncle Bob" person.rollback! person.name # => "Bill" person.name_changed? # => false
Присвоение того же значения не изменяет атрибут:
person.name = 'Bill' person.name_changed? # => false person.name_change # => nil
Какие атрибуты изменились?
person.name = 'Bob'
person.changed # => ["name"]
person.changes # => {"name" => ["Bill", "Bob"]}
Если атрибут модифицируется на месте, используйте [attribute_name]_will_change! для маркировки изменения атрибута. В противном случае Active Model не сможет отслеживать изменения атрибутов, изменённых на месте. Обратите внимание, что Active Record может автоматически определять модификации на месте. Вам не нужно вызывать [attribute_name]_will_change! для моделей Active Record.
person.name_will_change! person.name_change # => ["Bill", "Bill"] person.name << 'y' person.name_change # => ["Bill", "Billy"]
Публичные методы экземпляра
# File activemodel/lib/active_model/dirty.rb, line 145 def changed changed_attributes.keys end
Возвращает массив с именами атрибутов с несохранёнными изменениями.
person.changed # => [] person.name = 'bob' person.changed # => ["name"]
# File activemodel/lib/active_model/dirty.rb, line 136 def changed? changed_attributes.present? end
Возвращает true , если какие-либо атрибуты имеют несохранённые изменения, false в противном случае.
person.changed? # => false person.name = 'bob' person.changed? # => true
# File activemodel/lib/active_model/dirty.rb, line 175 def changed_attributes @changed_attributes ||= ActiveSupport::HashWithIndifferentAccess.new end
Возвращает хеш атрибутов с несохранёнными изменениями, указывающий их исходные значения, например, attr => original value.
person.name # => "bob"
person.name = 'robert'
person.changed_attributes # => {"name" => "bob"}
# File activemodel/lib/active_model/dirty.rb, line 155
def changes
ActiveSupport::HashWithIndifferentAccess[changed.map { |attr| [attr, attribute_change(attr)] }]
end Возвращает хеш изменённых атрибутов, указывающий их исходные и новые значения, например, attr => [original value, new value].
person.changes # => {}
person.name = 'bob'
person.changes # => { "name" => ["bill", "bob"] }
# File activemodel/lib/active_model/dirty.rb, line 165 def previous_changes @previously_changed ||= ActiveSupport::HashWithIndifferentAccess.new end
Возвращает хеш атрибутов, которые были изменены до сохранения модели.
person.name # => "bob"
person.name = 'robert'
person.save
person.previous_changes # => {"name" => ["bob", "robert"]}
# File activemodel/lib/active_model/dirty.rb, line 197
def restore_attributes(attributes = changed)
attributes.each { |attr| restore_attribute! attr }
end Восстанавливает все предыдущие данные указанных атрибутов.
Приватные методы экземпляра
# File activemodel/lib/active_model/dirty.rb, line 216 def changes_applied # :doc: @previously_changed = changes @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new end
Удаляет текущие изменения и делает их доступными через previous_changes.
# File activemodel/lib/active_model/dirty.rb, line 268 def clear_attribute_changes(attributes) # :doc: attributes_changed_by_setter.except!(*attributes) end
Удаляет информацию о изменениях для указанных атрибутов.
# File activemodel/lib/active_model/dirty.rb, line 222 def clear_changes_information # :doc: @previously_changed = ActiveSupport::HashWithIndifferentAccess.new @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new end
Очищает все данные о изменениях: текущие изменения и предыдущие изменения.
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.