модуль ActiveModel::Dirty

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

Активный Модель Изменения

Предоставляет способ отслеживать изменения в вашем объекте так же, как и 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_change # => ['Steph', 'Stephanie']

*_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 293
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 303
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 308
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 298
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 288
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 279
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 336
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 346
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 265
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 324
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 318
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 356
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 313
def restore_attributes(attr_names = changed)
  attr_names.each { |attr_name| restore_attribute!(attr_name) }
end

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