mongoid 7.2.1 → 9.0.0

data/lib/mongoid/equality.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
 
   # 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.
     #
@@ -14,8 +17,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
@@ -26,42 +27,38 @@ module Mongoid
     # @example Compare for equality.
     #   document == other
     #
-    # @param [ Document, Object ] other The other object to compare with.
-    #
-    # @return [ true, false ] True if the ids are equal, false if not.
+    # @param [ Document | Object ] other The other object to compare with.
     #
-    # @since 1.0.0
+    # @return [ true | false ] True if the ids are equal, false if not.
     def ==(other)
       self.class == other.class &&
           attributes["_id"] == other.attributes["_id"]
     end
 
-    # 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.
-    #
-    # @since 1.0.0
-    def ===(other)
-      other.class == Class ? self.class === other : self == other
-    end
-
     # Delegates to ==. Used when needing checks in hashes.
     #
     # @example Perform equality checking.
     #   document.eql?(other)
     #
-    # @param [ Document, Object ] other The object to check against.
-    #
-    # @return [ true, false ] True if equal, false if not.
+    # @param [ Document | Object ] other The object to check against.
     #
-    # @since 1.0.0
+    # @return [ true | false ] True if equal, false if not.
     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)
+        other.is_a?(self)
+      end
+    end
   end
 end

data/lib/mongoid/errors/ambiguous_relationship.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
 
-    # This error is raised in case of an ambigous association.
+    # This error is raised in case of an ambiguous association.
     #
-    # @example An ambigous association.
+    # @example An ambiguous association.
     #   class Person
     #     include Mongoid::Document
     #
@@ -33,8 +33,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/attribute_not_loaded.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # Raised when attempting to read or write an attribute which has
+    # not been loaded. This can occur when using `.only` or `.without`
+    # query projection methods.
+    #
+    # @example Getting a field which has not been loaded.
+    #   Band.only(:name).first.label
+    #   #=> raises Mongoid::Errors::AttributeNotLoaded
+    #
+    # @example Setting a field which has not been loaded.
+    #   Band.without(:label).first.label = 'Sub Pop Records'
+    #   #=> raises Mongoid::Errors::AttributeNotLoaded
+    class AttributeNotLoaded < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   AttributeNotLoaded.new(Person, "title")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String | Symbol ] name The name of the attribute.
+      def initialize(klass, name)
+        super(
+          compose_message("attribute_not_loaded", { klass: klass.name, name: name })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/callback.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -15,8 +15,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/create_collection_failure.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # Raised when an attempt to create a collection failed.
+    class CreateCollectionFailure < MongoidError
+
+      # Instantiate the create collection error.
+      #
+      # @param [ String ] collection_name The name of the collection that
+      #   Mongoid failed to create.
+      # @param [ Hash ] collection_options The options that were used when
+      #   tried to create the collection.
+      # @param [ Mongo::Error::OperationFailure ] error The error raised when
+      #   tried to create the collection.
+      #
+      # @api private
+      def initialize(collection_name, collection_options, error)
+        super(
+            compose_message(
+                "create_collection_failure",
+                {
+                  collection_name: collection_name,
+                  collection_options: collection_options,
+                  error: "#{error.class}: #{error.message}"
+                }
+            )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/criteria_argument_required.rb

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

data/lib/mongoid/errors/delete_restriction.rb

@@ -1,27 +1,24 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 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 ] association
-      #
-      # @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

data/lib/mongoid/errors/document_not_destroyed.rb

@@ -1,24 +1,20 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 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,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -20,23 +20,25 @@ module Mongoid
       #   DocumentNotFound.new(Person, :ssn => "1234", :name => "Helen")
       #
       # @param [ Class ] klass The model class.
-      # @param [ Hash, Array, Object ] params The attributes or ids.
-      # @param [ Array ] unmatched The unmatched ids, if appropriate
+      # @param [ Hash | Array | Object ] params The attributes or ids.
+      # @param [ Array | Hash ] unmatched The unmatched ids, if appropriate. If
+      #   there is a shard key this will be a hash.
       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),
               attributes: params,
               total: total(params),
-              missing: missing(unmatched)
+              missing: missing(unmatched),
+              shard_key: shard_key(unmatched)
             }
           )
         )
@@ -49,14 +51,14 @@ module Mongoid
       # @example Get the missing string.
       #   error.missing(1)
       #
-      # @param [ Object, Array ] unmatched The ids that did not match.
+      # @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(", ")
+        elsif unmatched.is_a?(::Hash)
+          unmatched[:_id] || unmatched["_id"]
         else
           unmatched
         end
@@ -67,11 +69,9 @@ module Mongoid
       # @example Get the searched string.
       #   error.searched(1)
       #
-      # @param [ Object, Array ] params The ids that were searched for.
+      # @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(", ") + " ..."
@@ -85,11 +85,9 @@ module Mongoid
       # @example Get the total.
       #   error.total([ 1, 2, 3 ])
       #
-      # @param [ Object, Array ] params What was searched for.
+      # @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
@@ -100,12 +98,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/drop_collection_failure.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # Raised when an attempt to drop a collection failed.
+    class DropCollectionFailure < MongoidError
+
+      # Instantiate the drop collection error.
+      #
+      # @param [ String ] collection_name The name of the collection that
+      #   Mongoid failed to drop.
+      #
+      # @api private
+      def initialize(collection_name, collection_options, error)
+        super(
+            compose_message(
+                "drop_collection_failure",
+                {
+                  collection_name: collection_name
+                }
+            )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/empty_config_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+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/immutable_attribute.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting the change the value of an
+    # immutable attribute. For example, the _id attribute is immutable,
+    # and attempting to change it on a document that has already been
+    # persisted will result in this error.
+    class ImmutableAttribute < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   ImmutableAttribute.new(:_id, "1234")
+      #
+      # @param [ Symbol | String ] name The name of the attribute.
+      # @param [ Object ] value The attempted set value.
+      def initialize(name, value)
+        super(
+          compose_message("immutable_attribute", { name: name, value: value })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/in_memory_collation_not_supported.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -12,8 +12,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_async_query_executor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a bad async query executor option is attempted
+    # to be set.
+    class InvalidQueryExecutor < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ Symbol | String ] executor The attempted async query executor.
+      #
+      # @api private
+      def initialize(executor)
+        super(
+          compose_message(
+            "invalid_async_query_executor",
+            { executor: executor, options: [:immediate, :global_thread_pool] }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_auto_encryption_configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when automatic encryption configuration for a client
+    # is invalid.
+    class InvalidAutoEncryptionConfiguration < MongoidError
+
+      # Initialize the error.
+      #
+      # @param [ Symbol ] name The name of the client config.
+      def initialize(name, kms_provider = nil)
+        if kms_provider
+          super(
+            compose_message(
+              "invalid_auto_encryption_configuration_for_kms_provider",
+              { client: name, kms_provider: kms_provider }
+            )
+          )
+        else
+          super(
+            compose_message(
+              "invalid_auto_encryption_configuration",
+              { client: name }
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_collection.rb

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

data/lib/mongoid/errors/invalid_config_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+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,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -13,9 +13,7 @@ module Mongoid
       # @example Create the new error.
       #   InvalidConfigOption.new(:name, [ :option ])
       #
-      # @param [ Symbol, String ] name The attempted config option name.
-      #
-      # @since 3.0.0
+      # @param [ Symbol | String ] name The attempted config option name.
       def initialize(name)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_dependent_strategy.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -14,10 +14,8 @@ module Mongoid
       #
       # @param [ Mongoid::Association ] association The association for which this
       #   dependency is defined.
-      # @param [ Symbol, String ] invalid_strategy The attempted invalid strategy.
+      # @param [ Symbol | String ] invalid_strategy The attempted invalid strategy.
       # @param [ Array<Symbol> ] valid_strategies The valid strategies.
-      #
-      # @since 7.0.0
       def initialize(association, invalid_strategy, valid_strategies)
         super(
             compose_message(

data/lib/mongoid/errors/invalid_discriminator_key_target.rb

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

data/lib/mongoid/errors/invalid_dot_dollar_assignment.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to use the setter for a field that starts
+    # with a dollar sign ($) or contains a dot/period (.).
+    class InvalidDotDollarAssignment < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ Class ] klass The class of the document.
+      # @param [ Class ] attr The attribute attempted to be written.
+      #
+      # @api private
+      def initialize(klass, attr)
+        super(
+          compose_message("invalid_dot_dollar_assignment", { klass: klass, attr: attr })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_elem_match_operator.rb

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