mongoid 7.0.6 → 7.1.2

data/lib/mongoid/association/referenced/belongs_to/binding.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -8,7 +10,7 @@ module Mongoid
         class Binding
           include Bindable
 
-          # Binds the base object to the inverse of the relation. This is so we
+          # Binds the base object to the inverse of the association. This is so we
           # are referenced to the actual objects themselves on both sides.
           #
           # This case sets the association on the inverse object as well as the

data/lib/mongoid/association/referenced/belongs_to/buildable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -16,11 +18,12 @@ module Mongoid
           #   relation.build(meta, attrs)
           #
           # @param [ Object ] base The base object.
-          # @param [ Object ] object The object to use to build the relation.
-          # @param [ String ] type The type of the relation.
+          # @param [ Object ] object The object to use to build the association.
+          # @param [ String ] type The type of the association.
+          # @param [ nil ] selected_fields Must be nil.
           #
           # @return [ Document ] A single document.
-          def build(base, object, type = nil)
+          def build(base, object, type = nil, selected_fields = nil)
             return object unless query?(object)
             execute_query(object, type)
           end

data/lib/mongoid/association/referenced/belongs_to/eager.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -10,8 +12,6 @@ module Mongoid
           private
 
           def preload
-            raise Errors::EagerLoad.new(@association.name) if @association.polymorphic?
-
             @docs.each do |d|
               set_relation(d, nil)
             end
@@ -22,6 +22,44 @@ module Mongoid
             end
           end
 
+          # Retrieves the documents referenced by the association, and
+          # yields each one sequentially to the provided block. If the
+          # association is not polymorphic, all documents are retrieved in
+          # a single query. If the association is polymorphic, one query is
+          # issued per association target class.
+          def each_loaded_document(&block)
+            if @association.polymorphic?
+              keys_by_type_from_docs.each do |type, keys|
+                each_loaded_document_of_class(Object.const_get(type), keys, &block)
+              end
+            else
+              super
+            end
+          end
+
+          # Returns a map from association target class name to foreign key
+          # values for the documents of that association target class,
+          # as referenced by this association.
+          def keys_by_type_from_docs
+            inverse_type_field = @association.inverse_type
+
+            @docs.each_with_object({}) do |doc, keys_by_type|
+              next unless doc.respond_to?(inverse_type_field) && doc.respond_to?(group_by_key)
+              inverse_type_name = doc.send(inverse_type_field)
+              # If a particular document does not have a value for this
+              # association, inverse_type_name will be nil.
+              next if inverse_type_name.nil?
+
+              key_value = doc.send(group_by_key)
+              # If a document has the *_type field set but the corresponding
+              # *_id field not set, the key value here will be nil.
+              next unless key_value
+
+              keys_by_type[inverse_type_name] ||= []
+              keys_by_type[inverse_type_name].push(key_value)
+            end
+          end
+
           def group_by_key
             @association.foreign_key
           end

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

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
       class BelongsTo
 
-        # This class handles all behaviour for relations that are either
+        # This class handles all behavior for associations that are either
         # one-to-many or one-to-one, where the foreign key is stored on this side
-        # of the relation and the reference is to document(s) in another
+        # of the association and the reference is to document(s) in another
         # collection.
         class Proxy < Association::One
           include Evolvable
@@ -16,9 +18,9 @@ module Mongoid
           # @example Create the new proxy.
           #   Association::BelongsTo::Proxy.new(game, person, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
+          # @param [ Document ] base The document this association hangs off of.
           # @param [ Document, Array<Document> ] target The target (parent) of the
-          #   relation.
+          #   association.
           # @param [ Association ] association The association object.
           def initialize(base, target, association)
             init(base, target, association) do
@@ -31,7 +33,7 @@ module Mongoid
           # document by deleting the foreign key and the reference, orphaning
           # the target document in the process.
           #
-          # @example Nullify the relation.
+          # @example Nullify the association.
           #   person.game.nullify
           #
           def nullify
@@ -40,14 +42,14 @@ module Mongoid
           end
 
           # Substitutes the supplied target documents for the existing document
-          # in the relation.
+          # in the association.
           #
-          # @example Substitute the relation.
+          # @example Substitute the association.
           #   name.substitute(new_name)
           #
           # @param [ Document, Array<Document> ] replacement The replacement.
           #
-          # @return [ self, nil ] The relation or nil.
+          # @return [ self, nil ] The association or nil.
           #
           # @since 2.0.0.rc.1
           def substitute(replacement)
@@ -61,7 +63,7 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding object.
           #   binding([ address ])
@@ -90,12 +92,12 @@ module Mongoid
             _association.build(klass, replacement)
           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.
+          # @return [ true, false ] If the association is persistable.
           #
           # @since 2.1.0
           def persistable?
@@ -116,10 +118,10 @@ 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?
             #   Association::BelongsTo::Proxy.embedded?
             #
             # @return [ false ] Always false.

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -15,7 +17,7 @@ module Mongoid
           #   BelongsTo.new(association, parent_docs)
           #
           # @param [ Array<Association> ] associations Associations to eager load
-          # @param [ Array<Document> ] docs Documents to preload the relations
+          # @param [ Array<Document> ] docs Documents to preload the associations
           #
           # @return [ Base ] The eager load preloader
           #
@@ -28,7 +30,7 @@ module Mongoid
 
           # Run the preloader.
           #
-          # @example Preload the relations into the documents.
+          # @example Preload the associations into the documents.
           #   loader.run
           #
           # @return [ Array ] The list of documents given.
@@ -45,11 +47,11 @@ module Mongoid
 
           protected
 
-          # Preload the current relation.
+          # Preload the current association.
           #
           # This method should be implemented in the subclass
           #
-          # @example Preload the current relation into the documents.
+          # @example Preload the current association into the documents.
           #   loader.preload
           #
           # @since 4.0.0
@@ -57,17 +59,29 @@ module Mongoid
             raise NotImplementedError
           end
 
-          # Run the preloader.
-          #
-          # @example Iterate over the documents loaded for the current relation
-          #   loader.each_loaded_document { |doc| }
+          # Retrieves the documents referenced by the association, and
+          # yields each one sequentially to the provided block. If the
+          # association is not polymorphic, all documents are retrieved in
+          # a single query. If the association is polymorphic, one query is
+          # issued per association target class.
           #
           # @since 4.0.0
-          def each_loaded_document
-            doc_keys = keys_from_docs
-            return @association.klass.none if doc_keys.all?(&:nil?)
+          def each_loaded_document(&block)
+            each_loaded_document_of_class(@association.klass, keys_from_docs, &block)
+          end
 
-            criteria = @association.klass.any_in(key => doc_keys)
+          # Retrieves the documents of the specified class, that have the
+          # foreign key included in the specified list of keys.
+          #
+          # When the documents are retrieved, the set of inclusions applied
+          # is the set of inclusions applied to the host document minus the
+          # association that is being eagerly loaded.
+          private def each_loaded_document_of_class(cls, keys)
+            # Note: keys should not include nil elements.
+            # Upstream code is responsible for eliminating nils from keys.
+            return cls.none if keys.empty?
+
+            criteria = cls.any_in(key => keys)
             criteria.inclusions = criteria.inclusions - [@association]
             criteria.each do |doc|
               yield doc
@@ -91,6 +105,9 @@ module Mongoid
 
           # Return a hash with the current documents grouped by key.
           #
+          # Documents that do not have a value for the association being loaded
+          # are not returned.
+          #
           # @example Return a hash with the current documents grouped by key.
           #   loader.grouped_docs
           #
@@ -100,10 +117,15 @@ module Mongoid
           def grouped_docs
             @grouped_docs[@association.name] ||= @docs.group_by do |doc|
               doc.send(group_by_key) if doc.respond_to?(group_by_key)
+            end.reject do |k, v|
+              k.nil?
             end
           end
 
-          # Group the documents and return the keys
+          # Group the documents and return the keys.
+          #
+          # This method omits nil keys (i.e. keys from documents that do not
+          # have a value for the association being loaded).
           #
           # @example
           #   loader.keys_from_docs
@@ -131,10 +153,10 @@ module Mongoid
 
           # Set the pre-loaded document into its parent.
           #
-          # @example Set docs into parent using the current relation name.
+          # @example Set docs into parent using the current association name.
           #   loader.set_relation(doc, docs)
           #
-          # @param [ Document ] doc The object to set the relation on
+          # @param [ Document ] doc The object to set the association on
           # @param [ Document, Array ] element to set into the parent
           #
           # @since 4.0.0

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/referenced/has_and_belongs_to_many/binding'
 require 'mongoid/association/referenced/has_and_belongs_to_many/buildable'
 require 'mongoid/association/referenced/has_and_belongs_to_many/proxy'
@@ -31,7 +34,9 @@ module Mongoid
             :foreign_key,
             :index,
             :order,
-            :primary_key
+            :primary_key,
+            :inverse_primary_key,
+            :inverse_foreign_key,
         ].freeze
 
         # The complete list of valid options for this association, including
@@ -89,7 +94,7 @@ module Mongoid
         # @since 7.0
         def validation_default; true; end
 
-        # Are ids only saved on this side of the relation?
+        # Are ids only saved on this side of the association?
         #
         # @return [ true, false ] Whether this association has a forced nil inverse.
         #
@@ -105,7 +110,7 @@ module Mongoid
         # @since 7.0
         def stores_foreign_key?; true; end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::HasAndBelongsToMany::Proxy ] The proxy class.
         #
@@ -124,9 +129,9 @@ module Mongoid
                              default_foreign_key_field
         end
 
-        # The criteria used for querying this relation.
+        # The criteria used for querying this association.
         #
-        # @return [ Mongoid::Criteria ] The criteria used for querying this relation.
+        # @return [ Mongoid::Criteria ] The criteria used for querying this association.
         #
         # @since 7.0
         def criteria(base, id_list = nil)
@@ -140,7 +145,9 @@ module Mongoid
         #
         # @since 7.0
         def inverse_foreign_key
-          if @options.key?(:inverse_of)
+          if @options.key?(:inverse_foreign_key)
+            @options[:inverse_foreign_key]
+          elsif @options.key?(:inverse_of)
             inverse_of ? "#{inverse_of.to_s.singularize}#{FOREIGN_KEY_SUFFIX}" : nil
           else
             "#{inverse_class_name.demodulize.underscore}#{FOREIGN_KEY_SUFFIX}"

data/lib/mongoid/association/referenced/has_and_belongs_to_many/binding.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
       class HasAndBelongsToMany
 
-        # Binding class for all has_and_belongs_to_many relations.
+        # Binding class for all has_and_belongs_to_many associations.
         class Binding
           include Bindable
 
-          # Binds a single document with the inverse relation. Used
+          # Binds a single document with the inverse association. Used
           # specifically when appending to the proxy.
           #
           # @example Bind one document.
@@ -53,11 +55,15 @@ module Mongoid
 
           # Find the inverse id referenced by inverse_keys
           def inverse_record_id(doc)
-            inverse_association = determine_inverse_association(doc)
-            if inverse_association
-              _base.__send__(inverse_association.primary_key)
+            if pk = _association.options[:inverse_primary_key]
+              _base.send(pk)
             else
-              _base._id
+              inverse_association = determine_inverse_association(doc)
+              if inverse_association
+                _base.__send__(inverse_association.primary_key)
+              else
+                _base._id
+              end
             end
           end
 

data/lib/mongoid/association/referenced/has_and_belongs_to_many/buildable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -16,11 +18,12 @@ module Mongoid
           #   relation.build(association, attrs)
           #
           # @param [ Object ] base The base object.
-          # @param [ Object ] object The object to use to build the relation.
+          # @param [ Object ] object The object to use to build the association.
           # @param [ String ] type Not used in this context.
+          # @param [ nil ] selected_fields Must be nil.
           #
           # @return [ Array<Document> ] The documents.
-          def build(base, object, type = nil)
+          def build(base, object, type = nil, selected_fields = nil)
             if query?(object)
               query_criteria(object)
             else

data/lib/mongoid/association/referenced/has_and_belongs_to_many/eager.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced

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

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
       class HasAndBelongsToMany
 
-        # This class defines the behaviour for all relations that are a
+        # This class defines the behavior for all associations that are a
         # many-to-many between documents in different collections.
         class Proxy < Referenced::HasMany::Proxy
 
-          # 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.
@@ -40,7 +42,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.
@@ -74,9 +76,9 @@ 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.
@@ -97,8 +99,8 @@ 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 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 or :destroy the appropriate removal will occur.
           #
           # @example Delete the document.
@@ -123,7 +125,7 @@ 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.preferences.nullify
           #
           # @param [ Array<Document> ] replacement The replacement documents.
@@ -134,13 +136,18 @@ module Mongoid
               execute_callback :before_remove, doc
             end
             unless _association.forced_nil_inverse?
+              if field = _association.options[:inverse_primary_key]
+                ipk = _base.send(field)
+              else
+                ipk = _base._id
+              end
               if replacement
                 objects_to_clear = _base.send(foreign_key) - replacement.collect do |object|
                   object.send(_association.primary_key)
                 end
-                criteria(objects_to_clear).pull(inverse_foreign_key => _base._id)
+                criteria(objects_to_clear).pull(inverse_foreign_key => ipk)
               else
-                criteria.pull(inverse_foreign_key => _base._id)
+                criteria.pull(inverse_foreign_key => ipk)
               end
             end
             if persistable?
@@ -167,15 +174,15 @@ module Mongoid
           alias :purge :nullify
 
           # 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.preferences.substitute([ new_post ])
           #
           # @param [ Array<Document> ] replacement The replacement target.
           #
-          # @return [ Many ] The relation.
+          # @return [ Many ] The association.
           #
           # @since 2.0.0.rc.1
           def substitute(replacement)
@@ -206,7 +213,7 @@ 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.
@@ -220,7 +227,7 @@ module Mongoid
             execute_callback :after_add, document
           end
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   relation.binding([ address ])
@@ -252,7 +259,7 @@ 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.
@@ -292,10 +299,10 @@ 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::ManyToMany.embedded?
             #
             # @return [ false ] Always false.