mongoid 9.0.11 → 9.1.0

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

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # An queryable selectable is selectable, in that it has the ability to select
       # document from the database. The selectable module brings all functionality
       # to the selectable that has to do with building MongoDB selectors.
@@ -12,13 +10,13 @@ module Mongoid
         extend Macroable
 
         # Constant for a LineString $geometry.
-        LINE_STRING = "LineString"
+        LINE_STRING = 'LineString'
 
         # Constant for a Point $geometry.
-        POINT = "Point"
+        POINT = 'Point'
 
         # Constant for a Polygon $geometry.
-        POLYGON = "Polygon"
+        POLYGON = 'Polygon'
 
         # @attribute [rw] negating If the next expression is negated.
         # @attribute [rw] selector The query selector.
@@ -43,27 +41,23 @@ module Mongoid
           end
 
           criteria.inject(clone) do |query, condition|
-            if condition.nil?
-              raise Errors::CriteriaArgumentRequired, :all
-            end
+            raise Errors::CriteriaArgumentRequired, :all if condition.nil?
 
             condition = expand_condition_to_array_values(condition)
 
             if strategy
-              send(strategy, condition, "$all")
+              send(strategy, condition, '$all')
             else
               condition.inject(query) do |_query, (field, value)|
-                v = {'$all' => value}
-                if negating?
-                  v = {'$not' => v}
-                end
+                v = { '$all' => value }
+                v = { '$not' => v } if negating?
                 _query.add_field_expression(field.to_s, v)
               end
             end
           end.reset_strategies!
         end
-        alias :all_in :all
-        key :all, :union, "$all"
+        alias all_in all
+        key :all, :union, '$all'
 
         # Add the $and criterion.
         #
@@ -76,10 +70,8 @@ module Mongoid
         #
         # @return [ Selectable ] The new selectable.
         def and(*criteria)
-          _mongoid_flatten_arrays(criteria).inject(self.clone) do |c, new_s|
-            if new_s.is_a?(Selectable)
-              new_s = new_s.selector
-            end
+          _mongoid_flatten_arrays(criteria).inject(clone) do |c, new_s|
+            new_s = new_s.selector if new_s.is_a?(Selectable)
             normalized = _mongoid_expand_keys(new_s)
             normalized.each do |k, v|
               k = k.to_s
@@ -90,16 +82,15 @@ module Mongoid
                 # we can add to existing conditions.
                 # Otherwise use $and.
                 if v.is_a?(Hash) &&
-                  v.length == 1 &&
-                  (new_k = v.keys.first).start_with?('$') &&
-                  (existing_kv = c.selector[k]).is_a?(Hash) &&
-                  !existing_kv.key?(new_k) &&
-                  existing_kv.keys.all? { |sub_k| sub_k.start_with?('$') }
-                then
+                   v.length == 1 &&
+                   (new_k = v.keys.first).start_with?('$') &&
+                   (existing_kv = c.selector[k]).is_a?(Hash) &&
+                   !existing_kv.key?(new_k) &&
+                   existing_kv.keys.all? { |sub_k| sub_k.start_with?('$') }
                   merged_v = c.selector[k].merge(v)
                   c.selector.store(k, merged_v)
                 else
-                  c = c.send(:__multi__, [k => v], '$and')
+                  c = c.send(:__multi__, [ { k => v } ], '$and')
                 end
               else
                 c.selector.store(k, v)
@@ -108,7 +99,7 @@ module Mongoid
             c
           end
         end
-        alias :all_of :and
+        alias all_of and
 
         # Add the range selection.
         #
@@ -122,14 +113,12 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def between(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :between
-          end
+          raise Errors::CriteriaArgumentRequired, :between if criterion.nil?
 
           selection(criterion) do |selector, field, value|
             selector.store(
               field,
-              { "$gte" => value.min, "$lte" => value.max }
+              { '$gte' => value.min, '$lte' => value.max }
             )
           end
         end
@@ -152,13 +141,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def elem_match(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :elem_match
-          end
+          raise Errors::CriteriaArgumentRequired, :elem_match if criterion.nil?
 
-          and_with_operator(criterion, "$elemMatch")
+          and_with_operator(criterion, '$elemMatch')
         end
-        key :elem_match, :override, "$elemMatch"
+        key :elem_match, :override, '$elemMatch'
 
         # Add the $exists selection.
         #
@@ -175,15 +162,13 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def exists(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :exists
-          end
+          raise Errors::CriteriaArgumentRequired, :exists if criterion.nil?
 
-          typed_override(criterion, "$exists") do |value|
+          typed_override(criterion, '$exists') do |value|
             Mongoid::Boolean.evolve(value)
           end
         end
-        key :exists, :override, "$exists" do |value|
+        key :exists, :override, '$exists' do |value|
           Mongoid::Boolean.evolve(value)
         end
 
@@ -222,26 +207,24 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def geo_spatial(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :geo_spatial
-          end
+          raise Errors::CriteriaArgumentRequired, :geo_spatial if criterion.nil?
 
           __merge__(criterion)
         end
 
-        key :intersects_line, :override, "$geoIntersects", "$geometry" do |value|
-          { "type" => LINE_STRING, "coordinates" => value }
+        key :intersects_line, :override, '$geoIntersects', '$geometry' do |value|
+          { 'type' => LINE_STRING, 'coordinates' => value }
         end
-        key :intersects_point, :override, "$geoIntersects", "$geometry" do |value|
-          { "type" => POINT, "coordinates" => value }
+        key :intersects_point, :override, '$geoIntersects', '$geometry' do |value|
+          { 'type' => POINT, 'coordinates' => value }
         end
-        key :intersects_polygon, :override, "$geoIntersects", "$geometry" do |value|
-          { "type" => POLYGON, "coordinates" => value }
+        key :intersects_polygon, :override, '$geoIntersects', '$geometry' do |value|
+          { 'type' => POLYGON, 'coordinates' => value }
         end
-        key :within_polygon, :override, "$geoWithin", "$geometry" do |value|
-          { "type" => POLYGON, "coordinates" => value }
+        key :within_polygon, :override, '$geoWithin', '$geometry' do |value|
+          { 'type' => POLYGON, 'coordinates' => value }
         end
-        key :within_box, :override, "$geoWithin", "$box"
+        key :within_box, :override, '$geoWithin', '$box'
 
         # Add the $eq criterion to the selector.
         #
@@ -255,13 +238,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def eq(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :eq
-          end
+          raise Errors::CriteriaArgumentRequired, :eq if criterion.nil?
 
-          and_with_operator(criterion, "$eq")
+          and_with_operator(criterion, '$eq')
         end
-        key :eq, :override, "$eq"
+        key :eq, :override, '$eq'
 
         # Add the $gt criterion to the selector.
         #
@@ -275,13 +256,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def gt(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :gt
-          end
+          raise Errors::CriteriaArgumentRequired, :gt if criterion.nil?
 
-          and_with_operator(criterion, "$gt")
+          and_with_operator(criterion, '$gt')
         end
-        key :gt, :override, "$gt"
+        key :gt, :override, '$gt'
 
         # Add the $gte criterion to the selector.
         #
@@ -295,13 +274,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def gte(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :gte
-          end
+          raise Errors::CriteriaArgumentRequired, :gte if criterion.nil?
 
-          and_with_operator(criterion, "$gte")
+          and_with_operator(criterion, '$gte')
         end
-        key :gte, :override, "$gte"
+        key :gte, :override, '$gte'
 
         # Adds the $in selection to the selectable.
         #
@@ -318,26 +295,22 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def in(condition)
-          if condition.nil?
-            raise Errors::CriteriaArgumentRequired, :in
-          end
+          raise Errors::CriteriaArgumentRequired, :in if condition.nil?
 
           condition = expand_condition_to_array_values(condition)
 
           if strategy
-            send(strategy, condition, "$in")
+            send(strategy, condition, '$in')
           else
             condition.inject(clone) do |query, (field, value)|
-              v = {'$in' => value}
-              if negating?
-                v = {'$not' => v}
-              end
+              v = { '$in' => value }
+              v = { '$not' => v } if negating?
               query.add_field_expression(field.to_s, v)
             end.reset_strategies!
           end
         end
-        alias :any_in :in
-        key :in, :intersect, "$in"
+        alias any_in in
+        key :in, :intersect, '$in'
 
         # Add the $lt criterion to the selector.
         #
@@ -351,13 +324,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def lt(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :lt
-          end
+          raise Errors::CriteriaArgumentRequired, :lt if criterion.nil?
 
-          and_with_operator(criterion, "$lt")
+          and_with_operator(criterion, '$lt')
         end
-        key :lt, :override, "$lt"
+        key :lt, :override, '$lt'
 
         # Add the $lte criterion to the selector.
         #
@@ -371,13 +342,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def lte(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :lte
-          end
+          raise Errors::CriteriaArgumentRequired, :lte if criterion.nil?
 
-          and_with_operator(criterion, "$lte")
+          and_with_operator(criterion, '$lte')
         end
-        key :lte, :override, "$lte"
+        key :lte, :override, '$lte'
 
         # Add a $maxDistance selection to the selectable.
         #
@@ -388,12 +357,10 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def max_distance(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :max_distance
-          end
+          raise Errors::CriteriaArgumentRequired, :max_distance if criterion.nil?
 
           # $maxDistance must be given together with $near
-          __add__(criterion, "$maxDistance")
+          __add__(criterion, '$maxDistance')
         end
 
         # Adds $mod selection to the selectable.
@@ -408,13 +375,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def mod(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :mod
-          end
+          raise Errors::CriteriaArgumentRequired, :mod if criterion.nil?
 
-          and_with_operator(criterion, "$mod")
+          and_with_operator(criterion, '$mod')
         end
-        key :mod, :override, "$mod"
+        key :mod, :override, '$mod'
 
         # Adds $ne selection to the selectable.
         #
@@ -428,14 +393,12 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def ne(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :ne
-          end
+          raise Errors::CriteriaArgumentRequired, :ne if criterion.nil?
 
-          and_with_operator(criterion, "$ne")
+          and_with_operator(criterion, '$ne')
         end
-        alias :excludes :ne
-        key :ne, :override, "$ne"
+        alias excludes ne
+        key :ne, :override, '$ne'
 
         # Adds a $near criterion to a geo selection.
         #
@@ -449,13 +412,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def near(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :near
-          end
+          raise Errors::CriteriaArgumentRequired, :near if criterion.nil?
 
-          and_with_operator(criterion, "$near")
+          and_with_operator(criterion, '$near')
         end
-        key :near, :override, "$near"
+        key :near, :override, '$near'
 
         # Adds a $nearSphere criterion to a geo selection.
         #
@@ -469,13 +430,11 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def near_sphere(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :near_sphere
-          end
+          raise Errors::CriteriaArgumentRequired, :near_sphere if criterion.nil?
 
-          and_with_operator(criterion, "$nearSphere")
+          and_with_operator(criterion, '$nearSphere')
         end
-        key :near_sphere, :override, "$nearSphere"
+        key :near_sphere, :override, '$nearSphere'
 
         # Adds the $nin selection to the selectable.
         #
@@ -492,26 +451,22 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def nin(condition)
-          if condition.nil?
-            raise Errors::CriteriaArgumentRequired, :nin
-          end
+          raise Errors::CriteriaArgumentRequired, :nin if condition.nil?
 
           condition = expand_condition_to_array_values(condition)
 
           if strategy
-            send(strategy, condition, "$nin")
+            send(strategy, condition, '$nin')
           else
             condition.inject(clone) do |query, (field, value)|
-              v = {'$nin' => value}
-              if negating?
-                v = {'$not' => v}
-              end
+              v = { '$nin' => value }
+              v = { '$not' => v } if negating?
               query.add_field_expression(field.to_s, v)
             end.reset_strategies!
           end
         end
-        alias :not_in :nin
-        key :nin, :intersect, "$nin"
+        alias not_in nin
+        key :nin, :intersect, '$nin'
 
         # Adds $nor selection to the selectable.
         #
@@ -555,32 +510,28 @@ module Mongoid
           if criteria.empty?
             dup.tap { |query| query.negating = !query.negating }
           else
-            criteria.compact.inject(self.clone) do |c, new_s|
-              if new_s.is_a?(Selectable)
-                new_s = new_s.selector
-              end
+            criteria.compact.inject(clone) do |c, new_s|
+              new_s = new_s.selector if new_s.is_a?(Selectable)
               _mongoid_expand_keys(new_s).each do |k, v|
                 k = k.to_s
                 if c.selector[k] || k.start_with?('$')
-                  c = c.send(:__multi__, [{'$nor' => [{k => v}]}], '$and')
+                  c = c.send(:__multi__, [ { '$nor' => [ { k => v } ] } ], '$and')
+                elsif v.is_a?(Hash)
+                  c = c.send(:__multi__, [ { '$nor' => [ { k => v } ] } ], '$and')
                 else
-                  if v.is_a?(Hash)
-                    c = c.send(:__multi__, [{'$nor' => [{k => v}]}], '$and')
-                  else
-                    if v.is_a?(Regexp)
-                      negated_operator = '$not'
-                    else
-                      negated_operator = '$ne'
-                    end
-                    c = c.send(:__override__, {k => v}, negated_operator)
-                  end
+                  negated_operator = if v.is_a?(Regexp)
+                                       '$not'
+                                     else
+                                       '$ne'
+                                     end
+                  c = c.send(:__override__, { k => v }, negated_operator)
                 end
               end
               c
             end
           end
         end
-        key :not, :override, "$not"
+        key :not, :override, '$not'
 
         # Negate the arguments, constraining the query to only those documents
         # that do NOT match the arguments.
@@ -604,8 +555,8 @@ module Mongoid
 
           exprs = criteria.map do |criterion|
             _mongoid_expand_keys(
-                criterion.is_a?(Selectable) ?
-                  criterion.selector : criterion)
+              criterion.is_a?(Selectable) ? criterion.selector : criterion
+            )
           end
 
           self.and('$nor' => exprs)
@@ -690,9 +641,9 @@ module Mongoid
               else
                 Hash[criterion.map do |k, v|
                   if k.is_a?(Symbol)
-                    [k.to_s, v]
+                    [ k.to_s, v ]
                   else
-                    [k, v]
+                    [ k, v ]
                   end
                 end]
               end
@@ -716,15 +667,13 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def with_size(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :with_size
-          end
+          raise Errors::CriteriaArgumentRequired, :with_size if criterion.nil?
 
-          typed_override(criterion, "$size") do |value|
+          typed_override(criterion, '$size') do |value|
             ::Integer.evolve(value)
           end
         end
-        key :with_size, :override, "$size" do |value|
+        key :with_size, :override, '$size' do |value|
           ::Integer.evolve(value)
         end
 
@@ -742,15 +691,13 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def with_type(criterion)
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :with_type
-          end
+          raise Errors::CriteriaArgumentRequired, :with_type if criterion.nil?
 
-          typed_override(criterion, "$type") do |value|
+          typed_override(criterion, '$type') do |value|
             ::Integer.evolve(value)
           end
         end
-        key :with_type, :override, "$type" do |value|
+        key :with_type, :override, '$type' do |value|
           ::Integer.evolve(value)
         end
 
@@ -774,12 +721,10 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def text_search(terms, opts = nil)
-          if terms.nil?
-            raise Errors::CriteriaArgumentRequired, :terms
-          end
+          raise Errors::CriteriaArgumentRequired, :terms if terms.nil?
 
           clone.tap do |query|
-            criterion = {'$text' => { '$search' => terms }}
+            criterion = { '$text' => { '$search' => terms } }
             criterion['$text'].merge!(opts) if opts
             if query.selector['$text']
               # Per https://www.mongodb.com/docs/manual/reference/operator/query/text/
@@ -788,7 +733,7 @@ module Mongoid
               # overwriting previous text search condition with the currently
               # given one.
               Mongoid.logger.warn('Multiple $text expressions per query are not currently supported by the server')
-              query.selector = {'$and' => [query.selector]}.merge(criterion)
+              query.selector = { '$and' => [ query.selector ] }.merge(criterion)
             else
               query.selector = query.selector.merge(criterion)
             end
@@ -810,10 +755,10 @@ module Mongoid
         #
         # @return [ Selectable ] The cloned selectable.
         def where(*criteria)
-          criteria.inject(clone) do |query, criterion|
-            if criterion.nil?
-              raise Errors::CriteriaArgumentRequired, :where
-            end
+          return clone.reset_strategies! if criteria.empty?
+
+          criteria.inject(self) do |query, criterion|
+            raise Errors::CriteriaArgumentRequired, :where if criterion.nil?
 
             # We need to save the criterion in an instance variable so
             # Modifiable methods know how to create a polymorphic object.
@@ -823,15 +768,13 @@ module Mongoid
             # only ever specify one criterion to #where.
             @criterion = criterion
             if criterion.is_a?(String)
-              js_query(criterion)
+              query.js_query(criterion)
             else
-              expr_query(criterion)
+              query.expr_query(criterion)
             end
-          end.reset_strategies!
+          end
         end
 
-        private
-
         # Adds the specified expression to the query.
         #
         # Criterion must be a hash in one of the following forms:
@@ -850,10 +793,8 @@ module Mongoid
         # @return [ Selectable ] The cloned selectable.
         # @api private
         def expr_query(criterion)
-          if criterion.nil?
-            raise ArgumentError, 'Criterion cannot be nil here'
-          end
-          unless Hash === criterion
+          raise ArgumentError, 'Criterion cannot be nil here' if criterion.nil?
+          unless criterion.is_a?(Hash)
             raise Errors::InvalidQuery, "Expression must be a Hash: #{Errors::InvalidQuery.truncate_expr(criterion)}"
           end
 
@@ -872,25 +813,6 @@ module Mongoid
           end
         end
 
-        # Force the values of the criterion to be evolved.
-        #
-        # @api private
-        #
-        # @example Force values to booleans.
-        #   selectable.force_typing(criterion) do |val|
-        #     Boolean.evolve(val)
-        #   end
-        #
-        # @param [ Hash ] criterion The criterion.
-        def typed_override(criterion, operator)
-          if criterion
-            criterion.transform_values! do |value|
-              yield(value)
-            end
-          end
-          __override__(criterion, operator)
-        end
-
         # Create a javascript selection.
         #
         # @api private
@@ -905,7 +827,7 @@ module Mongoid
           clone.tap do |query|
             if negating?
               query.add_operator_expression('$and',
-                [{'$nor' => [{'$where' => criterion}]}])
+                                            [ { '$nor' => [ { '$where' => criterion } ] } ])
             else
               query.add_operator_expression('$where', criterion)
             end
@@ -913,6 +835,23 @@ module Mongoid
           end
         end
 
+        private
+
+        # Force the values of the criterion to be evolved.
+        #
+        # @api private
+        #
+        # @example Force values to booleans.
+        #   selectable.force_typing(criterion) do |val|
+        #     Boolean.evolve(val)
+        #   end
+        #
+        # @param [ Hash ] criterion The criterion.
+        def typed_override(criterion, operator, &block)
+          criterion.transform_values!(&block) if criterion
+          __override__(criterion, operator)
+        end
+
         # Take the provided criterion and store it as a selection in the query
         # selector.
         #
@@ -935,7 +874,6 @@ module Mongoid
         end
 
         class << self
-
           # Get the methods on the selectable that can be forwarded to from a model.
           #
           # @example Get the forwardable methods.
@@ -944,7 +882,7 @@ module Mongoid
           # @return [ Array<Symbol> ] The names of the forwardable methods.
           def forwardables
             public_instance_methods(false) -
-              [ :negating, :negating=, :negating?, :selector, :selector= ]
+              %i[negating negating= negating? selector selector=]
           end
         end
       end