mongoid 7.0.12 → 7.3.3

data/lib/mongoid/matcher/field_operator.rb

@@ -0,0 +1,54 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module FieldOperator
+      MAP = {
+        '$all' => All,
+        '$bitsAllClear' => BitsAllClear,
+        '$bitsAllSet' => BitsAllSet,
+        '$bitsAnyClear' => BitsAnyClear,
+        '$bitsAnySet' => BitsAnySet,
+        '$elemMatch' => ElemMatch,
+        '$eq' => Eq,
+        '$exists' => Exists,
+        '$gt' => Gt,
+        '$gte' => Gte,
+        '$in' => In,
+        '$lt' => Lt,
+        '$lte' => Lte,
+        '$mod' => Mod,
+        '$nin' => Nin,
+        '$ne' => Ne,
+        '$not' => Not,
+        '$regex' => Regex,
+        '$size' => Size,
+        '$type' => Type,
+      }.freeze
+
+      module_function def get(op)
+        MAP.fetch(op)
+      rescue KeyError
+        raise Errors::InvalidFieldOperator.new(op)
+      end
+
+      module_function def apply_array_field_operator(exists, value, condition)
+        if Array === value
+          value.any? { |v| yield v }
+        else
+          yield value
+        end
+      end
+
+      module_function def apply_comparison_operator(operator, left, right)
+        left.send(operator, right)
+      rescue ArgumentError, NoMethodError, TypeError
+        # We silence bogus comparison attempts, e.g. number to string
+        # comparisons.
+        # Several different exceptions may be produced depending on the types
+        # involved.
+        false
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/gt.rb

@@ -0,0 +1,17 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Gt
+      module_function def matches?(exists, value, condition)
+        case condition
+        when Range
+          raise Errors::InvalidQuery, "$gt argument cannot be a Range: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+        FieldOperator.apply_array_field_operator(exists, value, condition) do |v|
+          FieldOperator.apply_comparison_operator(:>, v, condition)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/gte.rb

@@ -0,0 +1,17 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Gte
+      module_function def matches?(exists, value, condition)
+        case condition
+        when Range
+          raise Errors::InvalidQuery, "$gte argument cannot be a Range: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+        FieldOperator.apply_array_field_operator(exists, value, condition) do |v|
+          FieldOperator.apply_comparison_operator(:>=, v, condition)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/in.rb

@@ -0,0 +1,25 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module In
+      module_function def matches?(exists, value, condition)
+        unless Array === condition
+          raise Errors::InvalidQuery, "$in argument must be an array: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+        if Array === value
+          if value.any? { |v|
+            condition.any? do |c|
+              EqImplWithRegexp.matches?('$in', v, c)
+            end
+          } then
+            return true
+          end
+        end
+        condition.any? do |c|
+          EqImplWithRegexp.matches?('$in', value, c)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/lt.rb

@@ -0,0 +1,17 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Lt
+      module_function def matches?(exists, value, condition)
+        case condition
+        when Range
+          raise Errors::InvalidQuery, "$lt argument cannot be a Range: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+        FieldOperator.apply_array_field_operator(exists, value, condition) do |v|
+          FieldOperator.apply_comparison_operator(:<, v, condition)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/lte.rb

@@ -0,0 +1,17 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Lte
+      module_function def matches?(exists, value, condition)
+        case condition
+        when Range
+          raise Errors::InvalidQuery, "$lte argument cannot be a Range: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+        FieldOperator.apply_array_field_operator(exists, value, condition) do |v|
+          FieldOperator.apply_comparison_operator(:<=, v, condition)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/mod.rb

@@ -0,0 +1,17 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Mod
+      module_function def matches?(exists, value, condition)
+        unless Array === condition
+          raise Errors::InvalidQuery, "Unknown $mod argument #{condition}"
+        end
+        if condition.length != 2
+          raise Errors::InvalidQuery, "Malformed $mod argument #{condition}, should have 2 elements"
+        end
+        condition[1] == value%condition[0]
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/ne.rb

@@ -0,0 +1,16 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Ne
+      module_function def matches?(exists, value, condition)
+        case condition
+        when ::Regexp, BSON::Regexp::Raw
+          raise Errors::InvalidQuery, "'$ne' operator does not allow Regexp arguments: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+
+        !EqImpl.matches?(exists, value, condition, '$ne')
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/nin.rb

@@ -0,0 +1,11 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Nin
+      module_function def matches?(exists, value, condition)
+        !In.matches?(exists, value, condition)
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/nor.rb

@@ -0,0 +1,25 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Nor
+      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)}"
+        end
+
+        if expr.empty?
+          raise Errors::InvalidQuery, "$nor argument must be a non-empty array: #{Errors::InvalidQuery.truncate_expr(expr)}"
+        end
+
+        expr.each do |sub_expr|
+          if Expression.matches?(document, sub_expr)
+            return false
+          end
+        end
+
+        expr.any?
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/not.rb

@@ -0,0 +1,29 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Not
+      module_function def matches?(exists, value, condition)
+        case condition
+        when ::Regexp, BSON::Regexp::Raw
+          !Regex.matches?(exists, value, condition)
+        when Hash
+          if condition.empty?
+            raise Errors::InvalidQuery, "$not argument cannot be an empty hash: #{Errors::InvalidQuery.truncate_expr(condition)}"
+          end
+
+          condition.all? do |(k, cond_v)|
+            k = k.to_s
+            unless k.start_with?('$')
+              raise Errors::InvalidQuery, "$not arguments must be operators: #{Errors::InvalidQuery.truncate_expr(k)}"
+            end
+
+            !FieldOperator.get(k).matches?(exists, value, cond_v)
+          end
+        else
+          raise Errors::InvalidQuery, "$not argument must be a Hash or a regular expression: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/or.rb

@@ -0,0 +1,21 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Or
+      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)}"
+        end
+
+        if expr.empty?
+          raise Errors::InvalidQuery, "$or argument must be a non-empty array: #{Errors::InvalidQuery.truncate_expr(expr)}"
+        end
+
+        expr.any? do |sub_expr|
+          Expression.matches?(document, sub_expr)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/regex.rb

@@ -0,0 +1,41 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Regex
+      module_function def matches?(exists, value, condition)
+        condition = case condition
+        when Regexp
+          condition
+        when BSON::Regexp::Raw
+          condition.compile
+        else
+          # Note that strings must have been converted to a regular expression
+          # instance already (with $options taken into account, if provided).
+          raise Errors::InvalidQuery, "$regex requires a regular expression argument: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+
+        case value
+        when Array
+          value.any? do |v|
+            v =~ condition
+          end
+        when String
+          value =~ condition
+        else
+          false
+        end
+      end
+
+      module_function def matches_array_or_scalar?(value, condition)
+        if Array === value
+          value.any? do |v|
+            matches?(true, v, condition)
+          end
+        else
+          matches?(true, value, condition)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/size.rb

@@ -0,0 +1,26 @@
+module Mongoid
+  module Matcher
+
+    # @api private
+    module Size
+      module_function def matches?(exists, value, condition)
+        case condition
+        when Float
+          raise Errors::InvalidQuery, "$size argument must be a non-negative integer: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        when Numeric
+          if condition < 0
+            raise Errors::InvalidQuery, "$size argument must be a non-negative integer: #{Errors::InvalidQuery.truncate_expr(condition)}"
+          end
+        else
+          raise Errors::InvalidQuery, "$size argument must be a non-negative integer: #{Errors::InvalidQuery.truncate_expr(condition)}"
+        end
+
+        if Array === value
+          value.length == condition
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/matcher/type.rb

@@ -0,0 +1,99 @@
+module Mongoid
+  module Matcher
+
+    # @see https://docs.mongodb.com/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,110 @@
+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.
+    #
+    # 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).
+    #
+    # @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.
+    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))
+      end
+
+      current = [document]
+
+      key.to_s.split('.').each do |field|
+        new = []
+        current.each do |doc|
+          case doc
+          when Hash
+            if doc.key?(field)
+              new << doc[field]
+            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
+                if subdoc.key?(field)
+                  new << subdoc[field]
+                end
+              end
+            end
+          end
+        end
+        current = new
+        break if current.empty?
+      end
+
+      current
+    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,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that create new documents.
+    # Defines behavior for persistence operations that create new documents.
     #
     # @since 4.0.0
     module Creatable

data/lib/mongoid/persistable/deletable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that delete documents.
+    # Defines behavior for persistence operations that delete documents.
     #
     # @since 4.0.0
     module Deletable
@@ -45,7 +47,7 @@ module Mongoid
       #
       # @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.
@@ -115,7 +117,6 @@ module Mongoid
       #
       # @since 4.0.0
       def prepare_delete
-        return false unless catch(:abort) { apply_delete_dependencies! }
         yield(self)
         freeze
         self.destroyed = true
@@ -139,7 +140,7 @@ module Mongoid
         #
         # @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,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that destroy documents.
+    # Defines behavior for persistence operations that destroy documents.
     #
     # @since 4.0.0
     module Destroyable
@@ -21,13 +23,19 @@ module Mongoid
       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

data/lib/mongoid/persistable/incrementable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $inc operations.
+    # Defines behavior for $inc operations.
     #
     # @since 4.0.0
     module Incrementable
@@ -25,7 +27,9 @@ module Mongoid
           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,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for logical bitwise operations.
+    # Defines behavior for logical bitwise operations.
     #
     # @since 4.0.0
     module Logical
@@ -27,6 +29,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