Class: Mongoid::Relations::Referenced::In
- Defined in:
- lib/mongoid/relations/referenced/in.rb
Overview
This class handles all behaviour for relations that are either one-to-many or one-to-one, where the foreign key is store on this side of the relation and the reference is to document(s) in another collection.
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
Get the criteria that is used to eager load a relation of this type.
-
.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? ⇒ true
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
-
#initialize(base, target, metadata) ⇒ In
constructor
Instantiate a new referenced_in relation.
-
#nullify ⇒ Object
Removes the association between the base document and the target document by deleting the foreign key and the reference, orphaning the target document in the process.
-
#substitute(replacement) ⇒ In?
Substitutes the supplied target documents for the existing document in the relation.
Methods inherited from One
#clear, #in_memory, #respond_to?
Methods inherited from Proxy
eager_load_ids, #init, #substitutable, #with
Constructor Details
#initialize(base, target, metadata) ⇒ In
Instantiate a new referenced_in relation.
21 22 23 24 25 26 |
# File 'lib/mongoid/relations/referenced/in.rb', line 21 def initialize(base, target, ) init(base, target, ) do characterize_one(target) bind_one end end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Mongoid::Relations::Proxy
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.
104 105 106 |
# File 'lib/mongoid/relations/referenced/in.rb', line 104 def builder(base, , object) Builders::Referenced::In.new(base, , object) end |
.criteria(metadata, object, type = nil) ⇒ Criteria
Get the standard criteria used for querying this relation.
120 121 122 |
# File 'lib/mongoid/relations/referenced/in.rb', line 120 def criteria(, object, type = nil) type.where(_id: object) end |
.eager_load(metadata, ids) ⇒ Criteria
Get the criteria that is used to eager load a relation of this type.
136 137 138 139 140 141 142 |
# File 'lib/mongoid/relations/referenced/in.rb', line 136 def eager_load(, ids) raise Errors::EagerLoad.new(.name) if .polymorphic? klass, _ = .klass, .foreign_key klass.any_in("_id" => ids.uniq).each do |doc| IdentityMap.set(doc) end end |
.embedded? ⇒ false
Returns true if the relation is an embedded one. In this case always false.
153 154 155 |
# File 'lib/mongoid/relations/referenced/in.rb', line 153 def false end |
.foreign_key(name) ⇒ String
Get the foreign key for the provided name.
167 168 169 |
# File 'lib/mongoid/relations/referenced/in.rb', line 167 def foreign_key(name) "#{name}#{foreign_key_suffix}" end |
.foreign_key_default ⇒ nil
Get the default value for the foreign key.
179 180 181 |
# File 'lib/mongoid/relations/referenced/in.rb', line 179 def foreign_key_default nil end |
.foreign_key_suffix ⇒ String
Returns the suffix of the foreign key field, either “_id” or “_ids”.
191 192 193 |
# File 'lib/mongoid/relations/referenced/in.rb', line 191 def foreign_key_suffix "_id" end |
.macro ⇒ Symbol
Returns the macro for this relation. Used mostly as a helper in reflection.
202 203 204 |
# File 'lib/mongoid/relations/referenced/in.rb', line 202 def macro :belongs_to 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.
228 229 230 |
# File 'lib/mongoid/relations/referenced/in.rb', line 228 def nested_builder(, attributes, ) Builders::NestedAttributes::One.new(, attributes, ) end |
.path(document) ⇒ Root
Get the path calculator for the supplied document.
242 243 244 |
# File 'lib/mongoid/relations/referenced/in.rb', line 242 def path(document) Mongoid::Atomic::Paths::Root.new(document) end |
.stores_foreign_key? ⇒ true
Tells the caller if this relation is one that stores the foreign key on its own objects.
255 256 257 |
# File 'lib/mongoid/relations/referenced/in.rb', line 255 def stores_foreign_key? true end |
.valid_options ⇒ Array<Symbol>
Get the valid options allowed with this relation.
267 268 269 |
# File 'lib/mongoid/relations/referenced/in.rb', line 267 def [ :autobuild, :autosave, :dependent, :foreign_key, :index, :polymorphic, :touch ] end |
.validation_default ⇒ true, false
Get the default validation setting for the relation. Determines if by default a validates associated will occur.
280 281 282 |
# File 'lib/mongoid/relations/referenced/in.rb', line 280 def validation_default false end |
Instance Method Details
#nullify ⇒ Object
Removes the association between the base document and the target document by deleting the foreign key and the reference, orphaning the target document in the process.
35 36 37 38 |
# File 'lib/mongoid/relations/referenced/in.rb', line 35 def nullify unbind_one target.save end |
#substitute(replacement) ⇒ In?
Substitutes the supplied target documents for the existing document in the relation.
52 53 54 55 56 57 58 |
# File 'lib/mongoid/relations/referenced/in.rb', line 52 def substitute(replacement) unbind_one return nil unless replacement self.target = replacement bind_one self end |