mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/errors/eager_load.rb

@@ -1,13 +1,11 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # This error is raised when attempting to eager load a many to many
     # relation.
     class EagerLoad < MongoidError
 
-      attr_reader :name
-
       # Create the new eager load error.
       #
       # @example Create the new eager load error.
@@ -17,8 +15,7 @@ module Mongoid #:nodoc
       #
       # @since 2.2.0
       def initialize(name)
-        @name = name
-        super(translate("eager_load", { :name => name }))
+        super(compose_message("eager_load", { name: name }))
       end
     end
   end

data/lib/mongoid/errors/invalid_collection.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 access a Mongo::Collection from an
     # embedded document.
@@ -10,7 +10,7 @@ module Mongoid #:nodoc
     class InvalidCollection < MongoidError
       def initialize(klass)
         super(
-          translate("invalid_collection", { :klass => klass.name })
+          compose_message("invalid_collection", { klass: klass.name })
         )
       end
     end

data/lib/mongoid/errors/invalid_config_option.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when a bad configuration option is attempted to be
+    # set.
+    class InvalidConfigOption < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   InvalidConfigOption.new(:name, [ :option ])
+      #
+      # @param [ Symbol, String ] name The attempted config option name.
+      #
+      # @since 3.0.0
+      def initialize(name)
+        super(
+          compose_message(
+            "invalid_config_option",
+            { name: name, options: Config.settings.keys.map(&:inspect).join(", ") }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_database.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # Raised when the database connection has not been set up properly, either
     # by attempting to set an object on the db that is not a +Mongo::DB+, or
@@ -11,7 +11,7 @@ module Mongoid #:nodoc
     class InvalidDatabase < MongoidError
       def initialize(database)
         super(
-          translate("invalid_database", { :name => database.class.name })
+          compose_message("invalid_database", { name: database.class.name })
         )
       end
     end

data/lib/mongoid/errors/invalid_field.rb

@@ -1,18 +1,64 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+module Mongoid
+  module Errors
 
     # This error is raised when trying to create a field that conflicts with
-    # a Mongoid internal attribute or method.
-    #
-    # @example Create the error.
-    #   InvalidField.new('collection')
+    # an already defined method.
     class InvalidField < MongoidError
-      def initialize(name)
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   InvalidField.new(person, :crazy_method_name)
+      #
+      # @param [ Class ] klass The document class.
+      # @param [ Symbol ] name The method name.
+      def initialize(klass, name)
         super(
-          translate("invalid_field", { :name => name })
+          compose_message(
+            "invalid_field",
+            {
+              name: name,
+              origin: origin(klass, name),
+              file: location(klass, name)[0],
+              line: location(klass, name)[1]
+            }
+          )
         )
       end
+
+      private
+
+      # Get the origin of the method.
+      #
+      # @example Get the originating class or module.
+      #   error.origin(Person, :crazy_method_name)
+      #
+      # @param [ Class ] klass The document class.
+      # @param [ Symbol ] name The method name.
+      #
+      # @return [ Class, Module ] The originating class or module.
+      #
+      # @since 3.0.0
+      def origin(klass, name)
+        klass.instance_method(name).owner
+      end
+
+      # Get the location of the method.
+      #
+      # @example Get the location of the method on the filesystem.
+      #   error.location(Person, :crazy_method_name)
+      #
+      # @param [ Class ] klass The document class.
+      # @param [ Symbol ] name The method name.
+      #
+      # @return [ Array<String, Integer> ] The location of the method.
+      #
+      # @since 3.0.0
+      def location(klass, name)
+        @location ||=
+          (klass.instance_method(name).source_location || [ "Unknown", 0 ])
+      end
     end
   end
 end

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