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)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(name, *args, &block) (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.



116
117
118
 
# File 'lib/mongoid/relations/proxy.rb', line 116

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

Instance Attribute Details

- (Object) base

Returns the value of attribute base



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

def base
  @base
end

- (Object) loaded

Returns the value of attribute loaded



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

def loaded
  @loaded
end

- (Object) metadata

Returns the value of attribute metadata



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

def metadata
  @metadata
end

- (Object) target

Returns the value of attribute target



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

def target
  @target
end

Class Method Details

+ (Criteria) eager_load_ids(metadata, ids)

Get the criteria that is used to eager load a relation of this type.

Examples:

Get the eager load criteria.

Proxy.eager_load(metadata, criteria)

Parameters:

  • metadata (Metadata) —

    The relation metadata.

  • ids (Array<Object>) —

    The ids of the base docs.

Returns:

  • (Criteria) —

    The criteria to eager load the relation.

Since:

  • 2.2.0



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/mongoid/relations/proxy.rb', line 162

def eager_load_ids(metadata, ids)
  cleared = false
  klass, foreign_key = metadata.klass, metadata.foreign_key
  klass.any_in(foreign_key => ids).each do |doc|
    selector = { foreign_key => doc.send(foreign_key) }
    unless cleared
      IdentityMap.clear_many(klass, selector)
      cleared = true
    end
    yield(doc, foreign_key => doc.send(foreign_key))
  end
end

Instance Method Details

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

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:

  • base (Document) —

    The base document on the proxy.

  • target (Document, Array<Document>) —

    The target of the proxy.

  • metadata (Metadata) —

    The relation's metadata.

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

- (Object) substitutable

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

- (Document) with(options)

Tell the next persistance operation to store in a specific collection, database or session.

Examples:

Save the current document to a different collection.

model.with(collection: "secondary").save

Save the current document to a different database.

model.with(database: "secondary").save

Save the current document to a different session.

model.with(session: "replica_set").save

Save with a combination of options.

model.with(session: "sharded", database: "secondary").save

Parameters:

  • options (Hash) —

    The storage options.

Options Hash (options):

  • :collection (String, Symbol) —

    The collection name.

  • :database (String, Symbol) —

    The database name.

  • :session (String, Symbol) —

    The session name.

Returns:

Since:

  • 3.0.0



79
80
81
82
 
# File 'lib/mongoid/relations/proxy.rb', line 79

def with(options)
  Threaded.set_persistence_options(klass, options)
  self
end