mongoid 7.1.1 → 8.1.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -15,27 +14,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 symbol as a sort direction.
-          #
-          # @example Get the symbol as a sort direction.
-          #   "1".to_direction
-          #
-          # @return [ Integer ] The direction.
-          #
-          # @since 1.0.0
-          def to_direction
-            to_s.to_direction
-          end
-
           module ClassMethods
 
             # Adds a method on symbol as a convenience for the MongoDB operator.
@@ -47,8 +32,6 @@ module Mongoid
             # @param [ Symbol ] strategy The name of the merge strategy.
             # @param [ String ] operator The MongoDB operator.
             # @param [ String ] additional The additional MongoDB operator.
-            #
-            # @since 1.0.0
             def add_key(name, strategy, operator, additional = nil, &block)
               define_method(name) do
                 method = "__#{strategy}__".to_sym
@@ -65,10 +48,10 @@ module Mongoid
             # @param [ Object ] object The object to convert.
             #
             # @return [ Symbol ] The value as a symbol.
-            #
-            # @since 1.0.0
             def evolve(object)
-              __evolve__(object) { |obj| obj.to_sym }
+              __evolve__(object) do |obj|
+                obj.try(:to_sym)
+              end
             end
           end
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -15,8 +14,6 @@ module Mongoid
           #   time.__evolve_date__
           #
           # @return [ Time ] The date at midnight UTC.
-          #
-          # @since 1.0.0
           def __evolve_date__
             ::Time.utc(year, month, day, 0, 0, 0, 0)
           end
@@ -27,8 +24,6 @@ module Mongoid
           #   time.__evolve_time__
           #
           # @return [ Time ] The time in UTC.
-          #
-          # @since 1.0.0
           def __evolve_time__
             getutc
           end
@@ -46,10 +41,13 @@ 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__
+              res = begin
+                object.try(:__evolve_time__)
+              rescue ArgumentError
+                nil
+              end
+              res.nil? ? object : res
             end
           end
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -9,14 +8,22 @@ module Mongoid
         # This module contains additional time with zone behavior.
         module TimeWithZone
 
+          # Evolve the time as a date, UTC midnight.
+          #
+          # @example Evolve the time to a date query format.
+          #   time.__evolve_date__
+          #
+          # @return [ Time ] The date at midnight UTC.
+          def __evolve_date__
+            ::Time.utc(year, month, day, 0, 0, 0, 0)
+          end
+
           # Evolve the time into a utc time.
           #
           # @example Evolve the time.
           #   time.__evolve_time__
           #
           # @return [ Time ] The time in UTC.
-          #
-          # @since 1.0.0
           def __evolve_time__
             utc
           end
@@ -34,10 +41,13 @@ 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__
+              res = begin
+                object.try(:__evolve_time__)
+              rescue ArgumentError
+                nil
+              end
+              res.nil? ? object : res
             end
           end
         end

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

@@ -1,9 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
-
-unless defined?(Boolean)
-  class Boolean; end
-end
 
 if defined?(ActiveSupport)
   unless defined?(ActiveSupport::TimeWithZone)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -22,7 +21,7 @@ module Mongoid
       #
       #   Foo.where(:price.gt => 1)
       #
-      # ... causes a Key instance to be created thusly:
+      # ... causes a Key instance to be created as follows:
       #
       #   Key.new(:price, :__override__, '$gt')
       #
@@ -33,7 +32,7 @@ module Mongoid
       #
       # A yet more more complex example is the following condition:
       #
-      #   Foo.geo_spacial(:boundary.intersects_point => [1, 10])
+      #   Foo.geo_spatial(:boundary.intersects_point => [1, 10])
       #
       # Processing this condition will cause a Key instance to be created as
       # follows:
@@ -83,9 +82,7 @@ module Mongoid
         #
         # @param [ Object ] other The object to compare to.
         #
-        # @return [ true, false ] If the objects are equal.
-        #
-        # @since 1.0.0
+        # @return [ true | false ] If the objects are equal.
         def ==(other)
           return false unless other.is_a?(Key)
           name == other.name && operator == other.operator && expanded == other.expanded
@@ -94,9 +91,7 @@ module Mongoid
 
         # Calculate the hash code for a key.
         #
-        # @return [ Fixnum ] The hash code for the key.
-        #
-        # @since 1.1.0
+        # @return [ Integer ] The hash code for the key.
         def hash
           [name, operator, expanded].hash
         end
@@ -109,13 +104,11 @@ module Mongoid
         # @example Instantiate a key for sorting.
         #   Key.new(:field, :__override__, 1)
         #
-        # @param [ String, Symbol ] name The field name.
+        # @param [ String | Symbol ] name The field name.
         # @param [ Symbol ] strategy The name of the merge strategy.
         # @param [ String | Integer ] operator The MongoDB operator,
         #   or sort direction (1 or -1).
         # @param [ String ] expanded The Mongo expanded operator.
-        #
-        # @since 1.0.0
         def initialize(name, strategy, operator, expanded = nil, &block)
           unless operator.is_a?(String) || operator.is_a?(Integer)
             raise ArgumentError, "Operator must be a string or an integer: #{operator.inspect}"
@@ -131,11 +124,9 @@ module Mongoid
         #   key.__expr_part__(50)
         #
         # @param [ Object ] object The value to be included.
-        # @param [ true, false ] negating If the selection should be negated.
+        # @param [ true | false ] negating If the selection should be negated.
         #
         # @return [ Hash ] The raw MongoDB selector.
-        #
-        # @since 1.0.0
         def __expr_part__(object, negating = false)
           { name.to_s => transform_value(object, negating) }
         end
@@ -166,8 +157,6 @@ module Mongoid
         #   key.__sort_option__
         #
         # @return [ Hash ] The field/direction pair.
-        #
-        # @since 1.0.0
         def __sort_option__
           { name => operator }
         end
@@ -179,8 +168,6 @@ module Mongoid
         #   key.to_s
         #
         # @return [ String ] The key as a string.
-        #
-        # @since 1.1.0
         def to_s
           @name.to_s
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -18,8 +17,6 @@ module Mongoid
         # @param [ Symbol ] strategy The merge strategy.
         # @param [ String ] operator The MongoDB operator.
         # @param [ String ] additional The additional MongoDB operator.
-        #
-        # @since 1.0.0
         def key(name, strategy, operator, additional = nil, &block)
           ::Symbol.add_key(name, strategy, operator, additional, &block)
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,8 +16,6 @@ module Mongoid
         #   mergeable.intersect.in(field: [ 1, 2, 3 ])
         #
         # @return [ Mergeable ] The intersect flagged mergeable.
-        #
-        # @since 1.0.0
         def intersect
           use(:__intersect__)
         end
@@ -29,8 +26,6 @@ module Mongoid
         #   mergeable.override.in(field: [ 1, 2, 3 ])
         #
         # @return [ Mergeable ] The override flagged mergeable.
-        #
-        # @since 1.0.0
         def override
           use(:__override__)
         end
@@ -41,8 +36,6 @@ module Mongoid
         #   mergeable.union.in(field: [ 1, 2, 3 ])
         #
         # @return [ Mergeable ] The union flagged mergeable.
-        #
-        # @since 1.0.0
         def union
           use(:__union__)
         end
@@ -53,14 +46,33 @@ module Mongoid
         #   mergeable.reset_strategies!
         #
         # @return [ Criteria ] self.
-        #
-        # @since 1.0.0
         def reset_strategies!
           self.strategy = nil
           self.negating = nil
           self
         end
 
+        # Merge criteria with operators using the and operator.
+        #
+        # @param [ Hash ] criterion The criterion to add to the criteria.
+        # @param [ String ] operator The MongoDB operator.
+        #
+        # @return [ Criteria ] The resulting criteria.
+        def and_with_operator(criterion, operator)
+          crit = self
+          if criterion
+            criterion.each_pair do |field, value|
+              val = prepare(field, operator, value)
+              # The prepare method already takes the negation into account. We
+              # set negating to false here so that ``and`` doesn't also apply
+              # negation and we have a double negative.
+              crit.negating = false
+              crit = crit.and(field => val)
+            end
+          end
+          crit
+        end
+
         private
 
         # Adds the criterion to the existing selection.
@@ -74,8 +86,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __add__(criterion, operator)
           with_strategy(:__add__, criterion, operator)
         end
@@ -92,8 +102,6 @@ module Mongoid
         # @param [ String ] inner The inner MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __expanded__(criterion, outer, inner)
           selection(criterion) do |selector, field, value|
             selector.store(field, { outer => { inner => value }})
@@ -111,8 +119,6 @@ module Mongoid
         # @param [ Hash ] criterion The criteria.
         #
         # @return [ Mergeable ] The cloned object.
-        #
-        # @since 2.0.0
         def __merge__(criterion)
           selection(criterion) do |selector, field, value|
             selector.merge!(field.__expr_part__(value))
@@ -130,8 +136,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __intersect__(criterion, operator)
           with_strategy(:__intersect__, criterion, operator)
         end
@@ -152,8 +156,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __multi__(criteria, operator)
           clone.tap do |query|
             sel = query.selector
@@ -163,7 +165,7 @@ module Mongoid
               if expr.is_a?(Selectable)
                 expr = expr.selector
               end
-              normalized = _mongoid_normalize_expr(expr)
+              normalized = _mongoid_expand_keys(expr)
               sel.store(operator, result_criteria.push(normalized))
             end
           end
@@ -171,7 +173,7 @@ module Mongoid
 
         # Combines criteria into a MongoDB selector.
         #
-        # Criteria is an array of criterions which will be flattened.
+        # Criteria is an array of criterion objects which will be flattened.
         #
         # Each criterion can be:
         # - A hash
@@ -190,9 +192,9 @@ module Mongoid
             sel = query.selector
             _mongoid_flatten_arrays(criteria).each do |criterion|
               if criterion.is_a?(Selectable)
-                expr = _mongoid_normalize_expr(criterion.selector)
+                expr = _mongoid_expand_keys(criterion.selector)
               else
-                expr = criterion
+                expr = _mongoid_expand_keys(criterion)
               end
               if sel.empty?
                 sel.store(operator, [expr])
@@ -212,7 +214,7 @@ module Mongoid
         # explicitly only expands Array objects and Array subclasses.
         private def _mongoid_flatten_arrays(array)
           out = []
-          pending = array
+          pending = array.dup
           until pending.empty?
             item = pending.shift
             if item.nil?
@@ -226,11 +228,104 @@ module Mongoid
           out
         end
 
-        # @api private
-        private def _mongoid_normalize_expr(expr)
-          expr.inject({}) do |hash, (field, value)|
-            hash.merge!(field.__expr_part__(value.__expand_complex__))
+        # Takes a criteria hash and expands Key objects into hashes containing
+        # MQL corresponding to said key objects. Also converts the input to
+        # BSON::Document to permit indifferent access.
+        #
+        # The argument must be a hash containing key-value pairs of the
+        # following forms:
+        # - {field_name: value}
+        # - {'field_name' => value}
+        # - {key_instance: value}
+        # - {:$operator => operator_value_expression}
+        # - {'$operator' => operator_value_expression}
+        #
+        # Ruby does not permit multiple symbol operators. For example,
+        # {:foo.gt => 1, :foo.gt => 2} is collapsed to {:foo.gt => 2} by the
+        # language. Therefore this method never has to deal with multiple
+        # identical operators.
+        #
+        # Similarly, this method should never need to expand a literal value
+        # and an operator at the same time.
+        #
+        # This method effectively converts symbol keys to string keys in
+        # the input +expr+, such that the downstream code can assume that
+        # conditions always contain string keys.
+        #
+        # @param [ Hash ] expr Criteria including Key instances.
+        #
+        # @return [ BSON::Document ] The expanded criteria.
+        private def _mongoid_expand_keys(expr)
+          unless expr.is_a?(Hash)
+            raise ArgumentError, 'Argument must be a Hash'
           end
+
+          result = BSON::Document.new
+          expr.each do |field, value|
+            field.__expr_part__(value.__expand_complex__, negating?).each do |k, v|
+              if existing = result[k]
+                if existing.is_a?(Hash)
+                  # Existing value is an operator.
+                  # If new value is also an operator, ensure there are no
+                  # conflicts and add
+                  if v.is_a?(Hash)
+                    # The new value is also an operator.
+                    # If there are no conflicts, combine the hashes, otherwise
+                    # add new conditions to top level with $and.
+                    if (v.keys & existing.keys).empty?
+                      existing.update(v)
+                    else
+                      raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
+                      result['$and'] ||= []
+                      result['$and'] << {k => v}
+                    end
+                  else
+                    # The new value is a simple value.
+                    # Transform the implicit equality to either $eq or $regexp
+                    # depending on the type of the argument. See
+                    # https://www.mongodb.com/docs/manual/reference/operator/query/eq/#std-label-eq-usage-examples
+                    # for the description of relevant server behavior.
+                    op = case v
+                    when Regexp, BSON::Regexp::Raw
+                      '$regex'
+                    else
+                      '$eq'
+                    end
+                    # If there isn't an $eq/$regex operator already in the
+                    # query, transform the new value into an operator
+                    # expression and add it to the existing hash. Otherwise
+                    # add the new condition with $and to the top level.
+                    if existing.key?(op)
+                      raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
+                      result['$and'] ||= []
+                      result['$and'] << {k => v}
+                    else
+                      existing.update(op => v)
+                    end
+                  end
+                else
+                  # Existing value is a simple value.
+                  # See the notes above about transformations to $eq/$regex.
+                  op = case existing
+                  when Regexp, BSON::Regexp::Raw
+                    '$regex'
+                  else
+                    '$eq'
+                  end
+                  if v.is_a?(Hash) && !v.key?(op)
+                    result[k] = {op => existing}.update(v)
+                  else
+                    raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
+                    result['$and'] ||= []
+                    result['$and'] << {k => v}
+                  end
+                end
+              else
+                result[k] = v
+              end
+            end
+          end
+          result
         end
 
         # Adds the criterion to the existing selection.
@@ -244,8 +339,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __override__(criterion, operator)
           if criterion.is_a?(Selectable)
             criterion = criterion.selector
@@ -272,8 +365,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __union__(criterion, operator)
           with_strategy(:__union__, criterion, operator)
         end
@@ -288,8 +379,6 @@ module Mongoid
         # @param [ Symbol ] strategy The strategy to use.
         #
         # @return [ Mergeable ] The existing mergeable.
-        #
-        # @since 1.0.0
         def use(strategy)
           tap do |mergeable|
             mergeable.strategy = strategy
@@ -308,8 +397,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The cloned query.
-        #
-        # @since 1.0.0
         def with_strategy(strategy, criterion, operator)
           selection(criterion) do |selector, field, value|
             selector.store(
@@ -330,8 +417,6 @@ module Mongoid
         # @param [ Object ] value The value.
         #
         # @return [ Object ] The serialized value.
-        #
-        # @since 1.0.0
         def prepare(field, operator, value)
           unless operator =~ /exists|type|size/
             value = value.__expand_complex__