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



73
74
75
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 73

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



93
94
95
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 93

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



98
99
100
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 98

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

#attributes_in_database ⇒ Object

Alias for changed_attributes



118
119
120
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 118

def attributes_in_database
  mutations_from_database.changed_values
end

#changed_attribute_names_to_save ⇒ Object

Alias for changed



113
114
115
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 113

def changed_attribute_names_to_save
  mutations_from_database.changed_attribute_names
end

#changes_to_save ⇒ Object

Alias for changes



108
109
110
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 108

def changes_to_save
  mutations_from_database.changes
end

#has_changes_to_save? ⇒ Boolean

Alias for changed?

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 103

def has_changes_to_save?
  mutations_from_database.any_changes?
end

#reload ⇒ Object

reload the record and clears changed attributes.



30
31
32
33
34
35
36
37
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 30

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



65
66
67
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 65

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) 


52
53
54
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 52

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

#saved_changes ⇒ Object

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



83
84
85
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 83

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) 


78
79
80
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 78

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) 


88
89
90
 
# File 'lib/active_record/attribute_methods/dirty.rb', line 88

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