mongoid 7.1.11 → 7.2.0.rc1

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
@@ -585,7 +597,7 @@ module Mongoid
               end
               _mongoid_expand_keys(new_s).each do |k, v|
                 k = k.to_s
-                if c.selector[k] || k.start_with?('$')
+                if c.selector[k] || k[0] == ?$
                   c = c.send(:__multi__, [{'$nor' => [{k => v}]}], '$and')
                 else
                   if v.is_a?(Hash)
@@ -872,9 +884,12 @@ 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.start_with?('$')
+              if field_s[0] == ?$
                 # Query expression-level operator, like $and or $where
                 query.add_operator_expression(field_s, value)
               else

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,6 +123,10 @@ 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

@@ -38,7 +38,7 @@ module Mongoid
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field.start_with?('$')
+          if field[0] == ?$
             raise ArgumentError, "Field cannot be an operator (i.e. begin with $): #{field}"
           end
 
@@ -48,7 +48,7 @@ module Mongoid
             if value.is_a?(Hash) && selector[field].is_a?(Hash) &&
               value.keys.all? { |key|
                 key_s = key.to_s
-                key_s.start_with?('$') && !selector[field].key?(key_s)
+                key_s[0] == ?$ && !selector[field].key?(key_s)
               }
             then
               # Multiple operators can be combined on the same field by
@@ -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.
         #
@@ -185,7 +185,7 @@ module Mongoid
             raise ArgumentError, "Operator must be a string: #{operator}"
           end
 
-          unless operator.start_with?('$')
+          unless operator[0] == ?$
             raise ArgumentError, "Operator must begin with $: #{operator}"
           end
 
@@ -220,7 +220,7 @@ module Mongoid
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field.start_with?('$')
+          if field[0] == ?$
             add_operator_expression(field, value)
           else
             add_field_expression(field, value)

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
@@ -518,7 +568,7 @@ module Mongoid
     # @return [ Object ] The result of the method call.
     #
     # @since 1.0.0
-    ruby2_keywords def method_missing(name, *args, &block)
+    def method_missing(name, *args, &block)
       if klass.respond_to?(name)
         klass.send(:with_scope, self) do
           klass.send(name, *args, &block)
@@ -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/document.rb

@@ -194,8 +194,8 @@ module Mongoid
     #
     # @param [ Hash ] options The options.
     #
-    # @option options [ true, false ] :compact (Deprecated) Whether to include fields
-    #   with nil values in the json document.
+    # @option options [ true, false ] :compact Whether to include fields with
+    #   nil values in the json document.
     #
     # @return [ Hash ] The document as json.
     #
@@ -203,7 +203,6 @@ module Mongoid
     def as_json(options = nil)
       rv = super
       if options && options[:compact]
-        Mongoid.logger.warn('#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.')
         rv = rv.compact
       end
       rv
@@ -230,13 +229,12 @@ module Mongoid
       became = klass.new(clone_document)
       became._id = _id
       became.instance_variable_set(:@changed_attributes, changed_attributes)
-      new_errors = ActiveModel::Errors.new(became)
-      new_errors.copy!(errors)
-      became.instance_variable_set(:@errors, new_errors)
+      became.instance_variable_set(:@errors, ActiveModel::Errors.new(became))
+      became.errors.instance_variable_set(:@messages, errors.instance_variable_get(:@messages))
       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|
@@ -355,7 +353,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/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

data/lib/mongoid/errors/invalid_estimated_count_criteria.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+
+    class InvalidEstimatedCountCriteria < MongoidError
+
+      # Creates the exception raised when trying to call estimated_count
+      # on a filtered criteria.
+      #
+      # @param [ String ] class_name The klass of the criteria used to call
+      #                              estimated count.
+      #
+      # @api private
+      def initialize(class_name)
+        super(
+          compose_message(
+            "invalid_estimated_count_criteria",
+            { class_name: class_name }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_expression_operator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+
+    # Raised when invalid expression-level operator is passed to an
+    # embedded matcher.
+    class InvalidExpressionOperator < InvalidQuery
+
+      # Creates the exception.
+      #
+      # @param [ String ] operator The operator that was used.
+      #
+      # @api private
+      def initialize(operator)
+        @operator = operator
+        super(compose_message("invalid_expression_operator",
+          operator: operator,
+          valid_operators: "'$and', '$nor', '$or'",
+        ))
+      end
+
+      # @return [ String ] The operator that was used.
+      attr_reader :operator
+    end
+  end
+end

data/lib/mongoid/errors/invalid_field_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 an
+    # embedded matcher.
+    class InvalidFieldOperator < InvalidQuery
+
+      # @api private
+      VALID_OPERATORS = %w(
+        all elemMatch eq exists gt gte in lt lte ne nin not 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_field_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

data/lib/mongoid/errors/invalid_query.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+
+    # Raised when invalid query is passed to an embedded matcher, or an
+    # invalid query fragment is passed to the query builder (Criteria object).
+    class InvalidQuery < MongoidError
+
+      # Create the new invalid query error.
+      #
+      # @api private
+      def initialize(msg)
+        super
+      end
+
+      # Stringifies the argument using #inspect and truncates the result to
+      # about 100 characters.
+      #
+      # @param [ Object ] expr An expression to stringify and truncate.
+      #
+      # @api private
+      def self.truncate_expr(expr)
+        unless expr.is_a?(String)
+          expr = expr.inspect
+        end
+
+        if expr.length > 103
+          expr = if expr =~ /\A<#((?:.|\n)*)>\z/
+            "<##{expr.slice(0, 97)}...>"
+          else
+            expr.slice(0, 100) + '...'
+          end
+        end
+
+        expr
+      end
+    end
+  end
+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/errors.rb

@@ -8,10 +8,8 @@ require "mongoid/errors/criteria_argument_required"
 require "mongoid/errors/document_not_destroyed"
 require "mongoid/errors/document_not_found"
 require "mongoid/errors/eager_load"
-require "mongoid/errors/empty_config_file"
 require "mongoid/errors/in_memory_collation_not_supported"
 require "mongoid/errors/invalid_collection"
-require "mongoid/errors/invalid_config_file"
 require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_dependent_strategy"
 require "mongoid/errors/invalid_field"
@@ -22,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/factory.rb

@@ -7,10 +7,18 @@ module Mongoid
   module Factory
     extend self
 
+    # @deprecated
     TYPE = "_type".freeze
 
     # Builds a new +Document+ from the supplied attributes.
     #
+    # This method either instantiats klass or a descendant of klass if the attributes include
+    # klass' discriminator key.
+    #
+    # If the attributes contain the discriminator key (which is _type by default) and the
+    # discriminator value does not correspond to a descendant of klass then this method
+    # would create an instance of klass.
+    #
     # @example Build the document.
     #   Mongoid::Factory.build(Person, { "name" => "Durran" })
     #
@@ -20,9 +28,10 @@ module Mongoid
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = nil)
       attributes ||= {}
-      type = attributes[TYPE] || attributes[TYPE.to_sym]
-      if type && klass._types.include?(type)
-        type.constantize.new(attributes)
+      dvalue = attributes[klass.discriminator_key] || attributes[klass.discriminator_key.to_sym]
+      type = klass.get_discriminator_mapping(dvalue)
+      if type
+        type.new(attributes)
       else
         klass.new(attributes)
       end
@@ -31,6 +40,10 @@ module Mongoid
     # Builds a new +Document+ from the supplied attributes loaded from the
     # database.
     #
+    # If the attributes contain the discriminator key (which is _type by default) and the
+    # discriminator value does not correspond to a descendant of klass then this method
+    # raises an UnknownModel error.
+    #
     # If a criteria object is given, it is used in two ways:
     # 1. If the criteria has a list of fields specified via #only,
     #    only those fields are populated in the returned document.
@@ -54,7 +67,7 @@ module Mongoid
       if criteria
         selected_fields ||= criteria.options[:fields]
       end
-      type = (attributes || {})[TYPE]
+      type = (attributes || {})[klass.discriminator_key]
       if type.blank?
         obj = klass.instantiate(attributes, selected_fields)
         if criteria && criteria.association && criteria.parent_document
@@ -62,13 +75,17 @@ module Mongoid
         end
         obj
       else
-        camelized = type.camelize
+        constantized = klass.get_discriminator_mapping(type)
 
-        # Check if the class exists
-        begin
-          constantized = camelized.constantize
-        rescue NameError
-          raise Errors::UnknownModel.new(camelized, type)
+        unless constantized
+          camelized = type.camelize
+
+          # Check if the class exists
+          begin
+            constantized = camelized.constantize
+          rescue NameError
+            raise Errors::UnknownModel.new(camelized, type)
+          end
         end
 
         # Check if the class is a Document class