mongoid 7.0.2 → 8.1.1

data/lib/mongoid/errors/invalid_persistence_option.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
     # Raised when invalid options are used to create a persistence context.
-    #
-    # @since 6.0.0
     class InvalidPersistenceOption < MongoidError
 
       # Instantiate the persistence context option error.
@@ -14,8 +13,6 @@ module Mongoid
       #
       # @param [ Symbol ] invalid The invalid option.
       # @param [ Array<Symbol> ] valid The allowed options.
-      #
-      # @since 6.0.0
       def initialize(invalid, valid)
         super(
             compose_message(

data/lib/mongoid/errors/invalid_query.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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/invalid_relation.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # This error is raised when trying to create a relation that conflicts with
+    # This error is raised when trying to create an association that conflicts with
     # an already defined method.
-    #
-    # @since 6.0.0
     class InvalidRelation < MongoidError
 
       # Create the new error.
@@ -39,14 +38,12 @@ module Mongoid
       # @param [ Class ] klass The document class.
       # @param [ Symbol ] name The method name.
       #
-      # @return [ Class, Module ] The originating class or module.
-      #
-      # @since 6.0.0
+      # @return [ Class | Module ] The originating class or module.
       def origin(klass, name)
         klass.instance_method(name).owner
       end
 
-      # Get the location of the relation definition.
+      # Get the location of the association definition.
       #
       # @example Get the location of the method on the filesystem.
       #   error.location(Person, :crazy_method_name)
@@ -55,8 +52,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ Array<String, Integer> ] The location of the method.
-      #
-      # @since 6.0.0
       def location(klass, name)
         @location ||=
             (klass.instance_method(name).source_location || [ "Unknown", 0 ])

data/lib/mongoid/errors/invalid_relation_option.rb

@@ -1,8 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # Raised when an option provided for a relation is invalid.
+    # Raised when an option provided for an association is invalid.
     class InvalidRelationOption < MongoidError
 
       # Create the new error.
@@ -11,11 +12,9 @@ module Mongoid
       #   InvalidRelationOption.new(Person, invalid_option: 'make_me_a_sandwich')
       #
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] name The relation name.
+      # @param [ String | Symbol ] name The association name.
       # @param [ Symbol ] option The invalid option.
       # @param [ Array<Symbol> ] valid_options The valid option.
-      #
-      # @since 3.0.0
       def initialize(klass, name, option, valid_options)
         super(
             compose_message(

data/lib/mongoid/errors/invalid_scope.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -12,8 +13,6 @@ module Mongoid
       #
       # @param [ Class ] klass The model class.
       # @param [ Object ] value The attempted scope value.
-      #
-      # @since 3.0.0
       def initialize(klass, value)
         super(
           compose_message("invalid_scope", { klass: klass, value: value })

data/lib/mongoid/errors/invalid_session_use.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
     # This error is raised when a session is attempted to be used with a model whose client cannot use it, if
     #   sessions are nested, or if the mongodb deployment doesn't support sessions.
-    #
-    # @since 6.4.0
     class InvalidSessionUse < MongoidError
 
       # Create the error.
@@ -13,9 +12,7 @@ module Mongoid
       # @example Create the error.
       #   InvalidSessionUse.new(:invalid_session_use)
       #
-      # @param [ :invalid_sesion_use, :invalid_session_nesting ] error_type The type of session misuse.
-      #
-      # @since 6.4.0
+      # @param [ :invalid_session_use | :invalid_session_nesting ] error_type The type of session misuse.
       def initialize(error_type)
         super(compose_message(error_type.to_s))
       end

data/lib/mongoid/errors/invalid_set_polymorphic_relation.rb

@@ -1,12 +1,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # Raised when trying to set a polymorphic "references in" relation to a
-    # model with multiple "references many/one" relations pointing to that
+    # Raised when trying to set a polymorphic "references in" association to a
+    # model with multiple "references many/one" associations pointing to that
     # first model.
     #
-    # @example Invalid setting of a polymorphic relation.
+    # @example Invalid setting of a polymorphic association.
     #   class Face
     #     include Mongoid::Document
     #
@@ -26,7 +27,7 @@ module Mongoid
 
     class InvalidSetPolymorphicRelation < MongoidError
 
-      # Create the new invalid set polymorphic relation error.
+      # Create the new invalid set polymorphic association error.
       #
       # @example Create the error.
       #   InvalidSetPolymorphicRelation.new

data/lib/mongoid/errors/invalid_storage_options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -11,9 +12,7 @@ module Mongoid
       #   InvalidStorageOptions.new(Person, invalid_option: 'name')
       #
       # @param [ Class ] klass The model class.
-      # @param [ Hash, String, Symbol ] options The provided options.
-      #
-      # @since 3.0.0
+      # @param [ Hash | String | Symbol ] options The provided options.
       def initialize(klass, options)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_storage_parent.rb

@@ -1,8 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
     # Raised when calling store_in in a sub-class of Mongoid::Document
+    #
+    # @deprecated
     class InvalidStorageParent < MongoidError
 
       # Create the new error.
@@ -11,8 +14,6 @@ module Mongoid
       #    InvalidStorageParent.new(Person)
       #
       # @param [ Class ] klass The model class.
-      #
-      # @since 4.0.0
       def initialize(klass)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_time.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -12,8 +13,6 @@ module Mongoid
       #   InvalidTime.new("this is not a time")
       #
       # @param [ Object ] value The value that was attempted.
-      #
-      # @since 2.3.1
       def initialize(value)
         super(compose_message("invalid_time", { value: value }))
       end

data/lib/mongoid/errors/inverse_not_found.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -11,11 +12,9 @@ module Mongoid
       #   InverseNotFound.new(Town, :citizens, Person, :town_id)
       #
       # @param [ Class ] base The base class.
-      # @param [ Symbol ] name The name of the relation.
+      # @param [ Symbol ] name The name of the association.
       # @param [ Class ] klass The child class.
       # @param [ Symbol ] inverse The attempted inverse key.
-      #
-      # @since 3.0.0
       def initialize(base, name, klass, inverse)
         super(
           compose_message(

data/lib/mongoid/errors/mixed_client_configuration.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -13,8 +14,6 @@ module Mongoid
       #
       # @param [ Symbol ] name The name of the client config.
       # @param [ Hash ] config The configuration options.
-      #
-      # @since 3.0.0
       def initialize(name, config)
         super(
           compose_message(

data/lib/mongoid/errors/mixed_relations.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -16,8 +17,6 @@ module Mongoid
     #     embedded_in :person
     #     referenced_in :post
     #   end
-    #
-    # @since 2.0.0
     class MixedRelations < MongoidError
       def initialize(root_klass, embedded_klass)
         super(

data/lib/mongoid/errors/mongoid_error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -17,8 +18,6 @@ module Mongoid
       #   error.compose_message
       #
       # @return [ String ] The composed message.
-      #
-      # @since 3.0.0
       def compose_message(key, attributes = {})
         @problem = translate_problem(key, attributes)
         @summary = translate_summary(key, attributes)
@@ -46,7 +45,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.
@@ -54,12 +53,10 @@ module Mongoid
       # @example Create the problem.
       #   error.problem("error", {})
       #
-      # @param [ String, Symbol ] key The error key.
+      # @param [ String | Symbol ] key The error key.
       # @param [ Hash ] attributes The attributes to interpolate.
       #
       # @return [ String ] The problem.
-      #
-      # @since 3.0.0
       def translate_problem(key, attributes)
         translate("#{key}.message", attributes)
       end
@@ -69,12 +66,10 @@ module Mongoid
       # @example Create the summary.
       #   error.summary("error", {})
       #
-      # @param [ String, Symbol ] key The error key.
+      # @param [ String | Symbol ] key The error key.
       # @param [ Hash ] attributes The attributes to interpolate.
       #
       # @return [ String ] The summary.
-      #
-      # @since 3.0.0
       def translate_summary(key, attributes)
         translate("#{key}.summary", attributes)
       end
@@ -84,12 +79,10 @@ module Mongoid
       # @example Create the resolution.
       #   error.resolution("error", {})
       #
-      # @param [ String, Symbol ] key The error key.
+      # @param [ String | Symbol ] key The error key.
       # @param [ Hash ] attributes The attributes to interpolate.
       #
       # @return [ String ] The resolution.
-      #
-      # @since 3.0.0
       def translate_resolution(key, attributes)
         translate("#{key}.resolution", attributes)
       end

data/lib/mongoid/errors/nested_attributes_metadata_not_found.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -12,9 +13,7 @@ module Mongoid
       #   NestedAttributesMetadataNotFound.new(klass, name)
       #
       # @param [ Class ] klass The class of the document.
-      # @param [ Symbol, String ] name The name of the relation
-      #
-      # @since 3.0.0
+      # @param [ Symbol | String ] name The name of the association
       def initialize(klass, name)
         super(
           compose_message(

data/lib/mongoid/errors/no_client_config.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -9,11 +10,9 @@ module Mongoid
       # Create the new error.
       #
       # @example Create the error.
-      #   NoClientConfig.new(:secondary)
-      #
-      # @param [ String, Symbol ] name The name of the client.
+      #   NoClientConfig.new(:analytics)
       #
-      # @since 3.0.0
+      # @param [ String | Symbol ] name The name of the client.
       def initialize(name)
         super(compose_message("no_client_config", { name: name }))
       end

data/lib/mongoid/errors/no_client_database.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -10,10 +11,8 @@ module Mongoid
       # @example Create the new error.
       #   NoClientDatabase.new(:default, {}})
       #
-      # @param [ Symbol, String ] name The db config key.
+      # @param [ Symbol | String ] name The db config key.
       # @param [ Hash ] config The hash configuration options.
-      #
-      # @since 3.0.0
       def initialize(name, config)
         super(
           compose_message(

data/lib/mongoid/errors/no_client_hosts.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -10,10 +11,8 @@ module Mongoid
       # @example Create the new error.
       #   NoClientHosts.new(:default, {}})
       #
-      # @param [ Symbol, String ] name The db config key.
+      # @param [ Symbol | String ] name The db config key.
       # @param [ Hash ] config The hash configuration options.
-      #
-      # @since 3.0.0
       def initialize(name, config)
         super(
           compose_message(

data/lib/mongoid/errors/no_clients_config.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 error.
       #   NoClientsConfig.new
-      #
-      # @since 3.0.0
       def initialize
         super(compose_message("no_clients_config", {}))
       end

data/lib/mongoid/errors/no_default_client.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -8,11 +9,9 @@ module Mongoid
       # Create the new error with the defined client names.
       #
       # @example Create the new error.
-      #   NoDefaultClient.new([ :secondary ])
+      #   NoDefaultClient.new([ :analytics ])
       #
       # @param [ Array<Symbol> ] keys The defined clients.
-      #
-      # @since 3.0.0
       def initialize(keys)
         super(
           compose_message("no_default_client", { keys: keys.join(", ") })

data/lib/mongoid/errors/no_environment.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 new no environment error.
       #   NoEnvironment.new
-      #
-      # @since 2.4.0
       def initialize
         super(compose_message("no_environment", {}))
       end

data/lib/mongoid/errors/no_map_reduce_output.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -12,8 +13,6 @@ module Mongoid
       #   NoMapReduceOutput.new({ map: "" })
       #
       # @param [ Hash ] command The map/reduce command.
-      #
-      # @since 3.0.0
       def initialize(command)
         super(
           compose_message("no_map_reduce_output", { command: command })

data/lib/mongoid/errors/no_metadata.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -11,8 +12,6 @@ module Mongoid
       #   NoMetadata.new(Address)
       #
       # @param [ Class ] klass The document class.
-      #
-      # @since 3.0.0
       def initialize(klass)
         super(compose_message("no_metadata", { klass: klass }))
       end

data/lib/mongoid/errors/no_parent.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -12,8 +13,6 @@ module Mongoid
       #   NoParent.new(klass)
       #
       # @param [ Class ] klass The class of the embedded document.
-      #
-      # @since 3.0.0
       def initialize(klass)
         super(
           compose_message("no_parent", { klass: klass })

data/lib/mongoid/errors/readonly_attribute.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -11,10 +12,8 @@ module Mongoid
       # @example Create the new error.
       #   ReadonlyAttribute.new(:title, "mr")
       #
-      # @param [ Symbol, String ] name The name of the attribute.
+      # @param [ Symbol | String ] name The name of the attribute.
       # @param [ Object ] value The attempted set value.
-      #
-      # @since 3.0.0
       def initialize(name, value)
         super(
           compose_message("readonly_attribute", { name: name, value: value })

data/lib/mongoid/errors/readonly_document.rb

@@ -1,21 +1,18 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
     # Raised when attempting to persist a document that was loaded from the
     # database with partial fields.
-    #
-    # @since 4.0.0
     class ReadonlyDocument < MongoidError
 
-      # Instnatiate the exception.
+      # Instantiate the exception.
       #
       # @example Create the error.
       #   ReadonlyDocument.new(Band)
       #
       # @param [ Class ] klass The document class.
-      #
-      # @since 4.0.0
       def initialize(klass)
         super(compose_message("readonly_document", { klass: klass }))
       end

data/lib/mongoid/errors/scope_overwrite.rb

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

data/lib/mongoid/errors/too_many_nested_attribute_records.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
-    # This error is raised when trying to create set nested records above the
+    # This error is raised when trying to create set nested documents above the
     # specified :limit
     #
     # @example Create the error.

data/lib/mongoid/errors/unknown_attribute.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -12,9 +13,7 @@ module Mongoid
       #   UnknownAttribute.new(Person, "gender")
       #
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] name The name of the attribute.
-      #
-      # @since 3.0.0
+      # @param [ String | Symbol ] name The name of the attribute.
       def initialize(klass, name)
         super(
           compose_message("unknown_attribute", { klass: klass.name, name: name })

data/lib/mongoid/errors/unknown_model.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
@@ -13,8 +14,6 @@ module Mongoid
       #
       # @param [ String ] klass The model class.
       # @param [ String ] value The value used to determine the (invalid) class.
-      #
-      # @since 7.0.0
       def initialize(klass, value)
         super(
             compose_message("unknown_model", { klass: klass, value: value })

data/lib/mongoid/errors/unsaved_document.rb

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Errors
 
     # Raised when attempting to call create or create! through a
     # references_many when the parent document has not been saved. This
-    # prevents the child from getting presisted and immediately being orphaned.
+    # prevents the child from getting persisted and immediately being orphaned.
     class UnsavedDocument < MongoidError
       def initialize(base, document)
         super(