mongoid 8.1.13 → 9.0.0

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
 

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional date behavior.
+        # Adds query type-casting behavior to Date class.
         module Date
 
           # Evolve the date into a mongo friendly time, UTC midnight.
@@ -23,9 +24,9 @@ module Mongoid
           # @example Evolve the date.
           #   date.__evolve_time__
           #
-          # @return [ Time ] The date as a local time.
+          # @return [ Time | ActiveSupport::TimeWithZone ] The date as a local time.
           def __evolve_time__
-            ::Time.local(year, month, day)
+            ::Time.zone.local(year, month, day)
           end
 
           module ClassMethods

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional datetime behavior.
+        # Adds query type-casting behavior to DateTime class.
         module DateTime
 
           # Evolve the date time into a mongo friendly UTC time.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional hash behavior.
+        # Adds query type-casting behavior to Hash class.
         module Hash
 
           # Add an object to a hash using the merge strategies.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional nil behavior.
+        # Adds query type-casting behavior to NilClass.
         module NilClass
 
           # Add this object to nil.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional numeric behavior.
+        # Adds query type-casting behavior to Numeric module and its children.
         module Numeric
 
           # Evolve the numeric value into a mongo friendly date, aka UTC time at
@@ -43,21 +44,7 @@ module Mongoid
             #
             # @return [ Object ] The converted number.
             def __numeric__(object)
-              str = object.to_s
-              raise ArgumentError if str.empty?
-
-              # These requirements seem a bit odd, but they're explicitly specified in the tests,
-              # so we're obligated to keep them, for now. (This code was rewritten from a one-line
-              # regex, due to security concerns with a polynomial regex being used on uncontrolled
-              # data).
-
-              str = str.chop if str.end_with?('.')
-              return 0 if str.empty?
-
-              result = Integer(str) rescue Float(object)
-
-              integer = result.to_i
-              integer == result ? integer : result
+              object.to_s.match?(/\A[-+]?[0-9]*[0-9.]0*\z/) ? object.to_i : Float(object)
             end
 
             # Evolve the object to an integer.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional object behavior.
+        # Adds query type-casting behavior to Object class.
         module Object
 
           # Combine the two objects using the add strategy.
@@ -127,9 +128,11 @@ module Mongoid
           #   obj.regexp?
           #
           # @return [ false ] Always false.
+          # @deprecated
           def regexp?
             false
           end
+          Mongoid.deprecate(self, :regexp?)
 
           module ClassMethods
 

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional range behavior.
+        # Adds query type-casting behavior to Range class.
         module Range
 
           # Get the range as an array.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional regex behavior.
+        # Adds query type-casting behavior to Regexp class.
         module Regexp
 
           # Is the object a regexp?
@@ -14,7 +15,9 @@ module Mongoid
           #   /\A[123]/.regexp?
           #
           # @return [ true ] Always true.
+          # @deprecated
           def regexp?; true; end
+          Mongoid.deprecate(self, :regexp?)
 
           module ClassMethods
 
@@ -33,6 +36,7 @@ module Mongoid
             end
           end
 
+          # Adds query type-casting behavior to BSON::Regexp::Raw class.
           module Raw_
 
             # Is the object a regexp?
@@ -41,7 +45,9 @@ module Mongoid
             #   bson_raw_regexp.regexp?
             #
             # @return [ true ] Always true.
+            # @deprecated
             def regexp?; true; end
+            Mongoid.deprecate(self, :regexp?)
 
             module ClassMethods
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "set"
 
@@ -7,7 +8,7 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # This module contains additional object behavior.
+        # Adds query type-casting behavior to Set class.
         module Set
           module ClassMethods
 

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional object behavior.
+        # Adds query type-casting behavior to String class.
         module String
 
           # Evolve the string into a mongodb friendly date.
@@ -81,7 +82,7 @@ module Mongoid
             # @return [ Hash ] The selection.
             def __expr_part__(key, value, negating = false)
               if negating
-                { key => { "$#{value.regexp? ? "not" : "ne"}" => value }}
+                { key => { "$#{__regexp?(value) ? "not" : "ne"}" => value }}
               else
                 { key => value }
               end
@@ -98,9 +99,20 @@ module Mongoid
             # @return [ String ] The value as a string.
             def evolve(object)
               __evolve__(object) do |obj|
-                obj.regexp? ? obj : obj.to_s
+                __regexp?(obj) ? obj : obj.to_s
               end
             end
+
+            private
+
+            # Returns whether the object is Regexp-like.
+            #
+            # @param [ Object ] object The object to evaluate.
+            #
+            # @return [ Boolean ] Whether the object is Regexp-like.
+            def __regexp?(object)
+              object.is_a?(Regexp) || object.is_a?(BSON::Regexp::Raw)
+            end
           end
         end
       end

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional symbol behavior.
+        # Adds query type-casting behavior to Symbol class.
         module Symbol
 
           # Get the symbol as a specification.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional time behavior.
+        # Adds query type-casting behavior to Time class.
         module Time
 
           # Evolve the time as a date, UTC midnight.

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional time with zone behavior.
+        # Adds query type-casting behavior to
+        # ActiveSupport::TimeWithZone class.
         module TimeWithZone
 
           # Evolve the time as a date, UTC midnight.

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 if defined?(ActiveSupport)
   unless defined?(ActiveSupport::TimeWithZone)

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -131,6 +132,15 @@ module Mongoid
           { name.to_s => transform_value(object, negating) }
         end
 
+        # Gets the raw selector condition that would be passed to Mongo.
+        #
+        # @example Gets the raw selector condition.
+        #   key.transform_value(50)
+        #
+        # @param [ Object ] value The value to be included.
+        # @param [ true | false ] negating If the selection should be negated.
+        #
+        # @return [ Hash ] The raw MongoDB selector.
         def transform_value(value, negating = false)
           if block
             expr = block[value]

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

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

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -325,10 +326,6 @@ module Mongoid
               end
             end
           end
-          # Every query method that takes a user-supplied expression normalizes
-          # it here, so this is where the operator guard is enforced. See
-          # Selectable#_mongoid_validate_operators! for what it does not cover.
-          _mongoid_validate_operators!(result)
           result
         end
 
@@ -347,14 +344,6 @@ module Mongoid
           if criterion.is_a?(Selectable)
             criterion = criterion.selector
           end
-
-          # The __override__ path writes to the selector directly, so it
-          # bypasses _mongoid_expand_keys where the operator guard normally
-          # runs. Enforce the guard here so chained override methods
-          # (elem_match, exists, eq, gt, in, etc.) cannot smuggle $where or
-          # other JavaScript operators under strict mode.
-          _mongoid_validate_operators!(criterion)
-
           selection(criterion) do |selector, field, value|
             expression = prepare(field, operator, value)
             existing = selector[field]

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

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

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

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