mongoid 2.8.1 → 3.0.0.rc

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_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

data/lib/mongoid/errors/too_many_nested_attribute_records.rb

@@ -1,5 +1,5 @@
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # This error is raised when trying to create set nested records above the
     # specified :limit
@@ -9,9 +9,9 @@ module Mongoid #:nodoc
     class TooManyNestedAttributeRecords < MongoidError
       def initialize(association, limit)
         super(
-          translate(
+          compose_message(
             "too_many_nested_attribute_records",
-            { :association => association, :limit => limit }
+            { association: association, limit: limit }
           )
         )
       end

data/lib/mongoid/errors/unknown_attribute.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to set a value in Mongoid that is not
+    # already set with dynamic attributes or the field is not defined.
+    class UnknownAttribute < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   UnknownAttribute.new(Person, "gender")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String, Symbol ] name The name of the attribute.
+      #
+      # @since 3.0.0
+      def initialize(klass, name)
+        super(
+          compose_message("unknown_attribute", { klass: klass.name, name: name })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/unsaved_document.rb

@@ -1,20 +1,16 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+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.
     class UnsavedDocument < MongoidError
-
-      attr_reader :base, :document
-
       def initialize(base, document)
-        @base, @document = base, document
         super(
-          translate(
+          compose_message(
             "unsaved_document",
-            { :base => base.class.name, :document => document.class.name }
+            { base: base.class.name, document: document.class.name }
           )
         )
       end