Class: Mongoid::Relations::Referenced::In
- Includes:
- Evolvable
- 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
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_klass ⇒ Object
-
.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 included from Evolvable
Methods inherited from One
#__evolve_object_id__, #clear, #in_memory, #respond_to?
Methods inherited from Proxy
apply_ordering, #extend_proxies, #init, #klass, #reset_unloaded, #substitutable, #with
Methods included from Marshalable
Constructor Details
#initialize(base, target, metadata) ⇒ In
Instantiate a new referenced_in relation.
22 23 24 25 26 27 |
# File 'lib/mongoid/relations/referenced/in.rb', line 22 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.
119 120 121 |
# File 'lib/mongoid/relations/referenced/in.rb', line 119 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.
135 136 137 |
# File 'lib/mongoid/relations/referenced/in.rb', line 135 def criteria(, object, type = nil) type.where(.primary_key => object) end |
.eager_load_klass ⇒ Object
139 140 141 |
# File 'lib/mongoid/relations/referenced/in.rb', line 139 def eager_load_klass Relations::Eager::BelongsTo end |
.embedded? ⇒ false
Returns true if the relation is an embedded one. In this case always false.
152 153 154 |
# File 'lib/mongoid/relations/referenced/in.rb', line 152 def false end |
.foreign_key(name) ⇒ String
Get the foreign key for the provided name.
166 167 168 |
# File 'lib/mongoid/relations/referenced/in.rb', line 166 def foreign_key(name) "#{name}#{foreign_key_suffix}" end |
.foreign_key_default ⇒ nil
Get the default value for the foreign key.
178 179 180 |
# File 'lib/mongoid/relations/referenced/in.rb', line 178 def foreign_key_default nil end |
.foreign_key_suffix ⇒ String
Returns the suffix of the foreign key field, either “_id” or “_ids”.
190 191 192 |
# File 'lib/mongoid/relations/referenced/in.rb', line 190 def foreign_key_suffix "_id" end |
.macro ⇒ Symbol
Returns the macro for this relation. Used mostly as a helper in reflection.
201 202 203 |
# File 'lib/mongoid/relations/referenced/in.rb', line 201 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.
227 228 229 |
# File 'lib/mongoid/relations/referenced/in.rb', line 227 def nested_builder(, attributes, ) Builders::NestedAttributes::One.new(, attributes, ) end |
.path(document) ⇒ Root
Get the path calculator for the supplied document.
241 242 243 |
# File 'lib/mongoid/relations/referenced/in.rb', line 241 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.
254 255 256 |
# File 'lib/mongoid/relations/referenced/in.rb', line 254 def stores_foreign_key? true end |
.valid_options ⇒ Array<Symbol>
Get the valid options allowed with this relation.
266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/mongoid/relations/referenced/in.rb', line 266 def [ :autobuild, :autosave, :dependent, :foreign_key, :index, :polymorphic, :primary_key, :touch ] end |
.validation_default ⇒ true, false
Get the default validation setting for the relation. Determines if by default a validates associated will occur.
288 289 290 |
# File 'lib/mongoid/relations/referenced/in.rb', line 288 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.
36 37 38 39 |
# File 'lib/mongoid/relations/referenced/in.rb', line 36 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 = normalize(replacement) bind_one self end |