Class: Mongoid::Relations::Embedded::Many
- Includes:
- Batchable
- Defined in:
- lib/mongoid/relations/embedded/many.rb
Overview
This class handles the behaviour for a document that embeds many other documents within in it as an array.
Instance Attribute Summary
Attributes inherited from Proxy
#base, #loaded, #metadata, #target
Class Method Summary collapse
-
.builder(base, meta, object) ⇒ Builder
Return the builder that is responsible for generating the documents that will be used by this relation.
-
.embedded? ⇒ true
Returns true if the relation is an embedded one.
-
.foreign_key_suffix ⇒ nil
Returns the suffix of the foreign key field, either “_id” or “_ids”.
-
.macro ⇒ Symbol
Returns the macro for this relation.
-
.nested_builder(metadata, attributes, options) ⇒ NestedBuilder
Return the nested builder that is responsible for generating the documents that will be used by this relation.
-
.path(document) ⇒ Mongoid::Atomic::Paths::Embedded::Many
Get the path calculator for the supplied document.
-
.stores_foreign_key? ⇒ false
Tells the caller if this relation is one that stores the foreign key on its own objects.
-
.valid_options ⇒ Array<Symbol>
Get the valid options allowed with this relation.
-
.validation_default ⇒ true, false
Get the default validation setting for the relation.
Instance Method Summary collapse
-
#<<(*args) ⇒ Object
(also: #push)
Appends a document or array of documents to the relation.
-
#as_document ⇒ Array<Hash>
Get this relation as as its representation in the database.
-
#build(attributes = {}, options = {}, type = nil) {|doc| ... } ⇒ Document
(also: #new)
Builds a new document in the relation and appends it to the target.
-
#clear ⇒ Many
Clear the relation.
-
#concat(docs) ⇒ Array<Document>
Appends an array of documents to the relation.
-
#count ⇒ Integer
Returns a count of the number of documents in the association that have actually been persisted to the database.
-
#delete(document) ⇒ Document?
Delete the supplied document from the target.
-
#delete_all(conditions = {}) ⇒ Integer
Delete all the documents in the association without running callbacks.
-
#destroy_all(conditions = {}) ⇒ Integer
Destroy all the documents in the association whilst running callbacks.
-
#find(*args) ⇒ Array<Document>, Document
Finds a document in this association through several different methods.
-
#in_memory ⇒ Array<Document>
Get all the documents in the relation that are loaded into memory.
-
#initialize(base, target, metadata) ⇒ Many
constructor
Instantiate a new embeds_many relation.
-
#pop(count = nil) ⇒ Document+
Pop documents off the relation.
-
#substitute(docs) ⇒ Many
Substitutes the supplied target documents for the existing documents in the relation.
-
#unscoped ⇒ Criteria
Return the relation with all previous scoping removed.
Methods included from Batchable
#batch_clear, #batch_insert, #batch_remove, #batch_replace
Methods inherited from Many
#blank?, #create, #create!, #exists?, #find_or_create_by, #find_or_initialize_by, #nil?, #respond_to?, #scoped, #serializable_hash
Methods inherited from Proxy
eager_load_ids, #init, #substitutable, #with
Constructor Details
#initialize(base, target, metadata) ⇒ Many
Instantiate a new embeds_many relation.
207 208 209 210 211 212 213 214 215 216 |
# File 'lib/mongoid/relations/embedded/many.rb', line 207 def initialize(base, target, ) init(base, target, ) do target.each_with_index do |doc, index| integrate(doc) doc._index = index end @_unscoped = target.dup @target = scope(target) end end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(name, *args, &block) ⇒ Criteria, Object (private)
If the target array does not respond to the supplied method then try to find a named scope or criteria on the class and send the call there.
If the method exists on the array, use the default proxy behavior.
373 374 375 376 377 378 |
# File 'lib/mongoid/relations/embedded/many.rb', line 373 def method_missing(name, *args, &block) return super if target.respond_to?(name) klass.send(:with_scope, criteria) do criteria.send(name, *args, &block) end end |
Class Method Details
.builder(base, meta, object) ⇒ Builder
Return the builder that is responsible for generating the documents that will be used by this relation.
484 485 486 |
# File 'lib/mongoid/relations/embedded/many.rb', line 484 def builder(base, , object) Builders::Embedded::Many.new(base, , object) end |
.embedded? ⇒ true
Returns true if the relation is an embedded one. In this case always true.
497 498 499 |
# File 'lib/mongoid/relations/embedded/many.rb', line 497 def true end |
.foreign_key_suffix ⇒ nil
Returns the suffix of the foreign key field, either “_id” or “_ids”.
509 510 511 |
# File 'lib/mongoid/relations/embedded/many.rb', line 509 def foreign_key_suffix nil end |
.macro ⇒ Symbol
Returns the macro for this relation. Used mostly as a helper in reflection.
522 523 524 |
# File 'lib/mongoid/relations/embedded/many.rb', line 522 def macro :embeds_many end |
.nested_builder(metadata, attributes, options) ⇒ NestedBuilder
Return the nested builder that is responsible for generating the documents that will be used by this relation.
548 549 550 |
# File 'lib/mongoid/relations/embedded/many.rb', line 548 def nested_builder(, attributes, ) Builders::NestedAttributes::Many.new(, attributes, ) end |
.path(document) ⇒ Mongoid::Atomic::Paths::Embedded::Many
Get the path calculator for the supplied document.
563 564 565 |
# File 'lib/mongoid/relations/embedded/many.rb', line 563 def path(document) Mongoid::Atomic::Paths::Embedded::Many.new(document) end |
.stores_foreign_key? ⇒ false
Tells the caller if this relation is one that stores the foreign key on its own objects.
576 577 578 |
# File 'lib/mongoid/relations/embedded/many.rb', line 576 def stores_foreign_key? false end |
.valid_options ⇒ Array<Symbol>
Get the valid options allowed with this relation.
588 589 590 |
# File 'lib/mongoid/relations/embedded/many.rb', line 588 def [ :as, :cascade_callbacks, :cyclic, :order, :versioned, :store_as ] end |
.validation_default ⇒ true, false
Get the default validation setting for the relation. Determines if by default a validates associated will occur.
601 602 603 |
# File 'lib/mongoid/relations/embedded/many.rb', line 601 def validation_default true end |
Instance Method Details
#<<(*args) ⇒ Object Also known as: push
Appends a document or array of documents to the relation. Will set the parent and update the index in the process.
23 24 25 26 27 28 29 30 31 |
# File 'lib/mongoid/relations/embedded/many.rb', line 23 def <<(*args) docs = args.flatten return concat(docs) if docs.size > 1 if doc = docs.first append(doc) doc.save if persistable? && !_assigning? end self end |
#as_document ⇒ Array<Hash>
Get this relation as as its representation in the database.
42 43 44 45 46 47 48 |
# File 'lib/mongoid/relations/embedded/many.rb', line 42 def as_document attributes = [] _unscoped.each do |doc| attributes.push(doc.as_document) end attributes end |
#build(attributes = {}, options = {}, type = nil) ⇒ Document #build(attributes = {}, type = nil) ⇒ Document Also known as: new
Builds a new document in the relation and appends it to the target. Takes an optional type if you want to specify a subclass.
82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/mongoid/relations/embedded/many.rb', line 82 def build(attributes = {}, = {}, type = nil) if .is_a?(Class) , type = {}, end doc = Factory.build(type || .klass, attributes, ) append(doc) doc.apply_post_processed_defaults yield(doc) if block_given? doc.run_callbacks(:build) { doc } doc end |
#clear ⇒ Many
Clear the relation. Will delete the documents from the db if they are already persisted.
102 103 104 105 |
# File 'lib/mongoid/relations/embedded/many.rb', line 102 def clear batch_clear(target.dup) self end |
#concat(docs) ⇒ Array<Document>
Appends an array of documents to the relation. Performs a batch insert of the documents instead of persisting one at a time.
61 62 63 64 |
# File 'lib/mongoid/relations/embedded/many.rb', line 61 def concat(docs) batch_insert(docs) self end |
#count ⇒ Integer
Returns a count of the number of documents in the association that have actually been persisted to the database.
Use #size if you want the total number of documents.
117 118 119 |
# File 'lib/mongoid/relations/embedded/many.rb', line 117 def count target.select { |doc| doc.persisted? }.size end |
#delete(document) ⇒ Document?
Delete the supplied document from the target. This method is proxied in order to reindex the array after the operation occurs.
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/mongoid/relations/embedded/many.rb', line 132 def delete(document) doc = target.delete_one(document) if doc && !_binding? _unscoped.delete_one(doc) unless doc.paranoid? if _assigning? if doc.paranoid? doc.destroy(suppress: true) else base.add_atomic_pull(doc) end else doc.delete(suppress: true) unbind_one(doc) end end reindex doc end |
#delete_all(conditions = {}) ⇒ Integer
Delete all the documents in the association without running callbacks.
162 163 164 |
# File 'lib/mongoid/relations/embedded/many.rb', line 162 def delete_all(conditions = {}) remove_all(conditions, :delete) end |
#destroy_all(conditions = {}) ⇒ Integer
Destroy all the documents in the association whilst running callbacks.
177 178 179 |
# File 'lib/mongoid/relations/embedded/many.rb', line 177 def destroy_all(conditions = {}) remove_all(conditions, :destroy) end |
#find(*args) ⇒ Array<Document>, Document
Finds a document in this association through several different methods.
193 194 195 |
# File 'lib/mongoid/relations/embedded/many.rb', line 193 def find(*args) criteria.find(*args) end |
#in_memory ⇒ Array<Document>
Get all the documents in the relation that are loaded into memory.
226 227 228 |
# File 'lib/mongoid/relations/embedded/many.rb', line 226 def in_memory target end |
#pop(count = nil) ⇒ Document+
Pop documents off the relation. This can be a single document or multiples, and will automatically persist the changes.
245 246 247 248 249 250 251 252 253 |
# File 'lib/mongoid/relations/embedded/many.rb', line 245 def pop(count = nil) if count if docs = target[target.size - count, target.size] docs.each { |doc| delete(doc) } end else delete(target[-1]) end end |
#substitute(docs) ⇒ Many
Substitutes the supplied target documents for the existing documents in the relation.
266 267 268 269 |
# File 'lib/mongoid/relations/embedded/many.rb', line 266 def substitute(docs) batch_replace(docs) self end |
#unscoped ⇒ Criteria
Return the relation with all previous scoping removed. This is the exact representation of the docs in the database.
280 281 282 283 284 285 |
# File 'lib/mongoid/relations/embedded/many.rb', line 280 def unscoped criterion = klass.unscoped criterion. = true criterion.documents = _unscoped criterion end |