mongoid 7.0.2 → 8.1.1

data/lib/mongoid/matcher/type.rb

@@ -0,0 +1,99 @@
+module Mongoid
+  module Matcher
+
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/type/
+    #
+    # @api private
+    module Type
+      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
+
+      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

@@ -0,0 +1,130 @@
+module Mongoid
+
+  # @api private
+  module Matcher
+    # Extracts field values in the document at the specified key.
+    #
+    # The document can be a Hash or a model instance.
+    #
+    # The key is a valid MongoDB dot notation key. The following use cases are
+    # supported:
+    #
+    # - Simple field traversal (`foo`) - retrieves the field `foo` in the
+    #   current document.
+    # - Hash/embedded document field traversal (`foo.bar`) - retrieves the
+    #   field `foo` in the current document, then retrieves the field `bar`
+    #   from the value of `foo`. Each path segment could descend into an
+    #   embedded document or a hash field.
+    # - Array element retrieval (`foo.N`) - retrieves the Nth array element
+    #   from the field `foo` which must be an array. N must be a non-negative
+    #   integer.
+    # - Array traversal (`foo.bar`) - if `foo` is an array field, and
+    #   the elements of `foo` are hashes or embedded documents, this returns
+    #   an array of values of the `bar` field in each of the hashes in the
+    #   `foo` 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 [ 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 = document.send(:as_attributes)
+      end
+
+      current = [document]
+
+      key.to_s.split('.').each do |field|
+        new = []
+        current.each do |doc|
+          case doc
+          when Hash
+            actual_key = find_exact_key(doc, field)
+            if !actual_key.nil?
+              new << doc[actual_key]
+            end
+          when Array
+            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
+              end
+            end
+          end
+        end
+        current = new
+        break if current.empty?
+      end
+
+      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'
+require 'mongoid/matcher/eq_impl'
+require 'mongoid/matcher/eq_impl_with_regexp'
+require 'mongoid/matcher/exists'
+require 'mongoid/matcher/expression'
+require 'mongoid/matcher/field_expression'
+require 'mongoid/matcher/gt'
+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'
+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,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that create new documents.
-    #
-    # @since 4.0.0
+    # Defines behavior for persistence operations that create new documents.
     module Creatable
       extend ActiveSupport::Concern
 
@@ -17,8 +16,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?
@@ -39,8 +36,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
@@ -53,8 +48,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?
@@ -75,8 +68,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
@@ -90,11 +81,9 @@ module Mongoid
       #   document.post_process_insert
       #
       # @return [ true ] true.
-      #
-      # @since 4.0.0
       def post_process_insert
         self.new_record = false
-        flag_children_persisted
+        flag_descendants_persisted
         true
       end
 
@@ -110,18 +99,26 @@ 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
+        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
-        post_process_persist(result, options) and self
+        self
       end
 
       module ClassMethods
@@ -136,12 +133,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)
@@ -165,12 +160,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,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that delete documents.
-    #
-    # @since 4.0.0
+    # Defines behavior for persistence operations that delete documents.
     module Deletable
       extend ActiveSupport::Concern
 
@@ -16,10 +15,7 @@ module Mongoid
       # @param [ Hash ] options Options to pass to remove.
       #
       # @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?
@@ -42,10 +38,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.
@@ -58,8 +52,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?
@@ -79,8 +71,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
@@ -95,9 +85,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
@@ -112,10 +100,8 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the block.
-      #
-      # @since 4.0.0
       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
@@ -136,10 +122,8 @@ 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(_type: name) : conditions
+          selector = hereditary? ? conditions.merge(discriminator_key.to_sym => discriminator_value) : conditions
           where(selector).delete
         end
       end

data/lib/mongoid/persistable/destroyable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that destroy documents.
-    #
-    # @since 4.0.0
+    # Defines behavior for persistence operations that destroy documents.
     module Destroyable
       extend ActiveSupport::Concern
 
@@ -15,19 +14,23 @@ module Mongoid
       #
       # @param [ Hash ] options Options to pass to destroy.
       #
-      # @return [ true, false ] True if successful, false if not.
-      #
-      # @since 1.0.0
+      # @return [ true | false ] True if successful, false if not.
       def destroy(options = nil)
         raise Errors::ReadonlyDocument.new(self.class) if readonly?
         self.flagged_for_destroy = true
-        result = run_callbacks(:destroy) { delete(options || {}) }
+        result = run_callbacks(:destroy) do
+          if catch(:abort) { apply_destroy_dependencies! }
+            delete(options || {})
+          else
+            false
+          end
+        end
         self.flagged_for_destroy = false
         result
       end
 
       def destroy!(options = {})
-        destroy || raise(Errors::DocumentNotDestroyed.new(id, self.class))
+        destroy || raise(Errors::DocumentNotDestroyed.new(_id, self.class))
       end
 
       module ClassMethods
@@ -45,8 +48,6 @@ module Mongoid
         # @param [ Hash ] conditions Optional conditions to destroy by.
         #
         # @return [ Integer ] The number of documents destroyed.
-        #
-        # @since 1.0.0
         def destroy_all(conditions = nil)
           where(conditions || {}).destroy
         end

data/lib/mongoid/persistable/incrementable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $inc operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $inc operations.
     module Incrementable
       extend ActiveSupport::Concern
 
@@ -18,14 +17,14 @@ module Mongoid
       # @param [ Hash ] increments The field/inc increment pairs.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def inc(increments)
         prepare_atomic_operation do |ops|
           process_atomic_operations(increments) do |field, value|
             increment = value.__to_inc__
             current = attributes[field]
-            attributes[field] = (current || 0) + increment
+            new_value = (current || 0) + increment
+            process_attribute field, new_value if executing_atomically?
+            attributes[field] = new_value
             ops[atomic_attribute_name(field)] = increment
           end
           { "$inc" => ops } unless ops.empty?

data/lib/mongoid/persistable/logical.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for logical bitwise operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for logical bitwise operations.
     module Logical
       extend ActiveSupport::Concern
 
@@ -17,8 +16,6 @@ module Mongoid
       # @param [ Hash ] operations The bitwise operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def bit(operations)
         prepare_atomic_operation do |ops|
           process_atomic_operations(operations) do |field, values|
@@ -27,6 +24,7 @@ module Mongoid
               value = value & val if op.to_s == "and"
               value = value | val if op.to_s == "or"
             end
+            process_attribute field, value if executing_atomically?
             attributes[field] = value
             ops[atomic_attribute_name(field)] = values
           end

data/lib/mongoid/persistable/poppable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $pop operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $pop operations.
     module Poppable
       extend ActiveSupport::Concern
 
@@ -22,8 +21,6 @@ module Mongoid
       # @param [ Hash ] pops The field/value pop operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def pop(pops)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pops) do |field, value|

data/lib/mongoid/persistable/pullable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $pull and $pullAll operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $pull and $pullAll operations.
     module Pullable
       extend ActiveSupport::Concern
 
@@ -18,8 +17,6 @@ module Mongoid
       # @param [ Hash ] pulls The field/value pull pairs.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def pull(pulls)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pulls) do |field, value|
@@ -38,8 +35,6 @@ module Mongoid
       # @param [ Hash ] pulls The pull all operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def pull_all(pulls)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pulls) do |field, value|

data/lib/mongoid/persistable/pushable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $push and $addToSet operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $push and $addToSet operations.
     module Pushable
       extend ActiveSupport::Concern
 
@@ -17,12 +16,16 @@ module Mongoid
       # @param [ Hash ] adds The field/value pairs to add.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def add_to_set(adds)
         prepare_atomic_operation do |ops|
           process_atomic_operations(adds) do |field, value|
-            existing = send(field) || (attributes[field] ||= [])
+            existing = send(field) || attributes[field]
+            if existing.nil?
+              attributes[field] = []
+              # Read the value out of attributes:
+              # https://jira.mongodb.org/browse/MONGOID-4874
+              existing = attributes[field]
+            end
             values = [ value ].flatten(1)
             values.each do |val|
               existing.push(val) unless existing.include?(val)
@@ -44,12 +47,13 @@ module Mongoid
       # @param [ Hash ] pushes The $push operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def push(pushes)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pushes) do |field, value|
-            existing = send(field) || (attributes[field] ||= [])
+            existing = send(field) || begin
+              attributes[field] ||= []
+              attributes[field]
+            end
             values = [ value ].flatten(1)
             values.each{ |val| existing.push(val) }
             ops[atomic_attribute_name(field)] = { "$each" => values }