Spec-Zone.ru › Ruby on Rails 4.2

модуль ActiveModel::Dirty

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

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

Предоставляет способ отслеживания изменений в вашем объекте так же, как это делает 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)
    @name = name
  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("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 = "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 Модель не может отслеживать изменения в атрибутах, изменённых непосредственно. Обратите внимание, что Active Record может автоматически обнаруживать изменения, внесённые непосредственно. Вам не нужно вызывать +[имя_атрибута]_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 141
def changed
  changed_attributes.keys
end

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

person.changed # => []
person.name = 'bob'
person.changed # => ["name"]
changed?() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 132
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 171
def changed_attributes
  @changed_attributes ||= ActiveSupport::HashWithIndifferentAccess.new
end

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

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

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

person.changes # => {}
person.name = 'bob'
person.changes # => { "name" => ["bill", "bob"] }
previous_changes() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 161
def previous_changes
  @previously_changed ||= ActiveSupport::HashWithIndifferentAccess.new
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 189
def restore_attributes(attributes = changed)
  attributes.each { |attr| restore_attribute! attr }
end

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

Приватные методы экземпляра

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

Удаляет текущие изменения и делает их доступными через previous_changes.

clear_attribute_changes(attributes) Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 267
def clear_attribute_changes(attributes) # :doc:
  attributes_changed_by_setter.except!(*attributes)
end

Удаляет информацию о изменениях для предоставленных атрибутов.

clear_changes_information() Показать исходный код
# File activemodel/lib/active_model/dirty.rb, line 207
def clear_changes_information # :doc:
  @previously_changed = ActiveSupport::HashWithIndifferentAccess.new
  @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
end

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

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

Spec-Zone.ru

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