Class: Mongoid::Relations::Proxy

Inherits:
Object
  • Object
show all
Includes:
Threaded::Lifecycle
Defined in:
lib/mongoid/relations/proxy.rb

Overview

This class is the superclass for all relation proxy objects, and contains common behaviour for all of them.

Direct Known Subclasses

Many, One

Instance Attribute Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object (protected)

Default behavior of method missing should be to delegate all calls to the target of the proxy. This can be overridden in special cases.

Parameters:

  • name (String, Symbol) —

    The name of the method.

  • *args (Array) —

    The arguments passed to the method.



103
104
105
 
# File 'lib/mongoid/relations/proxy.rb', line 103

def method_missing(name, *args, &block)
  target.send(name, *args, &block)
end

Instance Attribute Details

#base ⇒ Object

Returns the value of attribute base.



18
19
20
 
# File 'lib/mongoid/relations/proxy.rb', line 18

def base
  @base
end

#loaded ⇒ Object

Returns the value of attribute loaded.



18
19
20
 
# File 'lib/mongoid/relations/proxy.rb', line 18

def loaded
  @loaded
end

#metadata ⇒ Object

Returns the value of attribute metadata.



18
19
20
 
# File 'lib/mongoid/relations/proxy.rb', line 18

def metadata
  @metadata
end

#target ⇒ Object

Returns the value of attribute target.



18
19
20
 
# File 'lib/mongoid/relations/proxy.rb', line 18

def target
  @target
end

Instance Method Details

#init(base, target, metadata) {|_self| ... } ⇒ Object

Convenience for setting the target and the metadata properties since all proxies will need to do this.

Examples:

Initialize the proxy.

proxy.init(person, name, metadata)

Parameters:

Yields:

  • (_self)

Yield Parameters:

Since:

  • 2.0.0.rc.1



36
37
38
39
40
 
# File 'lib/mongoid/relations/proxy.rb', line 36

def init(base, target, metadata)
  @base, @target, @metadata = base, target, metadata
  yield(self) if block_given?
  extend_proxy(metadata.extension) if metadata.extension?
end

#substitutable ⇒ Object

The default substitutable object for a relation proxy is the clone of the target.

Examples:

Get the substitutable.

proxy.substitutable

Returns:

  • (Object) —

    A clone of the target.

Since:

  • 2.1.6



51
52
53
 
# File 'lib/mongoid/relations/proxy.rb', line 51

def substitutable
  target
end