mongoid 2.1.9 → 2.2.0

data/lib/mongoid/document.rb

@@ -213,6 +213,15 @@ module Mongoid #:nodoc:
 
     private
 
+    # Returns the logger
+    #
+    # @return [ Logger ] The configured logger or a default Logger instance.
+    #
+    # @since 2.2.0
+    def logger
+      Mongoid.logger
+    end
+
     # Implement this for calls to flatten on array.
     #
     # @example Get the document as an array.
@@ -271,9 +280,23 @@ module Mongoid #:nodoc:
       end
 
       # Set the i18n scope to overwrite ActiveModel.
+      #
+      # @return [ Symbol ] :mongoid
       def i18n_scope
         :mongoid
       end
+
+      # Returns the logger
+      #
+      # @example Get the logger.
+      #   Person.logger
+      #
+      # @return [ Logger ] The configured logger or a default Logger instance.
+      #
+      # @since 2.2.0
+      def logger
+        Mongoid.logger
+      end
     end
   end
 end

data/lib/mongoid/errors.rb

@@ -1,9 +1,12 @@
 # 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_type"
 require "mongoid/errors/mixed_relations"

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/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_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/extensions.rb

@@ -20,7 +20,9 @@ class Array #:nodoc
 end
 
 class Binary; end #:nodoc:
-class Boolean; end #:nodoc:
+unless defined?(Boolean)
+  class Boolean; end
+end
 
 class FalseClass #:nodoc
   include Mongoid::Extensions::FalseClass::Equality

data/lib/mongoid/extensions/object_id/conversions.rb

@@ -46,7 +46,7 @@ module Mongoid #:nodoc:
           when ::Hash
             args.tap do |hash|
               hash.each_pair do |key, value|
-                next unless key.to_s =~ /id/
+                next unless klass.object_id_field?(key)
                 begin
                   hash[key] = convert(klass, value, reject_blank)
                 rescue BSON::InvalidObjectId; end

data/lib/mongoid/extras.rb

@@ -5,13 +5,23 @@ module Mongoid #:nodoc:
   module Extras
     extend ActiveSupport::Concern
 
-    delegate :cached?, :to => "self.class"
-
     included do
       class_attribute :cached
       self.cached = false
     end
 
+    # Is the class cached?
+    #
+    # @note Refactored from using delegate for class load performance.
+    #
+    # @example Is the class cached?
+    #   person.cached?
+    #
+    # @return [ true, false ] If the class is cached.
+    def cached?
+      self.class.cached?
+    end
+
     module ClassMethods #:nodoc
 
       # Sets caching on for this class. This class level configuration will

data/lib/mongoid/fields.rb

@@ -31,8 +31,6 @@ module Mongoid #:nodoc
   module Fields
     extend ActiveSupport::Concern
 
-    delegate :defaults, :fields, :to => "self.class"
-
     included do
       field(:_type, :type => String)
       field(:_id, :type => BSON::ObjectId)
@@ -41,6 +39,30 @@ module Mongoid #:nodoc
       alias :id= :_id=
     end
 
+    # Get the default fields.
+    #
+    # @note Refactored from using delegate for class load performance.
+    #
+    # @example Get the defaults.
+    #   model.defaults
+    #
+    # @return [ Array<String> ] The default field names.
+    def defaults
+      self.class.defaults
+    end
+
+    # Get the document's fields.
+    #
+    # @note Refactored from using delegate for class load performance.
+    #
+    # @example Get the fields.
+    #   model.fields
+    #
+    # @return [ Hash ] The fields.
+    def fields
+      self.class.fields
+    end
+
     class << self
 
       # Stores the provided block to be run when the option name specified is
@@ -161,6 +183,23 @@ module Mongoid #:nodoc
         subclass.defaults, subclass.fields = defaults.dup, fields.dup
       end
 
+      # Is the field with the provided name a BSON::ObjectId?
+      #
+      # @example Is the field a BSON::ObjectId?
+      #   Person.object_id_field?(:name)
+      #
+      # @param [ String, Symbol ] name The name of the field.
+      #
+      # @return [ true, false ] If the field is a BSON::ObjectId.
+      #
+      # @since 2.2.0
+      def object_id_field?(name)
+        field_name = name.to_s
+        field_name = "_id" if field_name == "id"
+        field = fields[field_name]
+        field ? field.object_id_field? : false
+      end
+
       # Replace a field with a new type.
       #
       # @example Replace the field.

data/lib/mongoid/fields/serializable.rb

@@ -44,6 +44,18 @@ module Mongoid #:nodoc:
           end.include?(:deserialize)
       end
 
+      # Get the constraint from the metadata once.
+      #
+      # @example Get the constraint.
+      #   field.constraint
+      #
+      # @return [ Constraint ] The relation's contraint.
+      #
+      # @since 2.1.0
+      def constraint
+        @constraint ||= metadata.constraint
+      end
+
       # Deserialize this field from the type stored in MongoDB to the type
       # defined on the model
       #
@@ -93,6 +105,30 @@ module Mongoid #:nodoc:
         @default, @label = options[:default], options[:label]
       end
 
+      # Get the metadata for the field if its a foreign key.
+      #
+      # @example Get the metadata.
+      #   field.metadata
+      #
+      # @return [ Metadata ] The relation metadata.
+      #
+      # @since 2.2.0
+      def metadata
+        @metadata ||= options[:metadata]
+      end
+
+      # Is the field a BSON::ObjectId?
+      #
+      # @example Is the field a BSON::ObjectId?
+      #   field.object_id_field?
+      #
+      # @return [ true, false ] If the field is a BSON::ObjectId.
+      #
+      # @since 2.2.0
+      def object_id_field?
+        @object_id_field ||= (type == BSON::ObjectId)
+      end
+
       # Serialize the object from the type defined in the model to a MongoDB
       # compatible object to store.
       #

data/lib/mongoid/fields/serializable/foreign_keys/array.rb

@@ -8,6 +8,19 @@ module Mongoid #:nodoc:
         class Array
           include Serializable
 
+          # Is the field a BSON::ObjectId?
+          #
+          # @example Is the field a BSON::ObjectId?
+          #   field.object_id_field?
+          #
+          # @return [ true, false ] If the field is a BSON::ObjectId.
+          #
+          # @since 2.2.0
+          def object_id_field?
+            @object_id_field ||=
+              metadata.polymorphic? ? true : metadata.klass.using_object_ids?
+          end
+
           # Serialize the object from the type defined in the model to a MongoDB
           # compatible object to store.
           #
@@ -22,20 +35,6 @@ module Mongoid #:nodoc:
           def serialize(object)
             object ? constraint.convert(object) : []
           end
-
-          protected
-
-          # Get the constraint from the metadata once.
-          #
-          # @example Get the constraint.
-          #   field.constraint
-          #
-          # @return [ Constraint ] The relation's contraint.
-          #
-          # @since 2.1.0
-          def constraint
-            @constraint ||= options[:metadata].constraint
-          end
         end
       end
     end

data/lib/mongoid/fields/serializable/foreign_keys/object.rb

@@ -8,6 +8,19 @@ module Mongoid #:nodoc:
         class Object
           include Serializable
 
+          # Is the field a BSON::ObjectId?
+          #
+          # @example Is the field a BSON::ObjectId?
+          #   field.object_id_field?
+          #
+          # @return [ true, false ] If the field is a BSON::ObjectId.
+          #
+          # @since 2.2.0
+          def object_id_field?
+            @object_id_field ||=
+              metadata.polymorphic? ? true : metadata.klass.using_object_ids?
+          end
+
           # Serialize the object from the type defined in the model to a MongoDB
           # compatible object to store.
           #
@@ -22,20 +35,6 @@ module Mongoid #:nodoc:
           def serialize(object)
             object.blank? ? nil : constraint.convert(object)
           end
-
-          protected
-
-          # Get the constraint from the metadata once.
-          #
-          # @example Get the constraint.
-          #   field.constraint
-          #
-          # @return [ Constraint ] The relation's contraint.
-          #
-          # @since 2.1.0
-          def constraint
-            @constraint ||= options[:metadata].constraint
-          end
         end
       end
     end

data/lib/mongoid/finders.rb

@@ -8,10 +8,10 @@ module Mongoid #:nodoc:
     # Delegate to the criteria methods that are natural for creating a new
     # criteria.
     critera_methods = [ :all_in, :any_in, :any_of, :asc, :ascending, :avg,
-                        :desc, :descending, :excludes, :limit, :max, :min,
-                        :not_in, :only, :order_by, :skip, :sum, :without,
-                        :where, :update, :update_all, :near ]
-    delegate *(critera_methods.dup << {:to => :criteria})
+                        :desc, :descending, :excludes, :includes, :limit,
+                        :max, :min, :not_in, :only, :order_by, :skip, :sum,
+                        :without, :where, :update, :update_all, :near ]
+    delegate *(critera_methods.dup << { :to => :criteria })
 
     # Find all documents that match the given conditions.
     #

data/lib/mongoid/identity_map.rb

@@ -10,31 +10,14 @@ module Mongoid #:nodoc:
     #   map.get(Person, id)
     #
     # @param [ Class ] klass The class of the document.
-    # @param [ Object ] id The document id.
+    # @param [ Object, Hash ] idenfier The document id or selector.
     #
     # @return [ Document ] The matching document.
     #
     # @since 2.1.0
-    def get(klass, id)
+    def get(klass, identifier)
       return nil unless Mongoid.identity_map_enabled?
-      documents_for(klass)[id]
-    end
-
-    # Get a single document that matches the provided criteria.
-    #
-    # @example Get the document for the criteria.
-    #   map.match(Person.where(:_id => id))
-    #
-    # @param [ Criteria ] criteria The criteria to match.
-    #
-    # @return [ Document ] The first matching document.
-    #
-    # @since 2.1.0
-    def match(criteria)
-      return nil unless Mongoid.identity_map_enabled?
-      documents_for(criteria.klass).values.detect do |doc|
-        doc.matches?(criteria.selector)
-      end
+      documents_for(klass)[identifier]
     end
 
     # Remove the document from the identity map.
@@ -67,6 +50,36 @@ module Mongoid #:nodoc:
       documents_for(document.class)[document.id] = document
     end
 
+    # Set a document in the identity map for the provided selector.
+    #
+    # @example Set the document in the map.
+    #   identity_map.set_selector(document, { :person_id => person.id })
+    #
+    # @param [ Document ] document The document to set.
+    # @param [ Hash ] selector The selector to identify it.
+    #
+    # @return [ Array<Document> ] The documents.
+    #
+    # @since 2.2.0
+    def set_many(document, selector)
+      (documents_for(document.class)[selector] ||= []).push(document)
+    end
+
+    # Set a document in the identity map for the provided selector.
+    #
+    # @example Set the document in the map.
+    #   identity_map.set_selector(document, { :person_id => person.id })
+    #
+    # @param [ Document ] document The document to set.
+    # @param [ Hash ] selector The selector to identify it.
+    #
+    # @return [ Document ] The matching document.
+    #
+    # @since 2.2.0
+    def set_one(document, selector)
+     documents_for(document.class)[selector] = document
+    end
+
     private
 
     # Get the documents in the identity map for a specific class.