mongoid 2.8.1 → 3.0.0.rc

data/lib/mongoid/document.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
 
   # This is the base module for all domain objects that need to be persisted to
   # the database as documents.
@@ -17,6 +17,8 @@ module Mongoid #:nodoc:
     # @param [ Document ] other The document to compare with.
     #
     # @return [ Integer ] -1, 0, 1.
+    #
+    # @since 1.0.0
     def <=>(other)
       attributes["_id"].to_s <=> other.attributes["_id"].to_s
     end
@@ -30,6 +32,8 @@ module Mongoid #:nodoc:
     # @param [ Document, Object ] other The other object to compare with.
     #
     # @return [ true, false ] True if the ids are equal, false if not.
+    #
+    # @since 1.0.0
     def ==(other)
       self.class == other.class &&
         attributes["_id"] == other.attributes["_id"]
@@ -43,12 +47,10 @@ module Mongoid #:nodoc:
     # @param [ Document, Object ] other The other object to compare with.
     #
     # @return [ true, false ] True if the classes are equal, false if not.
+    #
+    # @since 1.0.0
     def ===(other)
-      if other.class == Class
-        self.class === other
-      else
-        id == other.id
-      end
+      other.class == Class ? self.class === other : self == other
     end
 
     # Delegates to ==. Used when needing checks in hashes.
@@ -59,6 +61,8 @@ module Mongoid #:nodoc:
     # @param [ Document, Object ] other The object to check against.
     #
     # @return [ true, false ] True if equal, false if not.
+    #
+    # @since 1.0.0
     def eql?(other)
       self == (other)
     end
@@ -72,7 +76,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.0.0
     def freeze
-      tap { |doc| doc.as_document.freeze }
+      as_document.freeze and self
     end
 
     # Checks if the document is frozen
@@ -87,8 +91,8 @@ module Mongoid #:nodoc:
       attributes.frozen?
     end
 
-    # Delegates to id in order to allow two records of the same type and id to
-    # work with something like:
+    # Delegates to identity in order to allow two records of the same identity
+    # to work with something like:
     #
     #   [ Person.find(1), Person.find(2), Person.find(3) ] &
     #   [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
@@ -96,19 +100,25 @@ module Mongoid #:nodoc:
     # @example Get the hash.
     #   document.hash
     #
-    # @return [ Integer ] The hash of the document's id.
+    # @return [ Integer ] The hash of the document's identity.
+    #
+    # @since 1.0.0
     def hash
-      attributes["_id"].hash
+      identity.hash
     end
 
-    # Generate an id for this +Document+.
+    # A Document's is identified absolutely by it's class and database id:
+    #
+    # Person.first.identity #=> [Person, BSON::ObjectId('4f775130a04745933a000003')]
+    #
+    # @example Get the identity
+    #   document.identity
     #
-    # @example Create the id.
-    #   person.identify
+    # @return [ Array ] An array containing [document.class, document.id]
     #
-    # @return [ BSON::ObjectId, String ] A newly created id.
-    def identify
-      Identity.new(self).create
+    # @since 3.0.0
+    def identity
+      [ self.class, self.id ]
     end
 
     # Instantiate a new +Document+, setting the Document's attributes if
@@ -126,19 +136,19 @@ module Mongoid #:nodoc:
     #   :as and :without_protection
     #
     # @return [ Document ] A new document.
+    #
+    # @since 1.0.0
     def initialize(attrs = nil, options = nil)
       _building do
         @new_record = true
         @attributes ||= {}
         options ||= {}
-        apply_non_proc_defaults
-        identify if using_object_ids?
-        process(attrs, options[:as] || :default, !options[:without_protection]) do
-          identify unless using_object_ids?
+        apply_pre_processed_defaults
+        process_attributes(attrs, options[:as] || :default, !options[:without_protection]) do
           yield(self) if block_given?
         end
-        apply_proc_defaults
-        run_callbacks(:initialize) { self }
+        apply_post_processed_defaults
+        run_callbacks(:initialize) if _initialize_callbacks.any?
       end
     end
 
@@ -151,11 +161,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.4.0
     def to_key
-      if destroyed?
-        [ id ]
-      else
-        persisted? ? [ id ] : nil
-      end
+      (persisted? || destroyed?) ? [ id ] : nil
     end
 
     # Return an array with this +Document+ only in it.
@@ -164,6 +170,8 @@ module Mongoid #:nodoc:
     #   document.to_a
     #
     # @return [ Array<Document> ] An array with the document as its only item.
+    #
+    # @since 1.0.0
     def to_a
       [ self ]
     end
@@ -176,16 +184,17 @@ module Mongoid #:nodoc:
     #   person.as_document
     #
     # @return [ Hash ] A hash of all attributes in the hierarchy.
+    #
+    # @since 1.0.0
     def as_document
-      attributes.tap do |attrs|
-        return attrs if frozen?
-        relations.each_pair do |name, meta|
-          if meta.embedded?
-            relation = send(name)
-            attrs[name] = relation.as_document unless relation.blank?
-          end
+      return attributes if frozen?
+      embedded_relations.each_pair do |name, meta|
+        without_autobuild do
+          relation = send(name)
+          attributes[meta.store_as] = relation.as_document unless relation.blank?
         end
       end
+      attributes
     end
 
     # Returns an instance of the specified class with the attributes
@@ -199,16 +208,18 @@ module Mongoid #:nodoc:
     # @param [ Class ] klass The class to become.
     #
     # @return [ Document ] An instance of the specified class.
+    #
+    # @since 2.0.0
     def becomes(klass)
       unless klass.include?(Mongoid::Document)
         raise ArgumentError, "A class which includes Mongoid::Document is expected"
       end
-      klass.instantiate(frozen? ? attributes.dup : attributes).tap do |became|
-        became.instance_variable_set(:@errors, errors)
-        became.instance_variable_set(:@new_record, new_record?)
-        became.instance_variable_set(:@destroyed, destroyed?)
-        became._type = klass.to_s
-      end
+      became = klass.instantiate(frozen? ? attributes.dup : attributes)
+      became.instance_variable_set(:@errors, errors)
+      became.instance_variable_set(:@new_record, new_record?)
+      became.instance_variable_set(:@destroyed, destroyed?)
+      became._type = klass.to_s
+      became
     end
 
     # Print out the cache key. This will append different values on the
@@ -228,7 +239,7 @@ module Mongoid #:nodoc:
     # @since 2.4.0
     def cache_key
       return "#{model_key}/new" if new_record?
-      return "#{model_key}/#{id}-#{updated_at.utc.to_s(:number)}" unless self[:updated_at].nil?
+      return "#{model_key}/#{id}-#{updated_at.utc.to_s(:number)}" if updated_at
       "#{model_key}/#{id}"
     end
 
@@ -267,7 +278,7 @@ module Mongoid #:nodoc:
       nil
     end
 
-    module ClassMethods #:nodoc:
+    module ClassMethods
 
       # Performs class equality checking.
       #
@@ -292,14 +303,16 @@ module Mongoid #:nodoc:
       # @param [ Hash ] attrs The hash of attributes to instantiate with.
       #
       # @return [ Document ] A new document.
+      #
+      # @since 1.0.0
       def instantiate(attrs = nil)
         attributes = attrs || {}
-        allocate.tap do |doc|
-          doc.instance_variable_set(:@attributes, attributes)
-          doc.apply_defaults
-          IdentityMap.set(doc) unless _loading_revision?
-          doc.run_callbacks(:initialize) { doc }
-        end
+        doc = allocate
+        doc.instance_variable_set(:@attributes, attributes)
+        doc.apply_defaults
+        IdentityMap.set(doc) unless _loading_revision?
+        doc.run_callbacks(:initialize) if doc._initialize_callbacks.any?
+        doc
       end
 
       # Returns all types to query for when using this class as the base.
@@ -308,13 +321,17 @@ module Mongoid #:nodoc:
       #   document._types
       #
       # @return [ Array<Class> ] All subclasses of the current document.
+      #
+      # @since 1.0.0
       def _types
-        @_type ||= [descendants + [self]].flatten.uniq.map { |t| t.to_s }
+        @_type ||= (descendants + [ self ]).uniq.map { |t| t.to_s }
       end
 
       # Set the i18n scope to overwrite ActiveModel.
       #
       # @return [ Symbol ] :mongoid
+      #
+      # @since 2.0.0
       def i18n_scope
         :mongoid
       end
@@ -333,3 +350,5 @@ module Mongoid #:nodoc:
     end
   end
 end
+
+ActiveSupport.run_load_hooks(:mongoid, Mongoid::Document)

data/lib/mongoid/errors.rb

@@ -1,19 +1,40 @@
 # encoding: utf-8
 require "mongoid/errors/mongoid_error"
+require "mongoid/errors/ambiguous_relationship"
 require "mongoid/errors/callback"
 require "mongoid/errors/document_not_found"
 require "mongoid/errors/eager_load"
 require "mongoid/errors/invalid_collection"
+require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_database"
 require "mongoid/errors/invalid_field"
+require "mongoid/errors/invalid_field_option"
 require "mongoid/errors/invalid_find"
+require "mongoid/errors/invalid_index"
 require "mongoid/errors/invalid_options"
+require "mongoid/errors/invalid_scope"
+require "mongoid/errors/invalid_set_polymorphic_relation"
+require "mongoid/errors/invalid_storage_options"
 require "mongoid/errors/invalid_time"
-require "mongoid/errors/invalid_type"
+require "mongoid/errors/inverse_not_found"
 require "mongoid/errors/mixed_relations"
+require "mongoid/errors/mixed_session_configuration"
+require "mongoid/errors/nested_attributes_metadata_not_found"
+require "mongoid/errors/no_default_session"
 require "mongoid/errors/no_environment"
+require "mongoid/errors/no_map_reduce_output"
+require "mongoid/errors/no_parent"
+require "mongoid/errors/no_session_config"
+require "mongoid/errors/no_sessions_config"
+require "mongoid/errors/no_session_database"
+require "mongoid/errors/no_session_hosts"
+require "mongoid/errors/readonly_attribute"
 require "mongoid/errors/scope_overwrite"
 require "mongoid/errors/too_many_nested_attribute_records"
+require "mongoid/errors/unknown_attribute"
 require "mongoid/errors/unsaved_document"
+require "mongoid/errors/unsupported_javascript"
 require "mongoid/errors/unsupported_version"
 require "mongoid/errors/validations"
+require "mongoid/errors/versioning_not_on_root"
+require "mongoid/errors/delete_restriction"

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

@@ -1,13 +1,11 @@
 # encoding: utf-8
-module Mongoid #:nodoc
-  module Errors #:nodoc
+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
 
-      attr_reader :klass, :method
-
       # Create the new callbacks error.
       #
       # @example Create the new callbacks error.
@@ -18,8 +16,9 @@ module Mongoid #:nodoc
       #
       # @since 2.2.0
       def initialize(klass, method)
-        @klass, @method = klass, method
-        super(translate("callbacks", { :klass => klass, :method => method }))
+        super(
+          compose_message("callbacks", { klass: klass, method: method })
+        )
       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

@@ -1,28 +1,109 @@
 # 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
+module Mongoid
+  module Errors
 
-      attr_reader :klass, :identifiers
+    # 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
 
-      def initialize(klass, ids)
-        @klass = klass
-        @identifiers = ids.is_a?(Array) ? ids.join(", ") : ids
+      attr_reader :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)
+          raise ArgumentError, 'please also supply the unmatched ids'
+        end
         super(
-          translate(
-            "document_not_found",
-            { :klass => klass.name, :identifiers => identifiers }
+          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