mongoid 2.0.0.rc.7 → 2.0.0.rc.8

data/lib/mongoid/criterion/builder.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Criterion #:nodoc:
+
+    # This module defines criteria behavior for building documents for
+    # specified conditions.
+    module Builder
+
+      # Build a document given the selector and return it.
+      # Complex criteria, such as $in and $or operations will get ignored.
+      #
+      # @example build the document.
+      #   Person.where(:title => "Sir").build
+      #
+      # @example Build with selectors getting ignored.
+      #   Person.where(:age.gt => 5).build
+      #
+      # @return [ Document ] A non-persisted document.
+      #
+      # @since 2.0.0
+      def build(attrs = {})
+        klass.new(
+          selector.inject(attrs) do |hash, (key, value)|
+            hash.tap do |attrs|
+              unless key.to_s =~ /\$/ || value.is_a?(Hash)
+                attrs[key] = value
+              end
+            end
+          end
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/criterion/creational.rb

@@ -18,9 +18,9 @@ module Mongoid #:nodoc:
       # @return [ Document ] A newly created document.
       #
       # @since 2.0.0.rc.1
-      def create
+      def create(attrs = {})
         klass.create(
-          selector.inject({}) do |hash, (key, value)|
+          selector.inject(attrs) do |hash, (key, value)|
             hash.tap do |attrs|
               unless key.to_s =~ /\$/ || value.is_a?(Hash)
                 attrs[key] = value

data/lib/mongoid/criterion/exclusion.rb

@@ -1,23 +1,23 @@
 # encoding: utf-8
 module Mongoid #:nodoc:
   module Criterion #:nodoc:
+
+    # This module contains criteria behaviour for exclusion of values.
     module Exclusion
-      # Adds a criterion to the +Criteria+ that specifies values that are not allowed
-      # to match any document in the database. The MongoDB conditional operator that
-      # will be used is "$ne".
-      #
-      # Options:
-      #
-      # attributes: A +Hash+ where the key is the field name and the value is a
-      # value that must not be equal to the corresponding field value in the database.
-      #
-      # Example:
+
+      # Adds a criterion to the +Criteria+ that specifies values that are not
+      # allowed to match any document in the database. The MongoDB
+      # conditional operator that will be used is "$ne".
       #
-      # <tt>criteria.excludes(:field => "value1")</tt>
+      # @example Match documents without these values.
+      #   criteria.excludes(:field => "value1")
+      #   criteria.excludes(:field1 => "value1", :field2 => "value1")
       #
-      # <tt>criteria.excludes(:field1 => "value1", :field2 => "value1")</tt>
+      # @param [ Hash ] attributes: A +Hash+ where the key is the field
+      #   name and the value is a value that must not be equal to the
+      #   corresponding field value in the database.
       #
-      # Returns: <tt>self</tt>
+      # @return [ Criteria ] A newly cloned copy.
       def excludes(attributes = {})
         mongo_id = attributes.delete(:id)
         attributes = attributes.merge(:_id => mongo_id) if mongo_id
@@ -25,21 +25,18 @@ module Mongoid #:nodoc:
       end
 
       # Adds a criterion to the +Criteria+ that specifies values where none
-      # should match in order to return results. This is similar to an SQL "NOT IN"
-      # clause. The MongoDB conditional operator that will be used is "$nin".
+      # should match in order to return results. This is similar to an SQL
+      # "NOT IN" clause. The MongoDB conditional operator that will be
+      # used is "$nin".
       #
-      # Options:
+      # @example Match documents with values not in the provided.
+      #   criteria.not_in(:field => ["value1", "value2"])
+      #   criteria.not_in(:field1 => ["value1", "value2"], :field2 => ["value1"])
       #
-      # attributes: A +Hash+ where the key is the field name and the value is an
-      # +Array+ of values that none can match.
+      # @param [ Hash ] attributes A +Hash+ where the key is the field name
+      #   and the value is an +Array+ of values that none can match.
       #
-      # Example:
-      #
-      # <tt>criteria.not_in(:field => ["value1", "value2"])</tt>
-      #
-      # <tt>criteria.not_in(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
-      #
-      # Returns: <tt>self</tt>
+      # @return [ Criteria ] A newly cloned copy.
       def not_in(attributes)
         update_selector(attributes, "$nin")
       end
@@ -48,18 +45,47 @@ module Mongoid #:nodoc:
       # get returned from the Document. Used mainly for list views that do not
       # require all fields to be present. This is similar to SQL "SELECT" values.
       #
-      # Options:
+      # @example Limit the fields to only the specified.
+      #   criteria.only(:field1, :field2, :field3)
       #
-      # args: A list of field names to retrict the returned fields to.
+      # @note #only and #without cannot be used together.
       #
-      # Example:
+      # @param [ Array<Symbol> ] args A list of field names to limit to.
       #
-      # <tt>criteria.only(:field1, :field2, :field3)</tt>
-      #
-      # Returns: <tt>self</tt>
+      # @return [ Criteria ] A newly cloned copy.
       def only(*args)
         clone.tap do |crit|
-          crit.options[:fields] = args.flatten if args.any?
+          if args.any?
+            crit.options[:fields] = {:_type => 1}
+            crit.field_list = args.flatten
+            crit.field_list.each do |f|
+              crit.options[:fields][f] = 1
+            end
+          end
+        end
+      end
+
+      # Adds a criterion to the +Criteria+ that specifies the fields that will
+      # not get returned by the document.
+      #
+      # @example Filter out specific fields.
+      #   criteria.without(:field2, :field2)
+      #
+      # @note #only and #without cannot be used together.
+      #
+      # @param [ Array<Symbol> args A list of fields to exclude.
+      #
+      # @return [ Criteria ] A newly cloned copy.
+      #
+      # @since 2.0.0
+      def without(*args)
+        clone.tap do |crit|
+          if args.any?
+            crit.options[:fields] = {}
+            args.flatten.each do |f|
+              crit.options[:fields][f] = 0
+            end
+          end
         end
       end
     end

data/lib/mongoid/criterion/inclusion.rb

@@ -20,6 +20,22 @@ module Mongoid #:nodoc:
       end
       alias :all_in :all
 
+      # Adds a criterion to the +Criteria+ that specifies values where any can
+      # be matched in order to return results. This is similar to an SQL "IN"
+      # clause. The MongoDB conditional operator that will be used is "$in".
+      # Any previously matching "$in" arrays will be unioned with new
+      # arguments.
+      #
+      # @example Adding the criterion.
+      #   criteria.in(:field => ["value1"]).also_in(:field => ["value2"])
+      #
+      # @param [ Hash ] attributes Name/value pairs any can match.
+      #
+      # @return [ Criteria ] A new criteria with the added selector.
+      def also_in(attributes = {})
+        update_selector(attributes, "$in")
+      end
+
       # Adds a criterion to the +Criteria+ that specifies values that must
       # be matched in order to return results. This is similar to a SQL "WHERE"
       # clause. This is the actual selector that will be provided to MongoDB,
@@ -83,16 +99,13 @@ module Mongoid #:nodoc:
       #
       # @return [ Document, Criteria ] The matching document(s).
       def find(*args)
-        raise Errors::InvalidOptions.new(
-          :calling_document_find_with_nil_is_invalid, {}
-        ) if args[0].nil?
-        type, criteria = Criteria.parse!(klass, embedded, *args)
-        criteria.merge(self) if criteria.is_a?(Criteria)
+        type, crit = search(*args)
         case type
-        when :first then return criteria.one
-        when :last then return criteria.last
+        when :first then crit.one
+        when :last then crit.last
+        when :ids then execute_or_raise(args, crit)
         else
-          return criteria
+          crit
         end
       end
 
@@ -108,7 +121,7 @@ module Mongoid #:nodoc:
       #
       # @return [ Criteria ] A new criteria with the added selector.
       def in(attributes = {})
-        update_selector(attributes, "$in")
+        update_selector(attributes, "$in", :&)
       end
       alias :any_in :in
 
@@ -147,13 +160,39 @@ module Mongoid #:nodoc:
 
           selector.each_pair do |key, value|
             if crit.selector.has_key?(key) && crit.selector[key].respond_to?(:merge!)
-              crit.selector[key].merge!(value)
+              crit.selector[key] =
+                crit.selector[key].merge!(value) do |key, old, new|
+                  key == '$in' ? old & new : new
+                end
             else
               crit.selector[key] = value
             end
           end
         end
       end
+
+      private
+
+      # Execute the criteria or raise an error if no documents found.
+      #
+      # @example Execute or raise
+      #   criteria.execute_or_raise(id, criteria)
+      #
+      # @param [ Object ] args The arguments passed.
+      # @param [ Criteria ] criteria The criteria to execute.
+      #
+      # @raise [ Errors::DocumentNotFound ] If nothing returned.
+      #
+      # @return [ Document, Array<Document> ] The document(s).
+      #
+      # @since 2.0.0
+      def execute_or_raise(args, criteria)
+        (args[0].is_a?(Array) ? criteria.entries : criteria.one).tap do |result|
+          if Mongoid.raise_not_found_error && !args.flatten.blank?
+            raise Errors::DocumentNotFound.new(klass, args) if result.blank?
+          end
+        end
+      end
     end
   end
 end

data/lib/mongoid/criterion/optional.rb

@@ -102,7 +102,7 @@ module Mongoid #:nodoc:
       # <tt>criteria.id(["4ab2bc4b8ad548971900005c", "4c454e7ebf4b98032d000001"])</tt>
       #
       # Returns: <tt>self</tt>
-      def id(*ids)
+      def for_ids(*ids)
         ids.flatten!
         if ids.size > 1
           any_in(

data/lib/mongoid/criterion/selector.rb

@@ -2,26 +2,64 @@
 module Mongoid #:nodoc:
   module Criterion #:nodoc:
 
+    # The selector is a hash-like object that has special behaviour for merging
+    # mongoid criteria selectors.
     class Selector < Hash
-      attr_reader :klass
 
+      attr_reader :fields, :klass
+
+      # Create the new selector.
+      #
+      # @example Create the selector.
+      #   Selector.new(Person)
+      #
+      # @param [ Class ] klass The class the selector is for.
+      #
+      # @since 1.0.0
       def initialize(klass)
-        @klass = klass
+        @fields, @klass = klass.fields.except("_id", "_type"), klass
       end
 
+      # Set the value for the supplied key, attempting to typecast the value.
+      #
+      # @example Set the value for the key.
+      #   selector["$ne"] = { :name => "Zorg" }
+      #
+      # @param [ String, Symbol ] key The hash key.
+      # @param [ Object ] value The value to set.
+      #
+      # @since 2.0.0
       def []=(key, value)
         super(key, try_to_typecast(key, value))
       end
 
+      # Merge the selector with another hash.
+      #
+      # @example Merge the objects.
+      #   selector.merge!({ :key => "value" })
+      #
+      # @param [ Hash, Selector ] other The object to merge with.
+      #
+      # @return [ Selector ] The merged selector.
+      #
+      # @since 1.0.0
       def merge!(other)
-        other.each_pair do |key, value|
-          self[key] = value
+        tap do |selector|
+          other.each_pair do |key, value|
+            selector[key] = value
+          end
         end
-        self
       end
-      alias update merge!
+      alias :update :merge!
 
       if RUBY_VERSION < '1.9'
+
+        # Generate pretty inspection for old ruby versions.
+        #
+        # @example Inspect the selector.
+        #   selector.inspect
+        #
+        # @return [ String ] The inspected selector.
         def inspect
           ret = self.keys.inject([]) do |ret, key|
             ret << "#{key.inspect}=>#{self[key].inspect}"
@@ -32,14 +70,35 @@ module Mongoid #:nodoc:
 
       private
 
+      # If the key is defined as a field, then attempt to typecast it.
+      #
+      # @example Try to cast.
+      #   selector.try_to_typecast(:id, 1)
+      #
+      # @param [ String, Symbol ] key The field name.
+      # @param [ Object ] value The value.
+      #
+      # @return [ Object ] The typecasted value.
+      #
+      # @since 1.0.0
       def try_to_typecast(key, value)
         access = key.to_s
-        return value unless klass.fields.has_key?(access)
-
-        field = klass.fields[access]
+        return value unless fields.has_key?(access)
+        field = fields[access]
         typecast_value_for(field, value)
       end
 
+      # Get the typecast value for the defined field.
+      #
+      # @example Get the typecast value.
+      #   selector.typecast_value_for(:name, "Corbin")
+      #
+      # @param [ Field ] field The defined field.
+      # @param [ Object ] value The value to cast.
+      #
+      # @return [ Object ] The cast value.
+      #
+      # @since 1.0.0
       def typecast_value_for(field, value)
         return field.set(value) if field.type === value
         case value
@@ -57,6 +116,18 @@ module Mongoid #:nodoc:
         end
       end
 
+      # Typecast the value for booleans and integers in hashes.
+      #
+      # @example Typecast the hash values.
+      #   selector.typecast_hash_value(field, "$exists", "true")
+      #
+      # @param [ Field ] field The defined field.
+      # @param [ String ] key The modifier key.
+      # @param [ Object ] value The value to cast.
+      #
+      # @return [ Object ] The cast value.
+      #
+      # @since 1.0.0
       def typecast_hash_value(field, key, value)
         case key
         when "$exists"
@@ -67,8 +138,6 @@ module Mongoid #:nodoc:
           typecast_value_for(field, value)
         end
       end
-
     end
-
   end
 end

data/lib/mongoid/cursor.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 module Mongoid #:nodoc
   class Cursor
+    include Mongoid::Collections::Retry
     include Enumerable
     # Operations on the Mongo::Cursor object that will not get overriden by the
     # Mongoid::Cursor are defined here.
@@ -31,7 +32,11 @@ module Mongoid #:nodoc
     #
     # <tt>cursor.close</tt>
     OPERATIONS.each do |name|
-      define_method(name) { |*args| @cursor.send(name, *args) }
+      define_method(name) do |*args|
+        retry_on_connection_failure do
+          @cursor.send(name, *args)
+        end
+      end
     end
 
     # Iterate over each document in the cursor and yield to it.

data/lib/mongoid/default_scope.rb

@@ -3,26 +3,34 @@ module Mongoid #:nodoc:
 
   # This module handles functionality for creating default scopes.
   module DefaultScope
+    extend ActiveSupport::Concern
 
-    # Creates a default_scope for the +Document+, similar to ActiveRecord's
-    # default_scope. +DefaultScopes+ are proxied +Criteria+ objects that are
-    # applied by default to all queries for the class.
-    #
-    # @example Create a default scope.
-    #
-    #   class Person
-    #     include Mongoid::Document
-    #     field :active, :type => Boolean
-    #     field :count, :type => Integer
-    #
-    #     default_scope :where => { :active => true }
-    #   end
-    #
-    # @param [ Hash ] conditions The conditions to create with.
-    #
-    # @since 2.0.0.rc.1
-    def default_scope(conditions = {}, &block)
-      self.scope_stack << criteria.fuse(Scope.new(conditions, &block).conditions.scoped)
+    included do
+      class_attribute :default_scoping
+    end
+
+    module ClassMethods #:nodoc:
+
+      # Creates a default_scope for the +Document+, similar to ActiveRecord's
+      # default_scope. +DefaultScopes+ are proxied +Criteria+ objects that are
+      # applied by default to all queries for the class.
+      #
+      # @example Create a default scope.
+      #
+      #   class Person
+      #     include Mongoid::Document
+      #     field :active, :type => Boolean
+      #     field :count, :type => Integer
+      #
+      #     default_scope :where => { :active => true }
+      #   end
+      #
+      # @param [ Hash ] conditions The conditions to create with.
+      #
+      # @since 2.0.0.rc.1
+      def default_scope(conditions = {}, &block)
+        self.default_scoping = Scope.new(conditions, &block).conditions.scoped
+      end
     end
   end
 end