mongoid 7.0.10 → 7.4.0

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
@@ -10,8 +11,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 +21,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,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 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 +17,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 +32,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,16 +41,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.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ self, nil ] The association or nil.
           def substitute(replacement)
             unbind_one
             if replacement
@@ -61,14 +60,12 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding object.
           #   binding([ address ])
           #
           # @return [ Binding ] The binding object.
-          #
-          # @since 2.0.0.rc.1
           def binding
             BelongsTo::Binding.new(_base, _target, _association)
           end
@@ -83,21 +80,17 @@ module Mongoid
           # @param [ Document, Object ] replacement The replacement object.
           #
           # @return [ Document ] The document.
-          #
-          # @since 3.1.5
           def normalize(replacement)
             return replacement if replacement.is_a?(Document)
             _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.
-          #
-          # @since 2.1.0
+          # @return [ true, false ] If the association is persistable.
           def persistable?
             _target.persisted? && !_binding? && !_building?
           end
@@ -110,21 +103,17 @@ module Mongoid
             #
             # @param [ Association ] association The association object.
             # @param [ Array<Document> ] docs The array of documents.
-            #
-            # @since 7.0
             def eager_loader(association, docs)
               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.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               false
             end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/referenced/belongs_to/binding'
 require 'mongoid/association/referenced/belongs_to/buildable'
 require 'mongoid/association/referenced/belongs_to/proxy'
@@ -8,8 +10,6 @@ module Mongoid
     module Referenced
 
       # The BelongsTo type association.
-      #
-      # @since 7.0
       class BelongsTo
         include Relatable
         include Buildable
@@ -18,8 +18,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :autobuild,
             :autosave,
@@ -31,36 +29,29 @@ module Mongoid
             :primary_key,
             :touch,
             :optional,
-            :required
+            :required,
+            :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 type of the field holding the foreign key.
         #
         # @return [ Object ]
-        #
-        # @since 7.0
         FOREIGN_KEY_FIELD_TYPE = Object
 
         # 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 ||= [ HasMany, HasOne ].freeze
         end
@@ -68,8 +59,6 @@ module Mongoid
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           @owner_class.aliased_fields[name.to_s] = foreign_key
@@ -79,39 +68,29 @@ module Mongoid
         # Does this association type store the foreign key?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def stores_foreign_key?; true; end
 
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def embedded?; false; end
 
         # The default for validation the association object.
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def validation_default; false; end
 
         # Get the foreign key field for saving the association reference.
         #
         # @return [ String ] The foreign key field 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
         end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::BelongsTo::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -119,17 +98,13 @@ module Mongoid
         # Is this association polymorphic?
         #
         # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
         def polymorphic?
           @polymorphic ||= !!@options[:polymorphic]
         end
 
-        # The name of the field used to store the type of polymorphic relation.
+        # The name of the field used to store the type of polymorphic association.
         #
-        # @return [ String ] The field used to store the type of polymorphic relation.
-        #
-        # @since 7.0
+        # @return [ String ] The field used to store the type of polymorphic association.
         def inverse_type
           (@inverse_type ||= "#{name}_type") if polymorphic?
         end
@@ -140,8 +115,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::One ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::One.new(self, attributes, options)
         end
@@ -154,12 +127,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 setup_instance_methods!

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
@@ -6,15 +7,13 @@ module Mongoid
         extend ActiveSupport::Concern
 
         # Reset the given counter using the .count() query from the
-        # db. This method is usuful in case that a counter got
+        # db. This method is useful in case that a counter got
         # corrupted, or a new counter was added to the collection.
         #
         # @example Reset the given counter cache
         #   post.reset_counters(:comments)
         #
         # @param [ Symbol, Array ] counters One or more counter caches to reset
-        #
-        # @since 4.0.0
         def reset_counters(*counters)
           self.class.with(persistence_context) do |_class|
             _class.reset_counters(self, *counters)
@@ -24,7 +23,7 @@ module Mongoid
         module ClassMethods
 
           # Reset the given counter using the .count() query from the
-          # db. This method is usuful in case that a counter got
+          # db. This method is useful in case that a counter got
           # corrupted, or a new counter was added to the collection.
           #
           # @example Reset the given counter cache
@@ -32,8 +31,6 @@ module Mongoid
           #
           # @param [ String ] id The id of the object that will be reset.
           # @param [ Symbol, Array ] counters One or more counter caches to reset
-          #
-          # @since 3.1.0
           def reset_counters(id, *counters)
             document = id.is_a?(Document) ? id : find(id)
             counters.each do |name|
@@ -53,8 +50,6 @@ module Mongoid
           #
           # @param [ String ] id The id of the object to update.
           # @param [ Hash ] counters
-          #
-          # @since 3.1.0
           def update_counters(id, counters)
             where(:_id => id).inc(counters)
           end
@@ -68,8 +63,6 @@ module Mongoid
           #
           # @param [ Symbol ] counter_name Counter cache name
           # @param [ String ] id The id of the object that will have its counter incremented.
-          #
-          # @since 3.1.0
           def increment_counter(counter_name, id)
             update_counters(id, counter_name.to_sym => 1)
           end
@@ -83,8 +76,6 @@ module Mongoid
           #
           # @param [ Symbol ] counter_name Counter cache name
           # @param [ String ] id The id of the object that will have its counter decremented.
-          #
-          # @since 3.1.0
           def decrement_counter(counter_name, id)
             update_counters(id, counter_name.to_sym => -1)
           end
@@ -100,8 +91,6 @@ module Mongoid
         # @param [ Association ] association The association.
         #
         # @return [ Class ] The association's owning class.
-        #
-        # @since 7.0
         def self.define_callbacks!(association)
           name = association.name
           cache_column = association.counter_cache_column_name.to_sym

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

@@ -1,12 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
       module Eager
 
         # Base class for eager load preload functions.
-        #
-        # @since 4.0.0
         class Base
 
           # Instantiate the eager load class.
@@ -15,11 +14,9 @@ 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
-          #
-          # @since 4.0.0
           def initialize(associations, docs)
             @associations = associations
             @docs = docs
@@ -28,12 +25,10 @@ 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.
-          #
-          # @since 4.0.0
           def run
             @loaded = []
             while shift_association
@@ -45,29 +40,39 @@ 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
           def preload
             raise NotImplementedError
           end
 
-          # Run the preloader.
-          #
-          # @example Iterate over the documents loaded for the current relation
-          #   loader.each_loaded_document { |doc| }
-          #
-          # @since 4.0.0
-          def each_loaded_document
-            doc_keys = keys_from_docs
-            return @association.klass.none if doc_keys.all?(&:nil?)
+          # 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)
+            each_loaded_document_of_class(@association.klass, keys_from_docs, &block)
+          end
+
+          # 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 = @association.klass.any_in(key => doc_keys)
+            criteria = cls.criteria
+            criteria = criteria.apply_scope(@association.scope)
+            criteria = criteria.any_in(key => keys)
             criteria.inclusions = criteria.inclusions - [@association]
             criteria.each do |doc|
               yield doc
@@ -81,8 +86,6 @@ module Mongoid
           #
           # @param [ ObjectId ] id parent`s id
           # @param [ Document, Array ] element to push into the parent
-          #
-          # @since 4.0.0
           def set_on_parent(id, element)
             grouped_docs[id].each do |d|
               set_relation(d, element)
@@ -91,26 +94,30 @@ 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
           #
           # @return [ Hash ] hash with grouped documents.
-          #
-          # @since 4.0.0
           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
           #
           # @return [ Array ] keys, ids
-          #
-          # @since 4.0.0
           def keys_from_docs
             grouped_docs.keys
           end
@@ -123,21 +130,17 @@ module Mongoid
           #   loader.group_by_key
           #
           # @return [ Symbol ] Key to group by the current documents.
-          #
-          # @since 4.0.0
           def group_by_key
             raise NotImplementedError
           end
 
           # 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
           def set_relation(doc, element)
             doc.set_relation(@association.name, element) unless doc.blank?
           end
@@ -150,8 +153,6 @@ module Mongoid
           #   loader.shift_association
           #
           # @return [ Association ] The association object.
-          #
-          # @since 4.0.0
           def shift_association
             @association = @associations.shift
           end

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

@@ -1,22 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 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.
           #   person.preferences.bind_one(preference)
           #
           # @param [ Document ] doc The single document to bind.
-          #
-          # @since 2.0.0.rc.1
           def bind_one(doc)
             binding do
               inverse_keys = doc.you_must(_association.inverse_foreign_key)
@@ -36,8 +35,6 @@ module Mongoid
           #
           # @example Unbind the document.
           #   person.preferences.unbind_one(document)
-          #
-          # @since 2.0.0.rc.1
           def unbind_one(doc)
             binding do
               _base.send(_association.foreign_key).delete_one(record_id(doc))
@@ -53,11 +50,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,12 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
       class HasAndBelongsToMany
 
         # The Builder behavior for has_and_belongs_to_many associations.
-        #
-        # @since 7.0
         module Buildable
 
           # This builder either takes a hash and queries for the
@@ -16,11 +15,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,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced