Class: Mongoid::Association::Embedded::EmbedsOne::Proxy

Inherits:
One
  • Object
show all
Defined in:
lib/mongoid/association/embedded/embeds_one/proxy.rb

Overview

Since:

  • 7.0

Constant Summary collapse

VALID_OPTIONS =

The valid options when defining this relation.

Returns:

  • (Array<Symbol>) —

    The allowed options when defining this relation.

Since:

  • 7.0

[
    :autobuild,
    :as,
    :cascade_callbacks,
    :cyclic,
    :store_as
].freeze

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) ⇒ Proxy

Instantiate a new embeds_one relation.

Examples:

Create the new proxy.

One.new(person, name, association)

Parameters:

  • base (Document) —

    The document this relation hangs off of.

  • target (Document) —

    The child document in the relation.

  • association (Association) —

    The association metadata.

Since:

  • 7.0



29
30
31
32
33
34
35
36
37
 
# File 'lib/mongoid/association/embedded/embeds_one/proxy.rb', line 29

def initialize(base, target, association)
  init(base, target, association) do
    characterize_one(_target)
    bind_one
    characterize_one(_target)
    _base._reset_memoized_children!
    _target.save if persistable?
  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 relation is an embedded one. In this case always true.

Examples:

Is this relation embedded?

Association::Embedded::EmbedsOne.embedded?

Returns:

  • (true) —

    true.

Since:

  • 2.0.0.rc.1



107
108
109
 
# File 'lib/mongoid/association/embedded/embeds_one/proxy.rb', line 107

def embedded?
  true
end

.path(document) ⇒ Mongoid::Atomic::Paths::Embedded::One

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:

Since:

  • 2.1.0



122
123
124
 
# File 'lib/mongoid/association/embedded/embeds_one/proxy.rb', line 122

def path(document)
  Mongoid::Atomic::Paths::Embedded::One.new(document)
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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/mongoid/association/embedded/embeds_one/proxy.rb', line 50

def substitute(replacement)
  if replacement != self
    if _assigning?
      _base.add_atomic_unset(_target) unless replacement
    else
      # The associated object will be replaced by the below update if non-nil, so only
      # run the callbacks and state-changing code by passing persist: false in that case.
      _target.destroy(persist: !replacement) if persistable?
    end
    unbind_one
    return nil unless replacement
    replacement = Factory.build(klass, replacement) if replacement.is_a?(::Hash)
    self._target = replacement
    bind_one
    characterize_one(_target)
    _target.save if persistable?
  end
  self
end