Class: Mongoid::Association::Proxy

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Marshalable, Threaded::Lifecycle
Defined in:
lib/mongoid/association/proxy.rb

Overview

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

Direct Known Subclasses

Many, One

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Marshalable

#marshal_dump, #marshal_load

Instance Attribute Details

#_association ⇒ Object

Returns the value of attribute _association.



31
32
33
 
# File 'lib/mongoid/association/proxy.rb', line 31

def _association
  @_association
end

#_base ⇒ Object

Model instance for the base of the association.

For example, if a Post embeds_many Comments, _base is a particular instance of the Post model.



29
30
31
 
# File 'lib/mongoid/association/proxy.rb', line 29

def _base
  @_base
end

#_target ⇒ Object

Model instance for one to one associations, or array of model instances for one to many associations, for the target of the association.

For example, if a Post embeds_many Comments, _target is an array of Comment models embedded in a particular Post.



38
39
40
 
# File 'lib/mongoid/association/proxy.rb', line 38

def _target
  @_target
end

Class Method Details

.apply_ordering(criteria, association) ⇒ Criteria

Apply ordering to the criteria if it was defined on the association.

Examples:

Apply the ordering.

Proxy.apply_ordering(criteria, association)

Parameters:

  • criteria (Criteria) —

    The criteria to modify.

  • association (Association) —

    The association metadata.

Returns:

Since:

  • 3.0.6



204
205
206
 
# File 'lib/mongoid/association/proxy.rb', line 204

def apply_ordering(criteria, association)
  association.order ? criteria.order_by(association.order) : criteria
end

Instance Method Details

#extend_proxies(*extension) ⇒ Object

Allow extension to be an array and extend each module



63
64
65
 
# File 'lib/mongoid/association/proxy.rb', line 63

def extend_proxies(*extension)
  extension.flatten.each {|ext| extend_proxy(ext) }
end

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

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

Examples:

Initialize the proxy.

proxy.init(person, name, association)

Parameters:

Yields:

  • (_self)

Yield Parameters:

Since:

  • 2.0.0.rc.1



56
57
58
59
60
 
# File 'lib/mongoid/association/proxy.rb', line 56

def init(base, target, association)
  @_base, @_target, @_association = base, target, association
  yield(self) if block_given?
  extend_proxies(association.extension) if association.extension
end

#klass ⇒ Class

Get the class from the association, or return nil if no association present.

Examples:

Get the class.

proxy.klass

Returns:

  • (Class) —

    The association class.

Since:

  • 3.0.15



75
76
77
 
# File 'lib/mongoid/association/proxy.rb', line 75

def klass
  _association ? _association.klass : nil
end

#reset_unloaded ⇒ Object

Resets the criteria inside the association proxy. Used by many to many associations to keep the underlying ids array in sync.

Examples:

Reset the association criteria.

person.preferences.reset_relation_criteria

Since:

  • 3.0.14



86
87
88
 
# File 'lib/mongoid/association/proxy.rb', line 86

def reset_unloaded
  _target.reset_unloaded(criteria)
end

#substitutable ⇒ Object

The default substitutable object for an association proxy is the clone of the target.

Examples:

Get the substitutable.

proxy.substitutable

Returns:

  • (Object) —

    A clone of the target.

Since:

  • 2.1.6



99
100
101
 
# File 'lib/mongoid/association/proxy.rb', line 99

def substitutable
  _target
end