Class: Mongoid::Association::Referenced::HasMany::Proxy

Inherits:
Many
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/mongoid/association/referenced/has_many/proxy.rb

Overview

This class defines the behavior for all associations that are a one-to-many between documents in different collections.

Instance Attribute Summary

Attributes inherited from Proxy

#_association, #_base, #_target

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Many

#blank?, #create, #create!, #find_or_create_by, #find_or_create_by!, #find_or_initialize_by, #nil?, #respond_to?, #scoped, #serializable_hash

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 references_many association. Will set the foreign key and the base on the inverse object.

Examples:

Create the new association.

Referenced::Many.new(base, target, association)

Parameters:

  • base (Document) —

    The document this association hangs off of.

  • target (Array<Document>) —

    The target of the association.

  • association (Association) —

    The association metadata.



234
235
236
237
238
239
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 234

def initialize(base, target, association)
  enum = HasMany::Enumerable.new(target, base, association)
  init(base, enum, association) do
    raise_mixed if klass.embedded? && !klass.cyclic?
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing ⇒ Criteria | Object (private)

If the target array does not respond to the supplied method then try to find a named scope or criteria on the class and send the call there.

If the method exists on the array, use the default proxy behavior.

Parameters:

  • name (Symbol | String) —

    The name of the method.

  • *args (Object...) —

    The method args

  • block (Proc) —

    Optional block to pass.

Returns:

  • (Criteria | Object) —

    A Criteria or return value from the target.



434
435
436
437
438
439
440
441
442
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 434

ruby2_keywords def method_missing(name, *args, &block)
  if _target.respond_to?(name)
    _target.send(name, *args, &block)
  else
    klass.send(:with_scope, criteria) do
      criteria.public_send(name, *args, &block)
    end
  end
end

Class Method Details

.eager_loader(association, docs) ⇒ Object 



545
546
547
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 545

def eager_loader(association, docs)
  Eager.new(association, docs)
end

.embedded? ⇒ false

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

Examples:

Is this association embedded?

Referenced::Many.embedded?

Returns:

  • (false) —

    Always false.



556
557
558
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 556

def embedded?
  false
end

Instance Method Details

#<<(*args) ⇒ Array<Document> Also known as: push

Appends a document or array of documents to the association. Will set the parent and update the index in the process.

Examples:

Append a document.

person.posts << post

Push a document.

person.posts.push(post)

Concat with other documents.

person.posts.concat([ post_one, post_two ])

Parameters:

  • *args (Document...) —

    Any number of documents.

Returns:

  • (Array<Document>) —

    The loaded docs.



31
32
33
34
35
36
37
38
39
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 31

def <<(*args)
  docs = args.flatten
  return concat(docs) if docs.size > 1
  if doc = docs.first
    append(doc)
    doc.save if persistable? && !_assigning? && !doc.validated?
  end
  self
end

#build(attributes = {}, type = nil) {|doc| ... } ⇒ Document Also known as: new

Build a new document from the attributes and append it to this association without saving.

Examples:

Build a new document on the association.

person.posts.build(:title => "A new post")

Parameters:

  • attributes (Hash) (defaults to: {}) —

    The attributes of the new document.

  • type (Class) (defaults to: nil) —

    The optional subclass to build.

Yields:

  • (doc)

Returns:



73
74
75
76
77
78
79
80
81
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 73

def build(attributes = {}, type = nil)
  doc = Factory.execute_build(type || klass, attributes, execute_callbacks: false)
  append(doc)
  doc.apply_post_processed_defaults
  yield(doc) if block_given?
  doc.run_pending_callbacks
  doc.run_callbacks(:build) { doc }
  doc
end

#concat(documents) ⇒ Array<Document>

Appends an array of documents to the association. Performs a batch insert of the documents instead of persisting one at a time.

Examples:

Concat with other documents.

person.posts.concat([ post_one, post_two ])

Parameters:

  • documents (Array<Document>) —

    The docs to add.

Returns:



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 52

def concat(documents)
  docs, inserts = [], []
  documents.each do |doc|
    next unless doc
    append(doc)
    save_or_delay(doc, docs, inserts) if persistable?
  end
  persist_delayed(docs, inserts)
  self
end

#delete(document) ⇒ Document Also known as: delete_one

Delete the document from the association. This will set the foreign key on the document to nil. If the dependent options on the association are :delete_all or :destroy the appropriate removal will occur.

Examples:

Delete the document.

person.posts.delete(post)

Parameters:

  • document (Document) —

    The document to remove.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 95

def delete(document)
  execute_callbacks_around(:remove, document) do
    _target.delete(document) do |doc|
      if doc
        unbind_one(doc)
        cascade!(doc) if !_assigning?
      end
    end.tap do
      reset_unloaded
    end
  end
end

#delete_all(conditions = nil) ⇒ Integer

Deletes all related documents from the database given the supplied conditions.

Examples:

Delete all documents in the association.

person.posts.delete_all

Conditonally delete all documents in the association.

person.posts.delete_all({ :title => "Testing" })

Parameters:

  • conditions (Hash) (defaults to: nil) —

    Optional conditions to delete with.

Returns:

  • (Integer) —

    The number of documents deleted.



124
125
126
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 124

def delete_all(conditions = nil)
  remove_all(conditions, :delete_all)
end

#destroy_all(conditions = nil) ⇒ Integer

Destroys all related documents from the database given the supplied conditions.

Examples:

Destroy all documents in the association.

person.posts.destroy_all

Conditionally destroy all documents in the association.

person.posts.destroy_all({ :title => "Testing" })

Parameters:

  • conditions (Hash) (defaults to: nil) —

    Optional conditions to destroy with.

Returns:

  • (Integer) —

    The number of documents destroyed.



140
141
142
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 140

def destroy_all(conditions = nil)
  remove_all(conditions, :destroy_all)
end

#each ⇒ Array<Document>

Note:

This will load the entire association into memory.

Iterate over each document in the association and yield to the provided block.

Examples:

Iterate over the documents.

person.posts.each do |post|
  post.save
end

Returns:

  • (Array<Document>) —

    The loaded docs.



155
156
157
158
159
160
161
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 155

def each
  if block_given?
    _target.each { |doc| yield(doc) }
  else
    to_enum
  end
end

#exists?(id_or_conditions = :none) ⇒ true | false

Determine if any documents in this association exist in the database.

If the association contains documents but all of the documents exist only in the application, i.e. have not been persisted to the database, this method returns false.

This method queries the database on each invocation even if the association is already loaded into memory.

Examples:

Are there persisted documents?

person.posts.exists?

Parameters:

  • id_or_conditions (:none | nil | false | Hash | Object) (defaults to: :none) —

    When :none (the default), returns true if any persisted documents exist in the association. When nil or false, this will always return false. When a Hash is given, this queries the documents in the association for those that match the given conditions, and returns true if any match. Any other argument is interpreted as an id, and queries for the existence of documents in the association with a matching _id.

Returns:

  • (true | false) —

    True is persisted documents exist, false if not.



185
186
187
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 185

def exists?(id_or_conditions = :none)
  criteria.exists?(id_or_conditions)
end

#find(*args, &block) ⇒ Document | Array<Document> | nil

Note:

Each argument can be an individual id, an array of ids or a nested array. Each array will be flattened.

Note:

This will keep matching documents in memory for iteration later.

Find the matching document on the association, either based on id or conditions.

This method delegates to Mongoid::Criteria#find. If this method is not given a block, it returns one or many documents for the provided _id values.

If this method is given a block, it returns the first document of those found by the current Criteria object for which the block returns a truthy value.

Examples:

Find by an id.

person.posts.find(BSON::ObjectId.new)

Find by multiple ids.

person.posts.find([ BSON::ObjectId.new, BSON::ObjectId.new ])

Finds the first matching document using a block.

person.addresses.find { |addr| addr.state == 'CA' }

Parameters:

  • *args ([ Object | Array<Object> ]...) —

    The ids.

  • block (Proc) —

    Optional block to pass.

Returns:



219
220
221
222
223
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 219

def find(*args, &block)
  matching = criteria.find(*args, &block)
  Array(matching).each { |doc| _target.push(doc) }
  matching
end

#nullify ⇒ Object Also known as: nullify_all

Removes all associations between the base document and the target documents by deleting the foreign keys and the references, orphaning the target documents in the process.

Examples:

Nullify the association.

person.posts.nullify


247
248
249
250
251
252
253
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 247

def nullify
  criteria.update_all(foreign_key => nil)
  _target.clear do |doc|
    unbind_one(doc)
    doc.changed_attributes.delete(foreign_key)
  end
end

#purge ⇒ Many Also known as: clear

Clear the association. Will delete the documents from the db if they are already persisted.

Examples:

Clear the association.

person.posts.clear

Returns:

  • (Many) —

    The association emptied.



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 264

def purge
  unless _association.destructive?
    nullify
  else
    after_remove_error = nil
    criteria.delete_all
    many = _target.clear do |doc|
      execute_callback :before_remove, doc
      unbind_one(doc)
      doc.destroyed = true
      begin
        execute_callback :after_remove, doc
      rescue => e
        after_remove_error = e
      end
    end
    raise after_remove_error if after_remove_error
    many
  end
end

#substitute(replacement) ⇒ Many

Substitutes the supplied target documents for the existing documents in the association. If the new target is nil, perform the necessary deletion.

Examples:

Replace the association.

person.posts.substitute([ new_post ])

Parameters:

  • replacement (Array<Document>) —

    The replacement target.

Returns:

  • (Many) —

    The association.



297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 297

def substitute(replacement)
  if replacement
    new_docs, docs = replacement.compact, []
    new_ids = new_docs.map { |doc| doc._id }
    remove_not_in(new_ids)
    new_docs.each do |doc|
      docs.push(doc) if doc.send(foreign_key) != _base.send(_association.primary_key)
    end
    concat(docs)
  else
    purge
  end
  self
end

#unscoped ⇒ Criteria

Get a criteria for the documents without the default scoping applied.

Examples:

Get the unscoped criteria.

person.posts.unscoped

Returns:



319
320
321
 
# File 'lib/mongoid/association/referenced/has_many/proxy.rb', line 319

def unscoped
  klass.unscoped.where(foreign_key => _base.send(_association.primary_key))
end