module Mongoid::Stateful

Mixin module included into Mongoid::Document which adds behavior for getting the various lifecycle states a document can transition through.

Attributes

destroyed[W]
flagged_for_destroy[W]
previously_new_record[W]

Public Instance Methods

_destroy()
destroyed?() click to toggle source

Returns true if the Document has been succesfully destroyed, and false if it hasn’t. This is determined by the variable @destroyed and NOT by checking the database.

@example Is the document destroyed?

person.destroyed?

@return [ true | false ] True if destroyed, false if not.

# File lib/mongoid/stateful.rb, line 87
def destroyed?
  @destroyed ||= false
end
flagged_for_destroy?() click to toggle source

Returns whether or not the document has been flagged for deletion, but not destroyed yet. Used for atomic pulls of child documents.

@example Is the document flagged?

document.flagged_for_destroy?

@return [ true | false ] If the document is flagged.

# File lib/mongoid/stateful.rb, line 73
def flagged_for_destroy?
  @flagged_for_destroy ||= false
end
Also aliased as: marked_for_destruction?, _destroy
marked_for_destruction?()
new_record=(new_value) click to toggle source

Sets whether the document has been persisted to the database.

@param [ true | false ] new_value The value to set.

@return [ true | false ] The set value.

# File lib/mongoid/stateful.rb, line 17
def new_record=(new_value)
  @new_record ||= false
  if @new_record && !new_value
    @previously_new_record = true
  end
  @new_record = new_value
end
new_record?() click to toggle source

Returns true if the document has not been persisted to the database, false if it has. This is determined by the variable @new_record and NOT if the object has an id.

@example Is the document new?

person.new_record?

@return [ true | false ] True if new, false if not.

# File lib/mongoid/stateful.rb, line 33
def new_record?
  @new_record ||= false
end
persisted?() click to toggle source

Checks if the document has been saved to the database. Returns false if the document has been destroyed.

@example Is the document persisted?

person.persisted?

@return [ true | false ] True if persisted, false if not.

# File lib/mongoid/stateful.rb, line 53
def persisted?
  !new_record? && !destroyed?
end
previously_new_record?() click to toggle source

Returns true if this document was just created – that is, prior to the last save, the object didn’t exist in the database and new_record? would have returned true.

@return [ true | false ] True if was just created, false if not.

# File lib/mongoid/stateful.rb, line 42
def previously_new_record?
  @previously_new_record ||= false
end
previously_persisted?() click to toggle source

Checks if the document was previously saved to the database but now it has been deleted.

@return [ true | false ] True if was persisted but now destroyed,

otherwise false.
# File lib/mongoid/stateful.rb, line 62
def previously_persisted?
  !new_record? && destroyed?
end
pushable?() click to toggle source

Determine if the document can be pushed.

@example Is this pushable?

person.pushable?

@return [ true | false ] Is the document new and embedded?

# File lib/mongoid/stateful.rb, line 97
def pushable?
  new_record? &&
    embedded_many? &&
    _parent.persisted? &&
    !_parent.delayed_atomic_sets[atomic_path]
end
readonly!() click to toggle source

Flags the document as readonly. Will cause a ReadonlyDocument error to be raised if the document is attempted to be saved, updated or destroyed.

@example Flag the document as readonly.

document.readonly!

@return [ true | false ] true if the document was successfully marked

readonly, false otherwise.
# File lib/mongoid/stateful.rb, line 112
def readonly!
  if Mongoid.legacy_readonly
    Mongoid::Warnings.warn_legacy_readonly
    false
  else
    @readonly = true
  end
end
readonly?() click to toggle source

Is the document readonly?

@example Is the document readonly?

document.readonly?

@return [ true | false ] If the document is readonly.

# File lib/mongoid/stateful.rb, line 127
def readonly?
  if Mongoid.legacy_readonly
    __selected_fields != nil
  else
    @readonly ||= false
  end
end
settable?() click to toggle source

Determine if the document can be set.

@example Is this settable?

person.settable?

@return [ true | false ] Is this document a new embeds one?

# File lib/mongoid/stateful.rb, line 141
def settable?
  new_record? && embedded_one? && _parent.persisted?
end
updateable?() click to toggle source

Is the document updateable?

@example Is the document updateable?

person.updateable?

@return [ true | false ] If the document is changed and persisted.

# File lib/mongoid/stateful.rb, line 151
def updateable?
  persisted? && changed?
end

Private Instance Methods

reset_readonly() click to toggle source
# File lib/mongoid/stateful.rb, line 157
def reset_readonly
  self.__selected_fields = nil
end