mongoid 8.1.9 → 9.0.0

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

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.

data/lib/mongoid/contextual.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/contextual/queryable"
 require "mongoid/contextual/mongo"
@@ -6,6 +7,9 @@ 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
     extend Forwardable
 

data/lib/mongoid/copyable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
 
@@ -36,8 +37,8 @@ module Mongoid
     # hash. This is used recursively so that embedded associations are cloned
     # safely.
     #
-    # @param klass [ Class ] The class of the document to create.
-    # @param attrs [ Hash ] The hash of the attributes.
+    # @param [ Class ] klass The class of the document to create.
+    # @param [ Hash ] attrs The hash of the attributes.
     #
     # @return [ Document ] The new document.
     def self.clone_with_hash(klass, attrs)

data/lib/mongoid/criteria/findable.rb

@@ -1,7 +1,11 @@
 # 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.
@@ -10,7 +14,8 @@ module Mongoid
       #   criteria.execute_or_raise(id)
       #
       # @param [ Object ] ids The arguments passed.
-      # @param [ true | false ] multi Whether there arguments were a list.
+      # @param [ true | false ] multi Whether there arguments were a list,
+      #   and therefore the return value should be an array.
       #
       # @raise [ Errors::DocumentNotFound ] If nothing returned.
       #
@@ -36,9 +41,9 @@ module Mongoid
       #
       # @return [ Document | Array<Document> ] The matching document(s).
       def find(*args)
-        ids = args.__find_args__
+        ids = prepare_ids_for_find(args)
         raise_invalid if ids.any?(&:nil?)
-        for_ids(ids).execute_or_raise(ids, args.multi_arged?)
+        for_ids(ids).execute_or_raise(ids, multi_args?(args))
       end
 
       # Adds a criterion to the +Criteria+ that specifies an id that must be matched.
@@ -104,7 +109,7 @@ module Mongoid
         from_database_selector(ids).entries
       end
 
-      private def from_database_selector(ids)
+      def from_database_selector(ids)
         if ids.size > 1
           any_in(_id: ids)
         else
@@ -129,6 +134,41 @@ module Mongoid
         end
       end
 
+      # Convert args to the +#find+ method into a flat array of ids.
+      #
+      # @example Get the ids.
+      #   prepare_ids_for_find([ 1, [ 2, 3 ] ])
+      #
+      # @param [ Array<Object> ] args The arguments.
+      #
+      # @return [ Array ] The array of ids.
+      def prepare_ids_for_find(args)
+        args.flat_map do |arg|
+          case arg
+          when Array, Set
+            prepare_ids_for_find(arg)
+          when Range
+            arg.begin&.numeric? && arg.end&.numeric? ? arg.to_a : arg
+          else
+            arg
+          end
+        end.uniq(&:to_s)
+      end
+
+      # Indicates whether the given arguments array is a list of values.
+      # Used by the +find+ method to determine whether to return an array
+      # or single value.
+      #
+      # @example Are these arguments a list of values?
+      #   multi_args?([ 1, 2, 3 ]) #=> true
+      #
+      # @param [ Array ] args The arguments.
+      #
+      # @return [ true | false ] Whether the arguments are a list.
+      def multi_args?(args)
+        args.size > 1 || !args.first.is_a?(Hash) && args.first.resizable?
+      end
+
       # Convenience method of raising an invalid options error.
       #
       # @example Raise the error.

data/lib/mongoid/criteria/includable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -32,16 +33,16 @@ module Mongoid
 
       # Get a list of criteria that are to be executed for eager loading.
       #
-      # @return [ Array<Association> ] The inclusions.
+      # @return [ Array<Mongoid::Association::Relatable> ] The inclusions.
       def inclusions
         @inclusions ||= []
       end
 
       # Set the inclusions for the criteria.
       #
-      # @param [ Array<Association> ] value The inclusions.
+      # @param [ Array<Mongoid::Association::Relatable> ] value The inclusions.
       #
-      # @return [ Array<Association> ] The new inclusions.
+      # @return [ Array<Mongoid::Association::Relatable> ] The new inclusions.
       def inclusions=(value)
         @inclusions = value
       end
@@ -50,7 +51,7 @@ module Mongoid
 
       # Add an inclusion definition to the list of inclusions for the criteria.
       #
-      # @param [ Association ] association The association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       # @param [ String ] parent The name of the association above this one in
       #   the inclusion tree, if it is a nested inclusion.
       def add_inclusion(association, parent = nil)

data/lib/mongoid/criteria/inspectable.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
+
+    # Mixin module included in Mongoid::Criteria which adds custom
+    # +#inspect+ method functionality.
     module Inspectable
 
       # Get a pretty string representation of the criteria, including the

data/lib/mongoid/criteria/marshalable.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
+
+    # Mixin module for Mongoid::Criteria which adds custom
+    # Marshal.dump functionality.
     module Marshalable
 
       # Provides the data needed to Marshal.dump a criteria.

data/lib/mongoid/criteria/modifiable.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
+
+    # Mixin module for Mongoid::Criteria which adds the ability
+    # to build or create new documents with attributes initialized
+    # to the conditions of the criteria.
     module Modifiable
 
       # @attribute [r] create_attrs Additional attributes to add to the Document upon creation.

data/lib/mongoid/criteria/options.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

data/lib/mongoid/criteria/permission.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
+
+    # Mixin module for Mongoid::Criteria which adds strong
+    # parameters validation when using ActionController::Parameters
+    # objects as arguments to condition methods.
     module Permission
 
       [:all,

data/lib/mongoid/criteria/queryable/aggregable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

data/lib/mongoid/criteria/queryable/expandable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

data/lib/mongoid/criteria/queryable/extensions/array.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # The array module adds custom behavior for Origin onto the Array class.
+        # Adds query type-casting behavior to Array class.
         module Array
 
           # Combine the two objects using the add strategy.

data/lib/mongoid/criteria/queryable/extensions/big_decimal.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "bigdecimal"
 
@@ -7,8 +8,7 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # The big decimal module adds custom behavior for Origin onto the
-        # BigDecimal class.
+        # Adds query type-casting behavior to BigDecimal class.
         module BigDecimal
           module ClassMethods
 
@@ -31,9 +31,7 @@ module Mongoid
                   else
                     obj.to_s
                   end
-                # Always return on string for backwards compatibility with querying
-                # string-backed BigDecimal fields.
-                when BSON::Decimal128, String then obj
+                when BSON::Decimal128 then obj
                 else
                   if obj.numeric?
                     if Mongoid.map_big_decimal_to_decimal128

data/lib/mongoid/criteria/queryable/extensions/boolean.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains extensions for boolean selection.
+        # Adds query type-casting behavior to Mongoid::Boolean class.
         module Boolean
           module ClassMethods