mongoid 9.0.11 → 9.1.0

data/lib/mongoid/contextual/mongo.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/atomic_update_preparer'
 require 'mongoid/pluckable'
-require "mongoid/contextual/mongo/documents_loader"
-require "mongoid/contextual/atomic"
-require "mongoid/contextual/aggregable/mongo"
-require "mongoid/contextual/command"
-require "mongoid/contextual/map_reduce"
-require "mongoid/association/eager_loadable"
+require 'mongoid/contextual/mongo/documents_loader'
+require 'mongoid/contextual/atomic'
+require 'mongoid/contextual/aggregable/mongo'
+require 'mongoid/contextual/command'
+require 'mongoid/contextual/map_reduce'
+require 'mongoid/association/eager_loadable'
 
 module Mongoid
   module Contextual
-
     # Context object used for performing bulk query and persistence
     # operations on documents which are persisted in the database and
     # have not been loaded into application memory.
@@ -26,19 +24,18 @@ module Mongoid
       include Pluckable
 
       # Options constant.
-      OPTIONS = [ :hint,
-                  :limit,
-                  :skip,
-                  :sort,
-                  :batch_size,
-                  :max_scan,
-                  :max_time_ms,
-                  :snapshot,
-                  :comment,
-                  :read,
-                  :cursor_type,
-                  :collation
-                ].freeze
+      OPTIONS = %i[hint
+                   limit
+                   skip
+                   sort
+                   batch_size
+                   max_scan
+                   max_time_ms
+                   snapshot
+                   comment
+                   read
+                   cursor_type
+                   collation].freeze
 
       # @attribute [r] view The Mongo collection view.
       attr_reader :view
@@ -87,7 +84,7 @@ module Mongoid
       # Get the estimated number of documents matching the query.
       #
       # Unlike count, estimated_count does not take a block because it is not
-      # traditionally defined (with a block) on Enumarable like count is.
+      # traditionally defined (with a block) on Enumerable like count is.
       #
       # @example Get the estimated number of matching documents.
       #   context.estimated_count
@@ -97,12 +94,11 @@ module Mongoid
       #
       # @return [ Integer ] The number of matches.
       def estimated_count(options = {})
-        unless self.criteria.selector.empty?
-          if klass.default_scoping?
-            raise Mongoid::Errors::InvalidEstimatedCountScoping.new(self.klass)
-          else
-            raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass)
-          end
+        unless criteria.selector.empty?
+          raise Mongoid::Errors::InvalidEstimatedCountScoping.new(klass) if klass.default_scoping?
+
+          raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(klass)
+
         end
         view.estimated_document_count(options)
       end
@@ -116,7 +112,7 @@ module Mongoid
       def delete
         view.delete_many.deleted_count
       end
-      alias :delete_all :delete
+      alias delete_all delete
 
       # Destroy all documents in the database that match the selector.
       #
@@ -131,7 +127,7 @@ module Mongoid
           count
         end
       end
-      alias :destroy_all :destroy
+      alias destroy_all destroy
 
       # Get the distinct values in the db for the provided field.
       #
@@ -190,9 +186,10 @@ module Mongoid
       # @return [ true | false ] If the count is more than zero.
       #   Always false if passed nil or false.
       def exists?(id_or_conditions = :none)
-        return false if self.view.limit == 0
+        return false if view.limit == 0
+
         case id_or_conditions
-        when :none then !!(view.projection(_id: 1).limit(1).first)
+        when :none then !!view.projection(_id: 1).limit(1).first
         when nil, false then false
         when Hash then Mongo.new(criteria.where(id_or_conditions)).exists?
         else Mongo.new(criteria.where(_id: id_or_conditions)).exists?
@@ -214,9 +211,9 @@ module Mongoid
       #
       # @return [ Document ] The result of the command.
       def find_one_and_update(update, options = {})
-        if doc = view.find_one_and_update(update, options)
-          Factory.from_db(klass, doc)
-        end
+        return unless doc = view.find_one_and_update(update, options)
+
+        Factory.from_db(klass, doc)
       end
 
       # Execute the find and modify command, used for MongoDB's
@@ -234,9 +231,9 @@ module Mongoid
       #
       # @return [ Document ] The result of the command.
       def find_one_and_replace(replacement, options = {})
-        if doc = view.find_one_and_replace(replacement, options)
-          Factory.from_db(klass, doc)
-        end
+        return unless doc = view.find_one_and_replace(replacement, options)
+
+        Factory.from_db(klass, doc)
       end
 
       # Execute the find and modify command, used for MongoDB's
@@ -247,19 +244,19 @@ module Mongoid
       #
       # @return [ Document ] The result of the command.
       def find_one_and_delete
-        if doc = view.find_one_and_delete
-          Factory.from_db(klass, doc)
-        end
+        return unless doc = view.find_one_and_delete
+
+        Factory.from_db(klass, doc)
       end
 
       # Return the first result without applying sort
       #
       # @api private
       def find_first
-        if raw_doc = view.first
-          doc = Factory.from_db(klass, raw_doc, criteria)
-          eager_load([doc]).first
-        end
+        return unless raw_doc = view.first
+
+        doc = Factory.from_db(klass, raw_doc, criteria)
+        eager_load([ doc ]).first
       end
 
       # Create the new Mongo context. This delegates operations to the
@@ -287,9 +284,9 @@ module Mongoid
       #
       # @return [ Integer ] The number of documents.
       def length
-        self.count
+        count
       end
-      alias :size :length
+      alias size length
 
       # Limits the number of documents that are returned from the database.
       #
@@ -384,11 +381,9 @@ module Mongoid
       def take!
         # Do to_a first so that the Mongo#first method is not used and the
         # result is not sorted.
-        if fst = limit(1).to_a.first
-          fst
-        else
-          raise Errors::DocumentNotFound.new(klass, nil, nil)
-        end
+        raise Errors::DocumentNotFound.new(klass, nil, nil) unless fst = limit(1).to_a.first
+
+        fst
       end
 
       # Get a hash of counts for the values of a single field. For example,
@@ -432,20 +427,20 @@ module Mongoid
         name = klass.cleanse_localized_field_names(field)
 
         fld = klass.traverse_association_tree(name)
-        pipeline = [ { "$group" => { _id: "$#{name}", counts: { "$sum": 1 } } } ]
-        pipeline.unshift("$match" => view.filter) unless view.filter.blank?
+        pipeline = [ { '$group' => { _id: "$#{name}", counts: { '$sum': 1 } } } ]
+        pipeline.unshift('$match' => view.filter) unless view.filter.blank?
 
-        collection.aggregate(pipeline).reduce({}) do |tallies, doc|
+        collection.aggregate(pipeline).each_with_object({}) do |doc, tallies|
           is_translation = "#{name}_translations" == field.to_s
-          val = doc["_id"]
+          val = doc['_id']
 
           key = if val.is_a?(Array)
-            val.map do |v|
-              demongoize_with_field(fld, v, is_translation)
-            end
-          else
-            demongoize_with_field(fld, val, is_translation)
-          end
+                  val.map do |v|
+                    demongoize_with_field(fld, v, is_translation)
+                  end
+                else
+                  demongoize_with_field(fld, val, is_translation)
+                end
 
           # The only time where a key will already exist in the tallies hash
           # is when the values are stored differently in the database, but
@@ -455,8 +450,7 @@ module Mongoid
           # demongoized value is just the translation in the current locale,
           # which can be the same across multiple of those unequal hashes.
           tallies[key] ||= 0
-          tallies[key] += doc["counts"]
-          tallies
+          tallies[key] += doc['counts']
         end
       end
 
@@ -545,7 +539,7 @@ module Mongoid
           retrieve_nth_with_limit(0, limit)
         end
       end
-      alias :one :first
+      alias one first
 
       # Get the first document in the database for the criteria's selector or
       # raise an error if none is found.
@@ -794,9 +788,9 @@ module Mongoid
       # @example Apply the field limitations.
       #   context.apply_fields
       def apply_fields
-        if spec = criteria.options[:fields]
-          @view = view.projection(spec)
-        end
+        return unless spec = criteria.options[:fields]
+
+        @view = view.projection(spec)
       end
 
       # Apply the options.
@@ -810,9 +804,9 @@ module Mongoid
         OPTIONS.each do |name|
           apply_option(name)
         end
-        if criteria.options[:timeout] == false
-          @view = view.no_cursor_timeout
-        end
+        return unless criteria.options[:timeout] == false
+
+        @view = view.no_cursor_timeout
       end
 
       # Apply an option.
@@ -822,9 +816,17 @@ module Mongoid
       # @example Apply the skip option.
       #   context.apply_option(:skip)
       def apply_option(name)
-        if spec = criteria.options[name]
-          @view = view.send(name, spec)
-        end
+        return unless spec = criteria.options[name]
+
+        @view = view.send(name, spec)
+      end
+
+      # Returns materialized documents for use in the cross-cluster $lookup
+      # fallback. Reads from the collection view and instantiates documents.
+      #
+      # @api private
+      def docs_for_lookup_fallback
+        view.map { |doc| Factory.from_db(klass, doc, criteria) }
       end
 
       # Map the inverse sort symbols to the correct MongoDB values.
@@ -832,7 +834,7 @@ module Mongoid
       # @api private
       def inverse_sorting
         sort = view.sort || { _id: 1 }
-        Hash[sort.map{|k, v| [k, -1*v]}]
+        Hash[sort.map { |k, v| [ k, -1 * v ] }]
       end
 
       # Get the documents the context should iterate.
@@ -853,6 +855,8 @@ module Mongoid
           end
         else
           return view unless eager_loadable?
+          return eager_load_with_lookup if criteria.use_lookup?
+
           docs = view.map do |doc|
             Factory.from_db(klass, doc, criteria)
           end
@@ -870,9 +874,19 @@ module Mongoid
       #   end
       #
       # @param [ Document ] document The document to yield to.
-      def yield_document(document, &block)
-        doc = document.respond_to?(:_id) ?
-            document : Factory.from_db(klass, document, criteria)
+      def yield_document(document)
+        doc = if document.respond_to?(:_id)
+                document
+              elsif criteria.raw_results?
+                if criteria.typecast_results?
+                  demongoize_hash(klass, document)
+                else
+                  document
+                end
+              else
+                Factory.from_db(klass, document, criteria)
+              end
+
         yield(doc)
       end
 
@@ -898,6 +912,48 @@ module Mongoid
         demongoize_with_field(field, value, is_translation)
       end
 
+      # Demongoizes (converts from database to Ruby representation) the values
+      # of the given hash as if it were the raw representation of a document of
+      # the given klass.
+      #
+      # @note this method will modify the given hash, in-place, for performance
+      # reasons. If you wish to preserve the original hash, duplicate it before
+      # passing it to this method.
+      #
+      # @param [ Document ] klass the Document class that the given hash ought
+      #   to represent
+      # @param [ Hash | nil ] hash the Hash instance containing the values to
+      #   demongoize.
+      #
+      # @return [ Hash | nil ] the demongoized result (nil if the input Hash
+      #   was nil)
+      #
+      # @api private
+      def demongoize_hash(klass, hash)
+        return nil unless hash
+
+        hash.each_key do |key|
+          value = hash[key]
+
+          # does the key represent a declared field on the document?
+          if (field = klass.fields[key])
+            hash[key] = field.demongoize(value)
+            next
+          end
+
+          # does the key represent an embedded relation on the document?
+          aliased_name = klass.aliased_associations[key] || key
+          next unless (assoc = klass.relations[aliased_name])
+
+          case value
+          when Array then value.each { |h| demongoize_hash(assoc.klass, h) }
+          when Hash then demongoize_hash(assoc.klass, value)
+          end
+        end
+
+        hash
+      end
+
       # Demongoize the value for the given field. If the field is nil or the
       # field is a translations field, the value is demongoized using its class.
       #
@@ -932,10 +988,22 @@ module Mongoid
       # @return [ Array<Document> | Document ] The list of documents or a
       #   single document.
       def process_raw_docs(raw_docs, limit)
-        docs = raw_docs.map do |d|
-          Factory.from_db(klass, d, criteria)
-        end
-        docs = eager_load(docs)
+        docs = if criteria.raw_results?
+                 if criteria.typecast_results?
+                   raw_docs.map { |doc| demongoize_hash(klass, doc) }
+                 else
+                   raw_docs
+                 end
+               else
+                 mapped = raw_docs.map { |doc| Factory.from_db(klass, doc, criteria) }
+                 if criteria.use_lookup?
+                   mapped
+                 else
+                   # $lookup already eager loads related documents
+                   eager_load(mapped)
+                 end
+               end
+
         limit ? docs : docs.first
       end
 
@@ -972,7 +1040,14 @@ module Mongoid
         sort = view.sort || { _id: 1 }
         v = view.sort(sort).limit(limit || 1)
         v = v.skip(n) if n > 0
-        if raw_docs = v.to_a
+        if criteria.use_lookup?
+          # Update criteria and view with the sort, skip, and limit before eager loading
+          @criteria = criteria.order_by(sort).limit(limit || 1)
+          @criteria = @criteria.skip(n) if n > 0
+          @view = collection.find(criteria.selector, session: _session).limit(limit || 1).sort(sort)
+          @view = @view.skip(n) if n > 0
+          eager_load_with_lookup
+        elsif raw_docs = v.to_a
           process_raw_docs(raw_docs, limit)
         end
       end
@@ -984,8 +1059,17 @@ module Mongoid
       def retrieve_nth_to_last_with_limit(n, limit)
         v = view.sort(inverse_sorting).limit(limit || 1)
         v = v.skip(n) if n > 0
-        raw_docs = v.to_a.reverse
-        process_raw_docs(raw_docs, limit)
+        if criteria.use_lookup?
+          # Update criteria and view with the inverse sort, skip, and limit before eager loading
+          @criteria = criteria.order_by(inverse_sorting).limit(limit || 1)
+          @criteria = @criteria.skip(n) if n > 0
+          @view = collection.find(criteria.selector, session: _session).limit(limit || 1).sort(inverse_sorting)
+          @view = @view.skip(n) if n > 0
+          eager_load_with_lookup.reverse
+        else
+          raw_docs = v.to_a.reverse
+          process_raw_docs(raw_docs, limit)
+        end
       end
     end
   end

data/lib/mongoid/contextual/none.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/contextual/aggregable/none"
+require 'mongoid/contextual/aggregable/none'
 
 module Mongoid
   module Contextual
-
     # Context object used for performing bulk query and persistence
     # operations on a null set. The method interface of this class
     # is consistent with Mongoid::Contextual::Mongo.
@@ -49,9 +47,9 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      def each
+      def each(&block)
         if block_given?
-          [].each { |doc| yield(doc) }
+          [].each(&block)
           self
         else
           to_enum
@@ -73,7 +71,9 @@ module Mongoid
       #   search for, a hash of conditions, nil or false.
       #
       # @return [ false ] Always false.
-      def exists?(id_or_conditions = :none); false; end
+      def exists?(_id_or_conditions = :none)
+        false
+      end
 
       # Pluck the field values in null context.
       #
@@ -316,10 +316,10 @@ module Mongoid
       def length
         entries.length
       end
-      alias :size :length
+      alias size length
 
-      alias :find_first :first
-      alias :one :first
+      alias find_first first
+      alias one first
 
       private
 

data/lib/mongoid/contextual/queryable.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Contextual
-
     # Mixin module which adds methods to Mongoid::Criteria that
     # indicate the criteria query result will be an empty set.
     module Queryable
-
       # @attribute [r] collection The collection to query against.
       # @attribute [r] criteria The criteria for the context.
       # @attribute [r] klass The klass for the criteria.
@@ -22,7 +19,7 @@ module Mongoid
       def blank?
         !exists?
       end
-      alias :empty? :blank?
+      alias empty? blank?
     end
   end
 end

data/lib/mongoid/contextual.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/contextual/queryable"
-require "mongoid/contextual/mongo"
-require "mongoid/contextual/memory"
-require "mongoid/contextual/none"
+require 'mongoid/contextual/queryable'
+require 'mongoid/contextual/mongo'
+require 'mongoid/contextual/memory'
+require 'mongoid/contextual/none'
 
 module Mongoid
-
   # Parent mixin module which adds aggregation (#sum, #avg, etc.) and
   # atomic (#set, #unset, #push, etc.) behavior to Mongoid::Criteria.
   module Contextual
@@ -23,7 +21,7 @@ module Mongoid
 
     # The methods in the contexts themselves should all get delegated to,
     # including destructive, modification, and optional methods.
-    def_delegators :context, *(Mongo.public_instance_methods(false) - [ :skip, :limit ])
+    def_delegators :context, *(Mongo.public_instance_methods(false) - %i[skip limit load_async])
 
     # This gets blank and empty included.
     def_delegators :context, *Queryable.public_instance_methods(false)
@@ -64,7 +62,20 @@ module Mongoid
     # @return [ Mongo | Memory ] The context.
     def create_context
       return None.new(self) if empty_and_chainable?
+      return None.new(self) if short_circuit_query?
+
       embedded ? Memory.new(self) : Mongo.new(self)
     end
+
+    def short_circuit_query?
+      return false unless Mongoid.allow_short_circuit_queries?
+
+      selector.any? do |_field, condition|
+        next unless condition.is_a?(Hash)
+
+        v = condition['$in'] || condition[:$in]
+        v.is_a?(Array) && v.empty?
+      end
+    end
   end
 end

data/lib/mongoid/copyable.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
-
   # This module contains the behavior of Mongoid's clone/dup of documents.
   module Copyable
     extend ActiveSupport::Concern
@@ -29,7 +27,7 @@ module Mongoid
       attrs = clone_document.except(*self.class.id_fields)
       Copyable.clone_with_hash(self.class, attrs)
     end
-    alias :dup :clone
+    alias dup clone
 
     private
 
@@ -54,9 +52,9 @@ module Mongoid
       Factory.build(klass, attrs).tap do |object|
         dynamic_attrs.each do |attr_name, value|
           assoc = object.embedded_relations[attr_name]
-          if assoc&.one? && Hash === value
+          if assoc&.one? && value.is_a?(Hash)
             object.send("#{attr_name}=", clone_with_hash(assoc.klass, value))
-          elsif assoc&.many? && Array === value
+          elsif assoc&.many? && value.is_a?(Array)
             docs = value.map { |h| clone_with_hash(assoc.klass, h) }
             object.send("#{attr_name}=", docs)
           elsif object.respond_to?("#{attr_name}=")
@@ -101,10 +99,10 @@ module Mongoid
         if association.is_a?(Association::Embedded::EmbedsMany)
           attrs[association.key].each do |attr|
             embedded_klass = if type = attr[self.class.discriminator_key]
-              association.relation_class.get_discriminator_mapping(type) || association.relation_class
-            else
-              association.relation_class
-            end
+                               association.relation_class.get_discriminator_mapping(type) || association.relation_class
+                             else
+                               association.relation_class
+                             end
             process_localized_attributes(embedded_klass, attr)
           end
         else

data/lib/mongoid/criteria/findable.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # Mixin module included in Mongoid::Criteria which adds the ability
     # to find document by id.
     module Findable
-
       # Execute the criteria or raise an error if no documents found.
       #
       # @example Execute or raise
@@ -60,7 +57,7 @@ module Mongoid
       def for_ids(ids)
         ids = mongoize_ids(ids)
         if ids.size > 1
-          send(id_finder, { _id: { "$in" => ids }})
+          send(id_finder, { _id: { '$in' => ids } })
         else
           send(id_finder, { _id: ids.first })
         end
@@ -77,6 +74,7 @@ module Mongoid
       # @return [ Array<Document> ] The found documents.
       def multiple_from_db(ids)
         return entries if embedded?
+
         ids = mongoize_ids(ids)
         ids.empty? ? [] : from_database(ids)
       end
@@ -130,7 +128,7 @@ module Mongoid
       def mongoize_ids(ids)
         ids.map do |id|
           id = id[:_id] if id.respond_to?(:keys) && id[:_id]
-          klass.fields["_id"].mongoize(id)
+          klass.fields['_id'].mongoize(id)
         end
       end
 
@@ -148,7 +146,7 @@ module Mongoid
           when Array, Set
             prepare_ids_for_find(arg)
           when Range
-            arg.begin&.numeric? && arg.end&.numeric? ? arg.to_a : arg
+            (arg.begin&.numeric? && arg.end&.numeric?) ? arg.to_a : arg
           else
             arg
           end
@@ -166,7 +164,7 @@ module Mongoid
       #
       # @return [ true | false ] Whether the arguments are a list.
       def multi_args?(args)
-        args.size > 1 || !args.first.is_a?(Hash) && args.first.resizable?
+        args.size > 1 || (!args.first.is_a?(Hash) && args.first.resizable?)
       end
 
       # Convenience method of raising an invalid find error.