mongoid 7.0.13 → 7.1.0.rc0

data/lib/mongoid/criteria/permission.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   class Criteria
     module Permission

data/lib/mongoid/criteria/queryable.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
+require "mongoid/criteria/queryable/expandable"
 require "mongoid/criteria/queryable/extensions"
-require "mongoid/criteria/queryable/forwardable"
 require "mongoid/criteria/queryable/key"
 require "mongoid/criteria/queryable/macroable"
 require "mongoid/criteria/queryable/mergeable"
@@ -11,6 +13,7 @@ require "mongoid/criteria/queryable/optional"
 require "mongoid/criteria/queryable/options"
 require "mongoid/criteria/queryable/selectable"
 require "mongoid/criteria/queryable/selector"
+require "mongoid/criteria/queryable/storable"
 
 module Mongoid
   class Criteria
@@ -23,6 +26,8 @@ module Mongoid
     #     include Queryable
     #   end
     module Queryable
+      include Storable
+      include Expandable
       include Mergeable
       include Aggregable
       include Selectable
@@ -50,7 +55,7 @@ module Mongoid
       end
 
       # Initialize the new queryable. Will yield itself to the block if a block
-      # is provided for objects that need additional behaviour.
+      # is provided for objects that need additional behavior.
       #
       # @example Initialize the queryable.
       #   Queryable.new

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   class Criteria
     module Queryable

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+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.
+        #
+        # The condition must be a hash in one of the following forms:
+        # - {field_name: value}
+        # - {'field_name' => value}
+        # - {key_instance: value}
+        # - {'$operator' => operator_value_expression}
+        #
+        # This method expands the key instance form to the the operator form,
+        # and also converts hash key to string.
+        #
+        # The hash may contain multiple items, each representing a separate
+        # condition.
+        #
+        # @param [ Hash ] condition The condition to expand.
+        #
+        # @return [ Hash ] The expanded condition.
+        def expand_condition(condition)
+          mapped = condition.map do |field, value|
+            expand_one_condition(field, value)
+          end
+          Hash[mapped]
+        end
+
+        # 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.rb

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

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "bigdecimal"
 
 module Mongoid
@@ -6,7 +8,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

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   class Criteria
     module Queryable

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.
@@ -17,11 +19,8 @@ module Mongoid
           # @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

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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
@@ -58,7 +60,7 @@ module Mongoid
             #
             # @since 1.0.0
             def __numeric__(object)
-              object.to_s =~ /(\A[-+]?[0-9]+\z)|(\.0+\z)|(\.\z)/ ? object.to_i : Float(object)
+              object.to_s =~ /(^[-+]?[0-9]+$)|(\.0+$)|(\.$)/ ? object.to_i : Float(object)
             end
 
             # Evolve the object to an integer.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional object behaviour.
+        # This module contains additional object behavior.
         module Object
 
           # Combine the two objects using the add strategy.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional range behaviour.
+        # This module contains additional range behavior.
         module Range
 
           # Get the range as an array.

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

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional regex behaviour.
+        # This module contains additional regex behavior.
         module Regexp
 
           # Is the object a regexp?
           #
           # @example Is the object a regex?
-          #   /\A[123]/.regexp?
+          #   /^[123]/.regexp?
           #
           # @return [ true ] Always true.
           #
@@ -22,7 +24,7 @@ module Mongoid
             # Evolve the object into a regex.
             #
             # @example Evolve the object to a regex.
-            #   Regexp.evolve("\A[123]")
+            #   Regexp.evolve("^[123]")
             #
             # @param [ Regexp, String ] object The object to evolve.
             #
@@ -53,7 +55,7 @@ module Mongoid
               # Evolve the object into a raw bson regex.
               #
               # @example Evolve the object to a regex.
-              #   BSON::Regexp::Raw.evolve("\\A[123]")
+              #   BSON::Regexp::Raw.evolve("^[123]")
               #
               # @param [ BSON::Regexp::Raw, String ] object The object to evolve.
               #
@@ -76,4 +78,4 @@ 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__(:extend, Mongoid::Criteria::Queryable::Extensions::Regexp::Raw::ClassMethods)

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "set"
 
 module Mongoid
@@ -6,7 +8,7 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # This module contains additional object behaviour.
+        # This module contains additional object behavior.
         module Set
           module ClassMethods
 

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.

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

@@ -1,24 +1,14 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.
-          #
-          # @since 1.0.0
-          def __evolve_date__
-            ::Time.utc(year, month, day, 0, 0, 0, 0)
-          end
-
           # Evolve the time into a utc time.
           #
           # @example Evolve the time.