mongoid 6.4.4 → 7.5.1

data/lib/mongoid/equality.rb

@@ -1,8 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module contains the behaviour of Mongoid's clone/dup of documents.
+  # This module contains the behavior of Mongoid's clone/dup of documents.
   module Equality
+    # Leave the current contents of this module outside of InstanceMethods
+    # to prevent cherry picking conflicts. For now...
+    extend ActiveSupport::Concern
 
     # Default comparison is via the string version of the id.
     #
@@ -12,8 +16,6 @@ module Mongoid
     # @param [ Document ] other The document to compare with.
     #
     # @return [ Integer ] -1, 0, 1.
-    #
-    # @since 1.0.0
     def <=>(other)
       attributes["_id"].to_s <=> other.attributes["_id"].to_s
     end
@@ -27,8 +29,6 @@ module Mongoid
     # @param [ Document, Object ] other The other object to compare with.
     #
     # @return [ true, false ] True if the ids are equal, false if not.
-    #
-    # @since 1.0.0
     def ==(other)
       self.class == other.class &&
           attributes["_id"] == other.attributes["_id"]
@@ -42,10 +42,12 @@ module Mongoid
     # @param [ Document, Object ] other The other object to compare with.
     #
     # @return [ true, false ] True if the classes are equal, false if not.
-    #
-    # @since 1.0.0
     def ===(other)
-      other.class == Class ? self.class === other : self == other
+      if Mongoid.legacy_triple_equals
+        other.class == Class ? self.class === other : self == other
+      else
+        super
+      end
     end
 
     # Delegates to ==. Used when needing checks in hashes.
@@ -56,11 +58,26 @@ module Mongoid
     # @param [ Document, Object ] other The object to check against.
     #
     # @return [ true, false ] True if equal, false if not.
-    #
-    # @since 1.0.0
     def eql?(other)
       self == (other)
     end
+
+    module ClassMethods
+      # Performs class equality checking.
+      #
+      # @example Compare the classes.
+      #   document === other
+      #
+      # @param [ Document, Object ] other The other object to compare with.
+      #
+      # @return [ true, false ] True if the classes are equal, false if not.
+      def ===(other)
+        if Mongoid.legacy_triple_equals
+          other.class == Class ? self <= other : other.is_a?(self)
+        else
+          other.is_a?(self)
+        end
+      end
+    end
   end
 end
-

data/lib/mongoid/errors/ambiguous_relationship.rb

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # This error is raised in case of an ambigous relationship.
+    # This error is raised in case of an ambiguous association.
     #
-    # @example An ambigous relationship.
+    # @example An ambiguous association.
     #   class Person
     #     include Mongoid::Document
     #
@@ -31,8 +32,6 @@ module Mongoid
       # @param [ Class ] inverse The inverse class.
       # @param [ Symbol ] name The relation name.
       # @param [ Array<Symbol> ] candidates The potential inverses.
-      #
-      # @since 3.0.0
       def initialize(klass, inverse, name, candidates)
         super(
           compose_message(

data/lib/mongoid/errors/callback.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -13,8 +14,6 @@ module Mongoid
       #
       # @param [ Class ] klass The class of the document.
       # @param [ Symbol ] method The name of the method.
-      #
-      # @since 2.2.0
       def initialize(klass, method)
         super(
           compose_message("callbacks", { klass: klass, method: method })

data/lib/mongoid/errors/criteria_argument_required.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a method on Criteria is given a nil argument.
+    class CriteriaArgumentRequired < MongoidError
+
+      # Creates the new exception instance.
+      #
+      # @api private
+      def initialize(query_method)
+        super(compose_message("criteria_argument_required",
+          query_method: query_method))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/delete_restriction.rb

@@ -1,29 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # This error is raised when calling #save! or .create! on a model when one
-    # of the callbacks returns false.
+    # This error is raised when attempting to destroy a model which has
+    # an association with dependency option set to restrict.
     class DeleteRestriction < MongoidError
 
       # Create the new callbacks error.
       #
-      # @example Create the new callbacks error.
-      #   Callbacks.new(Post, :create!)
-      #
-      # @param [ Class ] document
-      # @param [ Symbol ] relation
-      #
-      # @since 3.0.0
-      def initialize(document, relation)
+      # @param [ Document ] document The document that was attempted to be
+      #   destroyed.
+      # @param [ Symbol ] association_name The name of the dependent
+      #   association that prevents the document from being deleted.
+      def initialize(document, association_name)
         super(
           compose_message(
             "delete_restriction",
-            { document: document.class, relation: relation }
+            { document: document.class, relation: association_name }
           )
         )
       end
     end
   end
 end
-

data/lib/mongoid/errors/document_not_destroyed.rb

@@ -1,22 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # Raised when attempting to destroy a document that had destory callbacks
+    # Raised when attempting to destroy a document that had destroy callbacks
     # return false.
-    #
-    # @since 4.0.0
     class DocumentNotDestroyed < MongoidError
 
-      # Instnatiate the exception.
+      # Instantiate the exception.
       #
       # @example Create the error.
       #   DocumentNotDestroyed.new(Band)
       #
       # @param [ Object ] id The document id.
       # @param [ Class ] klass The document class.
-      #
-      # @since 4.0.0
       def initialize(id, klass)
         super(compose_message("document_not_destroyed", { id: id.inspect, klass: klass }))
       end

data/lib/mongoid/errors/document_not_found.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -22,13 +23,13 @@ module Mongoid
       # @param [ Array ] unmatched The unmatched ids, if appropriate
       def initialize(klass, params, unmatched = nil)
         if !unmatched && !params.is_a?(Hash)
-          unmatched = Array(params)
+          unmatched = Array(params) if params
         end
 
         @klass, @params = klass, params
         super(
           compose_message(
-            message_key(params),
+            message_key(params, unmatched),
             {
               klass: klass.name,
               searched: searched(params),
@@ -50,8 +51,6 @@ module Mongoid
       # @param [ Object, Array ] unmatched The ids that did not match.
       #
       # @return [ String ] The missing string.
-      #
-      # @since 3.0.0
       def missing(unmatched)
         if unmatched.is_a?(::Array)
           unmatched.join(", ")
@@ -68,8 +67,6 @@ module Mongoid
       # @param [ Object, Array ] params The ids that were searched for.
       #
       # @return [ String ] The searched string.
-      #
-      # @since 3.0.0
       def searched(params)
         if params.is_a?(::Array)
           params.take(3).join(", ") + " ..."
@@ -86,8 +83,6 @@ module Mongoid
       # @param [ Object, Array ] params What was searched for.
       #
       # @return [ Integer ] The total number.
-      #
-      # @since 3.0.0
       def total(params)
         params.is_a?(::Array) ? params.count : 1
       end
@@ -98,12 +93,27 @@ module Mongoid
       #   error.problem
       #
       # @return [ String ] The problem.
-      #
-      # @since 3.0.0
-      def message_key(params)
-        case params
-          when Hash then "document_with_attributes_not_found"
-          else "document_not_found"
+      def message_key(params, unmatched)
+        if !params && !unmatched
+          "no_documents_found"
+        elsif Hash === params
+          "document_with_attributes_not_found"
+        elsif Hash === unmatched && unmatched.size >= 2
+          "document_with_shard_key_not_found"
+        else
+          "document_not_found"
+        end
+      end
+
+      # Get the shard key from the unmatched hash.
+      #
+      # @return [ String ] the shard key and value.
+      def shard_key(unmatched)
+        if Hash === unmatched
+          h = unmatched.dup
+          h.delete("_id")
+          h.delete(:_id)
+          h.map{|k,v| "#{k}: #{v}" }.join(", ")
         end
       end
     end

data/lib/mongoid/errors/eager_load.rb

@@ -1,9 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
     # This error is raised when attempting to eager load a many to many
-    # relation.
+    # association.
+    #
+    # @deprecated No longer used by Mongoid per MONGOID-4841.
     class EagerLoad < MongoidError
 
       # Create the new eager load error.
@@ -11,9 +14,7 @@ module Mongoid
       # @example Create the new eager load error.
       #   EagerLoad.new(:preferences)
       #
-      # @param [ Symbol ] name The name of the relation.
-      #
-      # @since 2.2.0
+      # @param [ Symbol ] name The name of the association.
       def initialize(name)
         super(compose_message("eager_load", { name: name }))
       end

data/lib/mongoid/errors/empty_config_file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when an empty configuration file is attempted to be
+    # loaded.
+    class EmptyConfigFile < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ String ] path The path of the config file used.
+      #
+      # @api private
+      def initialize(path)
+        super(
+          compose_message(
+            "empty_config_file",
+            { path: path }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/in_memory_collation_not_supported.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -10,8 +11,6 @@ module Mongoid
       #
       # @example Create the new unsupported collation error.
       #   InMemoryCollationNotSupported.new
-      #
-      # @since 6.1.0
       def initialize
         super(compose_message("in_memory_collation_not_supported"))
       end

data/lib/mongoid/errors/invalid_collection.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 

data/lib/mongoid/errors/invalid_config_file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a bad configuration file is attempted to be
+    # loaded.
+    class InvalidConfigFile < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ String ] path The path of the config file used.
+      #
+      # @api private
+      def initialize(path)
+        super(
+          compose_message(
+            "invalid_config_file",
+            { path: path }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_config_option.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -12,8 +13,6 @@ module Mongoid
       #   InvalidConfigOption.new(:name, [ :option ])
       #
       # @param [ Symbol, String ] name The attempted config option name.
-      #
-      # @since 3.0.0
       def initialize(name)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_dependent_strategy.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when an invalid strategy is defined for an association dependency.
+    class InvalidDependentStrategy < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   InvalidDependentStrategy.new(association, invalid_strategy, valid_strategies)
+      #
+      # @param [ Mongoid::Association ] association The association for which this
+      #   dependency is defined.
+      # @param [ Symbol, String ] invalid_strategy The attempted invalid strategy.
+      # @param [ Array<Symbol> ] valid_strategies The valid strategies.
+      def initialize(association, invalid_strategy, valid_strategies)
+        super(
+            compose_message(
+                "invalid_dependent_strategy",
+                { association: association,
+                  invalid_strategy: invalid_strategy,
+                  valid_strategies: valid_strategies
+                }
+            )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_discriminator_key_target.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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,32 @@
+# frozen_string_literal: true
+
+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,25 @@
+# frozen_string_literal: true
+
+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,27 @@
+# frozen_string_literal: true
+
+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.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -38,8 +39,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ Class, Module ] The originating class or module.
-      #
-      # @since 3.0.0
       def origin(klass, name)
         klass.instance_method(name).owner
       end
@@ -53,8 +52,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ Array<String, Integer> ] The location of the method.
-      #
-      # @since 3.0.0
       def location(klass, name)
         @location ||=
           (klass.instance_method(name).source_location || [ "Unknown", 0 ])

data/lib/mongoid/errors/invalid_field_operator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+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_field_option.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -15,8 +16,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       # @param [ Symbol ] option The option name.
       # @param [ Array<Symbol> ] valid All the valid options.
-      #
-      # @since 3.0.0
       def initialize(klass, name, option, valid)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_find.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -9,8 +10,6 @@ module Mongoid
       #
       # @example Create the error.
       #   InvalidFind.new
-      #
-      # @since 2.2.0
       def initialize
         super(compose_message("calling_document_find_with_nil_is_invalid", {}))
       end

data/lib/mongoid/errors/invalid_includes.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -13,8 +14,6 @@ module Mongoid
       #
       # @param [ Class ] klass The model class.
       # @param [ Array<Object> ] args The arguments passed to the includes.
-      #
-      # @since 3.0.2
       def initialize(klass, args)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_index.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -13,8 +14,6 @@ module Mongoid
       # @param [ Class ] klass The model class.
       # @param [ Hash ] spec The invalid specification.
       # @param [ Hash ] options The invalid options.
-      #
-      # @since 3.0.0
       def initialize(klass, spec, options)
         super(
           compose_message(