mongoid 8.1.13 → 9.0.0

data/lib/mongoid/contextual/memory.rb

@@ -1,18 +1,22 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/contextual/aggregable/memory"
 require "mongoid/association/eager_loadable"
-require "mongoid/field_readable"
 
 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
+    # Mongoid::Contextual::Mongo.
     class Memory
       include Enumerable
       include Aggregable::Memory
       include Association::EagerLoadable
       include Queryable
       include Positional
-      include FieldReadable
 
       # @attribute [r] root The root document.
       # @attribute [r] path The atomic path.
@@ -80,11 +84,7 @@ module Mongoid
       #
       # @return [ Array<Object> ] The distinct values for the field.
       def distinct(field)
-        if Mongoid.legacy_pluck_distinct
-          documents.map{ |doc| doc.send(field) }.uniq
-        else
-          pluck(field).uniq
-        end
+        pluck(field).uniq
       end
 
       # Iterate over the context. If provided a block, yield to a Mongoid
@@ -158,7 +158,7 @@ module Mongoid
       #
       # @return [ Document ] The first document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def first!
         first || raise_document_not_found_error
@@ -172,20 +172,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
@@ -229,7 +219,7 @@ module Mongoid
       #
       # @return [ Document ] The last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def last!
         last || raise_document_not_found_error
@@ -268,12 +258,8 @@ module Mongoid
       #
       # @return [ Array<Object> | Array<Array<Object>> ] The plucked values.
       def pluck(*fields)
-        if Mongoid.legacy_pluck_distinct
-          documents.pluck(*fields)
-        else
-          documents.map do |doc|
-            pluck_from_doc(doc, *fields)
-          end
+        documents.map do |doc|
+          pluck_from_doc(doc, *fields)
         end
       end
 
@@ -331,7 +317,7 @@ module Mongoid
       #
       # @return [ Document ] The document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def take!
         take || raise_document_not_found_error
@@ -392,8 +378,6 @@ module Mongoid
       # @example Get the second document.
       #   context.second
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The second document.
       def second
         eager_load([documents.second]).first
@@ -407,7 +391,7 @@ module Mongoid
       #
       # @return [ Document ] The second document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def second!
         second || raise_document_not_found_error
@@ -418,8 +402,6 @@ module Mongoid
       # @example Get the third document.
       #   context.third
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The third document.
       def third
         eager_load([documents.third]).first
@@ -433,7 +415,7 @@ module Mongoid
       #
       # @return [ Document ] The third document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def third!
         third || raise_document_not_found_error
@@ -444,8 +426,6 @@ module Mongoid
       # @example Get the fourth document.
       #   context.fourth
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The fourth document.
       def fourth
         eager_load([documents.fourth]).first
@@ -459,7 +439,7 @@ module Mongoid
       #
       # @return [ Document ] The fourth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def fourth!
         fourth || raise_document_not_found_error
@@ -470,8 +450,6 @@ module Mongoid
       # @example Get the fifth document.
       #   context.fifth
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The fifth document.
       def fifth
         eager_load([documents.fifth]).first
@@ -485,7 +463,7 @@ module Mongoid
       #
       # @return [ Document ] The fifth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def fifth!
         fifth || raise_document_not_found_error
@@ -496,8 +474,6 @@ module Mongoid
       # @example Get the second to last document.
       #   context.second_to_last
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The second to last document.
       def second_to_last
         eager_load([documents.second_to_last]).first
@@ -511,7 +487,7 @@ module Mongoid
       #
       # @return [ Document ] The second to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def second_to_last!
         second_to_last || raise_document_not_found_error
@@ -522,8 +498,6 @@ module Mongoid
       # @example Get the third to last document.
       #   context.third_to_last
       #
-      # @param [ Integer ] limit The number of documents to return.
-      #
       # @return [ Document ] The third to last document.
       def third_to_last
         eager_load([documents.third_to_last]).first
@@ -537,7 +511,7 @@ module Mongoid
       #
       # @return [ Document ] The third to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def third_to_last!
         third_to_last || raise_document_not_found_error
@@ -653,7 +627,8 @@ module Mongoid
         end
       end
 
-      # Compare two values, checking for nil.
+      # Compare two values, handling the cases when
+      # either value is nil.
       #
       # @api private
       #
@@ -661,15 +636,15 @@ module Mongoid
       #   context.compare(a, b)
       #
       # @param [ Object ] a The first object.
-      # @param [ Object ] b The first object.
+      # @param [ Object ] b The second object.
       #
       # @return [ Integer ] The comparison value.
       def compare(a, b)
-        case
-        when a.nil? then b.nil? ? 0 : 1
-        when b.nil? then -1
-        else a <=> b
-        end
+        return 0 if a.nil? && b.nil?
+        return 1 if a.nil?
+        return -1 if b.nil?
+
+        compare_operand(a) <=> compare_operand(b)
       end
 
       # Sort the documents in place.
@@ -681,9 +656,8 @@ module Mongoid
       def in_place_sort(values)
         documents.sort! do |a, b|
           values.map do |field, direction|
-            a_value, b_value = a[field], b[field]
-            direction * compare(a_value.__sortable__, b_value.__sortable__)
-          end.find { |value| !value.zero? } || 0
+            direction * compare(a[field], b[field])
+          end.detect { |value| !value.zero? } || 0
         end
       end
 
@@ -709,6 +683,23 @@ module Mongoid
         @criteria.send(:_session)
       end
 
+      # Get the operand value to be used in comparison.
+      # Adds capability to sort boolean values.
+      #
+      # @example Get the comparison operand.
+      #   compare_operand(true) #=> 1
+      #
+      # @param [ Object ] value The value to be used in comparison.
+      #
+      # @return [ Integer | Object ] The comparison operand.
+      def compare_operand(value)
+        case value
+        when TrueClass then 1
+        when FalseClass then 0
+        else value
+        end
+      end
+
       # Retrieve the value for the current document at the given field path.
       #
       # For example, if I have the following models:
@@ -742,10 +733,11 @@ module Mongoid
             # _translations hash so that we can get the specified translation in
             # the remaining
             if field&.localized?
-              document.public_send("#{segment}_translations")
+              document.send("#{segment}_translations")
             end
           end
-          res.nil? ? read_field_value(document, segment) : res
+          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.
           document.key?(segment.to_s) ?

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

@@ -1,3 +1,4 @@
+# rubocop:todo all
 require "mongoid/association/eager_loadable"
 
 module Mongoid
@@ -81,9 +82,9 @@ module Mongoid
         # @param [ Class ] klass Mongoid model class to instantiate documents.
         #   All records obtained from the database will be converted to an
         #   instance of this class, if possible.
-        # @param [ Mongoid::Criteria ] criteria. Criteria that specifies which
+        # @param [ Mongoid::Criteria ] criteria Criteria that specifies which
         #   documents should be loaded.
-        # @param [ Concurrent::AbstractExecutorService ] executor. Executor that
+        # @param [ Concurrent::AbstractExecutorService ] executor Executor that
         #   is capable of running `Concurrent::Promises::Future` instances.
         def initialize(view, klass, criteria, executor: self.class.executor)
           @view = view

data/lib/mongoid/contextual/mongo.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
+require 'mongoid/atomic_update_preparer'
 require "mongoid/contextual/mongo/documents_loader"
 require "mongoid/contextual/atomic"
 require "mongoid/contextual/aggregable/mongo"
 require "mongoid/contextual/command"
-require "mongoid/contextual/geo_near"
 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.
     class Mongo
       extend Forwardable
       include Enumerable
@@ -18,8 +23,6 @@ module Mongoid
       include Association::EagerLoadable
       include Queryable
 
-      Mongoid.deprecate(self, :geo_near)
-
       # Options constant.
       OPTIONS = [ :hint,
                   :limit,
@@ -73,6 +76,8 @@ module Mongoid
         if valid_for_count_documents?
           view.count_documents(options)
         else
+          # TODO: Remove this when we remove the deprecated for_js API.
+          # https://jira.mongodb.org/browse/MONGOID-5681
           view.count(options)
         end
       end
@@ -91,7 +96,11 @@ module Mongoid
       # @return [ Integer ] The number of matches.
       def estimated_count(options = {})
         unless self.criteria.selector.empty?
-          raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass)
+          if klass.default_scoping?
+            raise Mongoid::Errors::InvalidEstimatedCountScoping.new(self.klass)
+          else
+            raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass)
+          end
         end
         view.estimated_document_count(options)
       end
@@ -131,19 +140,11 @@ module Mongoid
       #
       # @return [ Array<Object> ] The distinct values for the field.
       def distinct(field)
-        name = if Mongoid.legacy_pluck_distinct
-          klass.database_field_name(field)
-        else
-          klass.cleanse_localized_field_names(field)
-        end
+        name = klass.cleanse_localized_field_names(field)
 
         view.distinct(name).map do |value|
-          if Mongoid.legacy_pluck_distinct
-            value.class.demongoize(value)
-          else
-            is_translation = "#{name}_translations" == field.to_s
-            recursive_demongoize(name, value, is_translation)
-          end
+          is_translation = "#{name}_translations" == field.to_s
+          recursive_demongoize(name, value, is_translation)
         end
       end
 
@@ -259,29 +260,6 @@ module Mongoid
         end
       end
 
-      # Execute a $geoNear command against the database.
-      #
-      # @example Find documents close to 10, 10.
-      #   context.geo_near([ 10, 10 ])
-      #
-      # @example Find with spherical distance.
-      #   context.geo_near([ 10, 10 ]).spherical
-      #
-      # @example Find with a max distance.
-      #   context.geo_near([ 10, 10 ]).max_distance(0.5)
-      #
-      # @example Provide a distance multiplier.
-      #   context.geo_near([ 10, 10 ]).distance_multiplier(1133)
-      #
-      # @param [ Array<Float> ] coordinates The coordinates.
-      #
-      # @return [ GeoNear ] The GeoNear command.
-      #
-      # @deprecated
-      def geo_near(coordinates)
-        GeoNear.new(collection, criteria, coordinates)
-      end
-
       # Create the new Mongo context. This delegates operations to the
       # underlying driver.
       #
@@ -360,22 +338,13 @@ module Mongoid
         normalized_select = fields.inject({}) do |hash, f|
           db_fn = klass.database_field_name(f)
           normalized_field_names.push(db_fn)
-
-          if Mongoid.legacy_pluck_distinct
-            hash[db_fn] = true
-          else
-            hash[klass.cleanse_localized_field_names(f)] = true
-          end
+          hash[klass.cleanse_localized_field_names(f)] = true
           hash
         end
 
         view.projection(normalized_select).reduce([]) do |plucked, doc|
           values = normalized_field_names.map do |n|
-            if Mongoid.legacy_pluck_distinct
-              n.include?('.') ? doc[n.partition('.')[0]] : doc[n]
-            else
-              extract_value(doc, n)
-            end
+            extract_value(doc, n)
           end
           plucked << (values.size == 1 ? values.first : values)
         end
@@ -419,7 +388,7 @@ module Mongoid
       #
       # @return [ Document ] The document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents to take.
       def take!
         # Do to_a first so that the Mongo#first method is not used and the
@@ -601,7 +570,7 @@ module Mongoid
       #
       # @return [ Document ] The first document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def first!
         first || raise_document_not_found_error
@@ -643,7 +612,7 @@ module Mongoid
       #
       # @return [ Document ] The last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def last!
         last || raise_document_not_found_error
@@ -667,7 +636,7 @@ module Mongoid
       #
       # @return [ Document ] The second document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def second!
         second || raise_document_not_found_error
@@ -691,7 +660,7 @@ module Mongoid
       #
       # @return [ Document ] The third document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def third!
         third || raise_document_not_found_error
@@ -715,7 +684,7 @@ module Mongoid
       #
       # @return [ Document ] The fourth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def fourth!
         fourth || raise_document_not_found_error
@@ -739,7 +708,7 @@ module Mongoid
       #
       # @return [ Document ] The fifth document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def fifth!
         fifth || raise_document_not_found_error
@@ -765,7 +734,7 @@ module Mongoid
       #
       # @return [ Document ] The second to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def second_to_last!
         second_to_last || raise_document_not_found_error
@@ -791,7 +760,7 @@ module Mongoid
       #
       # @return [ Document ] The third to last document.
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] raises when there are no
+      # @raise [ Mongoid::Errors::DocumentNotFound ] raises when there are no
       #   documents available.
       def third_to_last!
         third_to_last || raise_document_not_found_error
@@ -823,8 +792,8 @@ module Mongoid
       # @return [ true | false ] If the update succeeded.
       def update_documents(attributes, method = :update_one, opts = {})
         return false unless attributes
-        attributes = Hash[attributes.map { |k, v| [klass.database_field_name(k.to_s), v] }]
-        view.send(method, attributes.__consolidate__(klass), opts)
+
+        view.send(method, AtomicUpdatePreparer.prepare(attributes, klass), opts)
       end
 
       # Apply the field limitations.
@@ -1057,6 +1026,9 @@ module Mongoid
       #
       # @return [ true | false ] whether or not the current context
       #   excludes a `$where` operator.
+      #
+      # TODO: Remove this method when we remove the deprecated for_js API.
+      # https://jira.mongodb.org/browse/MONGOID-5681
       def valid_for_count_documents?(hash = view.filter)
         # Note that `view.filter` is a BSON::Document, and all keys in a
         # BSON::Document are strings; we don't need to worry about symbol
@@ -1091,7 +1063,7 @@ module Mongoid
       end
 
       def retrieve_nth_to_last_with_limit(n, limit)
-        v = view.sort(inverse_sorting).limit(limit || 1)
+        v = view.sort(inverse_sorting).skip(n).limit(limit || 1)
         v = v.skip(n) if n > 0
         raw_docs = v.to_a.reverse
         process_raw_docs(raw_docs, limit)

data/lib/mongoid/contextual/none.rb

@@ -1,38 +1,21 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 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.
     class None
       include Enumerable
-      alias :old_sum :sum
-
       include Aggregable::None
       include Queryable
 
       attr_reader :criteria, :klass
 
-      alias :new_sum :sum
-
-      # Get the sum in the null context.
-      #
-      # @example Get the sum of null context.
-      #     context.sum(_field)
-      #
-      # @param [ Symbol ] _field The field to sum.
-      #
-      # @return [ Integer | Symbol ] If Mongoid.broken_aggregables is
-      #   set to false, this will always be zero. Otherwise, it will return the
-      #   field name as a symbol.
-      def sum(_field = nil)
-        if Mongoid.broken_aggregables
-          old_sum(_field)
-        else
-          new_sum(_field)
-        end
-      end
-
       # Check if the context is equal to the other object.
       #
       # @example Check equality.
@@ -155,7 +138,7 @@ module Mongoid
       # @example Get the first document in null context.
       #   context.first!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def first!
         raise_document_not_found_error
       end
@@ -177,7 +160,7 @@ module Mongoid
       # @example Get the last document in null context.
       #   context.last!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def last!
         raise_document_not_found_error
       end
@@ -199,7 +182,7 @@ module Mongoid
       # @example Take a document in null context.
       #   context.take!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def take!
         raise_document_not_found_error
       end
@@ -219,7 +202,7 @@ module Mongoid
       # @example Get the second document in null context.
       #   context.second!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def second!
         raise_document_not_found_error
       end
@@ -239,7 +222,7 @@ module Mongoid
       # @example Get the third document in null context.
       #   context.third!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def third!
         raise_document_not_found_error
       end
@@ -259,7 +242,7 @@ module Mongoid
       # @example Get the fourth document in null context.
       #   context.fourth!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def fourth!
         raise_document_not_found_error
       end
@@ -279,7 +262,7 @@ module Mongoid
       # @example Get the fifth document in null context.
       #   context.fifth!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def fifth!
         raise_document_not_found_error
       end
@@ -299,7 +282,7 @@ module Mongoid
       # @example Get the second to last document in null context.
       #   context.second_to_last!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def second_to_last!
         raise_document_not_found_error
       end
@@ -319,7 +302,7 @@ module Mongoid
       # @example Get the third to last document in null context.
       #   context.third_to_last!
       #
-      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      # @raise [ Mongoid::Errors::DocumentNotFound ] always raises.
       def third_to_last!
         raise_document_not_found_error
       end
@@ -331,7 +314,7 @@ module Mongoid
       #
       # @return [ Integer ] Always zero.
       def length
-        Mongoid.broken_aggregables ? 0 : entries.length
+        entries.length
       end
       alias :size :length
 

data/lib/mongoid/contextual/queryable.rb

@@ -1,7 +1,11 @@
 # 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.