module Mongoid::Dirty

Public Instance Methods

changed() click to toggle source

Get the changed attributes for the document.

@example Get the changed attributes.

model.changed

@return [ Array<String> ] The changed attributes.

@since 2.4.0

# File lib/mongoid/dirty.rb, line 13
def changed
  changed_attributes.keys
end
changed?() click to toggle source

Has the document changed?

@example Has the document changed?

model.changed?

@return [ true, false ] If the document is changed.

@since 2.4.0

# File lib/mongoid/dirty.rb, line 25
def changed?
  changes.values.any? { |val| val } || children_changed?
end
changed_attributes() click to toggle source

Get the attribute changes.

@example Get the attribute changes.

model.changed_attributes

@return [ Hash<String, Object> ] The attribute changes.

@since 2.4.0

# File lib/mongoid/dirty.rb, line 51
def changed_attributes
  @changed_attributes ||= {}
end
changes() click to toggle source

Get all the changes for the document.

@example Get all the changes.

model.changes

@return [ Hash<String, Array<Object, Object> ] The changes.

@since 2.4.0

# File lib/mongoid/dirty.rb, line 63
def changes
  _changes = {}
  changed.each do |attr|
    change = attribute_change(attr)
    _changes[attr] = change if change
  end
  _changes
end
children_changed?() click to toggle source

Have any children (embedded documents) of this document changed?

@example Have any children changed?

model.children_changed?

@return [ true, false ] If any children have changed.

@since 2.4.1

# File lib/mongoid/dirty.rb, line 37
def children_changed?
  _children.any? do |child|
    child.changed?
  end
end
move_changes() click to toggle source

Call this method after save, so the changes can be properly switched.

This will unset the memoized children array, set new record to false, set the document as validated, and move the dirty changes.

@example Move the changes to previous.

person.move_changes

@since 2.1.0

# File lib/mongoid/dirty.rb, line 81
def move_changes
  @_children = nil
  @previous_changes = changes
  Atomic::UPDATES.each do |update|
    send(update).clear
  end
  changed_attributes.clear
end
post_persist() click to toggle source

Things that need to execute after a document has been persisted.

@example Handle post persistence.

document.post_persist

@since 3.0.0

# File lib/mongoid/dirty.rb, line 96
def post_persist
  reset_persisted_children
  move_changes
  Threaded.clear_options!
end
previous_changes() click to toggle source

Get the previous changes on the document.

@example Get the previous changes.

model.previous_changes

@return [ Hash<String, Array<Object, Object> ] The previous changes.

@since 2.4.0

# File lib/mongoid/dirty.rb, line 110
def previous_changes
  @previous_changes ||= {}
end
remove_change(name) click to toggle source

Remove a change from the dirty attributes hash. Used by the single field atomic updators.

@example Remove a flagged change.

model.remove_change(:field)

@param [ Symbol, String ] name The name of the field.

@since 2.1.0

# File lib/mongoid/dirty.rb, line 123
def remove_change(name)
  changed_attributes.delete(name.to_s)
end
setters() click to toggle source

Gets all the new values for each of the changed fields, to be passed to a MongoDB $set modifier.

@example Get the setters for the atomic updates.

person = Person.new(:title => "Sir")
person.title = "Madam"
person.setters # returns { "title" => "Madam" }

@return [ Hash ] A Hash of atomic setters.

@since 2.0.0

# File lib/mongoid/dirty.rb, line 138
def setters
  mods = {}
  changes.each_pair do |name, changes|
    if changes
      old, new = changes
      field = fields[name]
      key = atomic_attribute_name(name)
      if field && field.resizable?
        field.add_atomic_changes(self, name, key, mods, new, old)
      else
        mods[key] = new unless atomic_unsets.include?(key)
      end
    end
  end
  mods
end