Module: ActiveRecord::AttributeMethods::Dirty

Extended by:
ActiveSupport::Concern
Includes:
ActiveModel::Dirty
Defined in:
lib/active_record/attribute_methods/dirty.rb

Instance Method Summary collapse

Instance Method Details

#attribute_before_last_save(attr_name) ⇒ Object

Returns the original value of an attribute before the last save. Behaves similarly to attribute_was. This method is useful in after callbacks to get the original value of an attribute before the save that just occurred


76
77
78
# File 'lib/active_record/attribute_methods/dirty.rb', line 76

def attribute_before_last_save(attr_name)
  mutations_before_last_save.original_value(attr_name)
end

#attribute_change_to_be_saved(attr_name) ⇒ Object

Alias for attribute_change


96
97
98
# File 'lib/active_record/attribute_methods/dirty.rb', line 96

def attribute_change_to_be_saved(attr_name)
  mutations_from_database.change_to_attribute(attr_name)
end

#attribute_in_database(attr_name) ⇒ Object

Alias for attribute_was


101
102
103
# File 'lib/active_record/attribute_methods/dirty.rb', line 101

def attribute_in_database(attr_name)
  mutations_from_database.original_value(attr_name)
end

#attributes_in_databaseObject

Alias for changed_attributes


121
122
123
# File 'lib/active_record/attribute_methods/dirty.rb', line 121

def attributes_in_database
  changes_to_save.transform_values(&:first)
end

#changed_attribute_names_to_saveObject

Alias for changed


116
117
118
# File 'lib/active_record/attribute_methods/dirty.rb', line 116

def changed_attribute_names_to_save
  changes_to_save.keys
end

#changes_to_saveObject

Alias for changes


111
112
113
# File 'lib/active_record/attribute_methods/dirty.rb', line 111

def changes_to_save
  mutations_from_database.changes
end

#has_changes_to_save?Boolean

Alias for changed?

Returns:

  • (Boolean)

106
107
108
# File 'lib/active_record/attribute_methods/dirty.rb', line 106

def has_changes_to_save?
  mutations_from_database.any_changes?
end

#reloadObject

reload the record and clears changed attributes.


33
34
35
36
37
38
39
40
# File 'lib/active_record/attribute_methods/dirty.rb', line 33

def reload(*)
  super.tap do
    @previously_changed = ActiveSupport::HashWithIndifferentAccess.new
    @mutations_before_last_save = nil
    @attributes_changed_by_setter = ActiveSupport::HashWithIndifferentAccess.new
    @mutations_from_database = nil
  end
end

#saved_change_to_attribute(attr_name) ⇒ Object

Returns the change to an attribute during the last save. If the attribute was changed, the result will be an array containing the original value and the saved value.

Behaves similarly to attribute_change. This method is useful in after callbacks, to see the change in an attribute that just occurred

This method can be invoked as saved_change_to_name in instead of saved_change_to_attribute("name")


68
69
70
# File 'lib/active_record/attribute_methods/dirty.rb', line 68

def saved_change_to_attribute(attr_name)
  mutations_before_last_save.change_to_attribute(attr_name)
end

#saved_change_to_attribute?(attr_name, **options) ⇒ Boolean

Did this attribute change when we last saved? This method can be invoked as saved_change_to_name? instead of saved_change_to_attribute?("name"). Behaves similarly to attribute_changed?. This method is useful in after callbacks to determine if the call to save changed a certain attribute.

Options

from When passed, this method will return false unless the original value is equal to the given option

to When passed, this method will return false unless the value was changed to the given value

Returns:

  • (Boolean)

55
56
57
# File 'lib/active_record/attribute_methods/dirty.rb', line 55

def saved_change_to_attribute?(attr_name, **options)
  mutations_before_last_save.changed?(attr_name, **options)
end

#saved_changesObject

Returns a hash containing all the changes that were just saved.


86
87
88
# File 'lib/active_record/attribute_methods/dirty.rb', line 86

def saved_changes
  mutations_before_last_save.changes
end

#saved_changes?Boolean

Did the last call to save have any changes to change?

Returns:

  • (Boolean)

81
82
83
# File 'lib/active_record/attribute_methods/dirty.rb', line 81

def saved_changes?
  mutations_before_last_save.any_changes?
end

#will_save_change_to_attribute?(attr_name, **options) ⇒ Boolean

Alias for attribute_changed?

Returns:

  • (Boolean)

91
92
93
# File 'lib/active_record/attribute_methods/dirty.rb', line 91

def will_save_change_to_attribute?(attr_name, **options)
  mutations_from_database.changed?(attr_name, **options)
end