mongoid_heroku_stable 4.0.0

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

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when invalid options are passed to a relation macro.
+    class InvalidOptions < MongoidError
+
+      # Instantiate the options error.
+      #
+      # @example Create the error.
+      #   InvalidOptions.new(:name, :polymorphic, [ :as ])
+      #
+      # @param [ Symbol ] name The name of the relation.
+      # @param [ Symbol ] invalid The invalid option.
+      # @param [ Array<Symbol> ] valid The allowed options.
+      #
+      # @since 2.1.0
+      def initialize(name, invalid, valid)
+        super(
+          compose_message(
+            "invalid_options",
+            { name: name, invalid: invalid, valid: valid.join(', ') }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_path.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Used when attempting to get embedded paths with incorrect root path set.
+    class InvalidPath < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   InvalidPath.new(Address)
+      #
+      # @param [ Class ] klass The document class.
+      #
+      # @since 3.0.14
+      def initialize(klass)
+        super(compose_message("invalid_path", { klass: klass }))
+      end
+    end
+  end
+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

@@ -0,0 +1,22 @@
+# encoding: utf-8
+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
+
+      # Create the new invalid date error.
+      #
+      # @example Create the new invalid date error.
+      #   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
+    end
+  end
+end

data/lib/mongoid/errors/invalid_value.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to set an attribute with an invalid value.
+    # For example when try to set an Array value to a Hash attribute.
+    #
+    class InvalidValue < MongoidError
+      def initialize(field_class, value_class)
+        super(
+          compose_message("invalid_value", { value_class: value_class, field_class: field_class  })
+        )
+      end
+    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

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to reference an embedded document from
+    # a document in another collection that is not its parent.
+    #
+    # @example An illegal reference to an embedded document.
+    #   class Post
+    #     include Mongoid::Document
+    #     references_many :addresses
+    #   end
+    #
+    #   class Address
+    #     include Mongoid::Document
+    #     embedded_in :person
+    #     referenced_in :post
+    #   end
+    #
+    # @since 2.0.0
+    class MixedRelations < MongoidError
+      def initialize(root_klass, embedded_klass)
+        super(
+          compose_message(
+            "mixed_relations",
+            { root: root_klass, embedded: embedded_klass }
+          )
+        )
+      end
+    end
+  end
+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

@@ -0,0 +1,92 @@
+# encoding: utf-8
+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)
+        @problem = problem(key, attributes)
+        @summary = summary(key, attributes)
+        @resolution = resolution(key, attributes)
+
+        "\nProblem:\n  #{@problem}"+
+        "\nSummary:\n  #{@summary}"+
+        "\nResolution:\n  #{@resolution}"
+      end
+
+      private
+
+      # Given the key of the specific error and the options hash, translate the
+      # message.
+      #
+      # @example Translate the message.
+      #   error.translate("errors", :key => value)
+      #
+      # @param [ String ] key The key of the error in the locales.
+      # @param [ Hash ] options The objects to pass to create the message.
+      #
+      # @return [ String ] A localized error message string.
+      def translate(key, options)
+        ::I18n.translate("#{BASE_KEY}.#{key}", options)
+      end
+
+      # Create the problem.
+      #
+      # @example Create the problem.
+      #   error.problem("error", {})
+      #
+      # @param [ String, Symbol ] key The error key.
+      # @param [ Hash ] attributes The attributes to interpolate.
+      #
+      # @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("error", {})
+      #
+      # @param [ String, Symbol ] key The error key.
+      # @param [ Hash ] attributes The attributes to interpolate.
+      #
+      # @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("error", {})
+      #
+      # @param [ String, Symbol ] key The error key.
+      # @param [ Hash ] attributes The attributes to interpolate.
+      #
+      # @return [ String ] The resolution.
+      #
+      # @since 3.0.0
+      def resolution(key, attributes)
+        translate("#{key}.resolution", attributes)
+      end
+    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