Module: Mongoid::Document
- Extended by:
- ActiveSupport::Concern
- Includes:
- Components
- Defined in:
- lib/mongoid/document.rb,
lib/mongoid/railties/document.rb
Overview
This is the base module for all domain objects that need to be persisted to the database as documents.
Defined Under Namespace
Modules: ClassMethods
Constant Summary
Constants included from Components
Constants included from Callbacks
Constants included from Copyable
Instance Attribute Summary collapse
-
#new_record ⇒ Object
readonly
Returns the value of attribute new_record.
Attributes included from Keys
Attributes included from Attributes
Instance Method Summary collapse
-
#<=>(other) ⇒ Integer
Default comparison is via the string version of the id.
-
#==(other) ⇒ true, false
Performs equality checking on the document ids.
-
#===(other) ⇒ true, false
Performs class equality checking.
-
#_destroy ⇒ Object
Used in conjunction with fields_for to build a form element for the destruction of this association.
-
#as_document ⇒ Hash
Return a hash of the entire document hierarchy from this document and below.
-
#becomes(klass) ⇒ Document
Returns an instance of the specified class with the attributes and errors of the current document.
-
#eql?(other) ⇒ true, false
Delegates to ==.
-
#freeze ⇒ Document
Freezes the internal attributes of the document.
-
#frozen? ⇒ true, false
Checks if the document is frozen.
-
#hash ⇒ Integer
Delegates to id in order to allow two records of the same type and id to work with something like:.
-
#identify ⇒ BSON::ObjectId, String
Generate an id for this
Document
. -
#initialize(attrs = nil) ⇒ Document
Instantiate a new
Document
, setting the Document’s attributes if given. -
#reload ⇒ Document
Reloads the
Document
attributes from the database. -
#to_a ⇒ Array<Document>
Return an array with this
Document
only in it.
Methods included from Components
Methods included from Validations
#begin_validate, #exit_validate, #read_attribute_for_validation, #valid?, #validated?
Methods included from State
#destroyed=, #destroyed?, #new_record=, #new_record?, #persisted?, #pushable?, #settable?, #updateable?
Methods included from Sharding
#shard_key_fields, #shard_key_selector
Methods included from Serialization
Methods included from Safety
Methods included from Relations
#embedded?, #embedded_many?, #embedded_one?, #referenced_many?, #referenced_one?, #reload_relations
Methods included from Relations::Synchronization
#remove_inverse_keys, #syncable?, #synced, #synced?, #update_inverse_keys
Methods included from Relations::Reflections
#reflect_on_all_associations, #reflect_on_association
Methods included from Relations::Polymorphic
Methods included from Relations::Macros
Methods included from Relations::Builders
Methods included from Relations::Cascading
Methods included from Relations::Accessors
#build, #create_relation, #relation_exists?, #set_relation
Methods included from Persistence
#destroy, #insert, #remove, #save!, #update, #update_attribute, #update_attributes, #update_attributes!, #upsert
Methods included from Persistence::Atomic
#add_to_set, #bit, #inc, #pop, #pull, #pull_all, #push, #push_all, #rename, #set, #unset
Methods included from NestedAttributes
Methods included from Matchers
Methods included from Keys
#primary_key, #using_object_ids?
Methods included from Inspection
Methods included from Hierarchy
#_children, #_root, #hereditary?, #parentize, #remove_child, #reset_persisted_children
Methods included from Fields
#defaults, #fields, option, options
Methods included from Extras
Methods included from Dirty
#changes, #move_changes, #remove_change, #setters
Methods included from Collections
Methods included from Attributes
#attribute_present?, #read_attribute, #remove_attribute, #respond_to?, #write_attribute, #write_attributes
Methods included from Attributes::Processing
Methods included from Atomic
#add_atomic_pull, #atomic_delete_modifier, #atomic_insert_modifier, #atomic_path, #atomic_position, #atomic_pulls, #atomic_pushes, #atomic_selector, #atomic_sets, #atomic_unsets, #atomic_updates, #delayed_atomic_sets
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Mongoid::Attributes
Instance Attribute Details
#new_record ⇒ Object (readonly)
Returns the value of attribute new_record.
10 11 12 |
# File 'lib/mongoid/document.rb', line 10 def new_record @new_record end |
Instance Method Details
#<=>(other) ⇒ Integer
Default comparison is via the string version of the id.
20 21 22 |
# File 'lib/mongoid/document.rb', line 20 def <=>(other) attributes["_id"].to_s <=> other.attributes["_id"].to_s end |
#==(other) ⇒ true, false
Performs equality checking on the document ids. For more robust equality checking please override this method.
33 34 35 36 |
# File 'lib/mongoid/document.rb', line 33 def ==(other) self.class == other.class && attributes["_id"] == other.attributes["_id"] end |
#===(other) ⇒ true, false
Performs class equality checking.
46 47 48 |
# File 'lib/mongoid/document.rb', line 46 def ===(other) other.is_a?(self.class) end |
#_destroy ⇒ Object
Used in conjunction with fields_for to build a form element for the destruction of this association. Always returns false because Mongoid only supports immediate deletion of associations.
See ActionView::Helpers::FormHelper::fields_for for more info.
8 9 10 |
# File 'lib/mongoid/railties/document.rb', line 8 def _destroy false end |
#as_document ⇒ Hash
Return a hash of the entire document hierarchy from this document and below. Used when the attributes are needed for everything and not just the current document.
178 179 180 181 182 183 184 185 186 187 |
# File 'lib/mongoid/document.rb', line 178 def as_document attributes.tap do |attrs| relations.each_pair do |name, | if . relation = send(name) attrs[name] = relation.as_document unless relation.blank? end end end end |
#becomes(klass) ⇒ Document
Returns an instance of the specified class with the attributes and errors of the current document.
200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/mongoid/document.rb', line 200 def becomes(klass) unless klass.include?(Mongoid::Document) raise ArgumentError, 'A class which includes Mongoid::Document is expected' end klass.new.tap do |became| became.instance_variable_set('@attributes', @attributes) became.instance_variable_set('@errors', @errors) became.instance_variable_set('@new_record', new_record?) became.instance_variable_set('@destroyed', destroyed?) end end |
#eql?(other) ⇒ true, false
Delegates to ==. Used when needing checks in hashes.
58 59 60 |
# File 'lib/mongoid/document.rb', line 58 def eql?(other) self == (other) end |
#freeze ⇒ Document
Freezes the internal attributes of the document.
70 71 72 73 |
# File 'lib/mongoid/document.rb', line 70 def freeze attributes.freeze self end |
#frozen? ⇒ true, false
Checks if the document is frozen
83 84 85 |
# File 'lib/mongoid/document.rb', line 83 def frozen? raw_attributes.frozen? end |
#hash ⇒ Integer
Delegates to id in order to allow two records of the same type and id to work with something like:
[ Person.find(1), Person.find(2), Person.find(3) ] &
[ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
97 98 99 |
# File 'lib/mongoid/document.rb', line 97 def hash raw_attributes["_id"].hash end |
#identify ⇒ BSON::ObjectId, String
Generate an id for this Document
.
107 108 109 |
# File 'lib/mongoid/document.rb', line 107 def identify Identity.new(self).create end |
#initialize(attrs = nil) ⇒ Document
Instantiate a new Document
, setting the Document’s attributes if given. If no attributes are provided, they will be initialized with an empty Hash
.
If a primary key is defined, the document’s id will be set to that key, otherwise it will be set to a fresh BSON::ObjectId
string.
124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/mongoid/document.rb', line 124 def initialize(attrs = nil) building do @new_record = true @attributes = apply_default_attributes process(attrs) do yield self if block_given? identify end run_callbacks(:initialize) { self } end end |
#reload ⇒ Document
Reloads the Document
attributes from the database. If the document has not been saved then an error will get raised if the configuration option was set.
146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/mongoid/document.rb', line 146 def reload reloaded = collection.find_one(:_id => id) if Mongoid.raise_not_found_error raise Errors::DocumentNotFound.new(self.class, id) if reloaded.nil? end @attributes = {}.merge(reloaded || {}) changed_attributes.clear apply_default_attributes tap do reload_relations run_callbacks(:initialize) end end |