W3cubDocs

module ActiveRecord::AttributeMethods::Dirty

Included modules:: ActiveModel::Dirty

Public Instance Methods

attribute_before_last_save(attr_name) Show source

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

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 164
def attribute_before_last_save(attr_name)
  mutations_before_last_save.original_value(attr_name)
end

attribute_change(*) Show source

Calls superclass method

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 218
def attribute_change(*)
  emit_warning_if_needed("attribute_change", "saved_change_to_attribute")
  super
end

attribute_change_to_be_saved(attr_name) Show source

Alias for `attribute_change`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 184
def attribute_change_to_be_saved(attr_name)
  mutations_from_database.change_to_attribute(attr_name)
end

attribute_changed?(*) Show source

Calls superclass method

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 223
def attribute_changed?(*)
  emit_warning_if_needed("attribute_changed?", "saved_change_to_attribute?")
  super
end

attribute_in_database(attr_name) Show source

Alias for `attribute_was`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 189
def attribute_in_database(attr_name)
  mutations_from_database.original_value(attr_name)
end

attribute_was(*) Show source

Calls superclass method

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 213
def attribute_was(*)
  emit_warning_if_needed("attribute_was", "attribute_before_last_save")
  super
end

attributes_in_database() Show source

Alias for `changed_attributes`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 209
def attributes_in_database
  changes_to_save.transform_values(&:first)
end

changed(*) Show source

Calls superclass method ActiveModel::Dirty#changed

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 233
def changed(*)
  emit_warning_if_needed("changed", "saved_changes.keys")
  super
end

changed?(*) Show source

Calls superclass method ActiveModel::Dirty#changed?

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 228
def changed?(*)
  emit_warning_if_needed("changed?", "saved_changes?")
  super
end

changed_attribute_names_to_save() Show source

Alias for `changed`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 204
def changed_attribute_names_to_save
  changes_to_save.keys
end

changes_to_save() Show source

Alias for `changes`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 199
def changes_to_save
  mutations_from_database.changes
end

has_changes_to_save?() Show source

Alias for `changed?`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 194
def has_changes_to_save?
  mutations_from_database.any_changes?
end

reload(*) Show source

reload the record and clears changed attributes.

Calls superclass method

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 48
def reload(*)
  super.tap do
    @previous_mutation_tracker = nil
    clear_mutation_trackers
    @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
  end
end

save(*) Show source

Attempts to save the record and clears changed attributes if successful.

Calls superclass method

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 33
def save(*)
  if status = super
    changes_applied
  end
  status
end

save!(*) Show source

Attempts to save! the record and clears changed attributes if successful.

Calls superclass method

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 41
def save!(*)
  super.tap do
    changes_applied
  end
end

saved_change_to_attribute(attr_name) Show 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.

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”)`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 156
def saved_change_to_attribute(attr_name)
  mutations_before_last_save.change_to_attribute(attr_name)
end

saved_change_to_attribute?(attr_name, **options) Show source

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

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 143
def saved_change_to_attribute?(attr_name, **options)
  mutations_before_last_save.changed?(attr_name, **options)
end

saved_changes() Show source

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

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 174
def saved_changes
  mutations_before_last_save.changes
end

saved_changes?() Show source

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

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 169
def saved_changes?
  mutations_before_last_save.any_changes?
end

will_save_change_to_attribute?(attr_name, **options) Show source

Alias for `attribute_changed?`

# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 179
def will_save_change_to_attribute?(attr_name, **options)
  mutations_from_database.changed?(attr_name, **options)
end