mongoid 7.1.5 → 7.2.1

data/lib/mongoid/config.rb

@@ -32,6 +32,9 @@ module Mongoid
     # error.
     option :belongs_to_required_by_default, default: true
 
+    # Set the global discriminator key.
+    option :discriminator_key, default: "_type"
+
     # Raise an exception when a field is redefined.
     option :duplicate_fields_exception, default: false
 

data/lib/mongoid/contextual/mongo.rb

@@ -71,7 +71,26 @@ module Mongoid
       # @since 3.0.0
       def count(options = {}, &block)
         return super(&block) if block_given?
-        try_cache(:count) { view.count(options) }
+        try_cache(:count) { view.count_documents(options) }
+      end
+
+      # Get the estimated number of documents matching the query.
+      #
+      # Unlike count, estimated_count does not take a block because it is not
+      # traditionally defined (with a block) on Enumarable like count is.
+      #
+      # @example Get the estimated number of matching documents.
+      #   context.estimated_count
+      #
+      # @param [ Hash ] options The options, such as maxTimeMS to be factored
+      #   into the count.
+      #
+      # @return [ Integer ] The number of matches.
+      def estimated_count(options = {})
+        unless self.criteria.selector.empty?
+          raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass)
+        end
+        try_cache(:estimated_count) { view.estimated_document_count(options) }
       end
 
       # Delete all documents in the database that match the selector.
@@ -258,12 +277,12 @@ module Mongoid
         return documents.first if cached? && cache_loaded?
         try_cache(:first) do
           if sort = view.sort || ({ _id: 1 } unless opts[:id_sort] == :none)
-            if raw_doc = view.sort(sort).limit(-1).first
+            if raw_doc = view.sort(sort).limit(1).first
               doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           else
-            if raw_doc = view.limit(-1).first
+            if raw_doc = view.limit(1).first
               doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
@@ -372,7 +391,7 @@ module Mongoid
       def last(opts = {})
         try_cache(:last) do
           with_inverse_sorting(opts) do
-            if raw_doc = view.limit(-1).first
+            if raw_doc = view.limit(1).first
               doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end

data/lib/mongoid/copyable.rb

@@ -23,8 +23,12 @@ module Mongoid
       # elsewhere.
       attrs = clone_document.except("_id", "id")
       dynamic_attrs = {}
+      _attribute_names = self.attribute_names
       attrs.reject! do |attr_name, value|
-        dynamic_attrs.merge!(attr_name => value) unless self.attribute_names.include?(attr_name)
+        unless _attribute_names.include?(attr_name)
+          dynamic_attrs[attr_name] = value
+          true
+        end
       end
       self.class.new(attrs).tap do |object|
         dynamic_attrs.each do |attr_name, value|
@@ -76,8 +80,8 @@ module Mongoid
 
         if association.is_a?(Association::Embedded::EmbedsMany)
           attrs[association.key].each do |attr|
-            embedded_klass = if type = attr['_type']
-              type.constantize
+            embedded_klass = if type = attr[self.class.discriminator_key]
+              association.relation_class.get_discriminator_mapping(type) || association.relation_class
             else
               association.relation_class
             end

data/lib/mongoid/criteria.rb

@@ -20,9 +20,17 @@ module Mongoid
   # against the database.
   class Criteria
     include Enumerable
+
+    # @api private
+    alias :_enumerable_find :find
+
     include Contextual
     include Queryable
     include Findable
+
+    # @api private
+    alias :_findable_find :find
+
     include Inspectable
     include Includable
     include Marshalable
@@ -55,6 +63,48 @@ module Mongoid
       entries == other
     end
 
+    # Finds one or many documents given the provided _id values, or filters
+    # the documents in the current scope in the application process space
+    # after loading them if needed.
+    #
+    # If this method is not given a block, it delegates to +Findable#find+
+    # and finds one or many documents for the provided _id values.
+    #
+    # If this method is given a block, it delegates to +Enumerable#find+ and
+    # returns the first document of those found by the current Crieria object
+    # for which the block returns a truthy value.
+    #
+    # Note that the "default proc" argument of Enumerable is not specially
+    # treated by Mongoid - the decision between delegating to +Findable+ vs
+    # +Enumerable+ is made solely based on whether +find+ is passed a block.
+    #
+    # @example Finds a document by its _id, invokes Findable#find.
+    #   critera.find("1234")
+    #
+    # @example Finds the first matching document using a block, invokes Enumerable#find.
+    #   criteria.find { |item| item.name == "Depeche Mode" }
+    #
+    # @example Finds the first matching document using a block using the default Proc, invokes Enumerable#find.
+    #   criteria.find(-> { "Default Band" }) { |item| item.name == "Milwaukee Mode" }
+    #
+    # @example Tries to find a document whose _id is the stringification of the provided Proc, typically failing.
+    #   enumerator = criteria.find(-> { "Default Band" })
+    #
+    # @return [ Document | Array<Document> | nil ] A document or matching documents.
+    #
+    # @raise Errors::DocumentNotFound If the parameters were _id values and
+    #   not all documents are found and the +raise_not_found_error+
+    #   Mongoid configuration option is truthy.
+    #
+    # @see https://ruby-doc.org/core/Enumerable.html#method-i-find
+    def find(*args, &block)
+      if block_given?
+        _enumerable_find(*args, &block)
+      else
+        _findable_find(*args)
+      end
+    end
+
     # Needed to properly get a criteria back as json
     #
     # @example Get the criteria as json.
@@ -169,7 +219,7 @@ module Mongoid
     # @since 2.0.0
     def field_list
       if options[:fields]
-        options[:fields].keys.reject{ |key| key == "_type" }
+        options[:fields].keys.reject{ |key| key == klass.discriminator_key }
       else
         []
       end
@@ -292,7 +342,7 @@ module Mongoid
         args.unshift(:_id)
       end
       if klass.hereditary?
-        super(*args.push(:_type))
+        super(*args.push(klass.discriminator_key.to_sym))
       else
         super(*args)
       end
@@ -379,7 +429,7 @@ module Mongoid
     #
     # @return [ Criteria ] The cloned criteria.
     def type(types)
-      any_in(_type: Array(types))
+      any_in(self.discriminator_key.to_sym => Array(types))
     end
 
     # This is the general entry point for most MongoDB queries. This either
@@ -555,8 +605,8 @@ module Mongoid
     # @since 3.0.3
     def type_selectable?
       klass.hereditary? &&
-        !selector.keys.include?("_type") &&
-        !selector.keys.include?(:_type)
+        !selector.keys.include?(self.discriminator_key) &&
+        !selector.keys.include?(self.discriminator_key.to_sym)
     end
 
     # Get the selector for type selection.
@@ -572,9 +622,9 @@ module Mongoid
     def type_selection
       klasses = klass._types
       if klasses.size > 1
-        { _type: { "$in" => klass._types }}
+        { klass.discriminator_key.to_sym => { "$in" => klass._types }}
       else
-        { _type: klass._types[0] }
+        { klass.discriminator_key.to_sym => klass._types[0] }
       end
     end
 

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

@@ -33,7 +33,7 @@ module Mongoid
       #
       # A yet more more complex example is the following condition:
       #
-      #   Foo.geo_spacial(:boundary.intersects_point => [1, 10])
+      #   Foo.geo_spatial(:boundary.intersects_point => [1, 10])
       #
       # Processing this condition will cause a Key instance to be created as
       # follows:

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

@@ -237,9 +237,9 @@ module Mongoid
         # Similarly, this method should never need to expand a literal value
         # and an operator at the same time.
         #
-        # @param [ Hash ] Criteria including Key instances.
+        # @param [ Hash ] expr Criteria including Key instances.
         #
-        # @return [ Hash ] Expanded criteria.
+        # @return [ Hash ] The expanded criteria.
         private def _mongoid_expand_keys(expr)
           unless expr.is_a?(Hash)
             raise ArgumentError, 'Argument must be a Hash'

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

@@ -219,32 +219,44 @@ module Mongoid
         #   Source: https://docs.mongodb.com/manual/reference/operator/query/box/
         #
         # @example Add a geo intersect criterion for a line.
-        #   query.geo_spacial(:location.intersects_line => [[ 1, 10 ], [ 2, 10 ]])
+        #   query.geo_spatial(:location.intersects_line => [[ 1, 10 ], [ 2, 10 ]])
         #
         # @example Add a geo intersect criterion for a point.
-        #   query.geo_spacial(:location.intersects_point => [[ 1, 10 ]])
+        #   query.geo_spatial(:location.intersects_point => [[ 1, 10 ]])
         #
         # @example Add a geo intersect criterion for a polygon.
-        #   query.geo_spacial(:location.intersects_polygon => [[ 1, 10 ], [ 2, 10 ], [ 1, 10 ]])
+        #   query.geo_spatial(:location.intersects_polygon => [[ 1, 10 ], [ 2, 10 ], [ 1, 10 ]])
         #
         # @example Add a geo within criterion for a polygon.
-        #   query.geo_spacial(:location.within_polygon => [[ 1, 10 ], [ 2, 10 ], [ 1, 10 ]])
+        #   query.geo_spatial(:location.within_polygon => [[ 1, 10 ], [ 2, 10 ], [ 1, 10 ]])
         #
         # @example Add a geo within criterion for a box.
-        #   query.geo_spacial(:location.within_box => [[ 1, 10 ], [ 2, 10 ])
+        #   query.geo_spatial(:location.within_box => [[ 1, 10 ], [ 2, 10 ])
         #
         # @param [ Hash ] criterion The criterion.
         #
         # @return [ Selectable ] The cloned selectable.
+        def geo_spatial(criterion)
+          if criterion.nil?
+            raise Errors::CriteriaArgumentRequired, :geo_spatial
+          end
+
+          __merge__(criterion)
+        end
+
+        # Alias for +geo_spatial+.
         #
-        # @since 2.0.0
+        # @deprecated
         def geo_spacial(criterion)
+          # Duplicate method body so that we can raise this exception with
+          # geo_spacial as the indicated operator rather than geo_spatial.
           if criterion.nil?
             raise Errors::CriteriaArgumentRequired, :geo_spacial
           end
 
           __merge__(criterion)
         end
+
         key :intersects_line, :override, "$geoIntersects", "$geometry" do |value|
           { "type" => LINE_STRING, "coordinates" => value }
         end
@@ -872,6 +884,9 @@ module Mongoid
           end
 
           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|
               field_s = field.to_s
               if field_s[0] == ?$

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

@@ -84,16 +84,16 @@ module Mongoid
         # Evolves a multi-list selection, like an $and or $or criterion, and
         # performs the necessary serialization.
         #
-        # @api private
-        #
         # @example Evolve the multi-selection.
         #   selector.evolve_multi([{ field: "value" }])
         #
-        # @param [ Array<Hash> ] value The multi-selection.
+        # @param [ Array<Hash> ] specs The multi-selection.
         #
         # @return [ Array<Hash> ] The serialized values.
         #
         # @since 1.0.0
+        #
+        # @api private
         def evolve_multi(specs)
           unless specs.is_a?(Array)
             raise ArgumentError, "specs is not an array: #{specs.inspect}"
@@ -123,10 +123,6 @@ module Mongoid
               # {'foo' => {'$lt' => 5}}. This step should be done after all
               # value-based processing is complete.
               if key.is_a?(Key)
-                if serializer && evolved_value != value
-                  raise NotImplementedError, "This method is not prepared to handle key being a Key and serializer being not nil"
-                end
-
                 evolved_value = key.transform_value(evolved_value)
               end
 

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

@@ -74,7 +74,7 @@ module Mongoid
         #
         # This method takes the operator and the operator value expression
         # separately for callers' convenience. It can be considered to
-        # handle storing the hash `{operator => op_expr}`.
+        # handle storing the hash +{operator => op_expr}+.
         #
         # If the selector consists of a single condition which is the specified
         # operator (on the top level), the new condition given in op_expr is
@@ -115,7 +115,7 @@ module Mongoid
           end
 
           unless op_expr.is_a?(Array)
-            raise ArgumentError, "Operator value expression must be an array: #{op_expr}"
+            raise Errors::InvalidQuery, "#{operator} argument must be an array: #{Errors::InvalidQuery.truncate_expr(op_expr)}"
           end
 
           if selector.length == 1 && selector.keys.first == operator
@@ -141,7 +141,7 @@ module Mongoid
         #
         # This method takes the operator and the operator value expression
         # separately for callers' convenience. It can be considered to
-        # handle storing the hash `{operator => op_expr}`.
+        # handle storing the hash +{operator => op_expr}+.
         #
         # The operator value can be of any type.
         #

data/lib/mongoid/document.rb

@@ -229,12 +229,13 @@ module Mongoid
       became = klass.new(clone_document)
       became._id = _id
       became.instance_variable_set(:@changed_attributes, changed_attributes)
-      became.instance_variable_set(:@errors, ActiveModel::Errors.new(became))
-      became.errors.instance_variable_set(:@messages, errors.instance_variable_get(:@messages))
+      new_errors = ActiveModel::Errors.new(became)
+      new_errors.copy!(errors)
+      became.instance_variable_set(:@errors, new_errors)
       became.instance_variable_set(:@new_record, new_record?)
       became.instance_variable_set(:@destroyed, destroyed?)
-      became.changed_attributes["_type"] = self.class.to_s
-      became._type = klass.to_s
+      became.changed_attributes[klass.discriminator_key] = self.class.discriminator_value
+      became[klass.discriminator_key] = klass.discriminator_value
 
       # mark embedded docs as persisted
       embedded_relations.each_pair do |name, meta|
@@ -353,7 +354,19 @@ module Mongoid
       #
       # @since 1.0.0
       def _types
-        @_type ||= (descendants + [ self ]).uniq.map(&:to_s)
+        @_type ||= (descendants + [ self ]).uniq.map(&:discriminator_value)
+      end
+
+      # Clear the @_type cache. This is generally called when changing the discriminator
+      # key/value on a class.
+      #
+      # @example Get the types.
+      #   document._mongoid_clear_types
+      #
+      # @api private
+      def _mongoid_clear_types
+        @_type = nil
+        superclass._mongoid_clear_types if hereditary?
       end
 
       # Set the i18n scope to overwrite ActiveModel.

data/lib/mongoid/errors.rb

@@ -20,6 +20,13 @@ require "mongoid/errors/invalid_index"
 require "mongoid/errors/invalid_options"
 require "mongoid/errors/invalid_path"
 require "mongoid/errors/invalid_persistence_option"
+require "mongoid/errors/invalid_query"
+# Must be after invalid_query.
+require "mongoid/errors/invalid_discriminator_key_target"
+require "mongoid/errors/invalid_elem_match_operator"
+require "mongoid/errors/invalid_estimated_count_criteria"
+require "mongoid/errors/invalid_expression_operator"
+require "mongoid/errors/invalid_field_operator"
 require "mongoid/errors/invalid_relation"
 require "mongoid/errors/invalid_relation_option"
 require "mongoid/errors/invalid_scope"

data/lib/mongoid/errors/invalid_discriminator_key_target.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+
+    # Creates the exception raised when trying to set or get the 
+    # discriminator key on a child class.
+    #
+    # @param [ String ] class_name The class name.
+    # @param [ String ] operator The class' superclass.
+    #
+    # @api private
+    class InvalidDiscriminatorKeyTarget < MongoidError
+      def initialize(class_name, superclass)
+        super(
+          compose_message(
+            "invalid_discriminator_key_target",
+            { class_name: class_name, superclass: superclass }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_elem_match_operator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+
+    # Raised when invalid field-level operator is passed to the $elemMatch
+    # embedded matcher.
+    class InvalidElemMatchOperator < InvalidQuery
+
+      # @api private
+      VALID_OPERATORS = %w(
+        and all eq exists gt gte in lt lte ne nin nor not or regex size
+      ).freeze
+
+      # Creates the exception.
+      #
+      # @param [ String ] operator The operator that was used.
+      #
+      # @api private
+      def initialize(operator)
+        @operator = operator
+        super(compose_message("invalid_elem_match_operator",
+          operator: operator,
+          valid_operators: VALID_OPERATORS.map { |op| "'$#{op}'" }.join(', '),
+        ))
+      end
+
+      # @return [ String ] The operator that was used.
+      attr_reader :operator
+    end
+  end
+end