Class: Mongoid::Relations::Referenced::In

Inherits:
One
  • Object
show all
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

#base, #loaded, #metadata, #target

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Evolvable

#__evolve_object_id__

Methods inherited from One

#__evolve_object_id__, #clear, #in_memory, #respond_to?

Methods inherited from Proxy

apply_ordering, eager_load_ids, #extend_proxies, #init, #klass, #reset_unloaded, #substitutable, #with

Methods included from Marshalable

#marshal_dump, #marshal_load

Constructor Details

#initialize(base, target, metadata) ⇒ In

Instantiate a new referenced_in relation.

Examples:

Create the new relation.

Referenced::In.new(game, person, )

Parameters:

  • base (Document)

    The document this relation hangs off of.

  • target (Document, Array<Document>)

    The target (parent) of the relation.

  • metadata (Metadata)

    The relation's metadata.


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.

Examples:

Get the builder.

Referenced::In.builder(meta, object)

Parameters:

  • base (Document)

    The base document.

  • meta (Metadata)

    The metadata of the relation.

  • object (Document, Hash)

    A document or attributes to build with.

Returns:

  • (Builder)

    A new builder object.

Since:

  • 2.0.0.rc.1


105
106
107
# File 'lib/mongoid/relations/referenced/in.rb', line 105

def builder(base, meta, object)
  Builders::Referenced::In.new(base, meta, object)
end

.criteria(metadata, object, type = nil) ⇒ Criteria

Get the standard criteria used for querying this relation.

Examples:

Get the criteria.

Proxy.criteria(meta, id, Model)

Parameters:

  • metadata (Metadata)

    The metadata.

  • object (Object)

    The value of the foreign key.

  • type (Class) (defaults to: nil)

    The optional type.

Returns:

Since:

  • 2.1.0


121
122
123
# File 'lib/mongoid/relations/referenced/in.rb', line 121

def criteria(, object, type = nil)
  type.where(.primary_key => object)
end

.eager_load(metadata, ids) ⇒ Criteria

Get the criteria that is used to eager load a relation of this type.

Examples:

Get the eager load criteria.

Proxy.eager_load(, criteria)

Parameters:

  • metadata (Metadata)

    The relation metadata.

  • ids (Array<Object>)

    The ids of the target docs.

Returns:

  • (Criteria)

    The criteria to eager load the relation.

Raises:

Since:

  • 2.2.0


137
138
139
140
141
142
143
# File 'lib/mongoid/relations/referenced/in.rb', line 137

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.

Examples:

Is this relation embedded?

Referenced::In.embedded?

Returns:

  • (false)

    Always false.

Since:

  • 2.0.0.rc.1


154
155
156
# File 'lib/mongoid/relations/referenced/in.rb', line 154

def embedded?
  false
end

.foreign_key(name) ⇒ String

Get the foreign key for the provided name.

Examples:

Get the foreign key.

Referenced::In.foreign_key(:person)

Parameters:

Returns:

  • (String)

    The foreign key.

Since:

  • 3.0.0


168
169
170
# File 'lib/mongoid/relations/referenced/in.rb', line 168

def foreign_key(name)
  "#{name}#{foreign_key_suffix}"
end

.foreign_key_defaultnil

Get the default value for the foreign key.

Examples:

Get the default.

Referenced::In.foreign_key_default

Returns:

  • (nil)

    Always nil.

Since:

  • 2.0.0.rc.1


180
181
182
# File 'lib/mongoid/relations/referenced/in.rb', line 180

def foreign_key_default
  nil
end

.foreign_key_suffixString

Returns the suffix of the foreign key field, either “_id” or “_ids”.

Examples:

Get the suffix for the foreign key.

Referenced::In.foreign_key_suffix

Returns:

  • (String)

    “_id”

Since:

  • 2.0.0.rc.1


192
193
194
# File 'lib/mongoid/relations/referenced/in.rb', line 192

def foreign_key_suffix
  "_id"
end

.macroSymbol

Returns the macro for this relation. Used mostly as a helper in reflection.

Examples:

Get the macro.

Referenced::In.macro

Returns:


203
204
205
# File 'lib/mongoid/relations/referenced/in.rb', line 203

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.

Examples:

Get the nested builder.

Referenced::In.builder(attributes, options)

Parameters:

  • metadata (Metadata)

    The relation metadata.

  • attributes (Hash)

    The attributes to build with.

  • options (Hash)

    The options for the builder.

Options Hash (options):

  • :allow_destroy (true, false)

    Can documents be deleted?

  • :limit (Integer)

    Max number of documents to create at once.

  • :reject_if (Proc, Symbol)

    If documents match this option then they are ignored.

  • :update_only (true, false)

    Only existing documents can be modified.

Returns:

  • (NestedBuilder)

    A newly instantiated nested builder object.

Since:

  • 2.0.0.rc.1


229
230
231
# File 'lib/mongoid/relations/referenced/in.rb', line 229

def nested_builder(, attributes, options)
  Builders::NestedAttributes::One.new(, attributes, options)
end

.path(document) ⇒ Root

Get the path calculator for the supplied document.

Examples:

Get the path calculator.

Proxy.path(document)

Parameters:

  • document (Document)

    The document to calculate on.

Returns:

  • (Root)

    The root atomic path calculator.

Since:

  • 2.1.0


243
244
245
# File 'lib/mongoid/relations/referenced/in.rb', line 243

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.

Examples:

Does this relation store a foreign key?

Referenced::In.stores_foreign_key?

Returns:

  • (true)

    Always true.

Since:

  • 2.0.0.rc.1


256
257
258
# File 'lib/mongoid/relations/referenced/in.rb', line 256

def stores_foreign_key?
  true
end

.valid_optionsArray<Symbol>

Get the valid options allowed with this relation.

Examples:

Get the valid options.

Relation.valid_options

Returns:

  • (Array<Symbol>)

    The valid options.

Since:

  • 2.1.0


268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/mongoid/relations/referenced/in.rb', line 268

def valid_options
  [
    :autobuild,
    :autosave,
    :dependent,
    :foreign_key,
    :index,
    :polymorphic,
    :primary_key,
    :touch
  ]
end

.validation_defaulttrue, false

Get the default validation setting for the relation. Determines if by default a validates associated will occur.

Examples:

Get the validation default.

Proxy.validation_default

Returns:

  • (true, false)

    The validation default.

Since:

  • 2.1.9


290
291
292
# File 'lib/mongoid/relations/referenced/in.rb', line 290

def validation_default
  false
end

Instance Method Details

#nullifyObject

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.

Examples:

Nullify the relation.

person.game.nullify

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.

Examples:

Substitute the relation.

name.substitute(new_name)

Parameters:

  • new_target (Document, Array<Document>)

    The replacement.

  • building (true, false)

    Are we in build mode?

Returns:

  • (In, nil)

    The relation or nil.

Since:

  • 2.0.0.rc.1


53
54
55
56
57
58
59
# File 'lib/mongoid/relations/referenced/in.rb', line 53

def substitute(replacement)
  unbind_one
  return nil unless replacement
  self.target = replacement
  bind_one
  self
end