Class: Mongoid::Relations::Referenced::Many
- Includes:
- Batch
- Defined in:
- lib/mongoid/relations/referenced/many.rb
Overview
This class defines the behaviour for all relations that are a one-to-many between documents in different collections.
Direct Known Subclasses
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.
-
.criteria(metadata, object, type = nil) ⇒ Criteria
Get the standard criteria used for querying this relation.
-
.eager_load(metadata, ids) ⇒ Criteria
Eager load the relation based on the criteria.
-
.embedded? ⇒ false
Returns true if the relation is an embedded one.
-
.foreign_key_default ⇒ nil
Get the default value for the foreign key.
-
.foreign_key_suffix ⇒ String
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) ⇒ Root
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) ⇒ Array<Document>
(also: #push)
Appends a document or array of documents to the relation.
-
#build(attributes = {}, options = {}, type = nil) ⇒ Document
(also: #new)
Build a new document from the attributes and append it to this relation without saving.
-
#concat(documents) ⇒ Array<Document>
Appends an array of documents to the relation.
-
#create(attributes = nil, options = {}, type = nil, &block) ⇒ Document
Creates a new document on the references many relation.
-
#create!(attributes = nil, options = {}, type = nil, &block) ⇒ Document
Creates a new document on the references many relation.
-
#delete(document) ⇒ Document
Delete the document from the relation.
-
#delete_all(conditions = nil) ⇒ Integer
Deletes all related documents from the database given the supplied conditions.
-
#destroy_all(conditions = nil) ⇒ Integer
Destroys all related documents from the database given the supplied conditions.
-
#each ⇒ Array<Document>
Iterate over each document in the relation and yield to the provided block.
-
#find(*args) ⇒ Document, Criteria
Find the matchind document on the association, either based on id or conditions.
-
#initialize(base, target, metadata) ⇒ Many
constructor
Instantiate a new references_many relation.
-
#nullify ⇒ Object
(also: #nullify_all)
Removes all associations between the base document and the target documents by deleting the foreign keys and the references, orphaning the target documents in the process.
-
#purge ⇒ Many
(also: #clear)
Clear the relation.
-
#substitute(replacement) ⇒ Many
Substitutes the supplied target documents for the existing documents in the relation.
-
#unscoped ⇒ Criteria
Get a criteria for the documents without the default scoping applied.
Methods inherited from Many
#blank?, #exists?, #find_or_create_by, #find_or_initialize_by, #nil?, #respond_to?, #scoped, #serializable_hash
Methods inherited from Proxy
Constructor Details
#initialize(base, target, metadata) ⇒ Many
Instantiate a new references_many relation. Will set the foreign key and the base on the inverse object.
263 264 265 266 267 |
# File 'lib/mongoid/relations/referenced/many.rb', line 263 def initialize(base, target, ) init(base, Targets::Enumerable.new(target), ) do raise_mixed if klass. 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.
441 442 443 444 445 446 447 448 449 |
# File 'lib/mongoid/relations/referenced/many.rb', line 441 def method_missing(name, *args, &block) if target.respond_to?(name) target.send(name, *args, &block) else klass.send(:with_scope, criteria) do criteria.send(name, *args, &block) end 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.
535 536 537 |
# File 'lib/mongoid/relations/referenced/many.rb', line 535 def builder(base, , object) Builders::Referenced::Many.new(base, , object || []) end |
.criteria(metadata, object, type = nil) ⇒ Criteria
Get the standard criteria used for querying this relation.
551 552 553 |
# File 'lib/mongoid/relations/referenced/many.rb', line 551 def criteria(, object, type = nil) .klass.where(.foreign_key => object) end |
.eager_load(metadata, ids) ⇒ Criteria
Eager load the relation based on the criteria.
566 567 568 569 570 571 |
# File 'lib/mongoid/relations/referenced/many.rb', line 566 def eager_load(, ids) klass, foreign_key = .klass, .foreign_key klass.any_in(foreign_key => ids).each do |doc| IdentityMap.set_many(doc, foreign_key => doc.send(foreign_key)) end end |
.embedded? ⇒ false
Returns true if the relation is an embedded one. In this case always false.
582 583 584 |
# File 'lib/mongoid/relations/referenced/many.rb', line 582 def false end |
.foreign_key_default ⇒ nil
Get the default value for the foreign key.
594 595 596 |
# File 'lib/mongoid/relations/referenced/many.rb', line 594 def foreign_key_default nil end |
.foreign_key_suffix ⇒ String
Returns the suffix of the foreign key field, either “_id” or “_ids”.
606 607 608 |
# File 'lib/mongoid/relations/referenced/many.rb', line 606 def foreign_key_suffix "_id" end |
.macro ⇒ Symbol
Returns the macro for this relation. Used mostly as a helper in reflection.
617 618 619 |
# File 'lib/mongoid/relations/referenced/many.rb', line 617 def macro :references_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.
643 644 645 |
# File 'lib/mongoid/relations/referenced/many.rb', line 643 def nested_builder(, attributes, ) Builders::NestedAttributes::Many.new(, attributes, ) end |
.path(document) ⇒ Root
Get the path calculator for the supplied document.
657 658 659 |
# File 'lib/mongoid/relations/referenced/many.rb', line 657 def path(document) Mongoid::Atomic::Paths::Root.new(document) end |
.stores_foreign_key? ⇒ false
Tells the caller if this relation is one that stores the foreign key on its own objects.
670 671 672 |
# File 'lib/mongoid/relations/referenced/many.rb', line 670 def stores_foreign_key? false end |
.valid_options ⇒ Array<Symbol>
Get the valid options allowed with this relation.
682 683 684 |
# File 'lib/mongoid/relations/referenced/many.rb', line 682 def [ :as, :autosave, :dependent, :foreign_key, :order ] end |
.validation_default ⇒ true, false
Get the default validation setting for the relation. Determines if by default a validates associated will occur.
695 696 697 |
# File 'lib/mongoid/relations/referenced/many.rb', line 695 def validation_default true end |
Instance Method Details
#<<(*args) ⇒ Array<Document> 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.
31 32 33 34 35 36 37 38 |
# File 'lib/mongoid/relations/referenced/many.rb', line 31 def <<(*args) docs = args.flatten return concat(docs) if docs.size > 1 if doc = docs.first append(doc) doc.save if persistable? && !_assigning? && !doc.validated? end end |
#build(attributes = {}, options = {}, type = nil) ⇒ Document #build(attributes = {}, type = nil) ⇒ Document Also known as: new
Build a new document from the attributes and append it to this relation without saving.
85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/mongoid/relations/referenced/many.rb', line 85 def build(attributes = {}, = {}, type = nil) if .is_a? Class , type = {}, end Factory.build(type || klass, attributes, ).tap do |doc| append(doc) yield(doc) if block_given? doc.run_callbacks(:build) { doc } end end |
#concat(documents) ⇒ Array<Document>
When performing batch inserts the after callbacks will get executed before the documents have actually been persisted to the database due to an issue with Active Support’s callback system - we cannot explicitly fire the after callbacks by themselves.
Appends an array of documents to the relation. Performs a batch insert of the documents instead of persisting one at a time.
57 58 59 60 61 62 63 64 65 |
# File 'lib/mongoid/relations/referenced/many.rb', line 57 def concat(documents) batched do documents.each do |doc| next unless doc append(doc) doc.save if persistable? end end end |
#create(attributes = nil, options = {}, type = nil) ⇒ Document #create(attributes = nil, type = nil) ⇒ Document
Creates a new document on the references many relation. This will save the document if the parent has been persisted.
116 117 118 119 120 |
# File 'lib/mongoid/relations/referenced/many.rb', line 116 def create(attributes = nil, = {}, type = nil, &block) build(attributes, , type, &block).tap do |doc| base.persisted? ? doc.save : raise_unsaved(doc) end end |
#create!(attributes = nil, options = {}, type = nil) ⇒ Document #create!(attributes = nil, type = nil) ⇒ Document
Creates a new document on the references many relation. This will save the document if the parent has been persisted and will raise an error if validation fails.
143 144 145 146 147 |
# File 'lib/mongoid/relations/referenced/many.rb', line 143 def create!(attributes = nil, = {}, type = nil, &block) build(attributes, , type, &block).tap do |doc| base.persisted? ? doc.save! : raise_unsaved(doc) end end |
#delete(document) ⇒ Document
Delete the document from the relation. This will set the foreign key on the document to nil. If the dependent options on the relation are :delete or :destroy the appropriate removal will occur.
161 162 163 164 165 166 167 168 |
# File 'lib/mongoid/relations/referenced/many.rb', line 161 def delete(document) target.delete(document) do |doc| if doc unbind_one(doc) cascade!(doc) end end end |
#delete_all(conditions = nil) ⇒ Integer
Deletes all related documents from the database given the supplied conditions.
184 185 186 |
# File 'lib/mongoid/relations/referenced/many.rb', line 184 def delete_all(conditions = nil) remove_all(conditions, :delete_all) end |
#destroy_all(conditions = nil) ⇒ Integer
Destroys all related documents from the database given the supplied conditions.
202 203 204 |
# File 'lib/mongoid/relations/referenced/many.rb', line 202 def destroy_all(conditions = nil) remove_all(conditions, :destroy_all) end |
#each ⇒ Array<Document>
This will load the entire relation into memory.
Iterate over each document in the relation and yield to the provided block.
219 220 221 |
# File 'lib/mongoid/relations/referenced/many.rb', line 219 def each target.each { |doc| yield(doc) if block_given? } end |
#find(*args) ⇒ Document, Criteria
Find the matchind document on the association, either based on id or conditions.
248 249 250 |
# File 'lib/mongoid/relations/referenced/many.rb', line 248 def find(*args) criteria.find(*args) end |
#nullify ⇒ Object Also known as: nullify_all
Removes all associations between the base document and the target documents by deleting the foreign keys and the references, orphaning the target documents in the process.
277 278 279 280 281 282 |
# File 'lib/mongoid/relations/referenced/many.rb', line 277 def nullify criteria.update(.foreign_key => nil) target.clear do |doc| unbind_one(doc) end end |
#purge ⇒ Many Also known as: clear
Clear the relation. Will delete the documents from the db if they are already persisted.
294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/mongoid/relations/referenced/many.rb', line 294 def purge unless .destructive? nullify else criteria.delete_all target.clear do |doc| unbind_one(doc) doc.destroyed = true end end end |
#substitute(replacement) ⇒ Many
Substitutes the supplied target documents for the existing documents in the relation. If the new target is nil, perform the necessary deletion.
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/mongoid/relations/referenced/many.rb', line 319 def substitute(replacement) tap do |proxy| if replacement if replacement != proxy.in_memory new_docs, docs = replacement.compact.uniq, [] new_ids = new_docs.map { |doc| doc.id } remove_not_in(new_ids) new_docs.each do |doc| docs.push(doc) if doc.send(.foreign_key) != base.id end proxy.concat(docs) end else proxy.purge end end end |
#unscoped ⇒ Criteria
Get a criteria for the documents without the default scoping applied.
346 347 348 349 350 |
# File 'lib/mongoid/relations/referenced/many.rb', line 346 def unscoped klass.unscoped.where( .foreign_key => Conversions.flag(base.id, ) ) end |