Spec-Zone.ru › Ruby on Rails 5.2

модуль ActiveModel::Dirty

Включенные модули:
ActiveModel::AttributeMethods

Active Model 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"]

Открытые методы экземпляра

changed() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 170
def changed
  changed_attributes.keys
end

Возвращает массив с именами атрибутов с несохранёнными изменениями.

person.changed # => []
person.name = 'bob'
person.changed # => ["name"]
changed?() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 161
def changed?
  changed_attributes.present?
end

Возвращает true если у каких-либо атрибутов есть несохранённые изменения, false в противном случае.

person.changed? # => false
person.name = 'bob'
person.changed? # => true
changed_attributes() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 218
def changed_attributes
  # This should only be set by methods which will call changed_attributes
  # multiple times when it is known that the computed value cannot change.
  if defined?(@cached_changed_attributes)
    @cached_changed_attributes
  else
    attributes_changed_by_setter.reverse_merge(mutations_from_database.changed_values).freeze
  end
end

Возвращает хэш атрибутов с несохранёнными изменениями, указывающий их исходные значения, как attr => original value.

person.name # => "bob"
person.name = 'robert'
person.changed_attributes # => {"name" => "bob"}
changes() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 234
def changes
  cache_changed_attributes do
    ActiveSupport::HashWithIndifferentAccess[changed.map { |attr| [attr, attribute_change(attr)] }]
  end
end

Возвращает хэш изменённых атрибутов, указывающий их исходные и новые значения, как attr => [original value, new value].

person.changes # => {}
person.name = 'bob'
person.changes # => { "name" => ["bill", "bob"] }
changes_applied() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 146
def changes_applied
  unless defined?(@attributes)
    @previously_changed = changes
  end
  @mutations_before_last_save = mutations_from_database
  @attributes_changed_by_setter = ActiveSupport::HashWithIndifferentAccess.new
  forget_attribute_assignments
  @mutations_from_database = nil
end

Очищает данные изменений и перемещает changes в previously_changed и mutations_from_database в mutations_before_last_save соответственно.

clear_attribute_changes(attr_names) Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 205
def clear_attribute_changes(attr_names)
  attributes_changed_by_setter.except!(*attr_names)
  attr_names.each do |attr_name|
    clear_attribute_change(attr_name)
  end
end
clear_changes_information() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 197
def clear_changes_information
  @previously_changed = ActiveSupport::HashWithIndifferentAccess.new
  @mutations_before_last_save = nil
  @attributes_changed_by_setter = ActiveSupport::HashWithIndifferentAccess.new
  forget_attribute_assignments
  @mutations_from_database = nil
end

Очищает все данные изменений: текущие изменения и предыдущие изменения.

previous_changes() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 246
def previous_changes
  @previously_changed ||= ActiveSupport::HashWithIndifferentAccess.new
  @previously_changed.merge(mutations_before_last_save.changes)
end

Возвращает хэш атрибутов, которые были изменены до сохранения модели.

person.name # => "bob"
person.name = 'robert'
person.save
person.previous_changes # => {"name" => ["bob", "robert"]}
restore_attributes(attributes = changed) Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 192
def restore_attributes(attributes = changed)
  attributes.each { |attr| restore_attribute! attr }
end

Восстанавливает все предыдущие данные указанных атрибутов.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API