mongoid 2.4.10 → 3.0.0

data/lib/mongoid/errors/invalid_field_option.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to create a field that has an invalid
+    # option.
+    class InvalidFieldOption < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   InvalidFieldOption.new(Model, :name, :localized, [ :localize ])
+      #
+      # @param [ Class ] klass The document class.
+      # @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(
+            "invalid_field_option",
+            {
+              name: name,
+              klass: klass,
+              option: option,
+              valid: valid.join(", ")
+            }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_find.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Raised when invalid arguments are passed to #find.
     class InvalidFind < MongoidError
@@ -12,7 +12,7 @@ module Mongoid #:nodoc
       #
       # @since 2.2.0
       def initialize
-        super(translate("calling_document_find_with_nil_is_invalid", {}))
+        super(compose_message("calling_document_find_with_nil_is_invalid", {}))
       end
     end
   end

data/lib/mongoid/errors/invalid_index.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when an invalid index is defined.
+    class InvalidIndex < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   InvalidIndex.new(Band, name: 1)
+      #
+      # @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(
+            "invalid_index",
+            { klass: klass.name, spec: spec, options: options }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_options.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Raised when invalid options are passed to a relation macro.
     class InvalidOptions < MongoidError
@@ -17,9 +17,9 @@ module Mongoid #:nodoc
       # @since 2.1.0
       def initialize(name, invalid, valid)
         super(
-          translate(
+          compose_message(
             "invalid_options",
-            { :name => name, :invalid => invalid, :valid => valid.join(', ') }
+            { name: name, invalid: invalid, valid: valid.join(', ') }
           )
         )
       end

data/lib/mongoid/errors/invalid_scope.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when defining a scope of an invalid type.
+    class InvalidScope < MongoidError
+
+      # Create the error.
+      #
+      # @example Create the error.
+      #   InvalidScope.new(Band, {})
+      #
+      # @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 })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_set_polymorphic_relation.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+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
+    # first model.
+    #
+    # @example Invalid setting of a polymorphic relation.
+    #   class Face
+    #     include Mongoid::Document
+    #
+    #     has_one :left_eye, class_name: "Eye", as: :eyeable
+    #     has_one :right_eye, class_name: "Eye", as: :eyeable
+    #   end
+    #
+    #   class Eye
+    #     include Mongoid::Document
+    #
+    #     belongs_to :eyeable, polymorphic: true
+    #   end
+    #
+    #   eye = Eye.new
+    #   face = Face.new
+    #   eye.eyeable = face # Raises error
+
+    class InvalidSetPolymorphicRelation < MongoidError
+
+      # Create the new invalid set polymorphic relation error.
+      #
+      # @example Create the error.
+      #   InvalidSetPolymorphicRelation.new
+      def initialize(name, klass, other_klass)
+        super(compose_message("invalid_set_polymorphic_relation", { name: name, klass: klass, other_klass: other_klass }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_storage_options.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when options provided to :store_in are invalid.
+    class InvalidStorageOptions < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   InvalidStorageOptions.new(:collection_name)
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ Hash, String, Symbol ] options The provided options.
+      #
+      # @since 3.0.0
+      def initialize(klass, options)
+        super(
+          compose_message(
+            "invalid_storage_options",
+            { klass: klass, options: options }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_time.rb

@@ -1,13 +1,11 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # This exception is raised when a bad value is attempted to be converted to
     # a date or time.
     class InvalidTime < MongoidError
 
-      attr_reader :klass, :value
-
       # Create the new invalid date error.
       #
       # @example Create the new invalid date error.
@@ -17,8 +15,7 @@ module Mongoid #:nodoc
       #
       # @since 2.3.1
       def initialize(value)
-        @value = value
-        super(translate("invalid_time", { :value => value }))
+        super(compose_message("invalid_time", { value: value }))
       end
     end
   end

data/lib/mongoid/errors/inverse_not_found.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when no inverse_of definition can be found when needed.
+    class InverseNotFound < MongoidError
+
+      # Create then new error.
+      #
+      # @example Create the new error.
+      #   InverseNotFound.new(Town, :citizens, Person, :town_id)
+      #
+      # @param [ Class ] base The base class.
+      # @param [ Symbol ] name The name of the relation.
+      # @param [ Class ] The child class.
+      # @param [ Symbol ] inverse The attempted inverse key.
+      #
+      # @since 3.0.0
+      def initialize(base, name, klass, inverse)
+        super(
+          compose_message(
+            "inverse_not_found",
+            { base: base, name: name, klass: klass, inverse: inverse }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/mixed_relations.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # This error is raised when trying to reference an embedded document from
     # a document in another collection that is not it's parent.
@@ -19,16 +19,11 @@ module Mongoid #:nodoc
     #
     # @since 2.0.0
     class MixedRelations < MongoidError
-
-      attr_reader :root_klass, :embedded_klass
-
       def initialize(root_klass, embedded_klass)
-        @root_klass, @embedded_klass = root_klass, embedded_klass
-
         super(
-          translate(
+          compose_message(
             "mixed_relations",
-            { :root => root_klass, :embedded => embedded_klass }
+            { root: root_klass, embedded: embedded_klass }
           )
         )
       end

data/lib/mongoid/errors/mixed_session_configuration.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when a session configuration contains both a uri and
+    # other standard options.
+    class MixedSessionConfiguration < MongoidError
+
+      # Initialize the error.
+      #
+      # @example Initialize the error.
+      #   MixedSessionConfiguration.new(:name, {})
+      #
+      # @param [ Symbol ] name The name of the session config.
+      # @param [ Hash ] config The configuration options.
+      #
+      # @since 3.0.0
+      def initialize(name, config)
+        super(
+          compose_message(
+            "mixed_session_configuration",
+            { name: name, config: config }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/mongoid_error.rb

@@ -1,13 +1,28 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Default parent Mongoid error for all custom errors. This handles the base
     # key for the translations and provides the convenience method for
     # translating the messages.
     class MongoidError < StandardError
+
       BASE_KEY = "mongoid.errors.messages"
 
+      # Compose the message.
+      #
+      # @example Create the message
+      #   error.compose_message
+      #
+      # @return [ String ] The composed message.
+      #
+      # @since 3.0.0
+      def compose_message(key, attributes)
+        "\nProblem:\n  #{problem(key, attributes)}"+
+        "\nSummary:\n  #{summary(key, attributes)}"+
+        "\nResolution:\n  #{resolution(key, attributes)}"
+      end
+
       # Given the key of the specific error and the options hash, translate the
       # message.
       #
@@ -19,7 +34,43 @@ module Mongoid #:nodoc
       #
       # @return [ String ] A localized error message string.
       def translate(key, options)
-        ::I18n.translate("#{BASE_KEY}.#{key}", options)
+        ::I18n.translate("#{BASE_KEY}.#{key}", { locale: :en }.merge(options))
+      end
+
+      # Create the problem.
+      #
+      # @example Create the problem.
+      #   error.problem
+      #
+      # @return [ String ] The problem.
+      #
+      # @since 3.0.0
+      def problem(key, attributes)
+        translate("#{key}.message", attributes)
+      end
+
+      # Create the summary.
+      #
+      # @example Create the summary.
+      #   error.summary
+      #
+      # @return [ String ] The summary.
+      #
+      # @since 3.0.0
+      def summary(key, attributes)
+        translate("#{key}.summary", attributes)
+      end
+
+      # Create the resolution.
+      #
+      # @example Create the resolution.
+      #   error.resolution
+      #
+      # @return [ String ] The resolution.
+      #
+      # @since 3.0.0
+      def resolution(key, attributes)
+        translate("#{key}.resolution", attributes)
       end
     end
   end

data/lib/mongoid/errors/nested_attributes_metadata_not_found.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when metadata could not be found when defining
+    # nested attributes, or the name was incorrect.
+    class NestedAttributesMetadataNotFound < MongoidError
+
+      # Create the new metadata error.
+      #
+      # @example Create the new metadata error.
+      #   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
+      def initialize(klass, name)
+        super(
+          compose_message(
+            "nested_attributes_metadata_not_found",
+            { klass: klass, name: name }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_default_session.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when a default session is not defined.
+    class NoDefaultSession < MongoidError
+
+      # Create the new error with the defined session names.
+      #
+      # @example Create the new error.
+      #   NoDefaultSession.new([ :secondary ])
+      #
+      # @param [ Array<Symbol> ] keys The defined sessions.
+      #
+      # @since 3.0.0
+      def initialize(keys)
+        super(
+          compose_message("no_default_session", { keys: keys.join(", ") })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_environment.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Raised when trying to load configuration with no RACK_ENV set
     class NoEnvironment < MongoidError
@@ -12,7 +12,7 @@ module Mongoid #:nodoc
       #
       # @since 2.4.0
       def initialize
-        super(translate("no_environment", {}))
+        super(compose_message("no_environment", {}))
       end
     end
   end

data/lib/mongoid/errors/no_map_reduce_output.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when executing a map/reduce without specifying the output
+    # location.
+    class NoMapReduceOutput < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   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 })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_metadata.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Used when trying to persist data when metadata has not been set.
+    class NoMetadata < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   NoMetadata.new(Address)
+      #
+      # @param [ Class ] klass The document class.
+      #
+      # @since 3.0.0
+      def initialize(klass)
+        super(compose_message("no_metadata", { klass: klass }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_parent.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to persist an embedded document
+    # when there is no parent set.
+    class NoParent < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   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 })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_session_config.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting to create a new session that does
+    # not have a named configuration.
+    class NoSessionConfig < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   NoSessionConfig.new(:secondary)
+      #
+      # @param [ String, Symbol ] name The name of the session.
+      #
+      # @since 3.0.0
+      def initialize(name)
+        super(compose_message("no_session_config", { name: name }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_session_database.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when a session is configured without a database.
+    class NoSessionDatabase < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   NoSessionDatabase.new(:default, {}})
+      #
+      # @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(
+            "no_session_database",
+            { name: name, config: config }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_session_hosts.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when a session is configured without hosts.
+    class NoSessionHosts < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   NoSessionHosts.new(:default, {}})
+      #
+      # @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(
+            "no_session_hosts",
+            { name: name, config: config }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/no_sessions_config.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when no sessions exists in the database
+    # configuration.
+    class NoSessionsConfig < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   NoSessionsConfig.new
+      #
+      # @since 3.0.0
+      def initialize
+        super(compose_message("no_sessions_config", {}))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/readonly_attribute.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting the change the value of a readonly
+    # attribute after the document has been persisted.
+    class ReadonlyAttribute < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   ReadonlyAttribute.new(:title, "mr")
+      #
+      # @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 })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/scope_overwrite.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # This error is raised when trying to create a scope with an name already
     # taken by another scope or method
@@ -10,9 +10,9 @@ module Mongoid #:nodoc
     class ScopeOverwrite < MongoidError
       def initialize(model_name,scope_name)
         super(
-          translate(
+          compose_message(
             "scope_overwrite",
-            { :model_name => model_name, :scope_name => scope_name }
+            { model_name: model_name, scope_name: scope_name }
           )
         )
       end