mongoid-multi-db 3.0.0

data/lib/mongoid/errors.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require "mongoid/errors/mongoid_error"
+require "mongoid/errors/callback"
+require "mongoid/errors/document_not_found"
+require "mongoid/errors/eager_load"
+require "mongoid/errors/invalid_collection"
+require "mongoid/errors/invalid_database"
+require "mongoid/errors/invalid_field"
+require "mongoid/errors/invalid_find"
+require "mongoid/errors/invalid_options"
+require "mongoid/errors/invalid_time"
+require "mongoid/errors/invalid_type"
+require "mongoid/errors/mixed_relations"
+require "mongoid/errors/too_many_nested_attribute_records"
+require "mongoid/errors/unsaved_document"
+require "mongoid/errors/unsupported_version"
+require "mongoid/errors/validations"

data/lib/mongoid/errors/callback.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # This error is raised when calling #save! or .create! on a model when one
+    # of the callbacks returns false.
+    class Callback < MongoidError
+
+      attr_reader :klass, :method
+
+      # 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)
+        @klass, @method = klass, method
+        super(translate("callbacks", { :klass => klass, :method => method }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/document_not_found.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # Raised when querying the database for a document by a specific id which
+    # does not exist. If multiple ids were passed then it will display all of
+    # those.
+    #
+    # @example Create the error.
+    #   DocumentNotFound.new(Person, ["1", "2"])
+    class DocumentNotFound < MongoidError
+
+      attr_reader :klass, :identifiers
+
+      def initialize(klass, ids)
+        @klass = klass
+        @identifiers = ids.is_a?(Array) ? ids.join(", ") : ids
+
+        super(
+          translate(
+            "document_not_found",
+            { :klass => klass.name, :identifiers => identifiers }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/eager_load.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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.
+      #   EagerLoad.new(:preferences)
+      #
+      # @param [ Symbol ] name The name of the relation.
+      #
+      # @since 2.2.0
+      def initialize(name)
+        @name = name
+        super(translate("eager_load", { :name => name }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_collection.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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(
+          translate("invalid_collection", { :klass => klass.name })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_database.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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
+    # not setting anything at all.
+    #
+    # @example Create the error.
+    #   InvalidDatabase.new("Not a DB")
+    class InvalidDatabase < MongoidError
+      def initialize(database)
+        super(
+          translate("invalid_database", { :name => database.class.name })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_field.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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')
+    class InvalidField < MongoidError
+      def initialize(name)
+        super(
+          translate("invalid_field", { :name => name })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_find.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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(translate("calling_document_find_with_nil_is_invalid", {}))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_options.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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(
+          translate(
+            "invalid_options",
+            { :name => name, :invalid => invalid, :valid => valid.join(', ') }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_time.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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.
+      #   InvalidTime.new("this is not a time")
+      #
+      # @param [ Object ] value The value that was attempted.
+      #
+      # @since 2.3.1
+      def initialize(value)
+        @value = value
+        super(translate("invalid_time", { :value => value }))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_type.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # Raised when trying to get or set a value for a defined field, where the
+    # type of the object does not match the defined field type.
+    #
+    # @example Create the error.
+    #   InvalidType.new(Array, "Not an Array")
+    class InvalidType < MongoidError
+      def initialize(klass, value)
+        super(
+          translate(
+            "invalid_type",
+            {
+              :klass => klass.name,
+              :other => value.class.name,
+              :value => value.inspect
+            }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/mixed_relations.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # This error is raised when trying to reference an embedded document from
+    # a document in another collection that is not it's 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
+
+      attr_reader :root_klass, :embedded_klass
+
+      def initialize(root_klass, embedded_klass)
+        @root_klass, @embedded_klass = root_klass, embedded_klass
+
+        super(
+          translate(
+            "mixed_relations",
+            { :root => root_klass, :embedded => embedded_klass }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/mongoid_error.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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"
+
+      # 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
+    end
+  end
+end

data/lib/mongoid/errors/too_many_nested_attribute_records.rb

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

data/lib/mongoid/errors/unsaved_document.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # 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(
+            "unsaved_document",
+            { :base => base.class.name, :document => document.class.name }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/unsupported_version.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # Raised when the database version is not supported by Mongoid.
+    #
+    # @example Create the error.
+    #   UnsupportedVersion.new(Mongo::ServerVersion.new("1.3.1"))
+    class UnsupportedVersion < MongoidError
+      def initialize(version)
+        super(
+          translate(
+            "unsupported_version",
+            { :version => version, :mongo_version => Mongoid::MONGODB_VERSION }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/validations.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Errors #:nodoc
+
+    # Raised when a persistence method ending in ! fails validation. The message
+    # will contain the full error messages from the +Document+ in question.
+    #
+    # @example Create the error.
+    #   Validations.new(person.errors)
+    class Validations < MongoidError
+      attr_reader :document
+      def initialize(document)
+        @document = document
+        super(
+          translate(
+            "validations",
+            { :errors => document.errors.full_messages.join(", ") }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/extensions.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+require "mongoid/extensions/array/deletion"
+require "mongoid/extensions/false_class/equality"
+require "mongoid/extensions/hash/criteria_helpers"
+require "mongoid/extensions/hash/scoping"
+require "mongoid/extensions/integer/checks"
+require "mongoid/extensions/nil/collectionization"
+require "mongoid/extensions/object/checks"
+require "mongoid/extensions/object/reflections"
+require "mongoid/extensions/object/substitutable"
+require "mongoid/extensions/object/yoda"
+require "mongoid/extensions/proc/scoping"
+require "mongoid/extensions/string/checks"
+require "mongoid/extensions/string/conversions"
+require "mongoid/extensions/string/inflections"
+require "mongoid/extensions/symbol/checks"
+require "mongoid/extensions/symbol/inflections"
+require "mongoid/extensions/true_class/equality"
+require "mongoid/extensions/object_id/conversions"
+
+class Array #:nodoc
+  include Mongoid::Extensions::Array::Deletion
+end
+
+class Binary; end #:nodoc:
+unless defined?(Boolean)
+  class Boolean; end
+end
+
+class FalseClass #:nodoc
+  include Mongoid::Extensions::FalseClass::Equality
+end
+
+class Hash #:nodoc
+  include Mongoid::Extensions::Hash::CriteriaHelpers
+  include Mongoid::Extensions::Hash::Scoping
+end
+
+class Integer #:nodoc
+  include Mongoid::Extensions::Integer::Checks
+end
+
+class NilClass #:nodoc
+  include Mongoid::Extensions::Nil::Collectionization
+end
+
+class Object #:nodoc:
+  include Mongoid::Extensions::Object::Checks
+  include Mongoid::Extensions::Object::Reflections
+  include Mongoid::Extensions::Object::Substitutable
+  include Mongoid::Extensions::Object::Yoda
+end
+
+class Proc #:nodoc:
+  include Mongoid::Extensions::Proc::Scoping
+end
+
+class String #:nodoc
+  include Mongoid::Extensions::String::Checks
+  include Mongoid::Extensions::String::Conversions
+  include Mongoid::Extensions::String::Inflections
+end
+
+class Symbol #:nodoc
+  remove_method :size if instance_methods.include? :size # temporal fix for ruby 1.9
+  include Mongoid::Extensions::Symbol::Checks
+  include Mongoid::Extensions::Symbol::Inflections
+end
+
+class TrueClass #:nodoc
+  include Mongoid::Extensions::TrueClass::Equality
+end
+
+class BSON::ObjectId #:nodoc
+  extend Mongoid::Extensions::ObjectId::Conversions
+  def as_json(options = nil)
+    to_s
+  end
+  def to_xml(options = nil)
+    ActiveSupport::XmlMini.to_tag(options[:root], self.to_s, options)
+  end
+end