Class: Mongoid::Relations::Embedded::In

Inherits:
One
  • Object
show all
Defined in:
lib/mongoid/relations/embedded/in.rb

Overview

This class defines the behaviour necessary to handle relations that are embedded within another relation, either as a single document or multiple documents.

Constant Summary collapse

VALID_OPTIONS =

The allowed options when defining this relation.

Returns:

  • (Array<Symbol>) —

    The allowed options when defining this relation.

Since:

  • 6.0.0

[
 :autobuild,
 :cyclic,
 :polymorphic,
 :touch
].freeze

Instance Attribute Summary

Attributes inherited from Proxy

#__metadata, #base, #target

Class Method Summary collapse

Instance Method Summary collapse

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

Methods included from Marshalable

#marshal_dump, #marshal_load

Constructor Details

#initialize(base, target, metadata) ⇒ In

Instantiate a new embedded_in relation.

Examples:

Create the new relation.

Embedded::In.new(name, person, metadata)

Parameters:

  • base (Document) —

    The document the relation hangs off of.

  • target (Document) —

    The target (parent) of the relation.

  • metadata (Metadata) —

    The relation metadata.



33
34
35
36
37
38
 
# File 'lib/mongoid/relations/embedded/in.rb', line 33

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.

Embedded::In.builder(meta, object, person)

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 newly instantiated builder object.

Since:

  • 2.0.0.rc.1



118
119
120
 
# File 'lib/mongoid/relations/embedded/in.rb', line 118

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

.embedded? ⇒ true

Returns true if the relation is an embedded one. In this case always true.

Examples:

Is this relation embedded?

Embedded::In.embedded?

Returns:

  • (true) —

    true.

Since:

  • 2.0.0.rc.1



131
132
133
 
# File 'lib/mongoid/relations/embedded/in.rb', line 131

def embedded?
  true
end

.foreign_key_suffix ⇒ nil

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

Examples:

Get the suffix for the foreign key.

Referenced::Many.foreign_key_suffix

Returns:

  • (nil) —

    nil.

Since:

  • 3.0.0



143
144
145
 
# File 'lib/mongoid/relations/embedded/in.rb', line 143

def foreign_key_suffix
  nil
end

.macro ⇒ Symbol

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

Examples:

Get the macro.

Mongoid::Relations::Embedded::In.macro

Returns:

Since:

  • 2.0.0.rc.1



156
157
158
 
# File 'lib/mongoid/relations/embedded/in.rb', line 156

def macro
  :embedded_in
end

.nested_builder(metadata, attributes, options) ⇒ Builder

Return the nested builder that is responsible for generating the documents that will be used by this relation.

Examples:

Get the builder.

NestedAttributes::One.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:

  • (Builder) —

    A newly instantiated nested builder object.

Since:

  • 2.0.0.rc.1



182
183
184
 
# File 'lib/mongoid/relations/embedded/in.rb', line 182

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



196
197
198
 
# File 'lib/mongoid/relations/embedded/in.rb', line 196

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.

Examples:

Does this relation store a foreign key?

Embedded::In.stores_foreign_key?

Returns:

  • (false) —

    false.

Since:

  • 2.0.0.rc.1



209
210
211
 
# File 'lib/mongoid/relations/embedded/in.rb', line 209

def stores_foreign_key?
  false
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



221
222
223
 
# File 'lib/mongoid/relations/embedded/in.rb', line 221

def valid_options
  VALID_OPTIONS
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



234
235
236
 
# File 'lib/mongoid/relations/embedded/in.rb', line 234

def validation_default
  false
end

Instance Method Details

#substitute(replacement) ⇒ Document?

Substitutes the supplied target documents for the existing document in the relation.

Examples:

Substitute the new document.

person.name.substitute(new_name)

Parameters:

  • replacement (Document) —

    A document to replace the target.

Returns:

  • (Document, nil) —

    The relation or nil.

Since:

  • 2.0.0.rc.1



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/mongoid/relations/embedded/in.rb', line 51

def substitute(replacement)
  unbind_one
  unless replacement
    base.delete if persistable?
    return nil
  end
  base.new_record = true
  self.target = replacement
  bind_one
  self
end