Module: ActiveRecord::AttributeMethods::Dirty

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

Constant Summary

Constants included from ActiveModel::AttributeMethods

ActiveModel::AttributeMethods::CALL_COMPILABLE_REGEXP, ActiveModel::AttributeMethods::NAME_COMPILABLE_REGEXP

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included

Methods included from ActiveModel::Dirty

#attribute_changed?, #attribute_changed_in_place?, #attribute_previously_changed?, #attribute_previously_was, #attribute_was, #changed, #changed?, #changed_attributes, #changes, #changes_applied, #clear_attribute_changes, #clear_changes_information, #initialize_dup, #previous_changes, #restore_attributes

Methods included from ActiveModel::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_before_last_save(attr_name) ⇒ Object

Returns the original value of an attribute before the last save.

This method is useful in after callbacks to get the original value of an attribute before the save that triggered the callbacks to run. It can be invoked as name_before_last_save instead of attribute_before_last_save("name").


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

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

#attribute_change_to_be_saved(attr_name) ⇒ Object

Returns the change to an attribute that will be persisted during the next save.

This method is useful in validations and before callbacks, to see the change to an attribute that will occur when the record is saved. It can be invoked as name_change_to_be_saved instead of attribute_change_to_be_saved("name").

If the attribute will change, the result will be an array containing the original value and the new value about to be saved.


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

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

#attribute_in_database(attr_name) ⇒ Object

Returns the value of an attribute in the database, as opposed to the in-memory value that will be persisted the next time the record is saved.

This method is useful in validations and before callbacks, to see the original value of an attribute prior to any changes about to be saved. It can be invoked as name_in_database instead of attribute_in_database("name").


127
128
129
# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 127

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

#attributes_in_databaseObject

Returns a hash of the attributes that will change when the record is next saved.

The hash keys are the attribute names, and the hash values are the original attribute values in the database (as opposed to the in-memory values about to be saved).


154
155
156
# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 154

def attributes_in_database
  mutations_from_database.changed_values
end

#changed_attribute_names_to_saveObject

Returns an array of the names of any attributes that will change when the record is next saved.


144
145
146
# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 144

def changed_attribute_names_to_save
  mutations_from_database.changed_attribute_names
end

#changes_to_saveObject

Returns a hash containing all the changes that will be persisted during the next save.


138
139
140
# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 138

def changes_to_save
  mutations_from_database.changes
end

#has_changes_to_save?Boolean

Will the next call to save have any changes to persist?

Returns:

  • (Boolean)

132
133
134
# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 132

def has_changes_to_save?
  mutations_from_database.any_changes?
end

#reloadObject

reload the record and clears changed attributes.


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

def reload(*)
  super.tap do
    @mutations_before_last_save = nil
    @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.

This method is useful in after callbacks, to see the change in an attribute during the save that triggered the callbacks to run. It can be invoked as saved_change_to_name instead of saved_change_to_attribute("name").


63
64
65
# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 63

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

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

Did this attribute change when we last saved?

This method is useful in after callbacks to determine if an attribute was changed during the save that triggered the callbacks to run. It can be invoked as saved_change_to_name? instead of saved_change_to_attribute?("name").

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)

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

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

#saved_changesObject

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


83
84
85
# File 'activerecord/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 'activerecord/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

Will this attribute change the next time we save?

This method is useful in validations and before callbacks to determine if the next call to save will change a particular attribute. It can be invoked as will_save_change_to_name? instead of will_save_change_to_attribute?("name").

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 will be changed to the given value

Returns:

  • (Boolean)

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

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