модуль ActiveModel::Dirty

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

Отслеживание изменений Active Model

Позволяет отслеживать изменения объекта так же, как это делает Active Record.

Для реализации ActiveModel::Dirty необходимо:

include ActiveModel::Dirty в вашем объекте.
Вызвать define_attribute_methods, передав каждый метод, изменения которого нужно отслеживать.
Вызывать *_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_previously_changed?(from: nil, to: "Bill") # => true
person.name_previous_change     # => [nil, "Bill"]
person.name_previously_was      # => nil
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"]}

Если атрибут изменяется на месте, используйте *_will_change!, чтобы отметить, что атрибут изменяется. В противном случае Active Model не сможет отслеживать изменения атрибутов, измененных на месте. Обратите внимание, что Active Record может автоматически обнаруживать изменения на месте. Вызывать *_will_change! для моделей Active Record не нужно.

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

Методы можно вызывать как name_changed? или передавать аргумент универсальному методу attribute_changed?("name").

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

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

# File activemodel/lib/active_model/dirty.rb, line 155

Этот метод генерируется для каждого атрибута.

Возвращает старое и новое значения атрибута.

person = Person.new
person.name = 'Nick'
person.name_change # => [nil, 'Nick']

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

# File activemodel/lib/active_model/dirty.rb, line 144

Этот метод генерируется для каждого атрибута.

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

person = Person.new
person.name = 'Andrew'
person.name_changed? # => true

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

# File activemodel/lib/active_model/dirty.rb, line 193

Этот метод генерируется для каждого атрибута.

Возвращает старое и новое значения атрибута до последнего сохранения.

person = Person.new
person.name = 'Emmanuel'
person.save
person.name_previous_change # => [nil, 'Emmanuel']

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

# File activemodel/lib/active_model/dirty.rb, line 129

Этот метод генерируется для каждого атрибута.

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

person = Person.new
person.name = 'Britanny'
person.save
person.name_previously_changed? # => true
person.name_previously_changed?(from: nil, to: 'Britanny') # => true

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

# File activemodel/lib/active_model/dirty.rb, line 205

Этот метод генерируется для каждого атрибута.

Возвращает старое значение атрибута до последнего сохранения.

person = Person.new
person.name = 'Sage'
person.save
person.name_previously_was  # => nil

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

# File activemodel/lib/active_model/dirty.rb, line 182

Этот метод генерируется для каждого атрибута.

Возвращает старое значение атрибута.

person = Person.new(name: 'Steph')
person.name = 'Stephanie'
person.name_was # => 'Steph'

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

# File activemodel/lib/active_model/dirty.rb, line 166

Этот метод генерируется для каждого атрибута.

Если атрибут изменяется на месте, используйте *_will_change!, чтобы отметить, что атрибут изменяется. В противном случае Active Model не сможет отслеживать изменения атрибутов, измененных на месте. Обратите внимание, что Active Record может автоматически обнаруживать изменения на месте. Вызывать *_will_change! для моделей Active Record не нужно.

person = Person.new('Sandy')
person.name_will_change!
person.name_change # => ['Sandy', 'Sandy']

attribute_changed? (attr_name, **options) Показать исходный код

# File activemodel/lib/active_model/dirty.rb, line 300
def attribute_changed?(attr_name, **options)
  mutations_from_database.changed?(attr_name.to_s, **options)
end

Целевой метод для атрибутных методов *_changed?.

attribute_previously_changed? (attr_name, **options) Показать исходный код

# File activemodel/lib/active_model/dirty.rb, line 310
def attribute_previously_changed?(attr_name, **options)
  mutations_before_last_save.changed?(attr_name.to_s, **options)
end

Целевой метод для атрибутных методов *_previously_changed?.

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

# File activemodel/lib/active_model/dirty.rb, line 315
def attribute_previously_was(attr_name)
  mutations_before_last_save.original_value(attr_name.to_s)
end

Целевой метод для атрибутных методов *_previously_was.

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

# File activemodel/lib/active_model/dirty.rb, line 305
def attribute_was(attr_name)
  mutations_from_database.original_value(attr_name.to_s)
end

Целевой метод для атрибутных методов *_was.

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

# File activemodel/lib/active_model/dirty.rb, line 295
def changed
  mutations_from_database.changed_attribute_names
end

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

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

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

# File activemodel/lib/active_model/dirty.rb, line 286
def changed?
  mutations_from_database.any_changes?
end

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

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

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

# File activemodel/lib/active_model/dirty.rb, line 343
def changed_attributes
  mutations_from_database.changed_values
end

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

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

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

# File activemodel/lib/active_model/dirty.rb, line 353
def changes
  mutations_from_database.changes
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 272
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 в previous_changes, а mutations_from_database — в mutations_before_last_save соответственно.

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

# File activemodel/lib/active_model/dirty.rb, line 241
attribute_method_suffix "_previously_changed?", "_changed?", parameters: "**options"

Этот метод генерируется для каждого атрибута.

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

person = Person.new(name: 'Chris')
person.name = 'Jason'
person.name_change # => ['Chris', 'Jason']
person.clear_name_change
person.name_change # => nil

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

# File activemodel/lib/active_model/dirty.rb, line 331
def clear_attribute_changes(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 325
def clear_changes_information
  @mutations_before_last_save = nil
  forget_attribute_assignments
  @mutations_from_database = nil
end

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

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

# File activemodel/lib/active_model/dirty.rb, line 363
def previous_changes
  mutations_before_last_save.changes
end

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

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

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

# File activemodel/lib/active_model/dirty.rb, line 217

Этот метод генерируется для каждого атрибута.

Восстанавливает старое значение атрибута.

person = Person.new
person.name = 'Amanda'
person.restore_name!
person.name # => nil

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

# File activemodel/lib/active_model/dirty.rb, line 320
def restore_attributes(attr_names = changed)
  attr_names.each { |attr_name| restore_attribute!(attr_name) }
end

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