Class: Mongoid::Relations::Referenced::Many
- 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(name) ⇒ String
Get the foreign key for the provided name.
-
.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) {|doc| ... } ⇒ 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.
-
#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?, #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 references_many relation. Will set the foreign key and the base on the inverse object.
198 199 200 201 202 |
# File 'lib/mongoid/relations/referenced/many.rb', line 198 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.
373 374 375 376 377 378 379 380 381 |
# File 'lib/mongoid/relations/referenced/many.rb', line 373 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.
508 509 510 |
# File 'lib/mongoid/relations/referenced/many.rb', line 508 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.
524 525 526 527 528 529 530 531 532 533 |
# File 'lib/mongoid/relations/referenced/many.rb', line 524 def criteria(, object, type = nil) with_inverse_field_criterion( with_polymorphic_criterion( .klass.where(.foreign_key => object), , type ), ) end |
.eager_load(metadata, ids) ⇒ Criteria
Eager load the relation based on the criteria.
546 547 548 |
# File 'lib/mongoid/relations/referenced/many.rb', line 546 def eager_load(, ids) eager_load_ids(, ids) { |doc, key| IdentityMap.set_many(doc, key) } end |
.embedded? ⇒ false
Returns true if the relation is an embedded one. In this case always false.
559 560 561 |
# File 'lib/mongoid/relations/referenced/many.rb', line 559 def false end |
.foreign_key(name) ⇒ String
Get the foreign key for the provided name.
573 574 575 |
# File 'lib/mongoid/relations/referenced/many.rb', line 573 def foreign_key(name) "#{name}#{foreign_key_suffix}" end |
.foreign_key_default ⇒ nil
Get the default value for the foreign key.
585 586 587 |
# File 'lib/mongoid/relations/referenced/many.rb', line 585 def foreign_key_default nil end |
.foreign_key_suffix ⇒ String
Returns the suffix of the foreign key field, either “_id” or “_ids”.
597 598 599 |
# File 'lib/mongoid/relations/referenced/many.rb', line 597 def foreign_key_suffix "_id" end |
.macro ⇒ Symbol
Returns the macro for this relation. Used mostly as a helper in reflection.
608 609 610 |
# File 'lib/mongoid/relations/referenced/many.rb', line 608 def macro :has_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.
634 635 636 |
# File 'lib/mongoid/relations/referenced/many.rb', line 634 def nested_builder(, attributes, ) Builders::NestedAttributes::Many.new(, attributes, ) end |
.path(document) ⇒ Root
Get the path calculator for the supplied document.
648 649 650 |
# File 'lib/mongoid/relations/referenced/many.rb', line 648 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.
661 662 663 |
# File 'lib/mongoid/relations/referenced/many.rb', line 661 def stores_foreign_key? false end |
.valid_options ⇒ Array<Symbol>
Get the valid options allowed with this relation.
673 674 675 |
# File 'lib/mongoid/relations/referenced/many.rb', line 673 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.
686 687 688 |
# File 'lib/mongoid/relations/referenced/many.rb', line 686 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.
30 31 32 33 34 35 36 37 38 |
# File 'lib/mongoid/relations/referenced/many.rb', line 30 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 self 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.
81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/mongoid/relations/referenced/many.rb', line 81 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 |
#concat(documents) ⇒ Array<Document>
Appends an array of documents to the relation. Performs a batch insert of the documents instead of persisting one at a time.
52 53 54 55 56 57 58 59 60 61 |
# File 'lib/mongoid/relations/referenced/many.rb', line 52 def concat(documents) docs, inserts = [], [] documents.each do |doc| next unless doc append(doc) save_or_delay(doc, docs, inserts) if persistable? end persist_delayed(docs, inserts) self 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.
107 108 109 110 111 112 113 114 |
# File 'lib/mongoid/relations/referenced/many.rb', line 107 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.
130 131 132 |
# File 'lib/mongoid/relations/referenced/many.rb', line 130 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.
148 149 150 |
# File 'lib/mongoid/relations/referenced/many.rb', line 148 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.
165 166 167 |
# File 'lib/mongoid/relations/referenced/many.rb', line 165 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.
183 184 185 |
# File 'lib/mongoid/relations/referenced/many.rb', line 183 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.
212 213 214 215 216 217 |
# File 'lib/mongoid/relations/referenced/many.rb', line 212 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.
229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/mongoid/relations/referenced/many.rb', line 229 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.
254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/mongoid/relations/referenced/many.rb', line 254 def substitute(replacement) if replacement new_docs, docs = replacement.compact, [] 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 concat(docs) else purge end self end |
#unscoped ⇒ Criteria
Get a criteria for the documents without the default scoping applied.
278 279 280 281 282 |
# File 'lib/mongoid/relations/referenced/many.rb', line 278 def unscoped klass.unscoped.where( foreign_key => Conversions.flag(base.id, ) ) end |