mongoid 9.0.12 → 9.1.0

data/lib/mongoid/contextual/atomic.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Contextual
-
     # Mixin module included in Mongoid::Criteria which provides a
     # direct method interface to MongoDB's Update Operators ($set,
     # $pull, $inc, etc.) These operators can be applied to update
     # all documents in the database within the criteria scope,
     # without loading each document into Mongoid's memory.
     module Atomic
-
       # Execute an atomic $addToSet on the matching documents.
       #
       # @example Add the value to the set.
@@ -20,7 +17,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def add_to_set(adds)
-        view.update_many("$addToSet" => collect_operations(adds))
+        view.update_many('$addToSet' => collect_operations(adds))
       end
 
       # Perform an atomic $addToSet/$each on the matching documents.
@@ -32,7 +29,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def add_each_to_set(adds)
-        view.update_many("$addToSet" => collect_each_operations(adds))
+        view.update_many('$addToSet' => collect_each_operations(adds))
       end
 
       # Perform an atomic $bit operation on the matching documents.
@@ -44,7 +41,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def bit(bits)
-        view.update_many("$bit" => collect_operations(bits))
+        view.update_many('$bit' => collect_operations(bits))
       end
 
       # Perform an atomic $inc operation on the matching documents.
@@ -56,7 +53,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def inc(incs)
-        view.update_many("$inc" => collect_operations(incs))
+        view.update_many('$inc' => collect_operations(incs))
       end
 
       # Perform an atomic $mul operation on the matching documents.
@@ -68,7 +65,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def mul(factors)
-        view.update_many("$mul" => collect_operations(factors))
+        view.update_many('$mul' => collect_operations(factors))
       end
 
       # Perform an atomic $pop operation on the matching documents.
@@ -83,7 +80,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def pop(pops)
-        view.update_many("$pop" => collect_operations(pops))
+        view.update_many('$pop' => collect_operations(pops))
       end
 
       # Perform an atomic $pull operation on the matching documents.
@@ -97,7 +94,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def pull(pulls)
-        view.update_many("$pull" => collect_operations(pulls))
+        view.update_many('$pull' => collect_operations(pulls))
       end
 
       # Perform an atomic $pullAll operation on the matching documents.
@@ -109,7 +106,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def pull_all(pulls)
-        view.update_many("$pullAll" => collect_operations(pulls))
+        view.update_many('$pullAll' => collect_operations(pulls))
       end
 
       # Perform an atomic $push operation on the matching documents.
@@ -121,7 +118,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def push(pushes)
-        view.update_many("$push" => collect_operations(pushes))
+        view.update_many('$push' => collect_operations(pushes))
       end
 
       # Perform an atomic $push/$each operation on the matching documents.
@@ -133,7 +130,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def push_all(pushes)
-        view.update_many("$push" => collect_each_operations(pushes))
+        view.update_many('$push' => collect_each_operations(pushes))
       end
 
       # Perform an atomic $rename of fields on the matching documents.
@@ -145,11 +142,10 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def rename(renames)
-        operations = renames.inject({}) do |ops, (old_name, new_name)|
+        operations = renames.each_with_object({}) do |(old_name, new_name), ops|
           ops[old_name] = new_name.to_s
-          ops
         end
-        view.update_many("$rename" => collect_operations(operations))
+        view.update_many('$rename' => collect_operations(operations))
       end
 
       # Perform an atomic $set of fields on the matching documents.
@@ -161,7 +157,7 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def set(sets)
-        view.update_many("$set" => collect_operations(sets))
+        view.update_many('$set' => collect_operations(sets))
       end
 
       # Perform an atomic $unset of a field on the matching documents.
@@ -198,9 +194,9 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def set_min(fields)
-        view.update_many("$min" => collect_operations(fields))
+        view.update_many('$min' => collect_operations(fields))
       end
-      alias :clamp_upper_bound :set_min
+      alias clamp_upper_bound set_min
 
       # Performs an atomic $max update operation on the given field or fields.
       # Each field will be set to the maximum of [current_value, given value].
@@ -221,9 +217,9 @@ module Mongoid
       #
       # @return [ nil ] Nil.
       def set_max(fields)
-        view.update_many("$max" => collect_operations(fields))
+        view.update_many('$max' => collect_operations(fields))
       end
-      alias :clamp_lower_bound :set_max
+      alias clamp_lower_bound set_max
 
       private
 
@@ -231,7 +227,7 @@ module Mongoid
       #
       # @param [ Array | Hash ] ops The operations to collect.
       # @param [ Hash ] aggregator The hash to use to aggregate the operations.
-      # 
+      #
       # @return [ Hash ] The aggregated operations, by field.
       def collect_operations(ops, aggregator = {})
         ops.each_with_object(aggregator) do |(field, value), operations|
@@ -241,7 +237,7 @@ module Mongoid
 
       def collect_each_operations(ops)
         ops.each_with_object({}) do |(field, value), operations|
-          operations[database_field_name(field)] = { "$each" => Array.wrap(value).mongoize }
+          operations[database_field_name(field)] = { '$each' => Array.wrap(value).mongoize }
         end
       end
 
@@ -261,7 +257,7 @@ module Mongoid
       # @return [ Hash ] The selector for the atomic $unset operation.
       def collect_unset_operations(ops)
         ops.map { |op| op.is_a?(Hash) ? op.keys : op }.flatten
-           .map { |field| [database_field_name(field), true] }.to_h
+           .map { |field| [ database_field_name(field), true ] }.to_h
       end
     end
   end

data/lib/mongoid/contextual/command.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Contextual
-
     # Mixin module included in objects which represent database commands.
     module Command
-
       # @attribute [r] collection The collection to query against.
       # @attribute [r] criteria The criteria for the context.
       attr_reader :collection, :criteria

data/lib/mongoid/contextual/map_reduce.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Contextual
-
     # Represents a mapReduce database command instruction.
     class MapReduce
       extend Forwardable
@@ -20,7 +18,7 @@ module Mongoid
       #
       # @return [ Hash ] The counts.
       def counts
-        results["counts"]
+        results['counts']
       end
 
       # Iterates over each of the documents in the map/reduce, excluding the
@@ -32,12 +30,10 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      def each
+      def each(&block)
         validate_out!
         if block_given?
-          @map_reduce.each do |doc|
-            yield doc
-          end
+          @map_reduce.each(&block)
         else
           @map_reduce.to_enum
         end
@@ -50,7 +46,7 @@ module Mongoid
       #
       # @return [ Integer ] The number of emitted documents.
       def emitted
-        counts["emit"]
+        counts['emit']
       end
 
       # Provide a finalize js function for the map/reduce.
@@ -87,7 +83,7 @@ module Mongoid
       #
       # @return [ Integer ] The number of input documents.
       def input
-        counts["input"]
+        counts['input']
       end
 
       # Sets the map/reduce to use jsMode.
@@ -138,7 +134,7 @@ module Mongoid
       #
       # @return [ Integer ] The number of output documents.
       def output
-        counts["output"]
+        counts['output']
       end
 
       # Get the raw output from the map/reduce operation.
@@ -153,7 +149,7 @@ module Mongoid
         opts = { read: criteria.options.fetch(:read) } if criteria.options[:read]
         @map_reduce.database.command(cmd, (opts || {}).merge(session: _session)).first
       end
-      alias :results :raw
+      alias results raw
 
       # Execute the map/reduce, returning the raw output.
       # Useful when you don't care about map/reduce's output.
@@ -162,7 +158,7 @@ module Mongoid
       #   map_reduce.execute
       #
       # @return [ Hash ] The raw output
-      alias :execute :raw
+      alias execute raw
 
       # Get the number of documents reduced by the map/reduce.
       #
@@ -171,7 +167,7 @@ module Mongoid
       #
       # @return [ Integer ] The number of reduced documents.
       def reduced
-        counts["reduce"]
+        counts['reduce']
       end
 
       # Adds a javascript object to the global scope of the map/reduce.
@@ -194,7 +190,7 @@ module Mongoid
       #
       # @return [ Float ] The time in milliseconds.
       def time
-        results["timeMillis"]
+        results['timeMillis']
       end
 
       # Get a pretty string representation of the map/reduce, including the
@@ -205,14 +201,14 @@ module Mongoid
       #
       # @return [ String ] The inspection string.
       def inspect
-%Q{#<Mongoid::Contextual::MapReduce
+        %(#<Mongoid::Contextual::MapReduce
   selector: #{criteria.selector.inspect}
   class:    #{criteria.klass}
   map:      #{command[:map]}
   reduce:   #{command[:reduce]}
   finalize: #{command[:finalize]}
   out:      #{command[:out].inspect}>
-}
+)
       end
 
       # Returns the selector of the command spec.

data/lib/mongoid/contextual/memory.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/contextual/aggregable/memory"
-require "mongoid/association/eager_loadable"
-require "mongoid/field_readable"
+require 'mongoid/contextual/aggregable/memory'
+require 'mongoid/association/eager_loadable'
 
 module Mongoid
   module Contextual
-
     # Context object used for performing bulk query and persistence
     # operations on documents which have been loaded into application
     # memory. The method interface of this class is consistent with
@@ -18,7 +15,6 @@ module Mongoid
       include Association::EagerLoadable
       include Queryable
       include Positional
-      include FieldReadable
 
       # @attribute [r] root The root document.
       # @attribute [r] path The atomic path.
@@ -36,6 +32,7 @@ module Mongoid
       # @return [ true | false ] If the objects are equal.
       def ==(other)
         return false unless other.respond_to?(:entries)
+
         entries == other.entries
       end
 
@@ -53,13 +50,13 @@ module Mongoid
         end
         unless removed.empty?
           collection.find(selector).update_one(
-            positionally(selector, "$pullAll" => { path => removed }),
+            positionally(selector, '$pullAll' => { path => removed }),
             session: _session
           )
         end
         deleted
       end
-      alias :delete_all :delete
+      alias delete_all delete
 
       # Destroy all documents in the database that match the selector.
       #
@@ -75,7 +72,7 @@ module Mongoid
         end
         deleted
       end
-      alias :destroy_all :destroy
+      alias destroy_all destroy
 
       # Get the distinct values in the db for the provided field.
       #
@@ -98,11 +95,9 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      def each
+      def each(&block)
         if block_given?
-          documents_for_iteration.each do |doc|
-            yield(doc)
-          end
+          documents_for_iteration.each(&block)
           self
         else
           to_enum
@@ -143,14 +138,19 @@ module Mongoid
       #
       # @return [ Document ] The first document.
       def first(limit = nil)
-        if limit
-          eager_load(documents.first(limit))
+        use_first = limit.nil?
+        limit ||= 1
+        if criteria.use_lookup?
+          @criteria = criteria.limit(limit)
+          result = eager_load_with_lookup
         else
-          eager_load([documents.first]).first
+          result = eager_load(documents.first(limit))
         end
+
+        use_first ? result.first : result
       end
-      alias :one :first
-      alias :find_first :first
+      alias one first
+      alias find_first first
 
       # Get the first document in the database for the criteria's selector or
       # raise an error if none is found.
@@ -174,20 +174,10 @@ module Mongoid
       # @param [ Criteria ] criteria The criteria.
       def initialize(criteria)
         @criteria, @klass = criteria, criteria.klass
-
-        # Resolving the collection can build a Mongo::Client the first time it
-        # runs, so it happens before the budget opens. Where the budget is
-        # enforced with Timeout the exception is asynchronous, and landing in
-        # the middle of that would leave a half-built client behind.
-        if (first = criteria.documents.first)
-          @root = first._root
-          @collection = @root.collection
-        end
-
-        # One regexp budget covers the whole scan, so that the limit bounds the
-        # query rather than each document individually.
-        @documents = Matcher::RegexpBudget.open(criteria.selector) do
-          criteria.documents.select { |doc| doc._matches?(criteria.selector) }
+        @documents = criteria.documents.select do |doc|
+          @root ||= doc._root
+          @collection ||= root.collection
+          doc._matches?(criteria.selector)
         end
         apply_sorting
         apply_options
@@ -219,7 +209,7 @@ module Mongoid
         if limit
           eager_load(documents.last(limit))
         else
-          eager_load([documents.last]).first
+          eager_load([ documents.last ]).first
         end
       end
 
@@ -246,7 +236,7 @@ module Mongoid
       def length
         documents.length
       end
-      alias :size :length
+      alias size length
 
       # Limits the number of documents that are returned.
       #
@@ -284,9 +274,9 @@ module Mongoid
       #
       # @return [ Object | Array<Object> ] The picked values.
       def pick(*fields)
-        if doc = documents.first
-          pluck_from_doc(doc, *fields)
-        end
+        return unless doc = documents.first
+
+        pluck_from_doc(doc, *fields)
       end
 
       # Tally the field values in memory.
@@ -298,7 +288,7 @@ module Mongoid
       #
       # @return [ Hash ] The hash of counts.
       def tally(field)
-        return documents.each_with_object({}) do |d, acc|
+        documents.each_with_object({}) do |d, acc|
           v = retrieve_value_at_path(d, field)
           acc[v] ||= 0
           acc[v] += 1
@@ -317,7 +307,7 @@ module Mongoid
         if limit
           eager_load(documents.take(limit))
         else
-          eager_load([documents.first]).first
+          eager_load([ documents.first ]).first
         end
       end
 
@@ -392,7 +382,7 @@ module Mongoid
       #
       # @return [ Document ] The second document.
       def second
-        eager_load([documents.second]).first
+        eager_load([ documents.second ]).first
       end
 
       # Get the second document in the database for the criteria's selector or
@@ -416,7 +406,7 @@ module Mongoid
       #
       # @return [ Document ] The third document.
       def third
-        eager_load([documents.third]).first
+        eager_load([ documents.third ]).first
       end
 
       # Get the third document in the database for the criteria's selector or
@@ -440,7 +430,7 @@ module Mongoid
       #
       # @return [ Document ] The fourth document.
       def fourth
-        eager_load([documents.fourth]).first
+        eager_load([ documents.fourth ]).first
       end
 
       # Get the fourth document in the database for the criteria's selector or
@@ -464,7 +454,7 @@ module Mongoid
       #
       # @return [ Document ] The fifth document.
       def fifth
-        eager_load([documents.fifth]).first
+        eager_load([ documents.fifth ]).first
       end
 
       # Get the fifth document in the database for the criteria's selector or
@@ -488,7 +478,7 @@ module Mongoid
       #
       # @return [ Document ] The second to last document.
       def second_to_last
-        eager_load([documents.second_to_last]).first
+        eager_load([ documents.second_to_last ]).first
       end
 
       # Get the second to last document in the database for the criteria's selector or
@@ -512,7 +502,7 @@ module Mongoid
       #
       # @return [ Document ] The third to last document.
       def third_to_last
-        eager_load([documents.third_to_last]).first
+        eager_load([ documents.third_to_last ]).first
       end
 
       # Get the third to last document in the database for the criteria's selector or
@@ -531,6 +521,14 @@ module Mongoid
 
       private
 
+      # Returns materialized documents for use in the cross-cluster $lookup
+      # fallback. In the memory context, documents are already instantiated.
+      #
+      # @api private
+      def docs_for_lookup_fallback
+        documents
+      end
+
       # Get the documents the context should iterate. This follows 3 rules:
       #
       # @api private
@@ -542,7 +540,7 @@ module Mongoid
       def documents_for_iteration
         docs = documents[skipping || 0, limiting || documents.length] || []
         if eager_loadable?
-          eager_load(docs)
+          criteria.use_lookup? ? eager_load_with_lookup : eager_load(docs)
         end
         docs
       end
@@ -558,14 +556,15 @@ module Mongoid
       # @param [ Array<Document> ] docs The docs to update.
       def update_documents(attributes, docs)
         return false if !attributes || docs.empty?
-        updates = { "$set" => {}}
+
+        updates = { '$set' => {} }
         docs.each do |doc|
           @selector ||= root.atomic_selector
           doc.write_attributes(attributes)
-          updates["$set"].merge!(doc.atomic_updates["$set"] || {})
+          updates['$set'].merge!(doc.atomic_updates['$set'] || {})
           doc.move_changes
         end
-        collection.find(selector).update_one(updates, session: _session) unless updates["$set"].empty?
+        collection.find(selector).update_one(updates, session: _session) unless updates['$set'].empty?
       end
 
       # Get the limiting value.
@@ -588,9 +587,7 @@ module Mongoid
       # @param [ Integer ] value The limit.
       #
       # @return [ Integer ] The limit.
-      def limiting=(value)
-        @limiting = value
-      end
+      attr_writer :limiting
 
       # Get the skipping value.
       #
@@ -612,9 +609,7 @@ module Mongoid
       # @param [ Integer ] value The skip.
       #
       # @return [ Integer ] The skip.
-      def skipping=(value)
-        @skipping = value
-      end
+      attr_writer :skipping
 
       # Apply criteria options.
       #
@@ -626,6 +621,7 @@ module Mongoid
       # @return [ Memory ] self.
       def apply_options
         raise Errors::InMemoryCollationNotSupported.new if criteria.options[:collation]
+
         skip(criteria.options[:skip]).limit(criteria.options[:limit])
       end
 
@@ -634,9 +630,9 @@ module Mongoid
       # @example Apply the sorting params.
       #   context.apply_sorting
       def apply_sorting
-        if spec = criteria.options[:sort]
-          in_place_sort(spec)
-        end
+        return unless spec = criteria.options[:sort]
+
+        in_place_sort(spec)
       end
 
       # Compare two values, handling the cases when
@@ -689,8 +685,6 @@ module Mongoid
         doc.destroyed = true
       end
 
-      private
-
       def _session
         @criteria.send(:_session)
       end
@@ -734,29 +728,31 @@ module Mongoid
       #   doesn't exist.
       def retrieve_value_at_path(document, field_path)
         return if field_path.blank? || !document
+
         segment, remaining = field_path.to_s.split('.', 2)
 
         curr = if document.is_a?(Document)
-          # Retrieves field for segment to check localization. Only does one
-          # iteration since there's no dots
-          res = if remaining
-            field = document.class.traverse_association_tree(segment)
-            # If this is a localized field, and there are remaining, get the
-            # _translations hash so that we can get the specified translation in
-            # the remaining
-            if field&.localized?
-              document.public_send("#{segment}_translations")
-            end
-          end
-          res.nil? ? read_field_value(document, segment) : res
-        elsif document.is_a?(Hash)
-          # TODO: Remove the indifferent access when implementing MONGOID-5410.
-          document.key?(segment.to_s) ?
-            document[segment.to_s] :
-            document[segment.to_sym]
-        else
-          nil
-        end
+                 # Retrieves field for segment to check localization. Only does one
+                 # iteration since there's no dots
+                 res = if remaining
+                         field = document.class.traverse_association_tree(segment)
+                         # If this is a localized field, and there are remaining, get the
+                         # _translations hash so that we can get the specified translation in
+                         # the remaining
+                         document.send("#{segment}_translations") if field&.localized?
+                       end
+                 meth = klass.aliased_associations[segment] || segment
+                 res.nil? ? document.try(meth) : res
+               elsif document.is_a?(Hash)
+                 # TODO: Remove the indifferent access when implementing MONGOID-5410.
+                 if document.key?(segment.to_s)
+                   document[segment.to_s]
+                 else
+                   document[segment.to_sym]
+                 end
+               else
+                 nil
+               end
 
         return curr unless remaining
 

data/lib/mongoid/contextual/mongo/documents_loader.rb

@@ -1,5 +1,4 @@
-# rubocop:todo all
-require "mongoid/association/eager_loadable"
+require 'mongoid/association/eager_loadable'
 
 module Mongoid
   module Contextual
@@ -30,7 +29,7 @@ module Mongoid
         # @return [ Concurrent::ThreadPoolExecutor ] The executor
         #   to be used to execute document loading tasks.
         def self.global_thread_pool_async_query_executor
-          create_pool = Proc.new do |concurrency|
+          create_pool = proc do |concurrency|
             Concurrent::ThreadPoolExecutor.new(
               min_threads: 0,
               max_threads: concurrency,