mongoid 7.0.10 → 7.4.0

data/lib/mongoid/association/referenced/has_many/proxy.rb

@@ -1,17 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
       class HasMany
 
-        # This class defines the behaviour for all relations that are a
+        # This class defines the behavior for all associations that are a
         # one-to-many between documents in different collections.
         class Proxy < Association::Many
+          extend Forwardable
 
-          delegate :count, to: :criteria
-          delegate :first, :in_memory, :last, :reset, :uniq, to: :_target
+          def_delegator :criteria, :count
+          def_delegators :_target, :first, :in_memory, :last, :reset, :uniq
 
-          # Appends a document or array of documents to the relation. Will set
+          # Appends a document or array of documents to the association. Will set
           # the parent and update the index in the process.
           #
           # @example Append a document.
@@ -26,8 +28,6 @@ module Mongoid
           # @param [ Document, Array<Document> ] args Any number of documents.
           #
           # @return [ Array<Document> ] The loaded docs.
-          #
-          # @since 2.0.0.beta.1
           def <<(*args)
             docs = args.flatten
             return concat(docs) if docs.size > 1
@@ -40,7 +40,7 @@ module Mongoid
 
           alias :push :<<
 
-          # Appends an array of documents to the relation. Performs a batch
+          # Appends an array of documents to the association. Performs a batch
           # insert of the documents instead of persisting one at a time.
           #
           # @example Concat with other documents.
@@ -49,8 +49,6 @@ module Mongoid
           # @param [ Array<Document> ] documents The docs to add.
           #
           # @return [ Array<Document> ] The documents.
-          #
-          # @since 2.4.0
           def concat(documents)
             docs, inserts = [], []
             documents.each do |doc|
@@ -63,17 +61,15 @@ module Mongoid
           end
 
           # Build a new document from the attributes and append it to this
-          # relation without saving.
+          # association without saving.
           #
-          # @example Build a new document on the relation.
+          # @example Build a new document on the association.
           #   person.posts.build(:title => "A new post")
           #
           # @param [ Hash ] attributes The attributes of the new document.
           # @param [ Class ] type The optional subclass to build.
           #
           # @return [ Document ] The new document.
-          #
-          # @since 2.0.0.beta.1
           def build(attributes = {}, type = nil)
             doc = Factory.build(type || klass, attributes)
             append(doc)
@@ -85,9 +81,9 @@ module Mongoid
 
           alias :new :build
 
-          # Delete the document from the relation. This will set the foreign key
-          # on the document to nil. If the dependent options on the relation are
-          # :delete or :destroy the appropriate removal will occur.
+          # 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.
           #
           # @example Delete the document.
           #   person.posts.delete(post)
@@ -95,8 +91,6 @@ module Mongoid
           # @param [ Document ] document The document to remove.
           #
           # @return [ Document ] The matching document.
-          #
-          # @since 2.1.0
           def delete(document)
             execute_callback :before_remove, document
             _target.delete(document) do |doc|
@@ -111,17 +105,15 @@ module Mongoid
           # Deletes all related documents from the database given the supplied
           # conditions.
           #
-          # @example Delete all documents in the relation.
+          # @example Delete all documents in the association.
           #   person.posts.delete_all
           #
-          # @example Conditonally delete all documents in the relation.
+          # @example Conditonally delete all documents in the association.
           #   person.posts.delete_all({ :title => "Testing" })
           #
           # @param [ Hash ] conditions Optional conditions to delete with.
           #
           # @return [ Integer ] The number of documents deleted.
-          #
-          # @since 2.0.0.beta.1
           def delete_all(conditions = nil)
             remove_all(conditions, :delete_all)
           end
@@ -129,25 +121,23 @@ module Mongoid
           # Destroys all related documents from the database given the supplied
           # conditions.
           #
-          # @example Destroy all documents in the relation.
+          # @example Destroy all documents in the association.
           #   person.posts.destroy_all
           #
-          # @example Conditonally destroy all documents in the relation.
+          # @example Conditionally destroy all documents in the association.
           #   person.posts.destroy_all({ :title => "Testing" })
           #
           # @param [ Hash ] conditions Optional conditions to destroy with.
           #
-          # @return [ Integer ] The number of documents destroyd.
-          #
-          # @since 2.0.0.beta.1
+          # @return [ Integer ] The number of documents destroyed.
           def destroy_all(conditions = nil)
             remove_all(conditions, :destroy_all)
           end
 
-          # Iterate over each document in the relation and yield to the provided
+          # Iterate over each document in the association and yield to the provided
           # block.
           #
-          # @note This will load the entire relation into memory.
+          # @note This will load the entire association into memory.
           #
           # @example Iterate over the documents.
           #   person.posts.each do |post|
@@ -155,8 +145,6 @@ module Mongoid
           #   end
           #
           # @return [ Array<Document> ] The loaded docs.
-          #
-          # @since 2.1.0
           def each
             if block_given?
               _target.each { |doc| yield(doc) }
@@ -165,7 +153,14 @@ module Mongoid
             end
           end
 
-          # Determine if any documents in this relation exist in the database.
+          # 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.
           #
           # @example Are there persisted documents?
           #   person.posts.exists?
@@ -175,42 +170,50 @@ module Mongoid
             criteria.exists?
           end
 
-          # Find the matchind document on the association, either based on id or
+          # 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.
+          #
           # @example Find by an id.
           #   person.posts.find(BSON::ObjectId.new)
           #
           # @example Find by multiple ids.
           #   person.posts.find([ BSON::ObjectId.new, BSON::ObjectId.new ])
           #
+          # @example Finds the first matching document using a block.
+          #   person.addresses.find { |addr| addr.state == 'CA' }
+          #
           # @note This will keep matching documents in memory for iteration
           #   later.
           #
           # @param [ BSON::ObjectId, Array<BSON::ObjectId> ] args The ids.
+          # @param [ Proc ] block Optional block to pass.
           #
-          # @return [ Document, Criteria ] The matching document(s).
-          #
-          # @since 2.0.0.beta.1
-          def find(*args)
-            matching = criteria.find(*args)
+          # @return [ Document | Array<Document> | nil ] A document or matching documents.
+          def find(*args, &block)
+            matching = criteria.find(*args, &block)
             Array(matching).each { |doc| _target.push(doc) }
             matching
           end
 
-          # Instantiate a new references_many relation. Will set the foreign key
+          # Instantiate a new references_many association. Will set the foreign key
           # and the base on the inverse object.
           #
-          # @example Create the new relation.
+          # @example Create the new association.
           #   Referenced::Many.new(base, target, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
-          # @param [ Array<Document> ] target The target of the relation.
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Array<Document> ] target The target of the association.
           # @param [ Association ] association The association metadata.
-          #
-          # @since 2.0.0.beta.1
           def initialize(base, target, association)
-            enum = HasMany::Targets::Enumerable.new(target, base, association)
+            enum = HasMany::Enumerable.new(target, base, association)
             init(base, enum, association) do
               raise_mixed if klass.embedded? && !klass.cyclic?
             end
@@ -220,10 +223,8 @@ module Mongoid
           # documents by deleting the foreign keys and the references, orphaning
           # the target documents in the process.
           #
-          # @example Nullify the relation.
+          # @example Nullify the association.
           #   person.posts.nullify
-          #
-          # @since 2.0.0.rc.1
           def nullify
             criteria.update_all(foreign_key => nil)
             _target.clear do |doc|
@@ -234,15 +235,13 @@ module Mongoid
 
           alias :nullify_all :nullify
 
-          # Clear the relation. Will delete the documents from the db if they are
+          # Clear the association. Will delete the documents from the db if they are
           # already persisted.
           #
-          # @example Clear the relation.
+          # @example Clear the association.
           #   person.posts.clear
           #
-          # @return [ Many ] The relation emptied.
-          #
-          # @since 2.0.0.beta.1
+          # @return [ Many ] The association emptied.
           def purge
             unless _association.destructive?
               nullify
@@ -267,17 +266,15 @@ module Mongoid
           alias :clear :purge
 
           # Substitutes the supplied target documents for the existing documents
-          # in the relation. If the new target is nil, perform the necessary
+          # in the association. If the new target is nil, perform the necessary
           # deletion.
           #
-          # @example Replace the relation.
+          # @example Replace the association.
           #   person.posts.substitute([ new_post ])
           #
           # @param [ Array<Document> ] replacement The replacement target.
           #
-          # @return [ Many ] The relation.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ Many ] The association.
           def substitute(replacement)
             if replacement
               new_docs, docs = replacement.compact, []
@@ -300,8 +297,6 @@ module Mongoid
           #   person.posts.unscoped
           #
           # @return [ Criteria ] The unscoped criteria.
-          #
-          # @since 2.4.0
           def unscoped
             klass.unscoped.where(foreign_key => _base.send(_association.primary_key))
           end
@@ -311,12 +306,10 @@ module Mongoid
           # Appends the document to the target array, updating the index on the
           # document at the same time.
           #
-          # @example Append the document to the relation.
+          # @example Append the document to the association.
           #   relation.append(document)
           #
           # @param [ Document ] document The document to append to the target.
-          #
-          # @since 2.0.0.rc.1
           def append(document)
             with_add_callbacks(document, already_related?(document)) do
               _target.push(document)
@@ -326,7 +319,7 @@ module Mongoid
           end
 
           # Execute before/after add callbacks around the block unless the objects
-          # already have a persisted relation.
+          # already have a persisted association.
           #
           # @example Execute before/after add callbacks around the block.
           #   relation.with_add_callbacks(document, false)
@@ -334,15 +327,13 @@ module Mongoid
           # @param [ Document ] document The document to append to the target.
           # @param [ true, false ] already_related Whether the document is already related
           #   to the target.
-          #
-          # @since 5.1.0
           def with_add_callbacks(document, already_related)
             execute_callback :before_add, document unless already_related
             yield
             execute_callback :after_add, document unless already_related
           end
 
-          # Whether the document and the base already have a persisted relation.
+          # Whether the document and the base already have a persisted association.
           #
           # @example Is the document already related to the base.
           #   relation.already_related?(document)
@@ -350,36 +341,30 @@ module Mongoid
           # @param [ Document ] document The document to possibly append to the target.
           #
           # @return [ true, false ] Whether the document is already related to the base and the
-          #   relation is persisted.
-          #
-          # @since 5.1.0
+          #   association is persisted.
           def already_related?(document)
             document.persisted? &&
                 document._association &&
                 document.respond_to?(document._association.foreign_key) &&
-                document.__send__(document._association.foreign_key) == _base.id
+                document.__send__(document._association.foreign_key) == _base._id
           end
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   relation.binding([ address ])
           #
           # @return [ Binding ] The binding.
-          #
-          # @since 2.0.0.rc.1
           def binding
             HasMany::Binding.new(_base, _target, _association)
           end
 
-          # Get the collection of the relation in question.
+          # Get the collection of the association in question.
           #
-          # @example Get the collection of the relation.
+          # @example Get the collection of the association.
           #   relation.collection
           #
-          # @return [ Collection ] The collection of the relation.
-          #
-          # @since 2.0.2
+          # @return [ Collection ] The collection of the association.
           def collection
             klass.collection
           end
@@ -387,12 +372,10 @@ module Mongoid
           # Returns the criteria object for the target class with its documents set
           # to target.
           #
-          # @example Get a criteria for the relation.
+          # @example Get a criteria for the association.
           #   relation.criteria
           #
           # @return [ Criteria ] A new criteria.
-          #
-          # @since 2.0.0.beta.1
           def criteria
             @criteria ||= _association.criteria(_base)
           end
@@ -406,8 +389,6 @@ module Mongoid
           # @param [ Document ] document The document to cascade on.
           #
           # @return [ true, false ] If the association is destructive.
-          #
-          # @since 2.1.0
           def cascade!(document)
             if persistable?
               case _association.dependent
@@ -431,9 +412,7 @@ module Mongoid
           # @param [ Proc ] block Optional block to pass.
           #
           # @return [ Criteria, Object ] A Criteria or return value from the target.
-          #
-          # @since 2.0.0.beta.1
-          def method_missing(name, *args, &block)
+          ruby2_keywords def method_missing(name, *args, &block)
             if _target.respond_to?(name)
               _target.send(name, *args, &block)
             else
@@ -452,8 +431,6 @@ module Mongoid
           #
           # @param [ Array<Document> ] docs The delayed inserts.
           # @param [ Array<Hash> ] inserts The raw insert document.
-          #
-          # @since 3.0.0
           def persist_delayed(docs, inserts)
             unless docs.empty?
               collection.insert_many(inserts, session: _session)
@@ -465,14 +442,12 @@ module Mongoid
             end
           end
 
-          # Are we able to persist this relation?
+          # Are we able to persist this association?
           #
-          # @example Can we persist the relation?
+          # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the relation is persistable.
-          #
-          # @since 2.1.0
+          # @return [ true, false ] If the association is persistable.
           def persistable?
             !_binding? && (_creating? || _base.persisted? && !_building?)
           end
@@ -480,18 +455,16 @@ module Mongoid
           # Deletes all related documents from the database given the supplied
           # conditions.
           #
-          # @example Delete all documents in the relation.
+          # @example Delete all documents in the association.
           #   person.posts.delete_all
           #
-          # @example Conditonally delete all documents in the relation.
+          # @example Conditonally delete all documents in the association.
           #   person.posts.delete_all({ :title => "Testing" })
           #
           # @param [ Hash ] conditions Optional conditions to delete with.
           # @param [ Symbol ] method The deletion method to call.
           #
           # @return [ Integer ] The number of documents deleted.
-          #
-          # @since 2.1.0
           def remove_all(conditions = nil, method = :delete_all)
             selector = conditions || {}
             removed = klass.send(method, selector.merge!(criteria.selector))
@@ -510,8 +483,6 @@ module Mongoid
           #   proxy.remove_not_in([ id ])
           #
           # @param [ Array<Object> ] ids The ids.
-          #
-          # @since 2.4.0
           def remove_not_in(ids)
             removed = criteria.not_in(_id: ids)
             if _association.destructive?
@@ -540,8 +511,6 @@ module Mongoid
           #
           # @param [ Document ] doc The document.
           # @param [ Array<Document> ] inserts The inserts.
-          #
-          # @since 3.0.0
           def save_or_delay(doc, docs, inserts)
             if doc.new_record? && doc.valid?(:create)
               doc.run_before_callbacks(:save, :create)
@@ -558,15 +527,13 @@ module Mongoid
               Eager.new(association, docs)
             end
 
-            # Returns true if the relation is an embedded one. In this case
+            # Returns true if the association is an embedded one. In this case
             # always false.
             #
-            # @example Is this relation embedded?
+            # @example Is this association embedded?
             #   Referenced::Many.embedded?
             #
             # @return [ false ] Always false.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               false
             end

data/lib/mongoid/association/referenced/has_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/referenced/has_many/binding'
 require 'mongoid/association/referenced/has_many/buildable'
 require 'mongoid/association/referenced/has_many/proxy'
@@ -9,8 +11,6 @@ module Mongoid
     module Referenced
 
       # The has_many association.
-      #
-      # @since 7.0
       class HasMany
         include Relatable
         include Buildable
@@ -19,8 +19,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :after_add,
             :after_remove,
@@ -31,29 +29,24 @@ module Mongoid
             :dependent,
             :foreign_key,
             :order,
-            :primary_key
+            :primary_key,
+            :scope,
         ].freeze
 
         # The complete list of valid options for this association, including
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # The default foreign key suffix.
         #
         # @return [ String ] '_id'
-        #
-        # @since 7.0
         FOREIGN_KEY_SUFFIX = '_id'.freeze
 
         # The list of association complements.
         #
         # @return [ Array<Association> ] The association complements.
-        #
-        # @since 7.0
         def relation_complements
           @relation_complements ||= [ Referenced::BelongsTo ].freeze
         end
@@ -61,8 +54,6 @@ module Mongoid
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           self
@@ -71,8 +62,6 @@ module Mongoid
         # Setup the instance methods on the class having this association type.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup_instance_methods!
           define_getter!
           define_ids_getter!
@@ -91,8 +80,6 @@ module Mongoid
         #
         # @return [ String ] The foreign key field on the inverse for saving the
         #   association reference.
-        #
-        # @since 7.0
         def foreign_key
           @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
                              default_foreign_key_field
@@ -101,49 +88,37 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def embedded?; false; end
 
         # The default for validation the association object.
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def validation_default; true; end
 
         # Does this association type store the foreign key?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def stores_foreign_key?; false; end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::HasMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
 
-        # The criteria used for querying this relation.
-        #
-        # @return [ Mongoid::Criteria ] The criteria used for querying this relation.
+        # The criteria used for querying this association.
         #
-        # @since 7.0
+        # @return [ Mongoid::Criteria ] The criteria used for querying this association.
         def criteria(base)
           query_criteria(base.send(primary_key), base)
         end
 
         # The type of this association if it's polymorphic.
         #
-        # @note Only relevant for polymorphic relations.
+        # @note Only relevant for polymorphic associations.
         #
         # @return [ String, nil ] The type field.
-        #
-        # @since 7.0
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -155,8 +130,6 @@ module Mongoid
         # @param [ Class ] object_class The object class.
         #
         # @return [ Mongoid::Criteria ] The criteria object.
-        #
-        # @since 7.0
         def add_polymorphic_criterion(criteria, object_class)
           if polymorphic?
             criteria.where(type => object_class.name)
@@ -168,8 +141,6 @@ module Mongoid
         # Is this association polymorphic?
         #
         # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
         def polymorphic?
           @polymorphic ||= !!as
         end
@@ -190,8 +161,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::Many ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::Many.new(self, attributes, options)
         end
@@ -204,12 +173,17 @@ module Mongoid
         # @param [ Document ] document The document to calculate on.
         #
         # @return [ Root ] The root atomic path calculator.
-        #
-        # @since 2.1.0
         def path(document)
           Mongoid::Atomic::Paths::Root.new(document)
         end
 
+        # Get the scope to be applied when querying the association.
+        #
+        # @return [ Proc | Symbol | nil ] The association scope, if any.
+        def scope
+          @options[:scope]
+        end
+
         private
 
         def default_foreign_key_field
@@ -238,7 +212,9 @@ module Mongoid
         end
 
         def query_criteria(object, base)
-          crit = klass.where(foreign_key => object)
+          crit = klass.criteria
+          crit = crit.apply_scope(scope)
+          crit = crit.where(foreign_key => object)
           crit = with_polymorphic_criterion(crit, base)
           crit.association = self
           crit.parent_document = base