Class: Mongoid::Association::Embedded::EmbeddedIn::Proxy

Inherits:
One
  • Object
show all
Defined in:
build/mongoid-master/lib/mongoid/association/embedded/embedded_in/proxy.rb

Overview

Since:

  • 7.0

Instance Attribute Summary

Attributes inherited from Proxy

#_association, #_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, association) ⇒ In

Instantiate a new embedded_in association.

Examples:

Create the new association.

Association::Embedded::EmbeddedIn.new(person, address, association)

Parameters:

  • base (Document)

    The document the association hangs off of.

  • target (Document)

    The target (parent) of the association.

  • association (Association)

    The association metadata.

Since:

  • 7.0



21
22
23
24
25
26
# File 'build/mongoid-master/lib/mongoid/association/embedded/embedded_in/proxy.rb', line 21

def initialize(base, target, association)
  init(base, target, association) 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::Association::Proxy

Class Method Details

.embedded?true

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

Examples:

Is this association embedded?

Association::Embedded::EmbeddedIn.embedded?

Returns:

  • (true)

    true.

Since:

  • 2.0.0.rc.1



102
103
104
# File 'build/mongoid-master/lib/mongoid/association/embedded/embedded_in/proxy.rb', line 102

def embedded?
  true
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



116
117
118
# File 'build/mongoid-master/lib/mongoid/association/embedded/embedded_in/proxy.rb', line 116

def path(document)
  Mongoid::Atomic::Paths::Root.new(document)
end

Instance Method Details

#substitute(replacement) ⇒ Document?

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

Examples:

Substitute the new document.

person.name.substitute(new_name)

Parameters:

  • replacement (Document)

    A document to replace the target.

Returns:

  • (Document, nil)

    The association or nil.

Since:

  • 2.0.0.rc.1



39
40
41
42
43
44
45
46
47
48
49
# File 'build/mongoid-master/lib/mongoid/association/embedded/embedded_in/proxy.rb', line 39

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