module ActiveRecord::AttributeMethods::Dirty
Public Instance Methods
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 130 def attribute_before_last_save(attr_name) mutations_before_last_save.original_value(attr_name) end
Alias for attribute_change
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 150 def attribute_change_to_be_saved(attr_name) mutations_from_database.change_to_attribute(attr_name) end
Alias for attribute_was
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 155 def attribute_in_database(attr_name) mutations_from_database.original_value(attr_name) end
Alias for changed_attributes
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 175 def attributes_in_database changes_to_save.transform_values(&:first) end
Alias for changed
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 170 def changed_attribute_names_to_save changes_to_save.keys end
Alias for changes
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 165 def changes_to_save mutations_from_database.changes end
Alias for changed?
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 160 def has_changes_to_save? mutations_from_database.any_changes? end
reload
the record and clears changed attributes.
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 34 def reload(*) super.tap do @mutations_before_last_save = nil clear_mutation_trackers @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new end 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")
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 122 def saved_change_to_attribute(attr_name) mutations_before_last_save.change_to_attribute(attr_name) 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
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 109 def saved_change_to_attribute?(attr_name, **options) mutations_before_last_save.changed?(attr_name, **options) end
Returns a hash containing all the changes that were just saved.
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 140 def saved_changes mutations_before_last_save.changes end
Did the last call to save
have any changes to change?
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 135 def saved_changes? mutations_before_last_save.any_changes? end
Alias for attribute_changed?
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 145 def will_save_change_to_attribute?(attr_name, **options) mutations_from_database.changed?(attr_name, **options) end
Private Instance Methods
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 218 def _create_record(*) partial_writes? ? super(keys_for_partial_write) : super end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 214 def _update_record(*) partial_writes? ? super(keys_for_partial_write) : super end
ActiveModel::Dirty#attribute_will_change!
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 209 def attribute_will_change!(attr_name) super mutations_from_database.force_change(attr_name) end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 239 def cache_changed_attributes @cached_changed_attributes = changed_attributes yield ensure clear_changed_attributes_cache end
ActiveModel::Dirty#changes_include?
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 200 def changes_include?(attr_name) super || mutation_tracker.changed?(attr_name) end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 204 def clear_attribute_change(attr_name) mutation_tracker.forget_change(attr_name) mutations_from_database.forget_change(attr_name) end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 246 def clear_changed_attributes_cache remove_instance_variable(:@cached_changed_attributes) if defined?(@cached_changed_attributes) end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 230 def clear_mutation_trackers @mutation_tracker = nil @mutations_from_database = nil end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 226 def forget_attribute_assignments @attributes = @attributes.map(&:forgetting_assignment) end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 222 def keys_for_partial_write changed_attribute_names_to_save & self.class.column_names end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 186 def mutation_tracker unless defined?(@mutation_tracker) @mutation_tracker = nil end @mutation_tracker ||= AttributeMutationTracker.new(@attributes) end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 235 def mutations_before_last_save @mutations_before_last_save ||= NullMutationTracker.instance end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 193 def mutations_from_database unless defined?(@mutations_from_database) @mutations_from_database = nil end @mutations_from_database ||= mutation_tracker end
# File activerecord/lib/active_record/attribute_methods/dirty.rb, line 180 def write_attribute_without_type_cast(attr_name, _) result = super clear_attribute_change(attr_name) result end