mongoid 9.0.11 → 9.1.1

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

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # Contains behavior for merging existing selection with new selection.
       module Mergeable
-
         # @attribute [rw] strategy The name of the current strategy.
         attr_accessor :strategy
 
@@ -105,7 +102,7 @@ module Mongoid
         # @return [ Mergeable ] The new mergeable.
         def __expanded__(criterion, outer, inner)
           selection(criterion) do |selector, field, value|
-            selector.store(field, { outer => { inner => value }})
+            selector.store(field, { outer => { inner => value } })
           end
         end
 
@@ -162,10 +159,9 @@ module Mongoid
             sel = query.selector
             criteria.flatten.each do |expr|
               next unless expr
+
               result_criteria = sel[operator] || []
-              if expr.is_a?(Selectable)
-                expr = expr.selector
-              end
+              expr = expr.selector if expr.is_a?(Selectable)
               normalized = _mongoid_expand_keys(expr)
               sel.store(operator, result_criteria.push(normalized))
             end
@@ -192,17 +188,17 @@ module Mongoid
           clone.tap do |query|
             sel = query.selector
             _mongoid_flatten_arrays(criteria).each do |criterion|
-              if criterion.is_a?(Selectable)
-                expr = _mongoid_expand_keys(criterion.selector)
-              else
-                expr = _mongoid_expand_keys(criterion)
-              end
+              expr = if criterion.is_a?(Selectable)
+                       _mongoid_expand_keys(criterion.selector)
+                     else
+                       _mongoid_expand_keys(criterion)
+                     end
               if sel.empty?
-                sel.store(operator, [expr])
-              elsif sel.keys == [operator]
-                sel.store(operator, sel[operator] + [expr])
+                sel.store(operator, [ expr ])
+              elsif sel.keys == [ operator ]
+                sel.store(operator, sel[operator] + [ expr ])
               else
-                operands = [sel.dup] + [expr]
+                operands = [ sel.dup ] + [ expr ]
                 sel.clear
                 sel.store(operator, operands)
               end
@@ -257,9 +253,7 @@ module Mongoid
         #
         # @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
+          raise ArgumentError, 'Argument must be a Hash' unless expr.is_a?(Hash)
 
           result = BSON::Document.new
           expr.each do |field, value|
@@ -278,7 +272,7 @@ module Mongoid
                     else
                       raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
                       result['$and'] ||= []
-                      result['$and'] << {k => v}
+                      result['$and'] << { k => v }
                     end
                   else
                     # The new value is a simple value.
@@ -287,11 +281,11 @@ module Mongoid
                     # 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
+                         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
@@ -299,7 +293,7 @@ module Mongoid
                     if existing.key?(op)
                       raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
                       result['$and'] ||= []
-                      result['$and'] << {k => v}
+                      result['$and'] << { k => v }
                     else
                       existing.update(op => v)
                     end
@@ -308,17 +302,17 @@ module Mongoid
                   # 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
+                       when Regexp, BSON::Regexp::Raw
+                         '$regex'
+                       else
+                         '$eq'
+                       end
                   if v.is_a?(Hash) && !v.key?(op)
-                    result[k] = {op => existing}.update(v)
+                    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}
+                    result['$and'] << { k => v }
                   end
                 end
               else
@@ -326,6 +320,10 @@ module Mongoid
               end
             end
           end
+          # Every query method that takes a user-supplied expression normalizes
+          # it here, so this is where the operator guard is enforced. See
+          # Selectable#_mongoid_validate_operators! for what it does not cover.
+          _mongoid_validate_operators!(result)
           result
         end
 
@@ -341,9 +339,7 @@ module Mongoid
         #
         # @return [ Mergeable ] The new mergeable.
         def __override__(criterion, operator)
-          if criterion.is_a?(Selectable)
-            criterion = criterion.selector
-          end
+          criterion = criterion.selector if criterion.is_a?(Selectable)
           selection(criterion) do |selector, field, value|
             expression = prepare(field, operator, value)
             existing = selector[field]
@@ -419,15 +415,15 @@ module Mongoid
         #
         # @return [ Object ] The serialized value.
         def prepare(field, operator, value)
-          unless operator =~ /exists|type|size/
+          unless /exists|type|size/.match?(operator)
             value = value.__expand_complex__
             field = field.to_s
             name = aliases[field] || field
             serializer = serializers[name]
-            value = serializer ? serializer.evolve(value) : value
+            value = serializer.evolve(value) if serializer
           end
           selection = { operator => value }
-          negating? ? { "$not" => selection } : selection
+          negating? ? { '$not' => selection } : selection
         end
       end
     end

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

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # The optional module includes all behavior that has to do with extra
       # options surrounding queries, like skip, limit, sorting, etc.
       module Optional
@@ -24,7 +22,7 @@ module Mongoid
         def ascending(*fields)
           sort_with_list(*fields, 1)
         end
-        alias :asc :ascending
+        alias asc ascending
         key :asc, :override, 1
         key :ascending, :override, 1
 
@@ -52,7 +50,7 @@ module Mongoid
         def descending(*fields)
           sort_with_list(*fields, -1)
         end
-        alias :desc :descending
+        alias desc descending
         key :desc, :override, -1
         key :descending, :override, -1
 
@@ -80,7 +78,7 @@ module Mongoid
           option(value) do |options, query|
             val = value.to_i
             options.store(:limit, val)
-            query.pipeline.push("$limit" => val) if aggregating?
+            query.pipeline.push('$limit' => val) if aggregating?
           end
         end
 
@@ -93,9 +91,13 @@ module Mongoid
         # @param [ Integer ] value The max number of documents to scan.
         #
         # @return [ Optional ] The cloned optional.
+        #
+        # @deprecated The max_scan option is deprecated in MongoDB 4.0 and later.
+        #   Use max_time_ms instead.
         def max_scan(value = nil)
           option(value) { |options| options.store(:max_scan, value) }
         end
+        Mongoid.deprecate(self, :max_scan)
 
         # Adds a cumulative time limit in milliseconds for processing operations on a cursor.
         #
@@ -132,7 +134,7 @@ module Mongoid
           option(*args) do |options|
             options.store(
               :fields,
-              args.inject(options[:fields] || {}){ |sub, field| sub.tap { sub[field] = 1 }},
+              args.inject(options[:fields] || {}) { |sub, field| sub.tap { sub[field] = 1 } },
               false
             )
           end
@@ -173,11 +175,11 @@ module Mongoid
               criterion.__sort_option__.each_pair do |field, direction|
                 add_sort_option(options, field, direction)
               end
-              query.pipeline.push("$sort" => options[:sort]) if aggregating?
+              query.pipeline.push('$sort' => options[:sort]) if aggregating?
             end
           end
         end
-        alias :order :order_by
+        alias order order_by
 
         # Instead of merging the order criteria, use this method to completely
         # replace the existing ordering with the provided.
@@ -206,10 +208,10 @@ module Mongoid
           option(value) do |options, query|
             val = value.to_i
             options.store(:skip, val)
-            query.pipeline.push("$skip" => val) if aggregating?
+            query.pipeline.push('$skip' => val) if aggregating?
           end
         end
-        alias :offset :skip
+        alias offset skip
 
         # Limit the returned results via slicing embedded arrays.
         #
@@ -223,7 +225,7 @@ module Mongoid
           option(criterion) do |options|
             options.__union__(
               fields: criterion.inject({}) do |option, (field, val)|
-                option.tap { |opt| opt.store(field, { "$slice" => val }) }
+                option.tap { |opt| opt.store(field, { '$slice' => val }) }
               end
             )
           end
@@ -254,7 +256,7 @@ module Mongoid
           option(*args) do |options|
             options.store(
               :fields,
-              args.inject(options[:fields] || {}){ |sub, field| sub.tap { sub[field] = 0 }},
+              args.inject(options[:fields] || {}) { |sub, field| sub.tap { sub[field] = 0 } },
               false
             )
           end
@@ -337,9 +339,7 @@ module Mongoid
         # @return [ Queryable ] The cloned queryable.
         def option(*args)
           clone.tap do |query|
-            unless args.compact.empty?
-              yield(query.options, query)
-            end
+            yield(query.options, query) unless args.compact.empty?
           end
         end
 
@@ -359,12 +359,11 @@ module Mongoid
             fields.flatten.compact.each do |field|
               add_sort_option(options, field, direction)
             end
-            query.pipeline.push("$sort" => options[:sort]) if aggregating?
+            query.pipeline.push('$sort' => options[:sort]) if aggregating?
           end
         end
 
         class << self
-
           # Get the methods on the optional that can be forwarded to from a model.
           #
           # @example Get the forwardable methods.
@@ -372,7 +371,7 @@ module Mongoid
           #
           # @return [ Array<Symbol> ] The names of the forwardable methods.
           def forwardables
-            public_instance_methods(false) - [ :options, :options= ]
+            public_instance_methods(false) - %i[options options=]
           end
         end
       end

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

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # The options is a hash representation of options passed to MongoDB queries,
       # such as skip, limit, and sorting criteria.
       class Options < Smash
-
         # Convenience method for getting the field options.
         #
         # @example Get the fields options.
@@ -62,7 +59,7 @@ module Mongoid
         def store(key, value, localize = true)
           super(key, evolve(value, localize))
         end
-        alias :[]= :store
+        alias []= store
 
         # Convert the options to aggregation pipeline friendly options.
         #
@@ -72,9 +69,24 @@ module Mongoid
         # @return [ Array<Hash> ] The options in pipeline form.
         def to_pipeline
           pipeline = []
-          pipeline.push({ "$skip" => skip }) if skip
-          pipeline.push({ "$limit" => limit }) if limit
-          pipeline.push({ "$sort" => sort }) if sort
+          pipeline.push({ '$skip' => skip }) if skip
+          pipeline.push({ '$limit' => limit }) if limit
+          pipeline.push({ '$sort' => sort }) if sort
+          pipeline
+        end
+
+        # Convert the options to aggregation pipeline friendly options.
+        # This version places sort last to comply with $lookup requirements.
+        #
+        # @example Convert the options to a pipeline.
+        #   options.to_pipeline_for_lookup
+        #
+        # @return [ Array<Hash> ] The options in pipeline form.
+        def to_pipeline_for_lookup
+          pipeline = []
+          pipeline.push({ '$sort' => sort }) if sort
+          pipeline.push({ '$skip' => skip }) if skip
+          pipeline.push({ '$limit' => limit }) if limit
           pipeline
         end
 
@@ -124,11 +136,10 @@ module Mongoid
         #
         # @return [ Object ] The serialized hash.
         def evolve_hash(value, localize = true)
-          value.inject({}) do |hash, (field, _value)|
+          value.each_with_object({}) do |(field, _value), hash|
             name, serializer = storage_pair(field)
             name = localized_key(name, serializer) if localize
             hash[name] = _value
-            hash
           end
         end
       end

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

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # Represents an aggregation pipeline.
       class Pipeline < Array
-
         # @attribute [r] aliases The field aliases.
         attr_reader :aliases
 
@@ -35,7 +32,7 @@ module Mongoid
         #
         # @return [ Pipeline ] The pipeline.
         def group(entry)
-          push("$group" => evolve(entry.__expand_complex__))
+          push('$group' => evolve(entry.__expand_complex__))
         end
 
         # Initialize the new pipeline.
@@ -59,7 +56,7 @@ module Mongoid
         #
         # @return [ Pipeline ] The pipeline.
         def project(entry)
-          push("$project" => evolve(entry))
+          push('$project' => evolve(entry))
         end
 
         # Add the $unwind entry to the pipeline.
@@ -73,12 +70,12 @@ module Mongoid
         #
         # @return [ Pipeline ] The pipeline.
         def unwind(field_or_doc)
-          unless field_or_doc.respond_to? :keys
+          if field_or_doc.respond_to? :keys
+            push('$unwind' => field_or_doc)
+          else
             normalized = field_or_doc.to_s
             name = aliases[normalized] || normalized
-            push("$unwind" => name.__mongo_expression__)
-          else
-            push("$unwind" => field_or_doc)
+            push('$unwind' => name.__mongo_expression__)
           end
         end