mongoid 6.4.4 → 7.5.1

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

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
 
       # Provides a DSL around crafting aggregation framework commands.
-      #
-      # @since 2.0.0
       module Aggregable
         extend Macroable
 
@@ -22,8 +21,6 @@ module Mongoid
         #   aggregable.aggregating?
         #
         # @return [ true, false ] If the aggregable is aggregating.
-        #
-        # @since 2.0.0
         def aggregating?
           !!@aggregating
         end
@@ -39,8 +36,6 @@ module Mongoid
         # @param [ Hash ] operation The group operation.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def group(operation)
           aggregation(operation) do |pipeline|
             pipeline.group(operation)
@@ -63,8 +58,6 @@ module Mongoid
         # @param [ Hash ] operation The projection to make.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def project(operation = nil)
           aggregation(operation) do |pipeline|
             pipeline.project(operation)
@@ -79,8 +72,6 @@ module Mongoid
         # @param [ String, Symbol ] field The name of the field to unwind.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def unwind(field)
           aggregation(field) do |pipeline|
             pipeline.unwind(field)
@@ -101,8 +92,6 @@ module Mongoid
         # @param [ Hash ] operation The operation for the pipeline.
         #
         # @return [ Aggregable ] The cloned aggregable.
-        #
-        # @since 2.0.0
         def aggregation(operation)
           return self unless operation
           clone.tap do |query|

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      # This module encapsulates methods that expand various high level
+      # query forms to the MongoDB hash condition selector syntax.
+      #
+      # @example Example high level form.
+      #   Band.where(:foo.gt => 5)
+      #
+      # @api private
+      module Expandable
+
+        private
+
+        # Expands the specified condition to MongoDB syntax.
+        #
+        # This method is meant to be called when processing the items of
+        # a condition hash and the key and the value of each item are
+        # already available separately.
+        #
+        # The following parameter forms are accepted:
+        #
+        # - field is a string or symbol; value is the field query expresision
+        # - field is a Key instance; value is the field query expression
+        # - field is a string corresponding to a MongoDB operator; value is
+        #   the operator value expression.
+        #
+        # This method expands the field-value combination to the MongoDB
+        # selector syntax and returns an array of
+        # [expanded key, expanded value]. The expanded key is converted to
+        # a string if it wasn't already a string.
+        #
+        # @param [ String | Symbol | Key ] field The field to expand.
+        # @param [ Object ] value The field's value.
+        #
+        # @return [ Array<String, Object> ] The expanded field and value.
+        def expand_one_condition(field, value)
+          kv = field.__expr_part__(value.__expand_complex__, negating?)
+          [kv.keys.first.to_s, kv.values.first]
+        end
+
+        # Expand criterion values to arrays, to be used with operators that
+        # take an array as argument such as $in.
+        #
+        # @example Convert all the values to arrays.
+        #   selectable.with_array_values({ key: 1...4 })
+        #
+        # @param [ Hash ] criterion The criterion.
+        #
+        # @return [ Hash ] The $in friendly criterion with array values.
+        #
+        # @api private
+        def expand_condition_to_array_values(criterion)
+          if criterion.nil?
+            raise ArgumentError, 'Criterion cannot be nil here'
+          end
+
+          Hash[criterion.map do |key, value|
+            [key, value.__array__]
+          end]
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # The array module adds custom behaviour for Origin onto the Array class.
+        # The array module adds custom behavior for Origin onto the Array class.
         module Array
 
           # Combine the two objects using the add strategy.
@@ -15,8 +16,6 @@ module Mongoid
           # @param [ Object ] object The object to add.
           #
           # @return [ Object ] The result of the add.
-          #
-          # @since 1.0.0
           def __add__(object)
             object.__add_from_array__(self)
           end
@@ -27,8 +26,6 @@ module Mongoid
           #   [ 1, 2 ].__array__
           #
           # @return [ Array ] self
-          #
-          # @since 1.0.0
           def __array__; self; end
 
           # Makes a deep copy of the array, deep copying every element inside the
@@ -38,8 +35,6 @@ module Mongoid
           #   [ 1, 2, 3 ].__deep_copy__
           #
           # @return [ Array ] The deep copy of the array.
-          #
-          # @since 1.0.0
           def __deep_copy__
             map { |value| value.__deep_copy__ }
           end
@@ -51,8 +46,6 @@ module Mongoid
           #   [ Date.new(2010, 1, 1) ].__evolve_date__
           #
           # @return [ Array<Time> ] The array as times at midnight UTC.
-          #
-          # @since 1.0.0
           def __evolve_date__
             map { |value| value.__evolve_date__ }
           end
@@ -63,8 +56,6 @@ module Mongoid
           #   obj.__expand_complex__
           #
           # @return [ Array ] The expanded array.
-          #
-          # @since 1.1.0
           def __expand_complex__
             map do |value|
               value.__expand_complex__
@@ -77,22 +68,18 @@ module Mongoid
           #   [ 1231231231 ].__evolve_time__
           #
           # @return [ Array<Time> ] The array as times.
-          #
-          # @since 1.0.0
           def __evolve_time__
             map { |value| value.__evolve_time__ }
           end
 
           # Combine the two objects using an intersection strategy.
           #
-          # @example Interset with the object.
+          # @example Intersect with the object.
           #   [ 1, 2 ].__intersect__(3)
           #
           # @param [ Object ] object The object to intersect with.
           #
           # @return [ Object ] The result of the intersection.
-          #
-          # @since 1.0.0
           def __intersect__(object)
             object.__intersect_from_array__(self)
           end
@@ -104,8 +91,6 @@ module Mongoid
           #   [ :field, 1 ].__sort_option__
           #
           # @return [ Hash ] The array as sort criterion.
-          #
-          # @since 1.0.0
           def __sort_option__
             multi.inject({}) do |options, criteria|
               options.merge!(criteria.__sort_pair__)
@@ -119,8 +104,6 @@ module Mongoid
           #   [ field, 1 ].__sort_pair__
           #
           # @return [ Hash ] The field/direction pair.
-          #
-          # @since 1.0.0
           def __sort_pair__
             { first => last.to_direction }
           end
@@ -134,7 +117,7 @@ module Mongoid
           #
           # @return [ Array ] the array.
           #
-          # @since 1.0.0
+          # @deprecated
           def update_values(&block)
             replace(map(&block))
           end
@@ -149,8 +132,6 @@ module Mongoid
           #   [ 1, 2, 3 ].multi
           #
           # @return [ Array ] The multi-dimensional array.
-          #
-          # @since 1.0.0
           def multi
             first.is_a?(::Symbol) || first.is_a?(::String) ? [ self ] : self
           end
@@ -165,8 +146,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Object ] The evolved object.
-            #
-            # @since 1.0.0
             def evolve(object)
               if object.is_a?(::Array)
                 object.map { |obj| obj.class.evolve(obj) }

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "bigdecimal"
 
 module Mongoid
@@ -6,7 +7,7 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # The big decimal module adds custom behaviour for Origin onto the
+        # The big decimal module adds custom behavior for Origin onto the
         # BigDecimal class.
         module BigDecimal
           module ClassMethods
@@ -20,8 +21,6 @@ module Mongoid
             # @param [ BigDecimal ] object The object to convert.
             #
             # @return [ String ] The big decimal as a string.
-            #
-            # @since 1.0.0
             def evolve(object)
               __evolve__(object) do |obj|
                 obj ? obj.to_s : obj

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
@@ -17,8 +18,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ true, false ] The boolean value.
-            #
-            # @since 1.0.0
             def evolve(object)
               __evolve__(object) do |obj|
                 obj.to_s =~ (/\A(true|t|yes|y|on|1|1.0)\z/i) ? true : false
@@ -31,4 +30,4 @@ module Mongoid
   end
 end
 
-::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)
+Mongoid::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional date behaviour.
+        # This module contains additional date behavior.
         module Date
 
           # Evolve the date into a mongo friendly time, UTC midnight.
@@ -13,8 +14,6 @@ module Mongoid
           #   date.__evolve_date__
           #
           # @return [ Time ] The date as a UTC time at midnight.
-          #
-          # @since 1.0.0
           def __evolve_date__
             ::Time.utc(year, month, day, 0, 0, 0, 0)
           end
@@ -25,8 +24,6 @@ module Mongoid
           #   date.__evolve_time__
           #
           # @return [ Time ] The date as a local time.
-          #
-          # @since 1.0.0
           def __evolve_time__
             ::Time.local(year, month, day)
           end
@@ -47,8 +44,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Time ] The evolved date.
-            #
-            # @since 1.0.0
             def evolve(object)
               object.__evolve_date__
             end

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional datetime behaviour.
+        # This module contains additional datetime behavior.
         module DateTime
 
           # Evolve the date time into a mongo friendly UTC time.
@@ -13,15 +14,10 @@ module Mongoid
           #   date_time.__evolve_time__
           #
           # @return [ Time ] The converted time in UTC.
-          #
-          # @since 1.0.0
           def __evolve_time__
             usec = strftime("%6N").to_f
-            if utc?
-              ::Time.utc(year, month, day, hour, min, sec, usec)
-            else
-              ::Time.local(year, month, day, hour, min, sec, usec).utc
-            end
+            u = utc
+            ::Time.utc(u.year, u.month, u.day, u.hour, u.min, u.sec, usec)
           end
 
           module ClassMethods
@@ -37,8 +33,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Time ] The evolved date time.
-            #
-            # @since 1.0.0
             def evolve(object)
               object.__evolve_time__
             end

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional hash behaviour.
+        # This module contains additional hash behavior.
         module Hash
 
           # Add an object to a hash using the merge strategies.
@@ -15,8 +16,6 @@ module Mongoid
           # @param [ Hash ] object The other hash to add.
           #
           # @return [ Hash ] The hash with object added.
-          #
-          # @since 1.0.0
           def __add__(object)
             apply_strategy(:__add__, object)
           end
@@ -29,8 +28,6 @@ module Mongoid
           # @param [ Array ] array The array to add to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __add_from_array__(array)
             { keys.first => array.__add__(values.first) }
           end
@@ -43,8 +40,6 @@ module Mongoid
           # @param [ Hash ] object The other hash to intersect.
           #
           # @return [ Hash ] The hash with object intersected.
-          #
-          # @since 1.0.0
           def __intersect__(object)
             apply_strategy(:__intersect__, object)
           end
@@ -57,8 +52,6 @@ module Mongoid
           # @param [ Array ] array The array to intersect to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __intersect_from_array__(array)
             { keys.first => array.__intersect__(values.first) }
           end
@@ -71,8 +64,6 @@ module Mongoid
           # @param [ Object ] object The object to intersect to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __intersect_from_object__(object)
             { keys.first => object.__intersect__(values.first) }
           end
@@ -85,8 +76,6 @@ module Mongoid
           # @param [ Hash ] object The other hash to union.
           #
           # @return [ Hash ] The hash with object unioned.
-          #
-          # @since 1.0.0
           def __union__(object)
             apply_strategy(:__union__, object)
           end
@@ -99,8 +88,6 @@ module Mongoid
           # @param [ Object ] object The object to union to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __union_from_object__(object)
             { keys.first => object.__union__(values.first) }
           end
@@ -111,8 +98,6 @@ module Mongoid
           #   { field: value }.__deep_copy__
           #
           # @return [ Hash ] The copied hash.
-          #
-          # @since 1.0.0
           def __deep_copy__
             {}.tap do |copy|
               each_pair do |key, value|
@@ -127,8 +112,6 @@ module Mongoid
           #   { field: 1 }.__sort_option__
           #
           # @return [ Hash ] The hash as sort option.
-          #
-          # @since 1.0.0
           def __sort_option__
             tap do |hash|
               hash.each_pair do |key, value|
@@ -143,8 +126,6 @@ module Mongoid
           #   obj.__expand_complex__
           #
           # @return [ Hash ] The expanded hash.
-          #
-          # @since 1.0.5
           def __expand_complex__
             replacement = {}
             each_pair do |key, value|
@@ -162,7 +143,7 @@ module Mongoid
           #
           # @return [ Hash ] the hash.
           #
-          # @since 1.0.0
+          # @deprecated
           def update_values(&block)
             each_pair do |key, value|
               store(key, block[value])
@@ -182,8 +163,6 @@ module Mongoid
           # @param [ Object ] object The object to merge.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def apply_strategy(strategy, object)
             tap do |hash|
               object.each_pair do |key, value|

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional nil behaviour.
+        # This module contains additional nil behavior.
         module NilClass
 
           # Add this object to nil.
@@ -15,8 +16,6 @@ module Mongoid
           # @param [ Object ] object The object to add.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __add__(object); object; end
 
           # Add this object to nil.
@@ -27,8 +26,6 @@ module Mongoid
           # @param [ Object ] object The object to expanded.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __expanded__(object); object; end
 
           # Evolve the nil into a date or time.
@@ -37,8 +34,6 @@ module Mongoid
           #   nil.__evolve_time__
           #
           # @return [ nil ] nil.
-          #
-          # @since 1.0.0
           def __evolve_time__; self; end
           alias :__evolve_date__ :__evolve_time__
 
@@ -50,8 +45,6 @@ module Mongoid
           # @param [ Object ] object The object to intersect.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __intersect__(object); object; end
 
           # Add this object to nil.
@@ -62,8 +55,6 @@ module Mongoid
           # @param [ Object ] object The object to override.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __override__(object); object; end
 
           # Add this object to nil.
@@ -74,8 +65,6 @@ module Mongoid
           # @param [ Object ] object The object to union.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __union__(object); object; end
         end
       end

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional numeric behaviour.
+        # This module contains additional numeric behavior.
         module Numeric
 
           # Evolve the numeric value into a mongo friendly date, aka UTC time at
@@ -14,8 +15,6 @@ module Mongoid
           #   125214512412.1123.__evolve_date__
           #
           # @return [ Time ] The time representation at UTC midnight.
-          #
-          # @since 1.0.0
           def __evolve_date__
             time = ::Time.at(self).utc
             ::Time.utc(time.year, time.month, time.day, 0, 0, 0, 0)
@@ -27,8 +26,6 @@ module Mongoid
           #   125214512412.1123.__evolve_time__
           #
           # @return [ Time ] The time representation.
-          #
-          # @since 1.0.0
           def __evolve_time__
             ::Time.at(self).utc
           end
@@ -39,8 +36,6 @@ module Mongoid
           #   1.to_direction
           #
           # @return [ Integer ] self.
-          #
-          # @since 1.0.0
           def to_direction; self; end
 
           module ClassMethods
@@ -55,10 +50,8 @@ module Mongoid
             # @param [ Object ] object The object to convert.
             #
             # @return [ Object ] The converted number.
-            #
-            # @since 1.0.0
             def __numeric__(object)
-              object.to_s =~ /(^[-+]?[0-9]+$)|(\.0+$)|(\.$)/ ? object.to_i : Float(object)
+              object.to_s =~ /(\A[-+]?[0-9]+\z)|(\.0+\z)|(\.\z)/ ? object.to_i : Float(object)
             end
 
             # Evolve the object to an integer.
@@ -69,8 +62,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Integer ] The evolved object.
-            #
-            # @since 1.0.0
             def evolve(object)
               __evolve__(object) do |obj|
                 __numeric__(obj) rescue obj