module ActiveRecord::AttributeMethods::Dirty

Public Instance Methods

attribute_before_last_save(attr_name) click to toggle source

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

# 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.to_s)
end
attribute_change_to_be_saved(attr_name) click to toggle source

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.

# File 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) click to toggle source

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

# File 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_database() click to toggle source

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

# File lib/active_record/attribute_methods/dirty.rb, line 154
def attributes_in_database
  mutations_from_database.changed_values
end
changed_attribute_names_to_save() click to toggle source

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

# File lib/active_record/attribute_methods/dirty.rb, line 144
def changed_attribute_names_to_save
  mutations_from_database.changed_attribute_names
end
changes_to_save() click to toggle source

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

# File lib/active_record/attribute_methods/dirty.rb, line 138
def changes_to_save
  mutations_from_database.changes
end
has_changes_to_save?() click to toggle source

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

# File lib/active_record/attribute_methods/dirty.rb, line 132
def has_changes_to_save?
  mutations_from_database.any_changes?
end
reload(*) click to toggle source

reload the record and clears changed attributes.

Calls superclass method
# File 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) click to toggle source

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

# File 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) click to toggle source

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

# File 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_changes() click to toggle source

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

# File lib/active_record/attribute_methods/dirty.rb, line 83
def saved_changes
  mutations_before_last_save.changes
end
saved_changes?() click to toggle source

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

# 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) click to toggle source

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

# File 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

Private Instance Methods

_create_record(attribute_names = attribute_names_for_partial_writes) click to toggle source
Calls superclass method
# File lib/active_record/attribute_methods/dirty.rb, line 200
def _create_record(attribute_names = attribute_names_for_partial_writes)
  id = super
  changes_applied
  id
end
_touch_row(attribute_names, time) click to toggle source
Calls superclass method
# File lib/active_record/attribute_methods/dirty.rb, line 165
def _touch_row(attribute_names, time)
  @_touch_attr_names = Set.new(attribute_names)

  affected_rows = super

  if @_skip_dirty_tracking ||= false
    clear_attribute_changes(@_touch_attr_names)
    return affected_rows
  end

  changes = {}
  @attributes.keys.each do |attr_name|
    next if @_touch_attr_names.include?(attr_name)

    if attribute_changed?(attr_name)
      changes[attr_name] = _read_attribute(attr_name)
      _write_attribute(attr_name, attribute_was(attr_name))
      clear_attribute_change(attr_name)
    end
  end

  changes_applied
  changes.each { |attr_name, value| _write_attribute(attr_name, value) }

  affected_rows
ensure
  @_touch_attr_names, @_skip_dirty_tracking = nil, nil
end
_update_record(attribute_names = attribute_names_for_partial_writes) click to toggle source
Calls superclass method
# File lib/active_record/attribute_methods/dirty.rb, line 194
def _update_record(attribute_names = attribute_names_for_partial_writes)
  affected_rows = super
  changes_applied
  affected_rows
end
attribute_names_for_partial_writes() click to toggle source
# File lib/active_record/attribute_methods/dirty.rb, line 206
def attribute_names_for_partial_writes
  partial_writes? ? changed_attribute_names_to_save : attribute_names
end
write_attribute_without_type_cast(attr_name, value) click to toggle source
Calls superclass method
# File lib/active_record/attribute_methods/dirty.rb, line 159
def write_attribute_without_type_cast(attr_name, value)
  result = super
  clear_attribute_change(attr_name)
  result
end