mongoid 7.3.2 → 7.4.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -12,18 +11,12 @@ module Mongoid
         extend Macroable
 
         # Constant for a LineString $geometry.
-        #
-        # @since 2.0.0
         LINE_STRING = "LineString"
 
         # Constant for a Point $geometry.
-        #
-        # @since 2.0.0
         POINT = "Point"
 
         # Constant for a Polygon $geometry.
-        #
-        # @since 2.0.0
         POLYGON = "Polygon"
 
         # @attribute [rw] negating If the next expression is negated.
@@ -41,8 +34,6 @@ module Mongoid
         # @param [ Hash ] criterion The key value pairs for $all matching.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def all(*criteria)
           if criteria.empty?
             return clone.tap do |query|
@@ -82,8 +73,6 @@ module Mongoid
         #   matches or Criteria objects that all must match to return results.
         #
         # @return [ Selectable ] The new selectable.
-        #
-        # @since 1.0.0
         def and(*criteria)
           _mongoid_flatten_arrays(criteria).inject(self.clone) do |c, new_s|
             if new_s.is_a?(Selectable)
@@ -130,8 +119,6 @@ module Mongoid
         # @param [ Hash ] criterion Multiple key/range pairs.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def between(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :between
@@ -162,8 +149,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/match pairs.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def elem_match(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :elem_match
@@ -187,8 +172,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/boolean existence checks.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def exists(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :exists
@@ -271,6 +254,26 @@ module Mongoid
         end
         key :within_box, :override, "$geoWithin", "$box"
 
+        # Add the $eq criterion to the selector.
+        #
+        # @example Add the $eq criterion.
+        #   selectable.eq(age: 60)
+        #
+        # @example Execute an $eq in a where query.
+        #   selectable.where(:field.eq => 10)
+        #
+        # @param [ Hash ] criterion The field/value pairs to check.
+        #
+        # @return [ Selectable ] The cloned selectable.
+        def eq(criterion)
+          if criterion.nil?
+            raise Errors::CriteriaArgumentRequired, :eq
+          end
+
+          __override__(criterion, "$eq")
+        end
+        key :eq, :override, "$eq"
+
         # Add the $gt criterion to the selector.
         #
         # @example Add the $gt criterion.
@@ -282,8 +285,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/value pairs to check.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def gt(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :gt
@@ -304,8 +305,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/value pairs to check.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def gte(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :gte
@@ -329,8 +328,6 @@ module Mongoid
         # @param [ Hash ] condition The field/value criterion pairs.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def in(condition)
           if condition.nil?
             raise Errors::CriteriaArgumentRequired, :in
@@ -364,8 +361,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/value pairs to check.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def lt(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :lt
@@ -386,8 +381,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/value pairs to check.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def lte(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :lte
@@ -405,8 +398,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/distance pairs.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def max_distance(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :max_distance
@@ -427,8 +418,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/mod selections.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def mod(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :mod
@@ -449,8 +438,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/ne selections.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def ne(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :ne
@@ -472,8 +459,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/location pair.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def near(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :near
@@ -494,8 +479,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/location pair.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def near_sphere(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :near_sphere
@@ -519,8 +502,6 @@ module Mongoid
         # @param [ Hash ] condition The field/value criterion pairs.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def nin(condition)
           if condition.nil?
             raise Errors::CriteriaArgumentRequired, :nin
@@ -552,8 +533,6 @@ module Mongoid
         #   matches or Criteria objects.
         #
         # @return [ Selectable ] The new selectable.
-        #
-        # @since 1.0.0
         def nor(*criteria)
           _mongoid_add_top_level_operation('$nor', criteria)
         end
@@ -564,8 +543,6 @@ module Mongoid
         #   selectable.negating?
         #
         # @return [ true, false ] If the selectable is negating.
-        #
-        # @since 1.0.0
         def negating?
           !!negating
         end
@@ -585,8 +562,6 @@ module Mongoid
         #   matches or Criteria objects to negate.
         #
         # @return [ Selectable ] The new selectable.
-        #
-        # @since 1.0.0
         def not(*criteria)
           if criteria.empty?
             dup.tap { |query| query.negating = true }
@@ -597,7 +572,7 @@ module Mongoid
               end
               _mongoid_expand_keys(new_s).each do |k, v|
                 k = k.to_s
-                if c.selector[k] || k[0] == ?$
+                if c.selector[k] || k.start_with?('$')
                   c = c.send(:__multi__, [{'$nor' => [{k => v}]}], '$and')
                 else
                   if v.is_a?(Hash)
@@ -648,8 +623,6 @@ module Mongoid
         #   thereof. Passing arrays is deprecated.
         #
         # @return [ Selectable ] The new selectable.
-        #
-        # @since 1.0.0
         def or(*criteria)
           _mongoid_add_top_level_operation('$or', criteria)
         end
@@ -680,8 +653,6 @@ module Mongoid
         #   thereof. Passing arrays is deprecated.
         #
         # @return [ Selectable ] The new selectable.
-        #
-        # @since 1.0.0
         def any_of(*criteria)
           criteria = _mongoid_flatten_arrays(criteria)
           case criteria.length
@@ -735,8 +706,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/size pairs criterion.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def with_size(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :with_size
@@ -763,8 +732,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/type pairs.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def with_type(criterion)
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :with_type
@@ -797,8 +764,6 @@ module Mongoid
         #   for options.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 2.2.0
         def text_search(terms, opts = nil)
           if terms.nil?
             raise Errors::CriteriaArgumentRequired, :terms
@@ -834,8 +799,6 @@ module Mongoid
         # @param [ String, Hash ] criterion The javascript or standard selection.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         def where(*criteria)
           criteria.inject(clone) do |query, criterion|
             if criterion.nil?
@@ -875,8 +838,6 @@ module Mongoid
         # @param [ Hash ] criterion The field/value pairs.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         # @api private
         def expr_query(criterion)
           if criterion.nil?
@@ -890,7 +851,7 @@ module Mongoid
           clone.tap do |query|
             normalized.each do |field, value|
               field_s = field.to_s
-              if field_s[0] == ?$
+              if field_s.start_with?('$')
                 # Query expression-level operator, like $and or $where
                 query.add_operator_expression(field_s, value)
               else
@@ -911,8 +872,6 @@ module Mongoid
         #   end
         #
         # @param [ Hash ] criterion The criterion.
-        #
-        # @since 1.0.0
         def typed_override(criterion, operator)
           if criterion
             criterion.update_values do |value|
@@ -932,8 +891,6 @@ module Mongoid
         # @param [ String ] criterion The javascript as a string.
         #
         # @return [ Selectable ] The cloned selectable
-        #
-        # @since 1.0.0
         def js_query(criterion)
           clone.tap do |query|
             if negating?
@@ -955,8 +912,6 @@ module Mongoid
         # @param [ Hash ] criterion The selection to store.
         #
         # @return [ Selectable ] The cloned selectable.
-        #
-        # @since 1.0.0
         # @api private
         def selection(criterion = nil)
           clone.tap do |query|
@@ -977,8 +932,6 @@ module Mongoid
           #   Selectable.forwardables
           #
           # @return [ Array<Symbol> ] The names of the forwardable methods.
-          #
-          # @since 1.0.0
           def forwardables
             public_instance_methods(false) -
               [ :negating, :negating=, :negating?, :selector, :selector= ]

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,8 +16,6 @@ module Mongoid
         # @param [ Hash, Selector ] other The object to merge in.
         #
         # @return [ Selector ] The selector.
-        #
-        # @since 1.0.0
         def merge!(other)
           other.each_pair do |key, value|
             if value.is_a?(Hash) && self[key.to_s].is_a?(Hash)
@@ -50,8 +47,6 @@ module Mongoid
         # @param [ Object ] value The value to add.
         #
         # @return [ Object ] The stored object.
-        #
-        # @since 1.0.0
         def store(key, value)
           name, serializer = storage_pair(key)
           if multi_selection?(name)
@@ -71,8 +66,6 @@ module Mongoid
         #   selector.to_pipeline
         #
         # @return [ Array<Hash> ] The pipeline entry for the selector.
-        #
-        # @since 2.0.0
         def to_pipeline
           pipeline = []
           pipeline.push({ "$match" => self }) unless empty?
@@ -91,8 +84,6 @@ module Mongoid
         #
         # @return [ Array<Hash> ] The serialized values.
         #
-        # @since 1.0.0
-        #
         # @api private
         def evolve_multi(specs)
           unless specs.is_a?(Array)
@@ -142,8 +133,6 @@ module Mongoid
         # @param [ Object ] value The value to serialize.
         #
         # @return [ Object ] The serialized object.
-        #
-        # @since 1.0.0
         def evolve(serializer, value)
           case value
           when Hash
@@ -166,8 +155,6 @@ module Mongoid
         # @param [ Array<Object> ] value The array to serialize.
         #
         # @return [ Object ] The serialized array.
-        #
-        # @since 1.0.0
         def evolve_array(serializer, value)
           value.map do |_value|
             evolve(serializer, _value)
@@ -185,8 +172,6 @@ module Mongoid
         # @param [ Hash ] value The hash to serialize.
         #
         # @return [ Object ] The serialized hash.
-        #
-        # @since 1.0.0
         def evolve_hash(serializer, value)
           value.each_pair do |operator, _value|
             if operator =~ /exists|type|size/
@@ -208,8 +193,6 @@ module Mongoid
         # @param [ String ] key The key to check.
         #
         # @return [ true, false ] If the key is for a multi-select.
-        #
-        # @since 1.0.0
         def multi_selection?(key)
           %w($and $or $nor).include?(key)
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -18,8 +17,6 @@ module Mongoid
         #   smash.__deep_copy__
         #
         # @return [ Smash ] The copied hash.
-        #
-        # @since 1.0.0
         def __deep_copy__
           self.class.new(aliases, serializers) do |copy|
             each_pair do |key, value|
@@ -39,8 +36,6 @@ module Mongoid
         #   responsible for serializing values. The keys of the hash must be
         #   strings that match the field name, and the values must respond to
         #   #localized? and #evolve(object).
-        #
-        # @since 1.0.0
         def initialize(aliases = {}, serializers = {})
           @aliases, @serializers = aliases, serializers
           yield(self) if block_given?
@@ -54,8 +49,6 @@ module Mongoid
         # @param [ String ] key The key.
         #
         # @return [ Object ] The found object.
-        #
-        # @since 2.0.0
         def [](key)
           fetch(aliases[key]) { super }
         end
@@ -75,8 +68,6 @@ module Mongoid
         # @param [ Object ] serializer The optional field serializer.
         #
         # @return [ String ] The normalized key.
-        #
-        # @since 1.0.0
         def localized_key(name, serializer)
           serializer && serializer.localized? ? "#{name}.#{::I18n.locale}" : name
         end
@@ -93,8 +84,6 @@ module Mongoid
         #
         # @return [ Array<String, Object> ] The name of the db field and
         #   serializer.
-        #
-        # @since 1.0.0
         def storage_pair(key)
           field = key.to_s
           name = aliases[field] || field

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -38,7 +37,7 @@ module Mongoid
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field[0] == ?$
+          if field.start_with?('$')
             raise ArgumentError, "Field cannot be an operator (i.e. begin with $): #{field}"
           end
 
@@ -48,14 +47,14 @@ module Mongoid
             if value.is_a?(Hash) && selector[field].is_a?(Hash) &&
               value.keys.all? { |key|
                 key_s = key.to_s
-                key_s[0] == ?$ && !selector[field].key?(key_s)
+                key_s.start_with?('$') && !selector[field].key?(key_s)
               }
             then
               # 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)
-            else
+            elsif selector[field] != value
               add_operator_expression('$and', [{field => value}])
             end
           else
@@ -124,7 +123,12 @@ 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.
-            selector.store(operator, op_expr)
+            if !Mongoid.broken_and && current_value = selector[operator]
+              new_value = current_value + op_expr
+              selector.store(operator, new_value)
+            else
+              selector.store(operator, op_expr)
+            end
           else
             # Other operators need to be added separately
             if selector[operator]
@@ -185,7 +189,7 @@ module Mongoid
             raise ArgumentError, "Operator must be a string: #{operator}"
           end
 
-          unless operator[0] == ?$
+          unless operator.start_with?('$')
             raise ArgumentError, "Operator must begin with $: #{operator}"
           end
 
@@ -220,7 +224,7 @@ module Mongoid
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field[0] == ?$
+          if field.start_with?('$')
             add_operator_expression(field, value)
           else
             add_field_expression(field, value)

data/lib/mongoid/criteria/queryable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/criteria/queryable/expandable"
 require "mongoid/criteria/queryable/extensions"
@@ -47,8 +46,6 @@ module Mongoid
       # @param [ Object ] other The object to compare against.
       #
       # @return [ true, false ] If the objects are equal.
-      #
-      # @since 1.0.0
       def ==(other)
         return false unless other.is_a?(Queryable)
         selector == other.selector && options == other.options
@@ -63,8 +60,6 @@ module Mongoid
       # @param [ Hash ] aliases The optional field aliases.
       # @param [ Hash ] serializers The optional field serializers.
       # @param [ Symbol ] driver The driver being used.
-      #
-      # @since 1.0.0
       def initialize(aliases = {}, serializers = {}, driver = :mongo)
         @aliases, @driver, @serializers = aliases, driver.to_sym, serializers
         @options = Options.new(aliases, serializers)
@@ -80,8 +75,6 @@ module Mongoid
       #   queryable.initialize_copy(criteria)
       #
       # @param [ Queryable ] other The original copy.
-      #
-      # @since 1.0.0
       def initialize_copy(other)
         @options = other.options.__deep_copy__
         @selector = other.selector.__deep_copy__

data/lib/mongoid/criteria/scopable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -11,8 +10,6 @@ module Mongoid
       #   criteria.apply_default_scope
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.0
       def apply_default_scope
         klass.without_default_scope do
           merge!(klass.default_scoping.call)
@@ -20,6 +17,31 @@ module Mongoid
         self.scoping_options = true, false
       end
 
+      # Applies a scope to the current criteria.
+      #
+      # This method does not modify the receiver but it may return a new
+      # object or the receiver depending on the argument: if the +scope+
+      # argument is nil, the receiver is returned without modification,
+      # otherwise a new criteria object is returned.
+      #
+      # @param [ Proc | Symbol | Criteria | nil ] scope The scope to apply.
+      #
+      # @return [ Criteria ] The criteria with the scope applied.
+      #
+      # @api private
+      def apply_scope(scope)
+        case scope
+        when Proc
+          instance_exec(&scope)
+        when Symbol
+          send(scope)
+        when Criteria
+          merge(scope)
+        else
+          self
+        end
+      end
+
       # Given another criteria, remove the other criteria's scoping from this
       # criteria.
       #
@@ -29,8 +51,6 @@ module Mongoid
       # @param [ Criteria ] other The other criteria.
       #
       # @return [ Criteria ] The criteria with scoping removed.
-      #
-      # @since 3.0.0
       def remove_scoping(other)
         if other
           reject_matching(other, :selector, :options)
@@ -49,8 +69,6 @@ module Mongoid
       # @param [ Hash ] options Additional query options.
       #
       # @return [ Criteria ] The scoped criteria.
-      #
-      # @since 3.0.0
       def scoped(options = nil)
         crit = clone
         crit.options.merge!(options || {})
@@ -66,8 +84,6 @@ module Mongoid
       #   criteria.scoped?
       #
       # @return [ true, false ] If the default scope is applied.
-      #
-      # @since 3.0.0
       def scoped?
         !!(defined?(@scoped) ? @scoped : nil)
       end
@@ -78,8 +94,6 @@ module Mongoid
       #   criteria.unscoped
       #
       # @return [ Criteria ] The unscoped criteria.
-      #
-      # @since 3.0.0
       def unscoped
         crit = clone
         unless unscoped?
@@ -95,8 +109,6 @@ module Mongoid
       #   criteria.unscoped?
       #
       # @return [ true, false ] If the criteria is force unscoped.
-      #
-      # @since 3.0.0
       def unscoped?
         !!(defined?(@unscoped) ? @unscoped : nil)
       end
@@ -107,8 +119,6 @@ module Mongoid
       #   criteria.scoping_options
       #
       # @return [ Array ] Scoped, unscoped.
-      #
-      # @since 3.0.0
       def scoping_options
         [ (defined?(@scoped) ? @scoped : nil), (defined?(@unscoped) ? @unscoped : nil) ]
       end
@@ -121,8 +131,6 @@ module Mongoid
       # @param [ Array ] options Scoped, unscoped.
       #
       # @return [ Array ] The new scoping options.
-      #
-      # @since 3.0.0
       def scoping_options=(options)
         @scoped, @unscoped = options
       end
@@ -136,8 +144,6 @@ module Mongoid
       #   criteria.with_default_scope
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.0
       def with_default_scope
         crit = clone
         if klass.default_scopable? && !unscoped? && !scoped?