1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/activemodel/lib/active_model/dirty.rb

206 lines
6.2 KiB
Ruby
Raw Normal View History

2010-03-27 14:03:36 -04:00
require 'active_support/hash_with_indifferent_access'
require 'active_support/core_ext/object/duplicable'
2010-03-27 14:03:36 -04:00
module ActiveModel
# == Active \Model \Dirty
#
# Provides a way to track changes in your object in the same way as
# Active Record does.
#
2011-04-11 15:54:46 -04:00
# The requirements for implementing ActiveModel::Dirty are:
2010-01-16 16:56:20 -05:00
#
# * <tt>include ActiveModel::Dirty</tt> in your object.
# * Call <tt>define_attribute_methods</tt> passing each method you want to
# track.
# * Call <tt>attr_name_will_change!</tt> before each change to the tracked
# attribute.
# * Call <tt>changes_applied</tt> after the changes are persisted.
# * Call <tt>reset_changes</tt> when you want to reset the changes
# information.
#
2010-01-16 16:56:20 -05:00
# A minimal implementation could be:
#
2010-01-16 16:56:20 -05:00
# class Person
# include ActiveModel::Dirty
#
# define_attribute_methods :name
#
2010-01-16 16:56:20 -05:00
# def name
# @name
# end
#
2010-01-16 16:56:20 -05:00
# def name=(val)
# name_will_change! unless val == @name
2010-01-16 16:56:20 -05:00
# @name = val
# end
#
2010-01-16 16:56:20 -05:00
# def save
# # do persistence work
# changes_applied
2010-01-16 16:56:20 -05:00
# end
#
# def reload!
# reset_changes
# end
2010-01-16 16:56:20 -05:00
# end
#
# A newly instantiated object is unchanged:
#
# person = Person.find_by(name: 'Uncle Bob')
# person.changed? # => false
#
# Change the name:
#
# person.name = 'Bob'
# person.changed? # => true
# person.name_changed? # => true
# person.name_changed?(from: "Uncle Bob", to: "Bob") # => true
# person.name_was # => "Uncle Bob"
# person.name_change # => ["Uncle Bob", "Bob"]
# person.name = 'Bill'
# person.name_change # => ["Uncle Bob", "Bill"]
#
# Save the changes:
#
# person.save
# person.changed? # => false
# person.name_changed? # => false
#
# Reset the changes:
#
# person.previous_changes # => {"name" => ["Uncle Bob", "Bill"]}
# person.reload!
# person.previous_changes # => {}
#
# Assigning the same value leaves the attribute unchanged:
#
# person.name = 'Bill'
# person.name_changed? # => false
# person.name_change # => nil
#
# Which attributes have changed?
#
# person.name = 'Bob'
# person.changed # => ["name"]
# person.changes # => {"name" => ["Bill", "Bob"]}
#
# If an attribute is modified in-place then make use of <tt>[attribute_name]_will_change!</tt>
# to mark that the attribute is changing. Otherwise ActiveModel can't track
# changes to in-place attributes.
#
# person.name_will_change!
# person.name_change # => ["Bill", "Bill"]
# person.name << 'y'
# person.name_change # => ["Bill", "Billy"]
module Dirty
extend ActiveSupport::Concern
include ActiveModel::AttributeMethods
included do
attribute_method_suffix '_changed?', '_change', '_will_change!', '_was'
attribute_method_affix prefix: 'reset_', suffix: '!'
end
# Returns +true+ if any attribute have unsaved changes, +false+ otherwise.
#
# person.changed? # => false
# person.name = 'bob'
# person.changed? # => true
def changed?
changed_attributes.present?
end
# Returns an array with the name of the attributes with unsaved changes.
#
# person.changed # => []
# person.name = 'bob'
# person.changed # => ["name"]
def changed
changed_attributes.keys
end
# Returns a hash of changed attributes indicating their original
# and new values like <tt>attr => [original value, new value]</tt>.
#
# person.changes # => {}
# person.name = 'bob'
# person.changes # => { "name" => ["bill", "bob"] }
def changes
2013-01-06 16:00:10 -05:00
ActiveSupport::HashWithIndifferentAccess[changed.map { |attr| [attr, attribute_change(attr)] }]
end
# Returns a hash of attributes that were changed before the model was saved.
#
# person.name # => "bob"
# person.name = 'robert'
# person.save
# person.previous_changes # => {"name" => ["bob", "robert"]}
def previous_changes
@previously_changed ||= ActiveSupport::HashWithIndifferentAccess.new
end
# Returns a hash of the attributes with unsaved changes indicating their original
# values like <tt>attr => original value</tt>.
#
# person.name # => "bob"
# person.name = 'robert'
# person.changed_attributes # => {"name" => "bob"}
def changed_attributes
@changed_attributes ||= ActiveSupport::HashWithIndifferentAccess.new
end
2013-06-11 16:39:46 -04:00
# Handle <tt>*_changed?</tt> for +method_missing+.
def attribute_changed?(attr, options = {}) #:nodoc:
result = changed_attributes.include?(attr)
result &&= options[:to] == __send__(attr) if options.key?(:to)
result &&= options[:from] == changed_attributes[attr] if options.key?(:from)
result
2013-06-11 16:39:46 -04:00
end
2013-06-11 16:39:46 -04:00
# Handle <tt>*_was</tt> for +method_missing+.
def attribute_was(attr) # :nodoc:
2013-06-11 16:39:46 -04:00
attribute_changed?(attr) ? changed_attributes[attr] : __send__(attr)
end
private
# Removes current changes and makes them accessible through +previous_changes+.
def changes_applied
@previously_changed = changes
@changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
end
# Removes all dirty data: current changes and previous changes
def reset_changes
@previously_changed = ActiveSupport::HashWithIndifferentAccess.new
@changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
end
# Handle <tt>*_change</tt> for +method_missing+.
def attribute_change(attr)
[changed_attributes[attr], __send__(attr)] if attribute_changed?(attr)
end
# Handle <tt>*_will_change!</tt> for +method_missing+.
def attribute_will_change!(attr)
return if attribute_changed?(attr)
begin
value = __send__(attr)
value = value.duplicable? ? value.clone : value
rescue TypeError, NoMethodError
end
changed_attributes[attr] = value
end
# Handle <tt>reset_*!</tt> for +method_missing+.
def reset_attribute!(attr)
if attribute_changed?(attr)
__send__("#{attr}=", changed_attributes[attr])
changed_attributes.delete(attr)
end
end
end
end