mongoid 8.1.5 → 9.0.0

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional date behavior.
+        # Adds query type-casting behavior to Date class.
         module Date
 
           # Evolve the date into a mongo friendly time, UTC midnight.
@@ -23,9 +24,9 @@ module Mongoid
           # @example Evolve the date.
           #   date.__evolve_time__
           #
-          # @return [ Time ] The date as a local time.
+          # @return [ Time | ActiveSupport::TimeWithZone ] The date as a local time.
           def __evolve_time__
-            ::Time.local(year, month, day)
+            ::Time.zone.local(year, month, day)
           end
 
           module ClassMethods

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional datetime behavior.
+        # Adds query type-casting behavior to DateTime class.
         module DateTime
 
           # Evolve the date time into a mongo friendly UTC time.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional hash behavior.
+        # Adds query type-casting behavior to Hash class.
         module Hash
 
           # Add an object to a hash using the merge strategies.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional nil behavior.
+        # Adds query type-casting behavior to NilClass.
         module NilClass
 
           # Add this object to nil.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional numeric behavior.
+        # Adds query type-casting behavior to Numeric module and its children.
         module Numeric
 
           # Evolve the numeric value into a mongo friendly date, aka UTC time at

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional object behavior.
+        # Adds query type-casting behavior to Object class.
         module Object
 
           # Combine the two objects using the add strategy.
@@ -127,9 +128,11 @@ module Mongoid
           #   obj.regexp?
           #
           # @return [ false ] Always false.
+          # @deprecated
           def regexp?
             false
           end
+          Mongoid.deprecate(self, :regexp?)
 
           module ClassMethods
 

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional range behavior.
+        # Adds query type-casting behavior to Range class.
         module Range
 
           # Get the range as an array.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional regex behavior.
+        # Adds query type-casting behavior to Regexp class.
         module Regexp
 
           # Is the object a regexp?
@@ -14,7 +15,9 @@ module Mongoid
           #   /\A[123]/.regexp?
           #
           # @return [ true ] Always true.
+          # @deprecated
           def regexp?; true; end
+          Mongoid.deprecate(self, :regexp?)
 
           module ClassMethods
 
@@ -33,6 +36,7 @@ module Mongoid
             end
           end
 
+          # Adds query type-casting behavior to BSON::Regexp::Raw class.
           module Raw_
 
             # Is the object a regexp?
@@ -41,7 +45,9 @@ module Mongoid
             #   bson_raw_regexp.regexp?
             #
             # @return [ true ] Always true.
+            # @deprecated
             def regexp?; true; end
+            Mongoid.deprecate(self, :regexp?)
 
             module ClassMethods
 

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "set"
 
@@ -7,7 +8,7 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # This module contains additional object behavior.
+        # Adds query type-casting behavior to Set class.
         module Set
           module ClassMethods
 

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional object behavior.
+        # Adds query type-casting behavior to String class.
         module String
 
           # Evolve the string into a mongodb friendly date.
@@ -81,7 +82,7 @@ module Mongoid
             # @return [ Hash ] The selection.
             def __expr_part__(key, value, negating = false)
               if negating
-                { key => { "$#{value.regexp? ? "not" : "ne"}" => value }}
+                { key => { "$#{__regexp?(value) ? "not" : "ne"}" => value }}
               else
                 { key => value }
               end
@@ -98,9 +99,20 @@ module Mongoid
             # @return [ String ] The value as a string.
             def evolve(object)
               __evolve__(object) do |obj|
-                obj.regexp? ? obj : obj.to_s
+                __regexp?(obj) ? obj : obj.to_s
               end
             end
+
+            private
+
+            # Returns whether the object is Regexp-like.
+            #
+            # @param [ Object ] object The object to evaluate.
+            #
+            # @return [ Boolean ] Whether the object is Regexp-like.
+            def __regexp?(object)
+              object.is_a?(Regexp) || object.is_a?(BSON::Regexp::Raw)
+            end
           end
         end
       end

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional symbol behavior.
+        # Adds query type-casting behavior to Symbol class.
         module Symbol
 
           # Get the symbol as a specification.

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional time behavior.
+        # Adds query type-casting behavior to Time class.
         module Time
 
           # Evolve the time as a date, UTC midnight.

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains additional time with zone behavior.
+        # Adds query type-casting behavior to
+        # ActiveSupport::TimeWithZone class.
         module TimeWithZone
 
           # Evolve the time as a date, UTC midnight.

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 if defined?(ActiveSupport)
   unless defined?(ActiveSupport::TimeWithZone)

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -131,6 +132,15 @@ module Mongoid
           { name.to_s => transform_value(object, negating) }
         end
 
+        # Gets the raw selector condition that would be passed to Mongo.
+        #
+        # @example Gets the raw selector condition.
+        #   key.transform_value(50)
+        #
+        # @param [ Object ] value The value to be included.
+        # @param [ true | false ] negating If the selection should be negated.
+        #
+        # @return [ Hash ] The raw MongoDB selector.
         def transform_value(value, negating = false)
           if block
             expr = block[value]

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -155,7 +156,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :elem_match
           end
 
-          and_or_override(criterion, "$elemMatch")
+          and_with_operator(criterion, "$elemMatch")
         end
         key :elem_match, :override, "$elemMatch"
 
@@ -258,7 +259,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :eq
           end
 
-          and_or_override(criterion, "$eq")
+          and_with_operator(criterion, "$eq")
         end
         key :eq, :override, "$eq"
 
@@ -278,7 +279,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :gt
           end
 
-          and_or_override(criterion, "$gt")
+          and_with_operator(criterion, "$gt")
         end
         key :gt, :override, "$gt"
 
@@ -298,7 +299,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :gte
           end
 
-          and_or_override(criterion, "$gte")
+          and_with_operator(criterion, "$gte")
         end
         key :gte, :override, "$gte"
 
@@ -354,7 +355,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :lt
           end
 
-          and_or_override(criterion, "$lt")
+          and_with_operator(criterion, "$lt")
         end
         key :lt, :override, "$lt"
 
@@ -374,7 +375,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :lte
           end
 
-          and_or_override(criterion, "$lte")
+          and_with_operator(criterion, "$lte")
         end
         key :lte, :override, "$lte"
 
@@ -411,7 +412,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :mod
           end
 
-          and_or_override(criterion, "$mod")
+          and_with_operator(criterion, "$mod")
         end
         key :mod, :override, "$mod"
 
@@ -431,7 +432,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :ne
           end
 
-          and_or_override(criterion, "$ne")
+          and_with_operator(criterion, "$ne")
         end
         alias :excludes :ne
         key :ne, :override, "$ne"
@@ -452,7 +453,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :near
           end
 
-          and_or_override(criterion, "$near")
+          and_with_operator(criterion, "$near")
         end
         key :near, :override, "$near"
 
@@ -472,7 +473,7 @@ module Mongoid
             raise Errors::CriteriaArgumentRequired, :near_sphere
           end
 
-          and_or_override(criterion, "$nearSphere")
+          and_with_operator(criterion, "$nearSphere")
         end
         key :near_sphere, :override, "$nearSphere"
 
@@ -933,22 +934,6 @@ module Mongoid
           end
         end
 
-        # Combine operator expessions onto a Criteria using either
-        # an override or ands depending on the status of the
-        # Mongoid.overwrite_chained_operators feature flag.
-        #
-        # @param [ Hash ] The criterion to add to the criteria.
-        # @param [ String ] operator The MongoDB operator.
-        #
-        # @return [ Criteria ] The resulting criteria.
-        def and_or_override(criterion, operator)
-          if Mongoid.overwrite_chained_operators
-            __override__(criterion, operator)
-          else
-            and_with_operator(criterion, operator)
-          end
-        end
-
         class << self
 
           # Get the methods on the selectable that can be forwarded to from a model.

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -75,7 +76,7 @@ module Mongoid
 
         # Get the store name and store value. If the value is of type range,
         # we need may need to change the store_name as well as the store_value,
-        # therefore, we cannot just use the evole method.
+        # therefore, we cannot just use the evolve method.
         #
         # @param [ String ] name The name of the field.
         # @param [ Object ] serializer The optional serializer for the field.
@@ -151,6 +152,8 @@ module Mongoid
         # @return [ Object ] The serialized object.
         def evolve(serializer, value)
           case value
+          when Mongoid::RawValue
+            value.raw_value
           when Hash
             evolve_hash(serializer, value)
           when Array
@@ -228,7 +231,7 @@ module Mongoid
         #
         # @api private
         #
-        # @param [ String ] key The to store the range for.
+        # @param [ String ] key The key at which to store the range.
         # @param [ Object ] serializer The optional serializer for the field.
         # @param [ Range ] value The Range to serialize.
         #

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -82,7 +83,7 @@ module Mongoid
         #
         #     {'$or' => [{'hello' => 'world'}]}
         #
-        # ... and operator is '$or' and op_expr is `[{'test' => 123'}]`,
+        # ... and operator is '$or' and op_expr is +[{'test' => 123'}]+,
         # the resulting selector will be:
         #
         #     {'$or' => [{'hello' => 'world'}, {'test' => 123}]}
@@ -123,7 +124,7 @@ module Mongoid
           elsif operator == '$and' || selector.empty?
             # $and can always be added to top level and it will be combined
             # with whatever other conditions exist.
-            if !Mongoid.broken_and && current_value = selector[operator]
+            if current_value = selector[operator]
               new_value = current_value + op_expr
               selector.store(operator, new_value)
             else
@@ -158,7 +159,7 @@ module Mongoid
         #
         #     {'foo' => 'bar', '$or' => [{'hello' => 'world'}]}
         #
-        # ... and operator is '$or' and op_expr is `{'test' => 123'}`,
+        # ... and operator is '$or' and op_expr is +{'test' => 123'}+,
         # the resulting selector will be:
         #
         #     {'foo' => 'bar', '$or' => [{'hello' => 'world'}, {'test' => 123}]}

data/lib/mongoid/criteria/queryable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/criteria/queryable/expandable"
 require "mongoid/criteria/queryable/extensions"

data/lib/mongoid/criteria/scopable.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria
+
+    # Mixin module included in Mongoid::Criteria which adds
+    # functionality related to default query scopes and named
+    # scopes.
     module Scopable
 
       # Applies the default scope to the criteria.

data/lib/mongoid/criteria/translator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   class Criteria

data/lib/mongoid/criteria.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/criteria/findable"
 require "mongoid/criteria/includable"
@@ -40,6 +41,26 @@ module Mongoid
     include Clients::Sessions
     include Options
 
+    class << self
+      # Convert the given hash to a criteria. Will iterate over each keys in the
+      # hash which must correspond to method on a criteria object. The hash
+      # must also include a "klass" key.
+      #
+      # @example Convert the hash to a criteria.
+      #   Criteria.from_hash({ klass: Band, where: { name: "Depeche Mode" })
+      #
+      # @param [ Hash ] hash The hash to convert.
+      #
+      # @return [ Criteria ] The criteria.
+      def from_hash(hash)
+        criteria = Criteria.new(hash.delete(:klass) || hash.delete('klass'))
+        hash.each_pair do |method, args|
+          criteria = criteria.__send__(method, args)
+        end
+        criteria
+      end
+    end
+
     # Static array used to check with method missing - we only need to ever
     # instantiate once.
     CHECK = []
@@ -90,7 +111,8 @@ module Mongoid
     #   enumerator = criteria.find(-> { "Default Band" })
     #
     # @param [ [ Object | Array<Object> ]... ] *args The id(s).
-    # @param [ Proc ] block Optional block to pass.
+    # @param &block Optional block to pass.
+    # @yield [ Object ] Yields each enumerable element to the block.
     #
     # @return [ Document | Array<Document> | nil ] A document or matching documents.
     #
@@ -158,7 +180,7 @@ module Mongoid
     #
     # @return [ Object ] The id.
     def extract_id
-      selector.extract_id
+      selector['_id'] || selector[:_id] || selector['id'] || selector[:id]
     end
 
     # Adds a criterion to the +Criteria+ that specifies additional options
@@ -221,7 +243,7 @@ module Mongoid
     # may be desired.
     #
     # @example Merge the criteria with another criteria.
-    #   criteri.merge(other_criteria)
+    #   criteria.merge(other_criteria)
     #
     # @example Merge the criteria with a hash. The hash must contain a klass
     #   key and the key/value pairs correspond to method names/args.
@@ -246,16 +268,16 @@ module Mongoid
     # @example Merge another criteria into this criteria.
     #   criteria.merge(Person.where(name: "bob"))
     #
-    # @param [ Criteria ] other The criteria to merge in.
+    # @param [ Criteria | Hash ] other The criteria to merge in.
     #
     # @return [ Criteria ] The merged criteria.
     def merge!(other)
-      criteria = other.to_criteria
-      selector.merge!(criteria.selector)
-      options.merge!(criteria.options)
-      self.documents = criteria.documents.dup unless criteria.documents.empty?
-      self.scoping_options = criteria.scoping_options
-      self.inclusions = (inclusions + criteria.inclusions).uniq
+      other = self.class.from_hash(other) if other.is_a?(Hash)
+      selector.merge!(other.selector)
+      options.merge!(other.options)
+      self.documents = other.documents.dup unless other.documents.empty?
+      self.scoping_options = other.scoping_options
+      self.inclusions = (inclusions + other.inclusions).uniq
       self
     end
 
@@ -348,9 +370,11 @@ module Mongoid
     #   criteria.to_criteria
     #
     # @return [ Criteria ] self.
+    # @deprecated
     def to_criteria
       self
     end
+    Mongoid.deprecate(self, :to_criteria)
 
     # Convert the criteria to a proc.
     #
@@ -437,6 +461,8 @@ module Mongoid
     # @param [ Hash ] scope The scope for the code.
     #
     # @return [ Criteria ] The criteria.
+    #
+    # @deprecated
     def for_js(javascript, scope = {})
       code = if scope.empty?
         # CodeWithScope is not supported for $where as of MongoDB 4.4
@@ -446,6 +472,7 @@ module Mongoid
       end
       js_query(code)
     end
+    Mongoid.deprecate(self, :for_js)
 
     private
 

data/lib/mongoid/deprecable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/deprecation"