123456789_123456789_123456789_123456789_123456789_

Module: ActiveRecord::AttributeMethods::Dirty

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveSupport::Concern
Instance Chain:
self, ::ActiveModel::Dirty, ::ActiveModel::AttributeMethods
Defined in: activerecord/lib/active_record/attribute_methods/dirty.rb

Constant Summary

::ActiveModel::AttributeMethods - Included

CALL_COMPILABLE_REGEXP, NAME_COMPILABLE_REGEXP

Class Method Summary

::ActiveSupport::Concern - Extended

append_features, class_methods, included

Instance Attribute Summary

::ActiveModel::Dirty - Included

#attribute_aliases, #attribute_aliases?, #attribute_method_matchers, #attribute_method_matchers?,
#changed?

Returns true if any of the attributes have unsaved changes, false otherwise.

Instance Method Summary

::ActiveModel::Dirty - Included

#changed

Returns an array with the name of the attributes with unsaved changes.
#changed_attributes

Returns a hash of the attributes with unsaved changes indicating their original values like attr => original value.
#changes

Returns a hash of changed attributes indicating their original and new values like attr => [original value, new value].
#changes_applied

Clears dirty data and moves changes to previously_changed and mutations_from_database to mutations_before_last_save respectively.
#clear_attribute_changes,
#clear_changes_information

Clears all dirty data: current changes and previous changes.
#previous_changes

Returns a hash of attributes that were changed before the model was saved.
#restore_attributes

Restore all previous data of the provided attributes.

::ActiveModel::AttributeMethods - Included

#attribute_missing

attribute_missing is like method_missing, but for attributes.
#method_missing

Allows access to the object attributes, which are held in the hash returned by #attributes, as though they were first-class methods.
#respond_to?,
#respond_to_without_attributes?

A Person instance with a name attribute can ask person.respond_to?(:name), person.respond_to?(:name=), and person.respond_to?(:name?) which will all return true.

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActiveModel::AttributeMethods

DSL Calls

included

[ GitHub ] 


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 12

included do
  if self < ::ActiveRecord::Timestamp
    raise "You cannot include Dirty after Timestamp"
  end

  class_attribute :partial_writes, instance_writer: false, default: true

  # Attribute methods for "changed in last call to save?"
  attribute_method_affix(prefix: "saved_change_to_", suffix: "?")
  attribute_method_prefix("saved_change_to_")
  attribute_method_suffix("_before_last_save")

  # Attribute methods for "will change if I call save?"
  attribute_method_affix(prefix: "will_save_change_to_", suffix: "?")
  attribute_method_suffix("_change_to_be_saved", "_in_database")
end

Instance Attribute Details

#has_changes_to_save? ⇒ Boolean (readonly)

Alias for changed?

[ GitHub ] 

  


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



def has_changes_to_save?
  mutations_from_database.any_changes?
end


  








  

    #saved_changes?  ⇒ Boolean  (readonly)
  



  

    

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


  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 78



def saved_changes?
  mutations_before_last_save.any_changes?
end


  







Instance Method Details



  

    #attribute_before_last_save(attr_name)  
  



  

    

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


  



  [ GitHub ]


  

  


# 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


  








  

    #attribute_change_to_be_saved(attr_name)  
  



  

    

Alias for attribute_change


  



  [ GitHub ]


  

  


# 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


  








  

    #attribute_in_database(attr_name)  
  



  

    

Alias for attribute_was


  



  [ GitHub ]


  

  


# 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


  








  

    #attributes_in_database  
  



  

    

Alias for changed_attributes


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 118



def attributes_in_database
  mutations_from_database.changed_values
end


  








  

    #changed_attribute_names_to_save  
  



  

    

Alias for changed


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 113



def changed_attribute_names_to_save
  mutations_from_database.changed_attribute_names
end


  








  

    #changes_to_save  
  



  

    

Alias for changes


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 108



def changes_to_save
  mutations_from_database.changes
end


  








  

    #reload  
  



  

    

reload the record and clears changed attributes.


  



  [ GitHub ]


  

  


# 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


  








  

    #saved_change_to_attribute(attr_name)  
  



  

    

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


  



  [ GitHub ]


  

  


# 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


  








  

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



  

    

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


  





  


  [ GitHub ]


  

  


# 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


  








  

    #saved_changes   (readonly)
  



  

    

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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/attribute_methods/dirty.rb', line 83



def saved_changes
  mutations_before_last_save.changes
end


  








  

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



  

    

Alias for attribute_changed?


  





  


  [ GitHub ]


  

  


# 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