mongoid 7.2.1 → 9.0.0

data/lib/mongoid/matcher/nin.rb

@@ -1,8 +1,23 @@
+# rubocop:todo all
 module Mongoid
   module Matcher
 
+    # In-memory matcher for $nin expression.
+    #
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/nin/
+    #
     # @api private
     module Nin
+
+      # Returns whether a value satisfies a $nin expression.
+      #
+      # @param [ true | false ] exists Whether the value exists.
+      # @param [ Object ] value The value to check.
+      # @param [ Array<Object> ] condition The $nin condition predicate.
+      #
+      # @return [ true | false ] Whether the value matches.
+      #
+      # @api private
       module_function def matches?(exists, value, condition)
         !In.matches?(exists, value, condition)
       end

data/lib/mongoid/matcher/nor.rb

@@ -1,8 +1,22 @@
+# rubocop:todo all
 module Mongoid
   module Matcher
 
+    # In-memory matcher for $nor expression.
+    #
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/nor/
+    #
     # @api private
     module Nor
+
+      # Returns whether a document satisfies a $nor expression.
+      #
+      # @param [ Mongoid::Document ] document The document.
+      # @param [ Array<Hash> ] expr The $nor conditions.
+      #
+      # @return [ true | false ] Whether the document matches.
+      #
+      # @api private
       module_function def matches?(document, expr)
         unless expr.is_a?(Array)
           raise Errors::InvalidQuery, "$nor argument must be an array: #{Errors::InvalidQuery.truncate_expr(expr)}"

data/lib/mongoid/matcher/not.rb

@@ -1,8 +1,24 @@
+# rubocop:todo all
 module Mongoid
   module Matcher
 
+    # In-memory matcher for $not expression.
+    #
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/not/
+    #
     # @api private
     module Not
+
+      # Returns whether a value satisfies an $not expression.
+      #
+      # @param [ true | false ] exists Whether the value exists.
+      # @param [ Object ] value The value to check.
+      # @param [ Hash | Regexp | BSON::Regexp::Raw ] condition
+      #   The $not condition predicate.
+      #
+      # @return [ true | false ] Whether the value matches.
+      #
+      # @api private
       module_function def matches?(exists, value, condition)
         case condition
         when ::Regexp, BSON::Regexp::Raw

data/lib/mongoid/matcher/or.rb

@@ -1,8 +1,22 @@
+# rubocop:todo all
 module Mongoid
   module Matcher
 
+    # In-memory matcher for $or expression.
+    #
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/or/
+    #
     # @api private
     module Or
+
+      # Returns whether a document satisfies an $or expression.
+      #
+      # @param [ Mongoid::Document ] document The document.
+      # @param [ Array<Hash> ] expr The $or conditions.
+      #
+      # @return [ true | false ] Whether the document matches.
+      #
+      # @api private
       module_function def matches?(document, expr)
         unless expr.is_a?(Array)
           raise Errors::InvalidQuery, "$or argument must be an array: #{Errors::InvalidQuery.truncate_expr(expr)}"

data/lib/mongoid/matcher/regex.rb

@@ -1,8 +1,23 @@
+# rubocop:todo all
 module Mongoid
   module Matcher
 
+    # In-memory matcher for $regex expression.
+    #
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/regex/
+    #
     # @api private
     module Regex
+
+      # Returns whether a value satisfies a $regex expression.
+      #
+      # @param [ true | false ] exists Not used.
+      # @param [ String | Array<String> ] value The value to check.
+      # @param [ Regexp | BSON::Regexp::Raw ] condition The $regex condition.
+      #
+      # @return [ true | false ] Whether the value matches.
+      #
+      # @api private
       module_function def matches?(exists, value, condition)
         condition = case condition
         when Regexp
@@ -27,6 +42,15 @@ module Mongoid
         end
       end
 
+      # Returns whether an scalar or array value matches a Regexp.
+      #
+      # @param [ true | false ] exists Not used.
+      # @param [ String | Array<String> ] value The value to check.
+      # @param [ Regexp ] condition The Regexp condition.
+      #
+      # @return [ true | false ] Whether the value matches.
+      #
+      # @api private
       module_function def matches_array_or_scalar?(value, condition)
         if Array === value
           value.any? do |v|

data/lib/mongoid/matcher/size.rb

@@ -1,8 +1,24 @@
+# rubocop:todo all
 module Mongoid
   module Matcher
 
+    # In-memory matcher for $size expression.
+    #
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/size/
+    #
     # @api private
     module Size
+
+      # Returns whether a value satisfies a $size expression.
+      #
+      # @param [ true | false ] exists Not used.
+      # @param [ Numeric ] value The value to check.
+      # @param [ Integer | Array<Object> ] condition The $size condition
+      #   predicate, either a non-negative Integer or an Array to match size.
+      #
+      # @return [ true | false ] Whether the value matches.
+      #
+      # @api private
       module_function def matches?(exists, value, condition)
         case condition
         when Float

data/lib/mongoid/matcher/type.rb

@@ -0,0 +1,124 @@
+# rubocop:todo all
+module Mongoid
+  module Matcher
+
+    # In-memory matcher for $type expression.
+    #
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/type/
+    #
+    # @api private
+    module Type
+
+      # Returns whether a value satisfies a $type expression.
+      #
+      # @param [ true | false ] exists Whether the value exists.
+      # @param [ Object ] value The value to check.
+      # @param [ Integer | Array<Integer> ] condition The $type condition
+      #   predicate which corresponds to the BSON type enumeration.
+      #
+      # @return [ true | false ] Whether the value matches.
+      #
+      # @api private
+      module_function def matches?(exists, value, condition)
+        conditions = case condition
+        when Array
+          condition
+        when Integer
+          [condition]
+        else
+          raise Errors::InvalidQuery, "Unknown $type argument: #{condition}"
+        end
+        conditions.each do |condition|
+          if one_matches?(exists, value, condition)
+            return true
+          end
+        end
+        false
+      end
+
+      # Returns whether a value satisfies a single $type expression
+      # value.
+      #
+      # @param [ true | false ] exists Whether the value exists.
+      # @param [ Object ] value The value to check.
+      # @param [ Integer ] condition The $type condition predicate
+      #   which corresponds to the BSON type enumeration.
+      #
+      # @return [ true | false ] Whether the value matches.
+      #
+      # @api private
+      module_function def one_matches?(exists, value, condition)
+        case condition
+        when 1
+          # Double
+          Float === value
+        when 2
+          # String
+          String === value
+        when 3
+          # Object
+          Hash === value
+        when 4
+          # Array
+          Array === value
+        when 5
+          # Binary data
+          BSON::Binary === value
+        when 6
+          # Undefined
+          BSON::Undefined === value
+        when 7
+          # ObjectId
+          BSON::ObjectId === value
+        when 8
+          # Boolean
+          TrueClass === value || FalseClass === value
+        when 9
+          # Date
+          Date === value || Time === value || DateTime === value
+        when 10
+          # Null
+          exists && NilClass === value
+        when 11
+          # Regex
+          Regexp::Raw === value || ::Regexp === value
+        when 12
+          # DBPointer deprecated
+          BSON::DbPointer === value
+        when 13
+          # JavaScript
+          BSON::Code === value
+        when 14
+          # Symbol deprecated
+          Symbol === value || BSON::Symbol::Raw === value
+        when 15
+          # Javascript with code deprecated
+          BSON::CodeWithScope === value
+        when 16
+          # 32-bit int
+          BSON::Int32 === value || Integer === value && (-2**32..2**32-1).include?(value)
+        when 17
+          # Timestamp
+          BSON::Timestamp === value
+        when 18
+          # Long
+          BSON::Int64 === value ||
+            Integer === value &&
+              (-2**64..2**64-1).include?(value) &&
+              !(-2**32..2**32-1).include?(value)
+        when 19
+          # Decimal
+          BSON::Decimal128 === value
+        when -1
+          # minKey
+          BSON::MinKey === value
+        when 127
+          # maxKey
+          BSON::MaxKey === value
+        else
+          raise Errors::InvalidQuery, "Unknown $type argument: #{condition}"
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher.rb

@@ -1,8 +1,11 @@
+# rubocop:todo all
 module Mongoid
 
+  # Utility module containing methods which assist in performing
+  # in-memory matching of documents with MQL query expressions.
+  #
   # @api private
   module Matcher
-
     # Extracts field values in the document at the specified key.
     #
     # The document can be a Hash or a model instance.
@@ -24,85 +27,87 @@ module Mongoid
     #   an array of values of the `bar` field in each of the hashes in the
     #   `foo` array.
     #
-    # The return value is a two-element array. The first element is the value
-    # retrieved, or an array of values. The second element is a boolean flag
-    # indicating whether an array was expanded at any point during the key
-    # traversal (because the respective document field was an array).
+    # This method can return an individual field value in some document
+    # or an array of values from multiple documents. The array can be returned
+    # because a field value in the specified path is an array of primitive
+    # values (e.g. integers) or because a field value in the specified path
+    # is an array of documents (e.g. a one-to-many embedded association),
+    # in which case the leaf value may be a scalar for each individual document.
+    # If the leaf value is an array and a one-to-many association was traversed,
+    # the return value will be an array of arrays. Note that an individual
+    # field value can also be an array and this case is indistinguishable
+    # from and behaves identically to association traversal for the purposes
+    # of, for example, subsequent array element retrieval.
     #
     # @param [ Document | Hash ] document The document to extract from.
     # @param [ String ] key The key path to extract.
     #
-    # @return [ Array<true | false, Object | Array, true | false> ]
-    #   Whether the value existed in the document, the extracted value
-    #   and the array expansion flag.
+    # @return [ Object | Array ] Field value or values.
     module_function def extract_attribute(document, key)
       if document.respond_to?(:as_attributes, true)
         # If a document has hash fields, as_attributes would keep those fields
         # as Hash instances which do not offer indifferent access.
         # Convert to BSON::Document to get indifferent access on hash fields.
-        document = BSON::Document.new(document.send(:as_attributes))
+        document = document.send(:as_attributes)
       end
 
-      src = document
-      expanded = false
-      exists = true
+      current = [document]
 
       key.to_s.split('.').each do |field|
-        if (index = field.to_i).to_s == field
-          # Array indexing
-          if Array === src
-            exists = index < src.length
-            src = src[index]
-          else
-            # Trying to index something that is not an array
-            exists = false
-            src = nil
-          end
-        else
-          case src
-          when nil
-            exists = false
+        new = []
+        current.each do |doc|
+          case doc
           when Hash
-            exists = src.key?(field)
-            src = src[field]
+            actual_key = find_exact_key(doc, field)
+            if !actual_key.nil?
+              new << doc[actual_key]
+            end
           when Array
-            expanded = true
-            exists = false
-            new = []
-            src.each do |doc|
-              case doc
-              when Hash
-                if doc.key?(field)
-                  v = doc[field]
-                  case v
-                  when Array
-                    new += v
-                  else
-                    new += [v]
-                  end
-                  exists = true
+            if (index = field.to_i).to_s == field
+              if doc.length > index
+                new << doc[index]
+              end
+            end
+            doc.each do |subdoc|
+              if Hash === subdoc
+                actual_key = find_exact_key(subdoc, field)
+                if !actual_key.nil?
+                  new << subdoc[actual_key]
                 end
-              else
-                # Trying to hash index into a value that is not a hash
               end
             end
-            src = new
-          else
-            # Trying to descend into a field that is not a hash using
-            # dot notation.
-            exists = false
-            src = nil
           end
         end
+        current = new
+        break if current.empty?
       end
 
-      [exists, src, expanded]
+      current
+    end
+
+    # Indifferent string or symbol key lookup, returning the exact key.
+    #
+    # @param [ Hash ] hash The input hash.
+    # @param [ String | Symbol ] key The key to perform indifferent lookups with.
+    #
+    # @return [ String | Symbol | nil ] The exact key (with the correct type) that exists in the hash, or nil if the key does not exist.
+    module_function def find_exact_key(hash, key)
+      key_s = key.to_s
+      return key_s if hash.key?(key_s)
+
+      key_sym = key.to_sym
+      hash.key?(key_sym) ? key_sym : nil
     end
   end
 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'
@@ -116,6 +121,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'
@@ -123,5 +129,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/persistable/creatable.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Persistable
 
     # Defines behavior for persistence operations that create new documents.
-    #
-    # @since 4.0.0
     module Creatable
       extend ActiveSupport::Concern
 
@@ -19,8 +17,6 @@ module Mongoid
       # @param [ Hash ] options Options to pass to insert.
       #
       # @return [ Document ] The persisted document.
-      #
-      # @since 1.0.0
       def insert(options = {})
         prepare_insert(options) do
           if embedded?
@@ -41,8 +37,6 @@ module Mongoid
       #   document.inserts
       #
       # @return [ Hash ] The insert ops.
-      #
-      # @since 2.1.0
       def atomic_inserts
         { atomic_insert_modifier => { atomic_position => as_attributes }}
       end
@@ -55,8 +49,6 @@ module Mongoid
       #   document.insert_as_embedded
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def insert_as_embedded
         raise Errors::NoParent.new(self.class.name) unless _parent
         if _parent.new_record?
@@ -77,8 +69,6 @@ module Mongoid
       #   document.insert_as_root
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def insert_as_root
         collection.insert_one(as_attributes, session: _session)
       end
@@ -92,11 +82,10 @@ module Mongoid
       #   document.post_process_insert
       #
       # @return [ true ] true.
-      #
-      # @since 4.0.0
       def post_process_insert
         self.new_record = false
-        flag_children_persisted
+        remember_storage_options!
+        flag_descendants_persisted
         true
       end
 
@@ -112,18 +101,29 @@ module Mongoid
       # @param [ Hash ] options The options.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def prepare_insert(options = {})
+        raise Errors::ReadonlyDocument.new(self.class) if readonly? && !Mongoid.legacy_readonly
         return self if performing_validations?(options) &&
           invalid?(options[:context] || :create)
-        result = run_callbacks(:save) do
-          run_callbacks(:create) do
-            yield(self)
-            post_process_insert
+        ensure_client_compatibility!
+        run_callbacks(:commit, with_children: true, skip_if: -> { in_transaction? }) do
+          run_callbacks(:save, with_children: false) do
+            run_callbacks(:create, with_children: false) do
+              run_callbacks(:persist_parent, with_children: false) do
+                _mongoid_run_child_callbacks(:save) do
+                  _mongoid_run_child_callbacks(:create) do
+                    result = yield(self)
+                    if !result.is_a?(Document) || result.errors.empty?
+                      post_process_insert
+                      post_process_persist(result, options)
+                    end
+                  end
+                end
+              end
+            end
           end
         end
-        post_process_persist(result, options) and self
+        self
       end
 
       module ClassMethods
@@ -138,12 +138,10 @@ module Mongoid
         # @example Create multiple new documents.
         #   Person.create({ title: "Mr" }, { title: "Mrs" })
         #
-        # @param [ Hash, Array ] attributes The attributes to create with, or an
+        # @param [ Hash | Array ] attributes The attributes to create with, or an
         #   Array of multiple attributes for multiple documents.
         #
-        # @return [ Document, Array<Document> ] The newly created document(s).
-        #
-        # @since 1.0.0
+        # @return [ Document | Array<Document> ] The newly created document(s).
         def create(attributes = nil, &block)
           _creating do
             if attributes.is_a?(::Array)
@@ -167,12 +165,10 @@ module Mongoid
         # @example Create multiple new documents.
         #   Person.create!({ title: "Mr" }, { title: "Mrs" })
         #
-        # @param [ Hash, Array ] attributes The attributes to create with, or an
+        # @param [ Hash | Array ] attributes The attributes to create with, or an
         #   Array of multiple attributes for multiple documents.
         #
-        # @return [ Document, Array<Document> ] The newly created document(s).
-        #
-        # @since 1.0.0
+        # @return [ Document | Array<Document> ] The newly created document(s).
         def create!(attributes = nil, &block)
           _creating do
             if attributes.is_a?(::Array)

data/lib/mongoid/persistable/deletable.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Persistable
 
     # Defines behavior for persistence operations that delete documents.
-    #
-    # @since 4.0.0
     module Deletable
       extend ActiveSupport::Concern
 
@@ -15,13 +13,14 @@ module Mongoid
       # @example Remove the document.
       #   document.remove
       #
-      # @param [ Hash ] options Options to pass to remove.
+      # @param [ Hash ] options The options.
+      # @option options [ true | false ] :persist Whether to persist
+      #   the delete action.
+      # @option options [ true | false ] :suppress Whether to update
+      #   the parent document in-memory when deleting an embedded document.
       #
       # @return [ TrueClass ] True.
-      #
-      # @since 1.0.0
       def delete(options = {})
-        raise Errors::ReadonlyDocument.new(self.class) if readonly?
         prepare_delete do
           unless options[:persist] == false
             if embedded?
@@ -44,10 +43,8 @@ module Mongoid
       #   document.atomic_deletes
       #
       # @return [ Hash ] The atomic deletes.
-      #
-      # @since 4.0.0
       def atomic_deletes
-        { atomic_delete_modifier => { atomic_path => _index ? { "_id" => id } : true }}
+        { atomic_delete_modifier => { atomic_path => _index ? { "_id" => _id } : true }}
       end
 
       # Delete the embedded document.
@@ -60,8 +57,6 @@ module Mongoid
       # @param [ Hash ] options The deletion options.
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 4.0.0
       def delete_as_embedded(options = {})
         _parent.remove_child(self) if notifying_parent?(options)
         if _parent.persisted?
@@ -81,8 +76,6 @@ module Mongoid
       #   document.delete_as_root
       #
       # @return [ true ] If the document was removed.
-      #
-      # @since 4.0.0
       def delete_as_root
         collection.find(atomic_selector).delete_one(session: _session)
         true
@@ -97,9 +90,7 @@ module Mongoid
       #
       # @param [ Hash ] options The delete options.
       #
-      # @return [ true, false ] If the parent should be notified.
-      #
-      # @since 4.0.0
+      # @return [ true | false ] If the parent should be notified.
       def notifying_parent?(options = {})
         !options.delete(:suppress)
       end
@@ -113,11 +104,9 @@ module Mongoid
       #     collection.find(atomic_selector).remove
       #   end
       #
-      # @return [ Object ] The result of the block.
-      #
-      # @since 4.0.0
+      # @return [ true ] If the object was deleted successfully.
       def prepare_delete
-        return false unless catch(:abort) { apply_delete_dependencies! }
+        raise Errors::ReadonlyDocument.new(self.class) if readonly?
         yield(self)
         freeze
         self.destroyed = true
@@ -138,8 +127,6 @@ module Mongoid
         # @param [ Hash ] conditions Optional conditions to delete by.
         #
         # @return [ Integer ] The number of documents deleted.
-        #
-        # @since 1.0.0
         def delete_all(conditions = {})
           selector = hereditary? ? conditions.merge(discriminator_key.to_sym => discriminator_value) : conditions
           where(selector).delete