W3cubDocs

/Ruby on Rails 5.2

module ActiveRecord::AttributeMethods::Dirty

Included modules:
ActiveModel::Dirty

Public Instance Methods

attribute_before_last_save(attr_name) Show source
# 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)
end

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

attribute_change_to_be_saved(attr_name) Show source
# File activerecord/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

Alias for attribute_change

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

Alias for attribute_was

attributes_in_database() Show source
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 118
def attributes_in_database
  mutations_from_database.changed_values
end

Alias for changed_attributes

changed_attribute_names_to_save() Show source
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 113
def changed_attribute_names_to_save
  mutations_from_database.changed_attribute_names
end

Alias for changed

changes_to_save() Show source
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 108
def changes_to_save
  mutations_from_database.changes
end

Alias for changes

has_changes_to_save?() Show source
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 103
def has_changes_to_save?
  mutations_from_database.any_changes?
end

Alias for changed?

reload(*) Show source
# File activerecord/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

reload the record and clears changed attributes.

Calls superclass method
saved_change_to_attribute(attr_name) Show source
# File activerecord/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

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

saved_change_to_attribute?(attr_name, **options) Show source
# File activerecord/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

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

saved_changes() Show source
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 83
def saved_changes
  mutations_before_last_save.changes
end

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

saved_changes?() Show source
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 78
def saved_changes?
  mutations_before_last_save.any_changes?
end

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

will_save_change_to_attribute?(attr_name, **options) Show source
# File activerecord/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

Alias for attribute_changed?

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.