123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Stateful

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Composable, Document, GlobalDiscriminatorKeyAssignment::InvalidFieldHost
Defined in: lib/mongoid/stateful.rb

Overview

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

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#_destroy (readonly)

Alias for #flagged_for_destroy?.

[ GitHub ] 

  


# File 'lib/mongoid/stateful.rb', line 77



alias :_destroy :flagged_for_destroy?


  








  

    #destroyed=(value)   (rw)
  

  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 10



attr_writer :destroyed, :flagged_for_destroy, :previously_new_record


  








  

    #destroyed?  ⇒ true | false  (rw)
  



  

    

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


  





    

    
Examples:

        


Is the document destroyed?



      
person.destroyed?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    True if destroyed, false if not.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 87



def destroyed?
  @destroyed ||= false
end


  








  

    #flagged_for_destroy=(value)   (rw)
  

  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 10



attr_writer :destroyed, :flagged_for_destroy, :previously_new_record


  








  

    #flagged_for_destroy?  ⇒ true | false  (rw)
    Also known as: #marked_for_destruction?, #_destroy
  



  

    

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


  





    

    
Examples:

        


Is the document flagged?



      
document.flagged_for_destroy?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    If the document is flagged.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 73



def flagged_for_destroy?
  @flagged_for_destroy ||= false
end


  








  

    #marked_for_destruction?   (readonly)
  



  

    

Alias for #flagged_for_destroy?.


  



  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 76



alias :marked_for_destruction? :flagged_for_destroy?


  








  

    #new_record=(new_value)  ⇒ true | false  (rw)
  



  

    

Sets whether the document has been persisted to the database.


  





  
Parameters:


    
  
  • 
    new_value
    (true | false)
—    
    

    The value to set.
    

    
  
    • 



Returns:


    
  
  • 
    (true | false)
—    
    

    The set value.
    

    
  
    • 





  [ GitHub ]


  

  


# 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?  ⇒ true | false  (rw)
  



  

    

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.


  





    

    
Examples:

        


Is the document new?



      
person.new_record?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    True if new, false if not.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 33



def new_record?
  @new_record ||= false
end


  








  

    #persisted?  ⇒ true | false  (readonly)
  



  

    

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


  





    

    
Examples:

        


Is the document persisted?



      
person.persisted?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    True if persisted, false if not.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 53



def persisted?
  !new_record? && !destroyed?
end


  








  

    #previously_new_record=(value)   (rw)
  

  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 10



attr_writer :destroyed, :flagged_for_destroy, :previously_new_record


  








  

    #previously_new_record?  ⇒ true | false  (rw)
  



  

    

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.


  





  
Returns:


    
  
  • 
    (true | false)
—    
    

    True if was just created, false if not.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 42



def previously_new_record?
  @previously_new_record ||= false
end


  








  

    #previously_persisted?  ⇒ true | false  (readonly)
  



  

    

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


  





  
Returns:


    
  
  • 
    (true | false)
—    
    

    True if was persisted but now destroyed, otherwise false.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 62



def previously_persisted?
  !new_record? && destroyed?
end


  








  

    #pushable?  ⇒ true | false  (readonly)
  



  

    

Determine if the document can be pushed.


  





    

    
Examples:

        


Is this pushable?



      
person.pushable?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    Is the document new and embedded?
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 97



def pushable?
  new_record? &&
    embedded_many? &&
    _parent.persisted? &&
    !_parent.delayed_atomic_sets[atomic_path]
end


  








  

    #readonly?  ⇒ true | false  (readonly)
  



  

    

Is the document readonly?


  





    

    
Examples:

        


Is the document readonly?



      
document.readonly?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    If the document is readonly.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 127



def readonly?
  if Mongoid.legacy_readonly
    __selected_fields != nil
  else
    @readonly ||= false
  end
end


  








  

    #settable?  ⇒ true | false  (readonly)
  



  

    

Determine if the document can be set.


  





    

    
Examples:

        


Is this settable?



      
person.settable?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    Is this document a new embeds one?
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 141



def settable?
  new_record? && embedded_one? && _parent.persisted?
end


  








  

    #updateable?  ⇒ true | false  (readonly)
  



  

    

Is the document updateable?


  





    

    
Examples:

        


Is the document updateable?



      
person.updateable?

  


Returns:


    
  
  • 
    (true | false)
—    
    

    If the document is changed and persisted.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 151



def updateable?
  persisted? && changed?
end


  







Instance Method Details



  

    #readonly!  ⇒ true | false 
  



  

    

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


  





    

    
Examples:

        


Flag the document as readonly.



      
document.readonly!

  


Returns:


    
  
  • 
    (true | false)
—    
    

    true if the document was successfully marked readonly, false otherwise.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 112



def readonly!
  if Mongoid.legacy_readonly
    Mongoid::Warnings.warn_legacy_readonly
    false
  else
    @readonly = true
  end
end


  








  

    #reset_readonly   (private)
  

  [ GitHub ]


  

  


# File 'lib/mongoid/stateful.rb', line 157



def reset_readonly
  self.__selected_fields = nil
end