mongoid_rails4 4.0.0

data/lib/mongoid/errors/ambiguous_relationship.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised in case of an ambigous relationship.
+    #
+    # @example An ambigous relationship.
+    #   class Person
+    #     include Mongoid::Document
+    #
+    #     has_many :invitations, inverse_of: :person
+    #     has_many :referred_invitations, class_name: "Invitation", inverse_of: :referred_by
+    #   end
+    #
+    #   class Invitation
+    #     include Mongoid::Document
+    #
+    #     belongs_to :person
+    #     belongs_to :referred_by, class_name: "Person"
+    #   end
+    class AmbiguousRelationship < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   AmbiguousRelationship.new(
+      #     Person, Drug, :person, [ :drugs, #   :evil_drugs ]
+      #   )
+      #
+      # @param [ Class ] klass The base class.
+      # @param [ Class ] inverse The inverse class.
+      # @param [ Symbol ] name The relation name.
+      # @param [ Array<Symbol> ] candidates The potential inverses.
+      #
+      # @since 3.0.0
+      def initialize(klass, inverse, name, candidates)
+        super(
+          compose_message(
+            "ambiguous_relationship",
+            {
+              klass: klass,
+              inverse: inverse,
+              name: name.inspect,
+              candidates: candidates.map(&:inspect).join(", ")
+            }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/callback.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when calling #save! or .create! on a model when one
+    # of the callbacks returns false.
+    class Callback < MongoidError
+
+      # Create the new callbacks error.
+      #
+      # @example Create the new callbacks error.
+      #   Callbacks.new(Post, :create!)
+      #
+      # @param [ Class ] klass The class of the document.
+      # @param [ Symbol ] method The name of the method.
+      #
+      # @since 2.2.0
+      def initialize(klass, method)
+        super(
+          compose_message("callbacks", { klass: klass, method: method })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/delete_restriction.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when calling #save! or .create! on a model when one
+    # of the callbacks returns false.
+    class DeleteRestriction < MongoidError
+
+      # Create the new callbacks error.
+      #
+      # @example Create the new callbacks error.
+      #   Callbacks.new(Post, :create!)
+      #
+      # @param [ Class ] klass The class of the document.
+      # @param [ Symbol ] method The name of the method.
+      #
+      # @since 3.0.0
+      def initialize(document, relation)
+        super(
+          compose_message(
+            "delete_restriction",
+            { document: document.class, relation: relation }
+          )
+        )
+      end
+    end
+  end
+end
+

data/lib/mongoid/errors/document_not_found.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when querying the database for a document by a specific id or by
+    # set of attributes which does not exist. If multiple ids were passed then
+    # it will display all of those.
+    class DocumentNotFound < MongoidError
+
+      attr_reader :klass, :params
+
+      # Create the new error.
+      #
+      # @example Create the error.
+      #   DocumentNotFound.new(Person, ["1", "2"])
+      #
+      # @example Create the error with attributes instead of ids
+      #   DocumentNotFound.new(Person, :ssn => "1234", :name => "Helen")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ Hash, Array, Object ] params The attributes or ids.
+      # @param [ Array ] unmatched The unmatched ids, if appropriate
+      def initialize(klass, params, unmatched = nil)
+        if !unmatched && !params.is_a?(Hash)
+          unmatched = Array(params)
+        end
+
+        @klass, @params = klass, params
+        super(
+          compose_message(
+            message_key(params),
+            {
+              klass: klass.name,
+              searched: searched(params),
+              attributes: params,
+              total: total(params),
+              missing: missing(unmatched)
+            }
+          )
+        )
+      end
+
+      private
+
+      # Get the string to display the document params that were unmatched.
+      #
+      # @example Get the missing string.
+      #   error.missing(1)
+      #
+      # @param [ Object, Array ] unmatched The ids that did not match.
+      #
+      # @return [ String ] The missing string.
+      #
+      # @since 3.0.0
+      def missing(unmatched)
+        if unmatched.is_a?(::Array)
+          unmatched.join(", ")
+        else
+          unmatched
+        end
+      end
+
+      # Get the string to display the document params that were searched for.
+      #
+      # @example Get the searched string.
+      #   error.searched(1)
+      #
+      # @param [ Object, Array ] params The ids that were searched for.
+      #
+      # @return [ String ] The searched string.
+      #
+      # @since 3.0.0
+      def searched(params)
+        if params.is_a?(::Array)
+          params.take(3).join(", ") + " ..."
+        else
+          params
+        end
+      end
+
+      # Get the total number of expected documents.
+      #
+      # @example Get the total.
+      #   error.total([ 1, 2, 3 ])
+      #
+      # @param [ Object, Array ] params What was searched for.
+      #
+      # @return [ Integer ] The total number.
+      #
+      # @since 3.0.0
+      def total(params)
+        params.is_a?(::Array) ? params.count : 1
+      end
+
+      # Create the problem.
+      #
+      # @example Create the problem.
+      #   error.problem
+      #
+      # @return [ String ] The problem.
+      #
+      # @since 3.0.0
+      def message_key(params)
+        case params
+          when Hash then "document_with_attributes_not_found"
+          else "document_not_found"
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/errors/eager_load.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting to eager load a many to many
+    # relation.
+    class EagerLoad < MongoidError
+
+      # Create the new eager load error.
+      #
+      # @example Create the new eager load error.
+      #   EagerLoad.new(:preferences)
+      #
+      # @param [ Symbol ] name The name of the relation.
+      #
+      # @since 2.2.0
+      def initialize(name)
+        super(compose_message("eager_load", { name: name }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_collection.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to access a Mongo::Collection from an
+    # embedded document.
+    #
+    # @example Create the error.
+    #   InvalidCollection.new(Address)
+    class InvalidCollection < MongoidError
+      def initialize(klass)
+        super(
+          compose_message("invalid_collection", { klass: klass.name })
+        )
+      end
+    end
+  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_field.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to create a field that conflicts with
+    # an already defined method.
+    class InvalidField < MongoidError
+
+      # 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(
+          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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # Raised when invalid arguments are passed to #find.
+    class InvalidFind < MongoidError
+
+      # Create the new invalid find error.
+      #
+      # @example Create the error.
+      #   InvalidFind.new
+      #
+      # @since 2.2.0
+      def initialize
+        super(compose_message("calling_document_find_with_nil_is_invalid", {}))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_includes.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when an invalid value is passed to an eager
+    # loading query.
+    class InvalidIncludes < MongoidError
+
+      # Initialize the error.
+      #
+      # @example Initialize the error.
+      #   InvalidIncludes.new(Band, [ :members ])
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ Array<Object> ] args The arguments passed to the includes.
+      #
+      # @since 3.0.2
+      def initialize(klass, args)
+        super(
+          compose_message(
+            "invalid_includes",
+            {
+              klass: klass.name,
+              args: args.map(&:inspect).join(", "),
+              relations: klass.relations.keys.map(&:inspect).join(", ")
+            }
+          )
+        )
+      end
+    end
+  end
+end