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

Inherits:

One

Object
Proxy
One
Mongoid::Relations::Referenced::In

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

.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.

Constructor Details

#initialize(base, target, metadata) ⇒ `In`

Instantiate a new referenced_in relation.

Examples:

Create the new relation.

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

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.

# File 'lib/mongoid/relations/referenced/in.rb', line 22

def initialize(base, target, metadata)
  init(base, target, metadata) 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



122
123
124

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

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:

(Criteria) —

The criteria.

Since:

2.1.0



138
139
140

# File 'lib/mongoid/relations/referenced/in.rb', line 138

def criteria(metadata, object, type = nil)
  type.where(metadata.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(metadata, 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:

(Errors::EagerLoad)

Since:

2.2.0

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

def eager_load(metadata, ids)
  raise Errors::EagerLoad.new(metadata.name) if metadata.polymorphic?
  klass, _ = metadata.klass, metadata.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



171
172
173

# File 'lib/mongoid/relations/referenced/in.rb', line 171

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:

name (Symbol) —

The name.

Returns:

(String) —

The foreign key.

Since:

3.0.0



185
186
187

# File 'lib/mongoid/relations/referenced/in.rb', line 185

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

.foreign_key_default ⇒ `nil`

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



197
198
199

# File 'lib/mongoid/relations/referenced/in.rb', line 197

def foreign_key_default
  nil
end

.foreign_key_suffix ⇒ `String`

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



209
210
211

# File 'lib/mongoid/relations/referenced/in.rb', line 209

def foreign_key_suffix
  "_id"
end

.macro ⇒ `Symbol`

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

Examples:

Get the macro.

Referenced::In.macro

Returns:

(Symbol) —

:belongs_to



220
221
222

# File 'lib/mongoid/relations/referenced/in.rb', line 220

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



246
247
248

# File 'lib/mongoid/relations/referenced/in.rb', line 246

def nested_builder(metadata, attributes, options)
  Builders::NestedAttributes::One.new(metadata, 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



260
261
262

# File 'lib/mongoid/relations/referenced/in.rb', line 260

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



273
274
275

# File 'lib/mongoid/relations/referenced/in.rb', line 273

def stores_foreign_key?
  true
end

.valid_options ⇒ `Array<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

# File 'lib/mongoid/relations/referenced/in.rb', line 285

def valid_options
  [
    :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.

Examples:

Get the validation default.

Proxy.validation_default

Returns:

(true, false) —

The validation default.

Since:

2.1.9



307
308
309

# File 'lib/mongoid/relations/referenced/in.rb', line 307

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.

Examples:

Nullify the relation.

person.game.nullify

# 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

# File 'lib/mongoid/relations/referenced/in.rb', line 53

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

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

Overview

Instance Attribute Summary

Attributes inherited from Proxy

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Evolvable

Methods inherited from One

Methods inherited from Proxy

Methods included from Marshalable

Constructor Details

#initialize(base, target, metadata) ⇒ In

Examples:

Create the new relation.

Dynamic Method Handling

Class Method Details

.builder(base, meta, object) ⇒ Builder

Examples:

Get the builder.

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

Examples:

Get the criteria.

.eager_load(metadata, ids) ⇒ Criteria

Examples:

Get the eager load criteria.

.embedded? ⇒ false

Examples:

Is this relation embedded?

.foreign_key(name) ⇒ String

Examples:

Get the foreign key.

.foreign_key_default ⇒ nil

Examples:

Get the default.

.foreign_key_suffix ⇒ String

Examples:

Get the suffix for the foreign key.

.macro ⇒ Symbol

Examples:

Get the macro.

.nested_builder(metadata, attributes, options) ⇒ NestedBuilder

Examples:

Get the nested builder.

.path(document) ⇒ Root

Examples:

Get the path calculator.

.stores_foreign_key? ⇒ true

Examples:

Does this relation store a foreign key?

.valid_options ⇒ Array<Symbol>

Examples:

Get the valid options.

.validation_default ⇒ true, false

Examples:

Get the validation default.

Instance Method Details

#nullify ⇒ Object

Examples:

Nullify the relation.

#substitute(replacement) ⇒ In?

Examples:

Substitute the relation.

#initialize(base, target, metadata) ⇒ `In`

.builder(base, meta, object) ⇒ `Builder`

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

.eager_load(metadata, ids) ⇒ `Criteria`

.embedded? ⇒ `false`

.foreign_key(name) ⇒ `String`

.foreign_key_default ⇒ `nil`

.foreign_key_suffix ⇒ `String`

.macro ⇒ `Symbol`

.nested_builder(metadata, attributes, options) ⇒ `NestedBuilder`

.path(document) ⇒ `Root`

.stores_foreign_key? ⇒ `true`

.valid_options ⇒ `Array<Symbol>`

.validation_default ⇒ `true`, `false`

#nullify ⇒ `Object`

#substitute(replacement) ⇒ `In`^?