Module: ActiveModel::Dirty

Extended by:
ActiveSupport::Concern
Includes:
AttributeMethods
Defined in:
lib/active_model/dirty.rb

Overview

Active Model Dirty

Provides a way to track changes in your object in the same way as Active Record does.

The requirements for implementing ActiveModel::Dirty are:

  • include ActiveModel::Dirty in your object.

  • Call define_attribute_methods passing each method you want to track.

  • Call [attr_name]_will_change! before each change to the tracked attribute.

  • Call changes_applied after the changes are persisted.

  • Call clear_changes_information when you want to reset the changes information.

  • Call restore_attributes when you want to restore previous data.

A minimal implementation could be:

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

A newly instantiated Person object is unchanged:

person = Person.new
person.changed? # => false

Change the name:

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

Save the changes:

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

Reset the changes:

person.previous_changes         # => {"name" => [nil, "Bill"]}
person.name_previously_changed? # => true
person.name_previous_change     # => [nil, "Bill"]
person.reload!
person.previous_changes         # => {}

Rollback the changes:

person.name = "Uncle Bob"
person.rollback!
person.name          # => "Bill"
person.name_changed? # => false

Assigning the same value leaves the attribute unchanged:

person.name = 'Bill'
person.name_changed? # => false
person.name_change   # => nil

Which attributes have changed?

person.name = 'Bob'
person.changed # => ["name"]
person.changes # => {"name" => ["Bill", "Bob"]}

If an attribute is modified in-place then make use of [attribute_name]_will_change! to mark that the attribute is changing. Otherwise Active Model can't track changes to in-place attributes. Note that Active Record can detect in-place modifications automatically. You do not need to call [attribute_name]_will_change! on Active Record models.

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

Constant Summary

Constants included from AttributeMethods

AttributeMethods::AttrNames, AttributeMethods::CALL_COMPILABLE_REGEXP, AttributeMethods::NAME_COMPILABLE_REGEXP

Instance Method Summary collapse

Methods included from AttributeMethods

#attribute_missing, #method_missing, #respond_to?, #respond_to_without_attributes?

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActiveModel::AttributeMethods

Instance Method Details

#attribute_changed?(attr, from: OPTION_NOT_GIVEN, to: OPTION_NOT_GIVEN) ⇒ Boolean

Handles *_changed? for method_missing.

Returns:

  • (Boolean) 


175
176
177
178
179
 
# File 'lib/active_model/dirty.rb', line 175

def attribute_changed?(attr, from: OPTION_NOT_GIVEN, to: OPTION_NOT_GIVEN) # :nodoc:
  !!changes_include?(attr) &&
    (to == OPTION_NOT_GIVEN || to == _read_attribute(attr)) &&
    (from == OPTION_NOT_GIVEN || from == changed_attributes[attr])
end

#attribute_changed_in_place?(attr_name) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


251
252
253
 
# File 'lib/active_model/dirty.rb', line 251

def attribute_changed_in_place?(attr_name) # :nodoc:
  mutations_from_database.changed_in_place?(attr_name)
end

#attribute_previously_changed?(attr) ⇒ Boolean

Handles *_previously_changed? for method_missing.

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/active_model/dirty.rb', line 187

def attribute_previously_changed?(attr) #:nodoc:
  previous_changes_include?(attr)
end

#attribute_was(attr) ⇒ Object

Handles *_was for method_missing.



182
183
184
 
# File 'lib/active_model/dirty.rb', line 182

def attribute_was(attr) # :nodoc:
  attribute_changed?(attr) ? changed_attributes[attr] : _read_attribute(attr)
end

#changed ⇒ Object

Returns an array with the name of the attributes with unsaved changes.

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



170
171
172
 
# File 'lib/active_model/dirty.rb', line 170

def changed
  changed_attributes.keys
end

#changed? ⇒ Boolean

Returns true if any of the attributes have unsaved changes, false otherwise.

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

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/active_model/dirty.rb', line 161

def changed?
  changed_attributes.present?
end

#changed_attributes ⇒ Object

Returns a hash of the attributes with unsaved changes indicating their original values like attr => original value.

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



218
219
220
221
222
223
224
225
226
 
# File '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

#changes ⇒ Object

Returns a hash of changed attributes indicating their original and new values like attr => [original value, new value].

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



234
235
236
237
238
 
# File 'lib/active_model/dirty.rb', line 234

def changes
  cache_changed_attributes do
    ActiveSupport::HashWithIndifferentAccess[changed.map { |attr| [attr, attribute_change(attr)] }]
  end
end

#changes_applied ⇒ Object

Clears dirty data and moves changes to previously_changed and mutations_from_database to mutations_before_last_save respectively.



146
147
148
149
150
151
152
153
154
 
# File '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

#clear_attribute_changes(attr_names) ⇒ Object 



205
206
207
208
209
210
 
# File '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 ⇒ Object

Clears all dirty data: current changes and previous changes.



197
198
199
200
201
202
203
 
# File '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

#initialize_dup(other) ⇒ Object

:nodoc:



134
135
136
137
138
139
140
141
142
 
# File 'lib/active_model/dirty.rb', line 134

def initialize_dup(other) # :nodoc:
  super
  if self.class.respond_to?(:_default_attributes)
    @attributes = self.class._default_attributes.map do |attr|
      attr.with_value_from_user(@attributes.fetch_value(attr.name))
    end
  end
  @mutations_from_database = nil
end

#previous_changes ⇒ Object

Returns a hash of attributes that were changed before the model was saved.

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



246
247
248
249
 
# File 'lib/active_model/dirty.rb', line 246

def previous_changes
  @previously_changed ||= ActiveSupport::HashWithIndifferentAccess.new
  @previously_changed.merge(mutations_before_last_save.changes)
end

#restore_attributes(attributes = changed) ⇒ Object

Restore all previous data of the provided attributes.



192
193
194
 
# File 'lib/active_model/dirty.rb', line 192

def restore_attributes(attributes = changed)
  attributes.each { |attr| restore_attribute! attr }
end