mongoid 9.0.11 → 9.1.0

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

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # The selector is a special kind of hash that knows how to serialize values
       # coming into it as well as being alias and locale aware for key names.
       class Selector < Smash
-
         # Merges another selector into this one.
         #
         # @example Merge in another selector.
@@ -31,9 +28,7 @@ module Mongoid
                 end
               end
             end
-            if multi_selection?(key)
-              value = (self[key.to_s] || []).concat(value)
-            end
+            value = (self[key.to_s] || []).concat(value) if multi_selection?(key)
             store(key, value)
           end
         end
@@ -58,7 +53,7 @@ module Mongoid
           end
           super(store_name, store_value)
         end
-        alias :[]= :store
+        alias []= store
 
         # Convert the selector to an aggregation pipeline entry.
         #
@@ -68,7 +63,7 @@ module Mongoid
         # @return [ Array<Hash> ] The pipeline entry for the selector.
         def to_pipeline
           pipeline = []
-          pipeline.push({ "$match" => self }) unless empty?
+          pipeline.push({ '$match' => self }) unless empty?
           pipeline
         end
 
@@ -85,7 +80,7 @@ module Mongoid
         # @return [ Array<String, String> ] The store name and store value.
         def store_creds(name, serializer, value)
           store_name = localized_key(name, serializer)
-          if Range === value
+          if value.is_a?(Range)
             evolve_range(store_name, serializer, value)
           else
             [ store_name, evolve(serializer, value) ]
@@ -104,18 +99,15 @@ module Mongoid
         #
         # @api private
         def evolve_multi(specs)
-          unless specs.is_a?(Array)
-            raise ArgumentError, "specs is not an array: #{specs.inspect}"
-          end
+          raise ArgumentError, "specs is not an array: #{specs.inspect}" unless specs.is_a?(Array)
+
           specs.map do |spec|
             Hash[spec.map do |key, value|
               # If an application nests conditionals, e.g.
               # {'$or' => [{'$or' => {...}}]},
               # when evolve_multi is called for the top level hash,
               # this call recursively transforms the bottom level $or.
-              if multi_selection?(key)
-                value = evolve_multi(value)
-              end
+              value = evolve_multi(value) if multi_selection?(key)
 
               # storage_pair handles field aliases but not localization for
               # some reason, although per its documentation Smash supposedly
@@ -130,9 +122,7 @@ module Mongoid
               # involves complex keys. For example, {:foo.lt => 5} produces
               # {'foo' => {'$lt' => 5}}. This step should be done after all
               # value-based processing is complete.
-              if key.is_a?(Key)
-                evolved_value = key.transform_value(evolved_value)
-              end
+              evolved_value = key.transform_value(evolved_value) if key.is_a?(Key)
 
               [ final_key, evolved_value ]
             end]
@@ -195,11 +185,11 @@ module Mongoid
         # @return [ Object ] The serialized hash.
         def evolve_hash(serializer, value)
           value.each_pair do |operator, _value|
-            if operator =~ /exists|type|size/
-              value[operator] = _value
-            else
-              value[operator] = evolve(serializer, _value)
-            end
+            value[operator] = if /exists|type|size/.match?(operator)
+                                _value
+                              else
+                                evolve(serializer, _value)
+                              end
           end
         end
 
@@ -239,13 +229,14 @@ module Mongoid
         def evolve_range(key, serializer, value)
           v = value.__evolve_range__(serializer: serializer)
           assocs = []
-          Fields.traverse_association_tree(key, serializers, associations, aliased_associations) do |meth, obj, is_field|
-            assocs.push([meth, obj, is_field])
+          Fields.traverse_association_tree(key, serializers, associations,
+                                           aliased_associations) do |meth, obj, is_field|
+            assocs.push([ meth, obj, is_field ])
           end
 
           # Iterate backwards until you get a field with type
           # Array or an embeds_many association.
-          inner_key = ""
+          inner_key = ''
           loop do
             # If there are no arrays or embeds_many associations, just return
             # the key and value without $elemMatch.
@@ -262,10 +253,10 @@ module Mongoid
           # the inner key (2) is ignored, and the outer key (1) is the original
           # key.
           if inner_key.blank?
-            [ key, { "$elemMatch" => v }]
+            [ key, { '$elemMatch' => v } ]
           else
             store_key = assocs.map(&:first).join('.')
-            store_value = { "$elemMatch" => { inner_key.chop => v } }
+            store_value = { '$elemMatch' => { inner_key.chop => v } }
             [ store_key,  store_value ]
           end
         end
@@ -282,7 +273,7 @@ module Mongoid
         #
         # @return [ true | false ] If the key is for a multi-select.
         def multi_selection?(key)
-          %w($and $or $nor).include?(key)
+          %w[$and $or $nor].include?(key)
         end
       end
     end

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

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # This is a smart hash for use with options and selectors.
       class Smash < Hash
-
         # @attribute [r] aliases The aliases.
         attr_reader :aliases
 
@@ -85,7 +82,7 @@ module Mongoid
         #
         # @return [ String ] The normalized key.
         def localized_key(name, serializer)
-          serializer && serializer.localized? ? "#{name}.#{::I18n.locale}" : name
+          (serializer && serializer.localized?) ? "#{name}.#{::I18n.locale}" : name
         end
 
         # Get the pair of objects needed to store the value in a hash by the
@@ -106,8 +103,6 @@ module Mongoid
           [ name, get_serializer(name) ]
         end
 
-        private
-
         # Retrieves the serializer for the given name. If the name exists in
         # the serializers hash then return that immediately, otherwise
         # recursively look through the associations and find the appropriate

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -16,7 +15,6 @@ module Mongoid
       #
       # @api private
       module Storable
-
         # Adds a field expression to the query.
         #
         # +field+ must be a field name, and it must be a string. The upstream
@@ -34,29 +32,24 @@ module Mongoid
         #
         # @return [ Storable ] self.
         def add_field_expression(field, value)
-          unless field.is_a?(String)
-            raise ArgumentError, "Field must be a string: #{field}"
-          end
+          raise ArgumentError, "Field must be a string: #{field}" unless field.is_a?(String)
 
-          if field.start_with?('$')
-            raise ArgumentError, "Field cannot be an operator (i.e. begin with $): #{field}"
-          end
+          raise ArgumentError, "Field cannot be an operator (i.e. begin with $): #{field}" if field.start_with?('$')
 
           if selector[field]
             # We already have a restriction by the field we are trying
             # to restrict, combine the restrictions.
             if value.is_a?(Hash) && selector[field].is_a?(Hash) &&
-              value.keys.all? { |key|
-                key_s = key.to_s
-                key_s.start_with?('$') && !selector[field].keys.map(&:to_s).include?(key_s)
-              }
-            then
+               value.keys.all? do |key|
+                 key_s = key.to_s
+                 key_s.start_with?('$') && !selector[field].keys.map(&:to_s).include?(key_s)
+               end
               # Multiple operators can be combined on the same field by
               # adding them to the existing hash.
               new_value = selector[field].merge(value)
               selector.store(field, new_value)
             elsif selector[field] != value
-              add_operator_expression('$and', [{field => value}])
+              add_operator_expression('$and', [ { field => value } ])
             end
           else
             selector.store(field, value)
@@ -106,12 +99,11 @@ module Mongoid
         #
         # @return [ Storable ] self.
         def add_logical_operator_expression(operator, op_expr)
-          unless operator.is_a?(String)
-            raise ArgumentError, "Operator must be a string: #{operator}"
-          end
+          raise ArgumentError, "Operator must be a string: #{operator}" unless operator.is_a?(String)
 
-          unless %w($and $nor $or).include?(operator)
-            raise ArgumentError, "This method only handles logical operators ($and, $nor, $or). Operator given: #{operator}"
+          unless %w[$and $nor $or].include?(operator)
+            raise ArgumentError,
+                  "This method only handles logical operators ($and, $nor, $or). Operator given: #{operator}"
           end
 
           unless op_expr.is_a?(Array)
@@ -130,13 +122,11 @@ module Mongoid
             else
               selector.store(operator, op_expr)
             end
-          else
+          elsif selector[operator]
             # Other operators need to be added separately
-            if selector[operator]
-              add_logical_operator_expression('$and', [operator => op_expr])
-            else
-              selector.store(operator, op_expr)
-            end
+            add_logical_operator_expression('$and', [ { operator => op_expr } ])
+          else
+            selector.store(operator, op_expr)
           end
 
           self
@@ -186,23 +176,17 @@ module Mongoid
         #
         # @return [ Storable ] self.
         def add_operator_expression(operator, op_expr)
-          unless operator.is_a?(String)
-            raise ArgumentError, "Operator must be a string: #{operator}"
-          end
+          raise ArgumentError, "Operator must be a string: #{operator}" unless operator.is_a?(String)
 
-          unless operator.start_with?('$')
-            raise ArgumentError, "Operator must begin with $: #{operator}"
-          end
+          raise ArgumentError, "Operator must begin with $: #{operator}" unless operator.start_with?('$')
 
-          if %w($and $nor $or).include?(operator)
-            return add_logical_operator_expression(operator, op_expr)
-          end
+          return add_logical_operator_expression(operator, op_expr) if %w[$and $nor $or].include?(operator)
 
           # For other operators, if the operator already exists in the
           # query, add the new condition with $and, otherwise add the
           # new condition to the top level.
           if selector[operator]
-            add_logical_operator_expression('$and', [{operator => op_expr}])
+            add_logical_operator_expression('$and', [ { operator => op_expr } ])
           else
             selector.store(operator, op_expr)
           end
@@ -221,9 +205,7 @@ module Mongoid
         #
         # @return [ Storable ] self.
         def add_one_expression(field, value)
-          unless field.is_a?(String)
-            raise ArgumentError, "Field must be a string: #{field}"
-          end
+          raise ArgumentError, "Field must be a string: #{field}" unless field.is_a?(String)
 
           if field.start_with?('$')
             add_operator_expression(field, value)
@@ -231,7 +213,6 @@ module Mongoid
             add_field_expression(field, value)
           end
         end
-
       end
     end
   end

data/lib/mongoid/criteria/queryable.rb

@@ -1,23 +1,21 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/criteria/queryable/expandable"
-require "mongoid/criteria/queryable/extensions"
-require "mongoid/criteria/queryable/key"
-require "mongoid/criteria/queryable/macroable"
-require "mongoid/criteria/queryable/mergeable"
-require "mongoid/criteria/queryable/smash"
-require "mongoid/criteria/queryable/aggregable"
-require "mongoid/criteria/queryable/pipeline"
-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"
+require 'mongoid/criteria/queryable/expandable'
+require 'mongoid/criteria/queryable/extensions'
+require 'mongoid/criteria/queryable/key'
+require 'mongoid/criteria/queryable/macroable'
+require 'mongoid/criteria/queryable/mergeable'
+require 'mongoid/criteria/queryable/smash'
+require 'mongoid/criteria/queryable/aggregable'
+require 'mongoid/criteria/queryable/pipeline'
+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
-
     # A queryable is any object that needs queryable's dsl injected into it to build
     # MongoDB queries. For example, a Mongoid::Criteria is an Queryable.
     #
@@ -50,6 +48,7 @@ module Mongoid
       # @return [ true | false ] If the objects are equal.
       def ==(other)
         return false unless other.is_a?(Queryable)
+
         selector == other.selector && options == other.options
       end
 
@@ -86,6 +85,17 @@ module Mongoid
         @selector = other.selector.__deep_copy__
         @pipeline = other.pipeline.__deep_copy__
       end
+
+      # Returns selector and options of the criteria in form of MongoDB command.
+      #
+      # @return [ Hash ] The command.
+      def to_mql
+        {
+          '$db': database_name,
+          find: collection.name,
+          filter: selector
+        }.merge(options)
+      end
     end
   end
 end

data/lib/mongoid/criteria/scopable.rb

@@ -1,14 +1,11 @@
 # 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.
       #
       # @example Apply the default scope.
@@ -66,7 +63,7 @@ module Mongoid
         self
       end
 
-      # Forces the criteria to be scoped, unless its inside an unscoped block.
+      # Forces the criteria to be scoped, unless it's inside an unscoped block.
       #
       # @example Force the criteria to be scoped.
       #   criteria.scoped(skip: 10)
@@ -77,9 +74,7 @@ module Mongoid
       def scoped(options = nil)
         crit = clone
         crit.options.merge!(options || {})
-        if klass.default_scopable? && !scoped?
-          crit.apply_default_scope
-        end
+        crit.apply_default_scope if klass.default_scopable? && !scoped?
         crit
       end
 
@@ -103,7 +98,8 @@ module Mongoid
         crit = clone
         unless unscoped?
           crit.scoping_options = false, true
-          crit.selector.clear; crit.options.clear
+          crit.selector.clear
+          crit.options.clear
         end
         crit
       end
@@ -151,9 +147,7 @@ module Mongoid
       # @return [ Criteria ] The criteria.
       def with_default_scope
         crit = clone
-        if klass.default_scopable? && !unscoped? && !scoped?
-          crit.apply_default_scope
-        end
+        crit.apply_default_scope if klass.default_scopable? && !unscoped? && !scoped?
         crit
       end
 

data/lib/mongoid/criteria/translator.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # This is a helper module for translating atomic and composite
     # Ruby values into corresponding query and option components.
     # Originally implemented as patches to core classes, that approach
@@ -28,19 +26,18 @@ module Mongoid
       # @return [ Hash | Numeric ] The direction.
       def to_direction(value)
         case value
-        when Hash then
+        when Hash
           value
-        when Numeric then
+        when Numeric
           value
-        when String then
-          value =~ /desc/i ? -1 : 1
-        when Symbol then
+        when String
+          /desc/i.match?(value) ? -1 : 1
+        when Symbol
           to_direction(value.to_s)
         else
           raise ArgumentError, "cannot translate #{value.inspect} (#{value.class}) to a direction specification"
         end
       end
     end
-
   end
 end