mongoid 7.2.4 → 7.3.0

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

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
 
-unless defined?(Boolean)
-  class Boolean; end
-end
-
 if defined?(ActiveSupport)
   unless defined?(ActiveSupport::TimeWithZone)
     require "active_support/time_with_zone"

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

@@ -33,4 +33,4 @@ module Mongoid
   end
 end
 
-::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)
+Mongoid::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)

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

@@ -227,7 +227,16 @@ module Mongoid
         end
 
         # Takes a criteria hash and expands Key objects into hashes containing
-        # MQL corresponding to said key objects.
+        # MQL corresponding to said key objects. Also converts the input to
+        # BSON::Document to permit indifferent access.
+        #
+        # The argument must be a hash containing key-value pairs of the
+        # following forms:
+        # - {field_name: value}
+        # - {'field_name' => value}
+        # - {key_instance: value}
+        # - {:$operator => operator_value_expression}
+        # - {'$operator' => operator_value_expression}
         #
         # Ruby does not permit multiple symbol operators. For example,
         # {:foo.gt => 1, :foo.gt => 2} is collapsed to {:foo.gt => 2} by the
@@ -237,19 +246,23 @@ module Mongoid
         # Similarly, this method should never need to expand a literal value
         # and an operator at the same time.
         #
+        # This method effectively converts symbol keys to string keys in
+        # the input +expr+, such that the downstream code can assume that
+        # conditions always contain string keys.
+        #
         # @param [ Hash ] expr Criteria including Key instances.
         #
-        # @return [ Hash ] The expanded criteria.
+        # @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
 
-          result = {}
+          result = BSON::Document.new
           expr.each do |field, value|
-            field.__expr_part__(value.__expand_complex__).each do |k, v|
-              if result[k]
-                if result[k].is_a?(Hash)
+            field.__expr_part__(value.__expand_complex__, negating?).each do |k, v|
+              if existing = result[k]
+                if existing.is_a?(Hash)
                   # Existing value is an operator.
                   # If new value is also an operator, ensure there are no
                   # conflicts and add
@@ -257,8 +270,8 @@ module Mongoid
                     # The new value is also an operator.
                     # If there are no conflicts, combine the hashes, otherwise
                     # add new conditions to top level with $and.
-                    if (v.keys & result[k].keys).empty?
-                      result[k].update(v)
+                    if (v.keys & existing.keys).empty?
+                      existing.update(v)
                     else
                       raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
                       result['$and'] ||= []
@@ -266,26 +279,39 @@ module Mongoid
                     end
                   else
                     # The new value is a simple value.
-                    # If there isn't an $eq operator already in the query,
-                    # transform the new value into an $eq operator and add it
-                    # to the existing hash. Otherwise add the new condition
-                    # with $and to the top level.
-                    if result[k].key?('$eq')
+                    # Transform the implicit equality to either $eq or $regexp
+                    # depending on the type of the argument. See
+                    # https://docs.mongodb.com/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
+                    # 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
+                    # add the new condition with $and to the top level.
+                    if existing.key?(op)
                       raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
                       result['$and'] ||= []
                       result['$and'] << {k => v}
                     else
-                      result[k].update('$eq' => v)
+                      existing.update(op => v)
                     end
                   end
                 else
                   # Existing value is a simple value.
-                  # If we are adding an operator, and the operator is not $eq,
-                  # convert existing value into $eq and add the new operator
-                  # to the same hash. Otherwise add the new condition with $and
-                  # to the top level.
-                  if v.is_a?(Hash) && !v.key?('$eq')
-                    result[k] = {'$eq' => result[k]}.update(v)
+                  # See the notes above about transformations to $eq/$regex.
+                  op = case existing
+                  when Regexp, BSON::Regexp::Raw
+                    '$regex'
+                  else
+                    '$eq'
+                  end
+                  if v.is_a?(Hash) && !v.key?(op)
+                    result[k] = {op => existing}.update(v)
                   else
                     raise NotImplementedError, 'Ruby does not allow same symbol operator with different values'
                     result['$and'] ||= []

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

@@ -195,11 +195,11 @@ module Mongoid
           end
 
           typed_override(criterion, "$exists") do |value|
-            ::Boolean.evolve(value)
+            Mongoid::Boolean.evolve(value)
           end
         end
         key :exists, :override, "$exists" do |value|
-          ::Boolean.evolve(value)
+          Mongoid::Boolean.evolve(value)
         end
 
         # Add a $geoIntersects or $geoWithin selection. Symbol operators must
@@ -882,19 +882,19 @@ module Mongoid
           if criterion.nil?
             raise ArgumentError, 'Criterion cannot be nil here'
           end
+          unless Hash === criterion
+            raise Errors::InvalidQuery, "Expression must be a Hash: #{Errors::InvalidQuery.truncate_expr(criterion)}"
+          end
 
+          normalized = _mongoid_expand_keys(criterion)
           clone.tap do |query|
-            unless Hash === criterion
-              raise Errors::InvalidQuery, "Expression must be a Hash: #{Errors::InvalidQuery.truncate_expr(criterion)}"
-            end
-            criterion.each do |field, value|
+            normalized.each do |field, value|
               field_s = field.to_s
               if field_s[0] == ?$
                 # Query expression-level operator, like $and or $where
                 query.add_operator_expression(field_s, value)
               else
-                exp_field, exp_value = expand_one_condition(field, value)
-                query.add_field_expression(exp_field, exp_value)
+                query.add_field_expression(field, value)
               end
             end
             query.reset_strategies!

data/lib/mongoid/document.rb

@@ -151,7 +151,7 @@ module Mongoid
     #
     # @since 2.4.0
     def to_key
-      (persisted? || destroyed?) ? [ id.to_s ] : nil
+      (persisted? || destroyed?) ? [ _id.to_s ] : nil
     end
 
     # Return an array with this +Document+ only in it.
@@ -273,20 +273,6 @@ module Mongoid
       @model_cache_key ||= self.class.model_name.cache_key
     end
 
-    # Implement this for calls to flatten on array.
-    #
-    # @example Get the document as an array.
-    #   document.to_ary
-    #
-    # @return [ nil ] Always nil.
-    #
-    # @since 2.1.0
-    def to_ary
-      nil
-    end
-
-    private
-
     def as_attributes
       return attributes if frozen?
       embedded_relations.each_pair do |name, meta|

data/lib/mongoid/errors/delete_restriction.rb

@@ -4,24 +4,23 @@
 module Mongoid
   module Errors
 
-    # This error is raised when calling #save! or .create! on a model when one
-    # of the callbacks returns false.
+    # This error is raised when attempting to destroy a model which has
+    # an association with dependency option set to restrict.
     class DeleteRestriction < MongoidError
 
       # Create the new callbacks error.
       #
-      # @example Create the new callbacks error.
-      #   Callbacks.new(Post, :create!)
-      #
-      # @param [ Class ] document
-      # @param [ Symbol ] association
+      # @param [ Document ] document The document that was attempted to be
+      #   destroyed.
+      # @param [ Symbol ] association_name The name of the dependent
+      #   association that prevents the document from being deleted.
       #
       # @since 3.0.0
-      def initialize(document, relation)
+      def initialize(document, association_name)
         super(
           compose_message(
             "delete_restriction",
-            { document: document.class, relation: relation }
+            { document: document.class, relation: association_name }
           )
         )
       end

data/lib/mongoid/errors/mongoid_error.rb

@@ -48,7 +48,7 @@ module Mongoid
       #
       # @return [ String ] A localized error message string.
       def translate(key, options)
-        ::I18n.translate("#{BASE_KEY}.#{key}", **options)
+        ::I18n.translate("#{BASE_KEY}.#{key}", options)
       end
 
       # Create the problem.

data/lib/mongoid/evolvable.rb

@@ -15,7 +15,7 @@ module Mongoid
     #
     # @since 3.0.0
     def __evolve_object_id__
-      id
+      _id
     end
   end
 end

data/lib/mongoid/extensions/boolean.rb

@@ -16,9 +16,8 @@ module Mongoid
       #
       # @since 3.0.0
       def mongoize(object)
-        ::Boolean.evolve(object)
+        evolve(object)
       end
-      alias :evolve :mongoize
     end
   end
 end

data/lib/mongoid/extensions/false_class.rb

@@ -28,7 +28,7 @@ module Mongoid
       #
       # @since 1.0.0
       def is_a?(other)
-        if other == ::Boolean || other.class == ::Boolean
+        if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true
         end
         super(other)

data/lib/mongoid/extensions/hash.rb

@@ -117,7 +117,7 @@ module Mongoid
       #
       # @since 3.0.2
       def delete_id
-        delete("_id") || delete("id") || delete(:id) || delete(:_id)
+        delete("_id") || delete(:_id) || delete("id") || delete(:id)
       end
 
       # Get the id attribute from this hash, whether it's prefixed with an
@@ -130,7 +130,7 @@ module Mongoid
       #
       # @since 2.3.2
       def extract_id
-        self["_id"] || self["id"] || self[:id] || self[:_id]
+        self["_id"] || self[:_id] || self["id"] || self[:id]
       end
 
       # Fetch a nested value via dot syntax.

data/lib/mongoid/extensions/true_class.rb

@@ -28,7 +28,7 @@ module Mongoid
       #
       # @since 1.0.0
       def is_a?(other)
-        if other == ::Boolean || other.class == ::Boolean
+        if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true
         end
         super(other)

data/lib/mongoid/fields.rb

@@ -13,6 +13,7 @@ module Mongoid
     extend ActiveSupport::Concern
 
     StringifiedSymbol = Mongoid::StringifiedSymbol
+    Boolean = Mongoid::Boolean
 
     # For fields defined with symbols use the correct class.
     #
@@ -37,10 +38,48 @@ module Mongoid
       time: Time
     }.with_indifferent_access
 
-    # Constant for all names of the id field in a document.
+    # Constant for all names of the _id field in a document.
     #
-    # @since 5.0.0
-    IDS = [ :_id, :id, '_id', 'id' ].freeze
+    # This does not include aliases of _id field.
+    #
+    # @api private
+    IDS = [ :_id, '_id', ].freeze
+
+    module ClassMethods
+      # Returns the list of id fields for this model class, as both strings
+      # and symbols.
+      #
+      # @return [ Array<Symbol | String> ] List of id fields.
+      #
+      # @api private
+      def id_fields
+        IDS.dup.tap do |id_fields|
+          aliased_fields.each do |k, v|
+            if v == '_id'
+              id_fields << k.to_sym
+              id_fields << k
+            end
+          end
+        end
+      end
+
+      # Extracts the id field from the specified attributes hash based on
+      # aliases defined in this class.
+      #
+      # @param [ Hash ] attributes The attributes to inspect.
+      #
+      # @return [ Object ] The id value.
+      #
+      # @api private
+      def extract_id_field(attributes)
+        id_fields.each do |k|
+          if v = attributes[k]
+            return v
+          end
+        end
+        nil
+      end
+    end
 
     included do
       class_attribute :aliased_fields
@@ -62,8 +101,7 @@ module Mongoid
         type: BSON::ObjectId
       )
 
-      alias :id :_id
-      alias :id= :_id=
+      alias_attribute(:id, :_id)
     end
 
     # Apply all default values to the document which are not procs.

data/lib/mongoid/inspectable.rb

@@ -20,7 +20,7 @@ module Mongoid
     def inspect
       inspection = []
       inspection.concat(inspect_fields).concat(inspect_dynamic_fields)
-      "#<#{self.class.name} _id: #{id}, #{inspection * ', '}>"
+      "#<#{self.class.name} _id: #{_id}, #{inspection * ', '}>"
     end
 
     private

data/lib/mongoid/matcher.rb

@@ -79,6 +79,11 @@ end
 
 require 'mongoid/matcher/all'
 require 'mongoid/matcher/and'
+require 'mongoid/matcher/bits'
+require 'mongoid/matcher/bits_all_clear'
+require 'mongoid/matcher/bits_all_set'
+require 'mongoid/matcher/bits_any_clear'
+require 'mongoid/matcher/bits_any_set'
 require 'mongoid/matcher/elem_match'
 require 'mongoid/matcher/elem_match_expression'
 require 'mongoid/matcher/eq'
@@ -92,6 +97,7 @@ require 'mongoid/matcher/gte'
 require 'mongoid/matcher/in'
 require 'mongoid/matcher/lt'
 require 'mongoid/matcher/lte'
+require 'mongoid/matcher/mod'
 require 'mongoid/matcher/ne'
 require 'mongoid/matcher/nin'
 require 'mongoid/matcher/nor'
@@ -99,5 +105,6 @@ require 'mongoid/matcher/not'
 require 'mongoid/matcher/or'
 require 'mongoid/matcher/regex'
 require 'mongoid/matcher/size'
+require 'mongoid/matcher/type'
 require 'mongoid/matcher/expression_operator'
 require 'mongoid/matcher/field_operator'

data/lib/mongoid/matcher/bits.rb

@@ -0,0 +1,41 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Bits
+      def matches?(exists, value, condition)
+        case value
+        when BSON::Binary
+          value = value.data.split('').map { |n| '%02x' % n.ord }.join.to_i(16)
+        end
+        case condition
+        when Array
+          array_matches?(value, condition)
+        when BSON::Binary
+          int_cond = condition.data.split('').map { |n| '%02x' % n.ord }.join.to_i(16)
+          int_matches?(value, int_cond)
+        when Integer
+          if condition < 0
+            raise Errors::InvalidQuery, "Invalid value for $#{operator_name} argument: negative integers are not allowed: #{condition}"
+          end
+          int_matches?(value, condition)
+        when Float
+          if (int_cond = condition.to_i).to_f == condition
+            if int_cond < 0
+              raise Errors::InvalidQuery, "Invalid value for $#{operator_name} argument: negative numbers are not allowed: #{condition}"
+            end
+            int_matches?(value, int_cond)
+          else
+            raise Errors::InvalidQuery, "Invalid type for $#{operator_name} argument: not representable as an integer: #{condition}"
+          end
+        else
+          raise Errors::InvalidQuery, "Invalid type for $#{operator_name} argument: #{condition}"
+        end
+      end
+
+      module_function def operator_name
+        name.sub(/.*::/, '').sub(/\A(.)/) { |l| l.downcase }
+      end
+    end
+  end
+end