mongoid 7.0.2 → 8.1.1

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "set"
 
 module Mongoid
@@ -6,7 +7,7 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # This module contains additional object behaviour.
+        # This module contains additional object behavior.
         module Set
           module ClassMethods
 
@@ -15,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,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional object behaviour.
+        # This module contains additional object behavior.
         module String
 
           # Evolve the string into a mongodb friendly date.
@@ -13,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)
@@ -26,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
@@ -38,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
@@ -50,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
@@ -67,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.
@@ -95,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 }}
@@ -119,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

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional symbol behaviour.
+        # This module contains additional symbol behavior.
         module Symbol
 
           # Get the symbol as a specification.
@@ -13,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.
@@ -45,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
@@ -63,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,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional time behaviour.
+        # This module contains additional time behavior.
         module Time
 
           # Evolve the time as a date, UTC midnight.
@@ -13,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
@@ -25,10 +24,8 @@ module Mongoid
           #   time.__evolve_time__
           #
           # @return [ Time ] The time in UTC.
-          #
-          # @since 1.0.0
           def __evolve_time__
-            utc
+            getutc
           end
 
           module ClassMethods
@@ -44,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,20 +1,29 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional time with zone behaviour.
+        # 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
@@ -32,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,7 +1,4 @@
-# encoding: utf-8
-unless defined?(Boolean)
-  class Boolean; end
-end
+# frozen_string_literal: true
 
 if defined?(ActiveSupport)
   unless defined?(ActiveSupport::TimeWithZone)

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

@@ -1,18 +1,78 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
 
-      # The key is a representation of a field in a queryable, that can be
-      # expanded to special MongoDB selectors.
+      # Key objects represent specifications for building query expressions
+      # utilizing MongoDB selectors.
+      #
+      # Simple key-value conditions are translated directly into expression
+      # hashes by Mongoid without utilizing Key objects. For example, the
+      # following condition:
+      #
+      #   Foo.where(price: 1)
+      #
+      # ... is translated to the following simple expression:
+      #
+      #   {price: 1}
+      #
+      # More complex conditions would start involving Key objects. For example:
+      #
+      #   Foo.where(:price.gt => 1)
+      #
+      # ... causes a Key instance to be created as follows:
+      #
+      #   Key.new(:price, :__override__, '$gt')
+      #
+      # This Key instance utilizes +operator+ but not +expanded+ nor +block+.
+      # The corresponding MongoDB query expression is:
+      #
+      #    {price: {'$gt' => 1}}
+      #
+      # A yet more more complex example is the following condition:
+      #
+      #   Foo.geo_spatial(:boundary.intersects_point => [1, 10])
+      #
+      # Processing this condition will cause a Key instance to be created as
+      # follows:
+      #
+      #   Key.new(:location, :__override__, '$geoIntersects', '$geometry') do |value|
+      #     { "type" => POINT, "coordinates" => value }
+      #   end
+      #
+      # ... eventually producing the following MongoDB query expression:
+      #
+      # {
+      #   boundary: {
+      #     '$geoIntersects' => {
+      #       '$geometry' => {
+      #         type: "Point" ,
+      #         coordinates: [ 1, 10 ]
+      #       }
+      #     }
+      #   }
+      # }
+      #
+      # Key instances can be thought of as procs that map a value to the
+      # MongoDB query expression required to obtain the key's condition,
+      # given the value.
       class Key
 
-        # @attribute [r] name The name of the field.
-        # @attribute [r] block The optional block to transform values.
-        # @attribute [r] operator The MongoDB query operator.
-        # @attribute [r] expanded The MongoDB expanded query operator.
-        # @attribute [r] strategy The name of the merge strategy.
-        attr_reader :block, :name, :operator, :expanded, :strategy
+        # @return [ String | Symbol ] The name of the field.
+        attr_reader :name
+
+        # @return [ String ] The MongoDB query operator.
+        attr_reader :operator
+
+        # @return [ String ] The MongoDB expanded query operator.
+        attr_reader :expanded
+
+        # @return [ Symbol ] The name of the merge strategy.
+        attr_reader :strategy
+
+        # @return [ Proc ] The optional block to transform values.
+        attr_reader :block
 
         # Does the key equal another object?
         #
@@ -22,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
@@ -33,25 +91,29 @@ 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
 
         # Instantiate the new key.
         #
-        # @example Instantiate the key.
-        #   Key.new("age", "$gt")
+        # @example Instantiate a key.
+        #   Key.new("age", :__override__, "$gt")
+        #
+        # @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 ] operator The Mongo operator.
+        # @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}"
+          end
+
           @name, @strategy, @operator, @expanded, @block =
             name, strategy, operator, expanded, block
         end
@@ -62,15 +124,31 @@ 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)
-          value = block ? block[object] : object
-          expression = { operator => expanded ? { expanded => value } : value }
-          { name.to_s => (negating && operator != "$not") ? { "$not" => expression } : expression }
+          { name.to_s => transform_value(object, negating) }
+        end
+
+        def transform_value(value, negating = false)
+          if block
+            expr = block[value]
+          else
+            expr = value
+          end
+
+          if expanded
+            expr = {expanded => expr}
+          end
+
+          expr = {operator => expr}
+
+          if negating && operator != '$not'
+            expr = {'$not' => expr}
+          end
+
+          expr
         end
 
         # Get the key as raw Mongo sorting options.
@@ -79,8 +157,6 @@ module Mongoid
         #   key.__sort_option__
         #
         # @return [ Hash ] The field/direction pair.
-        #
-        # @since 1.0.0
         def __sort_option__
           { name => operator }
         end
@@ -92,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,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
 
-      # Adds macro behaviour for adding symbol methods.
+      # Adds macro behavior for adding symbol methods.
       module Macroable
 
         # Adds a method on Symbol for convenience in where queries for the
@@ -16,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