module 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 164 def changed mutations_from_database.changed_attribute_names end
Возвращает массив с именами атрибутов с несохранёнными изменениями.
person.changed # => [] person.name = 'bob' person.changed # => ["name"]
# File activemodel/lib/active_model/dirty.rb, line 155 def changed? mutations_from_database.any_changes? end
Возвращает true если любой из атрибутов имеет несохранённые изменения, false в противном случае.
person.changed? # => false person.name = 'bob' person.changed? # => true
# File activemodel/lib/active_model/dirty.rb, line 207 def changed_attributes mutations_from_database.changed_values end
Возвращает хеш изменённых атрибутов, указывающий их исходные значения, например attr => original value.
person.name # => "bob"
person.name = 'robert'
person.changed_attributes # => {"name" => "bob"}
# File activemodel/lib/active_model/dirty.rb, line 217 def changes mutations_from_database.changes end
Возвращает хеш изменённых атрибутов, указывающий их исходные и новые значения, например attr => [original value, new value].
person.changes # => {}
person.name = 'bob'
person.changes # => { "name" => ["bill", "bob"] }
# File activemodel/lib/active_model/dirty.rb, line 141
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 Очищает данные о изменениях и перемещает changes в previously_changed, и mutations_from_database в mutations_before_last_save соответственно.
# File activemodel/lib/active_model/dirty.rb, line 195
def clear_attribute_changes(attr_names)
attr_names.each do |attr_name|
clear_attribute_change(attr_name)
end
end # File activemodel/lib/active_model/dirty.rb, line 189 def clear_changes_information @mutations_before_last_save = nil forget_attribute_assignments @mutations_from_database = nil end
Очищает все данные о изменениях: текущие изменения и предыдущие изменения.
# File activemodel/lib/active_model/dirty.rb, line 227 def previous_changes mutations_before_last_save.changes end
Возвращает хеш атрибутов, которые были изменены до сохранения модели.
person.name # => "bob"
person.name = 'robert'
person.save
person.previous_changes # => {"name" => ["bob", "robert"]}
# File activemodel/lib/active_model/dirty.rb, line 184
def restore_attributes(attr_names = changed)
attr_names.each { |attr_name| restore_attribute!(attr_name) }
end Восстанавливает все предыдущие данные указанных атрибутов.
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.