mongoid 7.1.1 → 8.1.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,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
@@ -31,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
@@ -45,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
@@ -59,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
@@ -73,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
@@ -87,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
@@ -101,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
@@ -113,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|
@@ -129,12 +112,10 @@ 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|
-                hash.store(key, value.to_direction)
+                hash.store(key, Mongoid::Criteria::Translator.to_direction(value))
               end
             end
           end
@@ -145,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|
@@ -155,22 +134,6 @@ module Mongoid
             replacement
           end
 
-          # Update all the values in the hash with the provided block.
-          #
-          # @example Update the values in place.
-          #   { field: "1" }.update_values(&:to_i)
-          #
-          # @param [ Proc ] block The block to execute on each value.
-          #
-          # @return [ Hash ] the hash.
-          #
-          # @since 1.0.0
-          def update_values(&block)
-            each_pair do |key, value|
-              store(key, block[value])
-            end
-          end
-
           private
 
           # Apply the provided strategy for the hash with the given object.
@@ -184,8 +147,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,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.
@@ -29,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.
@@ -39,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__
 
@@ -52,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.
@@ -64,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.
@@ -76,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -16,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)
@@ -29,22 +26,10 @@ module Mongoid
           #   125214512412.1123.__evolve_time__
           #
           # @return [ Time ] The time representation.
-          #
-          # @since 1.0.0
           def __evolve_time__
             ::Time.at(self).utc
           end
 
-          # Get the integer as a sort direction.
-          #
-          # @example Get the integer as a sort direction.
-          #   1.to_direction
-          #
-          # @return [ Integer ] self.
-          #
-          # @since 1.0.0
-          def to_direction; self; end
-
           module ClassMethods
 
             # Get the object as a numeric.
@@ -57,10 +42,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.match?(/\A[-+]?[0-9]*[0-9.]0*\z/) ? object.to_i : Float(object)
             end
 
             # Evolve the object to an integer.
@@ -71,8 +54,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

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,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 == self) ? self : [ self, object ].flatten.uniq
           end
@@ -31,8 +28,6 @@ module Mongoid
           # @param [ Array ] array The array to add to.
           #
           # @return [ Array ] The merged object.
-          #
-          # @since 1.0.0
           def __add_from_array__(array)
             array.concat(Array(self)).uniq
           end
@@ -45,8 +40,6 @@ module Mongoid
           # @param [ Object ] object The object to intersect.
           #
           # @return [ Array ] The result of the intersect.
-          #
-          # @since 1.0.0
           def __intersect__(object)
             object.__intersect_from_object__(self)
           end
@@ -59,8 +52,6 @@ module Mongoid
           # @param [ Array ] array The array to intersect to.
           #
           # @return [ Array ] The merged object.
-          #
-          # @since 1.0.0
           def __intersect_from_array__(array)
             array & Array(self)
           end
@@ -73,8 +64,6 @@ module Mongoid
           # @param [ Object ] object The value to intersect to.
           #
           # @return [ Array ] The merged object.
-          #
-          # @since 1.0.0
           def __intersect_from_object__(object)
             Array(object) & Array(self)
           end
@@ -87,8 +76,6 @@ module Mongoid
           # @param [ Object ] object The object to union.
           #
           # @return [ Array ] The result of the union.
-          #
-          # @since 1.0.0
           def __union__(object)
             object.__union_from_object__(self)
           end
@@ -101,8 +88,6 @@ module Mongoid
           # @param [ Object ] object The value to union to.
           #
           # @return [ Array ] The merged object.
-          #
-          # @since 1.0.0
           def __union_from_object__(object)
             (Array(object) + Array(self)).uniq
           end
@@ -114,8 +99,6 @@ module Mongoid
           #   1.__deep_copy__
           #
           # @return [ Object ] self.
-          #
-          # @since 1.0.0
           def __deep_copy__; self; end
 
           # Get the object as an array.
@@ -124,8 +107,6 @@ module Mongoid
           #   4.__array__
           #
           # @return [ Array ] The wrapped object.
-          #
-          # @since 1.0.0
           def __array__
             [ self ]
           end
@@ -136,8 +117,6 @@ module Mongoid
           #   obj.__expand_complex__
           #
           # @return [ Object ] self.
-          #
-          # @since 1.0.5
           def __expand_complex__
             self
           end
@@ -148,8 +127,6 @@ module Mongoid
           #   obj.regexp?
           #
           # @return [ false ] Always false.
-          #
-          # @since 1.0.4
           def regexp?
             false
           end
@@ -164,8 +141,6 @@ module Mongoid
             #   Object.evolve("test")
             #
             # @return [ Object ] The provided object.
-            #
-            # @since 1.0.0
             def evolve(object)
               object
             end
@@ -184,17 +159,16 @@ module Mongoid
             #   end
             #
             # @return [ Object ] The evolved object.
-            #
-            # @since 1.0.0
             def __evolve__(object)
               return nil if object.nil?
               case object
               when ::Array
                 object.map{ |obj| evolve(obj) }
               when ::Range
-                { "$gte" => evolve(object.min), "$lte" => evolve(object.max) }
+                object.__evolve_range__
               else
-                yield(object)
+                res = yield(object)
+                res.nil? ? object : res
               end
             end
           end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -15,39 +14,72 @@ module Mongoid
           #   1...3.__array__
           #
           # @return [ Array ] The range as an array.
-          #
-          # @since 1.0.0
           def __array__
             to_a
           end
 
-          # Convert the range to a min/max mongo friendly query for dates.
+          # Convert the range to a $gte/$lte mongo friendly query for dates.
           #
           # @example Evolve the range.
           #   (11231312..213123131).__evolve_date__
           #
-          # @return [ Hash ] The min/max range query with times at midnight.
-          #
-          # @since 1.0.0
+          # @return [ Hash ] The $gte/$lte range query with times at UTC midnight.
           def __evolve_date__
-            { "$gte" => min.__evolve_date__, "$lte" => max.__evolve_date__ }
+            __evolve_range_naive__.transform_values! {|v| v&.__evolve_date__ }
           end
 
-          # Convert the range to a min/max mongo friendly query for times.
+          # Convert the range to a $gte/$lte mongo friendly query for times.
           #
           # @example Evolve the range.
           #   (11231312..213123131).__evolve_date__
           #
-          # @return [ Hash ] The min/max range query with times.
-          #
-          # @since 1.0.0
+          # @return [ Hash ] The $gte/$lte range query with times in UTC.
           def __evolve_time__
-            { "$gte" => min.__evolve_time__, "$lte" => max.__evolve_time__ }
+            __evolve_range_naive__.transform_values! {|v| v&.__evolve_time__ }
+          end
+
+          # Convert the range to a $gte/$lte mongo friendly query.
+          #
+          # @example Evolve the range.
+          #   (11231312..213123131).__evolve_range__
+          #
+          # @param [ Object ] serializer The optional serializer for the field.
+          #
+          # @return [ Hash ] The $gte/$lte range query.
+          #
+          # @api private
+          def __evolve_range__(serializer: nil)
+            __evolve_range_naive__.transform_values! do |value|
+              if serializer
+                serializer.evolve(value)
+              else
+                case value
+                when Time, DateTime then value.__evolve_time__
+                when Date then value.__evolve_date__
+                else value
+                end
+              end
+            end
+          end
+
+          private
+
+          # @note This method's return value will be mutated by the __evolve_*__
+          #   methods, therefore it must always return new objects.
+          #
+          # @api private
+          def __evolve_range_naive__
+            hash = {}
+            hash['$gte'] = self.begin if self.begin
+            hash[exclude_end? ? "$lt" : "$lte"] = self.end if self.end
+            hash
           end
 
           module ClassMethods
 
             # Evolve the range. This will transform it into a $gte/$lte selection.
+            # Endless and beginning-less ranges will use only $gte or $lte respectively.
+            # End-excluded ranges (...) will use $lt selector instead of $lte.
             #
             # @example Evolve the range.
             #   Range.evolve(1..3)
@@ -55,11 +87,9 @@ module Mongoid
             # @param [ Range ] object The range to evolve.
             #
             # @return [ Hash ] The range as a gte/lte criteria.
-            #
-            # @since 1.0.0
             def evolve(object)
               return object unless object.is_a?(::Range)
-              { "$gte" => object.min, "$lte" => object.max }
+              object.__evolve_range__
             end
           end
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -12,11 +11,9 @@ module Mongoid
           # Is the object a regexp?
           #
           # @example Is the object a regex?
-          #   /^[123]/.regexp?
+          #   /\A[123]/.regexp?
           #
           # @return [ true ] Always true.
-          #
-          # @since 1.0.0
           def regexp?; true; end
 
           module ClassMethods
@@ -24,21 +21,19 @@ module Mongoid
             # Evolve the object into a regex.
             #
             # @example Evolve the object to a regex.
-            #   Regexp.evolve("^[123]")
+            #   Regexp.evolve("\A[123]")
             #
-            # @param [ Regexp, String ] object The object to evolve.
+            # @param [ Regexp | String ] object The object to evolve.
             #
             # @return [ Regexp ] The evolved regex.
-            #
-            # @since 1.0.0
             def evolve(object)
               __evolve__(object) do |obj|
-                ::Regexp.new(obj)
+                mongoize(obj)
               end
             end
           end
 
-          module Raw
+          module Raw_
 
             # Is the object a regexp?
             #
@@ -46,8 +41,6 @@ module Mongoid
             #   bson_raw_regexp.regexp?
             #
             # @return [ true ] Always true.
-            #
-            # @since 5.2.1
             def regexp?; true; end
 
             module ClassMethods
@@ -55,13 +48,11 @@ module Mongoid
               # Evolve the object into a raw bson regex.
               #
               # @example Evolve the object to a regex.
-              #   BSON::Regexp::Raw.evolve("^[123]")
+              #   BSON::Regexp::Raw.evolve("\\A[123]")
               #
-              # @param [ BSON::Regexp::Raw, String ] object The object to evolve.
+              # @param [ BSON::Regexp::Raw | String ] object The object to evolve.
               #
               # @return [ BSON::Regexp::Raw ] The evolved raw regex.
-              #
-              # @since 5.2.1
               def evolve(object)
                 __evolve__(object) do |obj|
                   obj.is_a?(String) ? BSON::Regexp::Raw.new(obj) : obj
@@ -77,5 +68,5 @@ end
 
 ::Regexp.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp)
 ::Regexp.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::ClassMethods)
-BSON::Regexp::Raw.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp::Raw)
-BSON::Regexp::Raw.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::Raw::ClassMethods)
+BSON::Regexp::Raw.__send__(:include,Mongoid::Criteria::Queryable::Extensions::Regexp::Raw_)
+BSON::Regexp::Raw.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::Raw_::ClassMethods)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "set"
 
@@ -17,11 +16,9 @@ module Mongoid
             # @example Evolve the set.
             #   Set.evolve(set)
             #
-            # @param [ Set, Object ] object The object to evolve.
+            # @param [ Set | Object ] object The object to evolve.
             #
             # @return [ Array ] The evolved set.
-            #
-            # @since 1.0.0
             def evolve(object)
               return object if !object || !object.respond_to?(:map)
               object.map{ |obj| obj.class.evolve(obj) }

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -15,8 +14,6 @@ module Mongoid
           #   "2012-1-1".__evolve_date__
           #
           # @return [ Time ] The time at UTC midnight.
-          #
-          # @since 1.0.0
           def __evolve_date__
             time = ::Time.parse(self)
             ::Time.utc(time.year, time.month, time.day, 0, 0, 0, 0)
@@ -28,8 +25,6 @@ module Mongoid
           #   "2012-1-1".__evolve_time__
           #
           # @return [ Time ] The string as a time.
-          #
-          # @since 1.0.0
           def __evolve_time__
             __mongoize_time__.utc
           end
@@ -40,8 +35,6 @@ module Mongoid
           #   "test".__mongo_expression__
           #
           # @return [ String ] The string with $ at the front.
-          #
-          # @since 2.0.0
           def __mongo_expression__
             start_with?("$") ? self : "$#{self}"
           end
@@ -52,13 +45,11 @@ module Mongoid
           #   "field ASC".__sort_option__
           #
           # @return [ Hash ] The string as a sort option hash.
-          #
-          # @since 1.0.0
           def __sort_option__
             split(/,/).inject({}) do |hash, spec|
               hash.tap do |_hash|
                 field, direction = spec.strip.split(/\s/)
-                _hash[field.to_sym] = direction.to_direction
+                _hash[field.to_sym] = Mongoid::Criteria::Translator.to_direction(direction)
               end
             end
           end
@@ -69,27 +60,13 @@ module Mongoid
           #   "field".__expr_part__(value)
           #
           # @param [ Object ] value The value of the criteria.
-          # @param [ true, false ] negating If the selection should be negated.
+          # @param [ true | false ] negating If the selection should be negated.
           #
           # @return [ Hash ] The selection.
-          #
-          # @since 1.0.0
           def __expr_part__(value, negating = false)
             ::String.__expr_part__(self, value, negating)
           end
 
-          # Get the string as a sort direction.
-          #
-          # @example Get the string as a sort direction.
-          #   "1".to_direction
-          #
-          # @return [ Integer ] The direction.
-          #
-          # @since 1.0.0
-          def to_direction
-            self =~ /desc/i ? -1 : 1
-          end
-
           module ClassMethods
 
             # Get the value as a expression.
@@ -97,13 +74,11 @@ module Mongoid
             # @example Get the value as an expression.
             #   String.__expr_part__("field", value)
             #
-            # @param [ String, Symbol ] key The field key.
+            # @param [ String | Symbol ] key The field key.
             # @param [ Object ] value The value of the criteria.
-            # @param [ true, false ] negating If the selection should be negated.
+            # @param [ true | false ] negating If the selection should be negated.
             #
             # @return [ Hash ] The selection.
-            #
-            # @since 2.0.0
             def __expr_part__(key, value, negating = false)
               if negating
                 { key => { "$#{value.regexp? ? "not" : "ne"}" => value }}
@@ -121,8 +96,6 @@ module Mongoid
             # @param [ Object ] object The object to convert.
             #
             # @return [ String ] The value as a string.
-            #
-            # @since 1.0.0
             def evolve(object)
               __evolve__(object) do |obj|
                 obj.regexp? ? obj : obj.to_s