модуль ActiveModel::Dirty

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

Модуль Active Model Dirty

Предоставляет способ отслеживания изменений в объекте, аналогично тому, как это делает Active Record.

Требования к реализации ActiveModel::Dirty:

include ActiveModel::Dirty в вашем объекте.
Вызов define_attribute_methods, передавая каждый метод, который вы хотите отслеживать.
Вызов attr_name_will_change! перед каждым изменением отслеживаемого атрибута.
Вызов changes_applied после сохранения изменений.
Вызов reset_changes при необходимости сброса информации о изменениях.

Минимальная реализация может быть следующей:

class Person
  include ActiveModel::Dirty

  define_attribute_methods :name

  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!
    reset_changes
  end
end

Новый созданный объект не изменён:

person = Person.find_by(name: 'Uncle Bob')
person.changed?       # => false

Изменение имени:

person.name = 'Bob'
person.changed?       # => true
person.name_changed?  # => true
person.name_changed?(from: "Uncle Bob", to: "Bob") # => true
person.name_was       # => "Uncle Bob"
person.name_change    # => ["Uncle Bob", "Bob"]
person.name = 'Bill'
person.name_change    # => ["Uncle Bob", "Bill"]

Сохранение изменений:

person.save
person.changed?       # => false
person.name_changed?  # => false

Сброс изменений:

person.previous_changes # => {"name" => ["Uncle Bob", "Bill"]}
person.reload!
person.previous_changes # => {}

Присваивание того же значения оставляет атрибут неизменным:

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! для обозначения того, что атрибут изменяется. В противном случае ActiveModel не может отслеживать изменения атрибутов, изменённых напрямую.

person.name_will_change!
person.name_change    # => ["Bill", "Bill"]
person.name << 'y'
person.name_change    # => ["Bill", "Billy"]

Общедоступные методы экземпляров

changed() Показать исходный код

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

person.changed # => []
person.name = 'bob'
person.changed # => ["name"]

# File activemodel/lib/active_model/dirty.rb, line 118
def changed
  changed_attributes.keys
end

changed?() Показать исходный код

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

person.changed? # => false
person.name = 'bob'
person.changed? # => true

# File activemodel/lib/active_model/dirty.rb, line 109
def changed?
  changed_attributes.present?
end

changed_attributes() Показать исходный код

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

person.name # => "bob"
person.name = 'robert'
person.changed_attributes # => {"name" => "bob"}

# File activemodel/lib/active_model/dirty.rb, line 148
def changed_attributes
  @changed_attributes ||= ActiveSupport::HashWithIndifferentAccess.new
end

changes() Показать исходный код

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

person.changes # => {}
person.name = 'bob'
person.changes # => { "name" => ["bill", "bob"] }

# File activemodel/lib/active_model/dirty.rb, line 128
def changes
  ActiveSupport::HashWithIndifferentAccess[changed.map { |attr| [attr, attribute_change(attr)] }]
end

previous_changes() Показать исходный код

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

person.name # => "bob"
person.name = 'robert'
person.save
person.previous_changes # => {"name" => ["bob", "robert"]}

# File activemodel/lib/active_model/dirty.rb, line 138
def previous_changes
  @previously_changed ||= ActiveSupport::HashWithIndifferentAccess.new
end