mongoid 2.0.0.beta.20 → 2.0.0.rc.1

data/lib/mongoid/config/database.rb

@@ -0,0 +1,167 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Config #:nodoc:
+
+    # This class handles the configuration and initialization of a mongodb
+    # database from options.
+    class Database < Hash
+
+      # Configure the database connections. This will return an array
+      # containing the master and an array of slaves.
+      #
+      # @example Configure the connection.
+      #   db.configure
+      #
+      # @return [ Array<Mongo::DB, Array<Mongo:DB>> ] The Mongo databases.
+      #
+      # @since 2.0.0.rc.1
+      def configure
+        [ master.db(name), slaves.map { |slave| slave.db(name) } ]
+      end
+
+      # Create the new db configuration class.
+      #
+      # @example Initialize the class.
+      #   Config::Database.new(
+      #     false, "uri" => { "mongodb://durran:password@localhost:27017/mongoid" }
+      #   )
+      #
+      # @param [ Hash ] options The configuration options.
+      #
+      # @option options [ String ] :database The database name.
+      # @option options [ String ] :host The database host.
+      # @option options [ String ] :password The password for authentication.
+      # @option options [ Integer ] :port The port for the database.
+      # @option options [ String ] :uri The uri for the database.
+      # @option options [ String ] :username The user for authentication.
+      #
+      # @since 2.0.0.rc.1
+      def initialize(options = {})
+        merge!(options)
+      end
+
+      private
+
+      # Do we need to authenticate against the database?
+      #
+      # @example Are we authenticating?
+      #   db.authenticating?
+      #
+      # @return [ true, false ] True if auth is needed, false if not.
+      #
+      # @since 2.0.0.rc.1
+      def authenticating?
+        username || password
+      end
+
+      # Takes the supplied options in the hash and created a URI from them to
+      # pass to the Mongo connection object.
+      #
+      # @example Build the URI.
+      #   db.build_uri
+      #
+      # @param [ Hash ] options The options to build with.
+      #
+      # @return [ String ] A mongo compliant URI string.
+      #
+      # @since 2.0.0.rc.1
+      def build_uri(options = {})
+        "mongodb://".tap do |base|
+          base << "#{username}:#{password}@" if authenticating?
+          base << "#{options["host"] || "localhost"}:#{options["port"] || 27017}"
+          base << "/#{self["database"]}" if authenticating?
+        end
+      end
+
+      # Create the mongo master connection from either the supplied URI
+      # or a generated one, while setting pool size and logging.
+      #
+      # @example Create the connection.
+      #   db.connection
+      #
+      # @return [ Mongo::Connection ] The mongo connection.
+      #
+      # @since 2.0.0.rc.1
+      def master
+        Mongo::Connection.from_uri(uri(self), optional).tap do |conn|
+          conn.apply_saved_authentication
+        end
+      end
+
+      # Create the mongo slave connections from either the supplied URI
+      # or a generated one, while setting pool size and logging.
+      #
+      # @example Create the connection.
+      #   db.connection
+      #
+      # @return [ Array<Mongo::Connection> ] The mongo slave connections.
+      #
+      # @since 2.0.0.rc.1
+      def slaves
+        (self["slaves"] || []).map do |options|
+          Mongo::Connection.from_uri(uri(options), optional(true)).tap do |conn|
+            conn.apply_saved_authentication
+          end
+        end
+      end
+
+      # Convenience for accessing the hash via dot notation.
+      #
+      # @example Access a value in alternate syntax.
+      #   db.host
+      #
+      # @return [ Object ] The value in the hash.
+      #
+      # @since 2.0.0.rc.1
+      def method_missing(name, *args, &block)
+        self[name.to_s]
+      end
+
+      # Get the name of the database, from either the URI supplied or the
+      # database value in the options.
+      #
+      # @example Get the database name.
+      #   db.name
+      #
+      # @return [ String ] The database name.
+      #
+      # @since 2.0.0.rc.1
+      def name
+        db_name = URI.parse(uri(self)).path.to_s.sub("/", "")
+        db_name.blank? ? database : db_name
+      end
+
+      # Get the options used in creating the database connection.
+      #
+      # @example Get the options.
+      #   db.options
+      #
+      # @param [ true, false ] slave Are the options for a slave db?
+      #
+      # @return [ Hash ] The hash of configuration options.
+      #
+      # @since 2.0.0.rc.1
+      def optional(slave = false)
+        {
+          :pool_size => pool_size,
+          :logger => Mongoid::Logger.new,
+          :slave_ok => slave
+        }
+      end
+
+      # Get a Mongo compliant URI for the database connection.
+      #
+      # @example Get the URI.
+      #   db.uri
+      #
+      # @param [ Hash ] options The options hash.
+      #
+      # @return [ String ] The URI for the connection.
+      #
+      # @since 2.0.0.rc.1
+      def uri(options = {})
+        options["uri"] || build_uri(options)
+      end
+    end
+  end
+end

data/lib/mongoid/contexts.rb

@@ -14,11 +14,8 @@ module Mongoid
     # Example:
     #
     # <tt>Contexts.context_for(criteria)</tt>
-    def self.context_for(criteria)
-      if criteria.klass.embedded?
-        return Contexts::Enumerable.new(criteria)
-      end
-      Contexts::Mongo.new(criteria)
+    def self.context_for(criteria, embedded = false)
+      embedded ? Enumerable.new(criteria) : Mongo.new(criteria)
     end
   end
 end

data/lib/mongoid/contexts/enumerable.rb

@@ -6,7 +6,7 @@ module Mongoid #:nodoc:
   module Contexts #:nodoc:
     class Enumerable
       include Ids, Paging
-      attr_reader :criteria
+      attr_accessor :criteria
 
       delegate :blank?, :empty?, :first, :last, :to => :execute
       delegate :klass, :documents, :options, :selector, :to => :criteria
@@ -42,6 +42,32 @@ module Mongoid #:nodoc:
         @count ||= filter.size
       end
 
+      # Delete all the documents in the database matching the selector.
+      #
+      # @example Delete the documents.
+      #   context.delete_all
+      #
+      # @return [ Integer ] The number of documents deleted.
+      #
+      # @since 2.0.0.rc.1
+      def delete_all
+        count.tap { filter.each(&:delete) }
+      end
+      alias :delete :delete_all
+
+      # Destroy all the documents in the database matching the selector.
+      #
+      # @example Destroy the documents.
+      #   context.destroy_all
+      #
+      # @return [ Integer ] The number of documents destroyed.
+      #
+      # @since 2.0.0.rc.1
+      def destroy_all
+        count.tap { filter.each(&:destroy) }
+      end
+      alias :destroy :destroy_all
+
       # Gets an array of distinct values for the supplied field across the
       # entire array or the susbset given the criteria.
       #
@@ -125,9 +151,9 @@ module Mongoid #:nodoc:
       #
       # The first document in the +Array+
       def shift
-        document = first
-        criteria.skip((options[:skip] || 0) + 1)
-        document
+        first.tap do |document|
+          self.criteria = criteria.skip((options[:skip] || 0) + 1)
+        end
       end
 
       # Get the sum of the field values for all the documents.

data/lib/mongoid/contexts/ids.rb

@@ -13,9 +13,9 @@ module Mongoid #:nodoc:
       #
       # The single or multiple documents.
       def id_criteria(params)
-        criteria.id(params)
+        self.criteria = criteria.id(params)
         result = params.is_a?(Array) ? criteria.entries : one
-        if Mongoid.raise_not_found_error
+        if Mongoid.raise_not_found_error && !params.blank?
           raise Errors::DocumentNotFound.new(klass, params) if result.blank?
         end
         return result

data/lib/mongoid/contexts/mongo.rb

@@ -3,7 +3,7 @@ module Mongoid #:nodoc:
   module Contexts #:nodoc:
     class Mongo
       include Ids, Paging
-      attr_reader :criteria
+      attr_accessor :criteria
 
       delegate :klass, :options, :selector, :to => :criteria
 
@@ -51,7 +51,6 @@ module Mongoid #:nodoc:
       def blank?
         klass.collection.find_one(selector, { :fields => [ :_id ] }).nil?
       end
-
       alias :empty? :blank?
 
       # Get the count of matching documents in the database for the context.
@@ -67,6 +66,32 @@ module Mongoid #:nodoc:
         @count ||= klass.collection.find(selector, process_options).count
       end
 
+      # Delete all the documents in the database matching the selector.
+      #
+      # @example Delete the documents.
+      #   context.delete_all
+      #
+      # @return [ Integer ] The number of documents deleted.
+      #
+      # @since 2.0.0.rc.1
+      def delete_all
+        klass.delete_all(:conditions => selector)
+      end
+      alias :delete :delete_all
+
+      # Destroy all the documents in the database matching the selector.
+      #
+      # @example Destroy the documents.
+      #   context.destroy_all
+      #
+      # @return [ Integer ] The number of documents destroyed.
+      #
+      # @since 2.0.0.rc.1
+      def destroy_all
+        klass.destroy_all(:conditions => selector)
+      end
+      alias :destroy :destroy_all
+
       # Gets an array of distinct values for the supplied field across the
       # entire collection or the susbset given the criteria.
       #
@@ -134,10 +159,10 @@ module Mongoid #:nodoc:
       def initialize(criteria)
         @criteria = criteria
         if klass.hereditary? && !criteria.selector.keys.include?(:_type)
-          criteria.in(:_type => criteria.klass._types)
+          @criteria = criteria.in(:_type => criteria.klass._types)
         end
-        criteria.enslave if klass.enslaved?
-        criteria.cache if klass.cached?
+        @criteria.enslave if klass.enslaved?
+        @criteria.cache if klass.cached?
       end
 
       # Iterate over each +Document+ in the results. This can take an optional

data/lib/mongoid/copyable.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Copyable
+    extend ActiveSupport::Concern
+
+    COPYABLES = [
+      :@accessed,
+      :@attributes,
+      :@metadata,
+      :@modifications,
+      :@previous_modifications
+    ]
+
+    protected
+
+    # Clone or dup the current +Document+. This will return all attributes with
+    # the exception of the document's id and versions, and will reset all the
+    # instance variables.
+    #
+    # Example:
+    #
+    # <tt>document.clone</tt>
+    # <tt>document.dup</tt>
+    #
+    # Options:
+    #
+    # other: The document getting cloned.
+    #
+    # Returns:
+    #
+    # A new document with all the attributes except id and versions
+    def initialize_copy(other)
+      instance_variables.each { |name| remove_instance_variable(name) }
+      COPYABLES.each do |name|
+        value = other.instance_variable_get(name)
+        instance_variable_set(name, value ? value.dup : nil)
+      end
+      @attributes.delete("_id")
+      @attributes.delete("versions")
+      @new_record = true
+      identify
+    end
+  end
+end

data/lib/mongoid/criteria.rb

@@ -1,11 +1,15 @@
 # encoding: utf-8
+require "mongoid/criterion/creational"
 require "mongoid/criterion/complex"
+require "mongoid/criterion/destructive"
 require "mongoid/criterion/exclusion"
 require "mongoid/criterion/inclusion"
+require "mongoid/criterion/inspection"
 require "mongoid/criterion/optional"
 require "mongoid/criterion/selector"
 
 module Mongoid #:nodoc:
+
   # The +Criteria+ class is the core object needed in Mongoid to retrieve
   # objects from the database. It is a DSL that essentially sets up the
   # selector and options arguments that get passed on to a <tt>Mongo::Collection</tt>
@@ -21,13 +25,15 @@ module Mongoid #:nodoc:
   #
   # <tt>criteria.execute</tt>
   class Criteria
+    include Enumerable
+    include Criterion::Creational
+    include Criterion::Destructive
     include Criterion::Exclusion
     include Criterion::Inclusion
+    include Criterion::Inspection
     include Criterion::Optional
-    include Enumerable
 
-    attr_reader :collection, :ids, :klass, :options, :selector
-    attr_accessor :documents
+    attr_accessor :collection, :documents, :embedded, :ids, :klass, :options, :selector
 
     delegate :aggregate, :avg, :blank?, :count, :distinct, :empty?,
              :execute, :first, :group, :id_criteria, :last, :max,
@@ -69,7 +75,7 @@ module Mongoid #:nodoc:
     # This will return an Enumerable context if the class is embedded,
     # otherwise it will return a Mongo context for root classes.
     def context
-      @context ||= Contexts.context_for(self)
+      @context ||= Contexts.context_for(self, embedded)
     end
 
     # Iterate over each +Document+ in the results. This can take an optional
@@ -79,8 +85,7 @@ module Mongoid #:nodoc:
     #
     # <tt>criteria.each { |doc| p doc }</tt>
     def each(&block)
-      context.iterate(&block)
-      self
+      tap { context.iterate(&block) }
     end
 
     # Return true if the criteria has some Document or not
@@ -116,9 +121,9 @@ module Mongoid #:nodoc:
     #
     # type: One of :all, :first:, or :last
     # klass: The class to execute on.
-    def initialize(klass)
-      @selector = Mongoid::Criterion::Selector.new(klass)
-      @options, @klass, @documents = {}, klass, []
+    def initialize(klass, embedded = false)
+      @selector = Criterion::Selector.new(klass)
+      @options, @klass, @documents, @embedded = {}, klass, [], embedded
     end
 
     # Merges another object into this +Criteria+. The other object may be a
@@ -133,9 +138,11 @@ module Mongoid #:nodoc:
     #
     # <tt>criteria.merge({ :conditions => { :title => "Sir" } })</tt>
     def merge(other)
-      @selector.update(other.selector)
-      @options.update(other.options)
-      @documents = other.documents
+      clone.tap do |crit|
+        crit.selector.update(other.selector)
+        crit.options.update(other.options)
+        crit.documents = other.documents
+      end
     end
 
     # Used for chaining +Criteria+ scopes together in the for of class methods
@@ -157,8 +164,6 @@ module Mongoid #:nodoc:
       end
     end
 
-    alias :to_ary :to_a
-
     # Returns the selector and options as a +Hash+ that would be passed to a
     # scope for use with named scopes.
     def scoped
@@ -167,39 +172,74 @@ module Mongoid #:nodoc:
       scope_options[:order_by] = sorting if sorting
       { :where => @selector }.merge(scope_options)
     end
+    alias :to_ary :to_a
 
-    # Translate the supplied arguments into a +Criteria+ object.
-    #
-    # If the passed in args is a single +String+, then it will
-    # construct an id +Criteria+ from it.
-    #
-    # If the passed in args are a type and a hash, then it will construct
-    # the +Criteria+ with the proper selector, options, and type.
-    #
-    # Options:
-    #
-    # args: either a +String+ or a +Symbol+, +Hash combination.
-    #
-    # Example:
-    #
-    # <tt>Criteria.translate(Person, "4ab2bc4b8ad548971900005c")</tt>
-    # <tt>Criteria.translate(Person, :conditions => { :field => "value"}, :limit => 20)</tt>
-    def self.translate(*args)
-      klass = args[0]
-      params = args[1] || {}
-      unless params.is_a?(Hash)
-        return klass.criteria.id_criteria(params)
+    class << self
+
+      # Encaspulates the behavior of taking arguments and parsing them into a
+      # finder type and a corresponding criteria object.
+      #
+      # Example:
+      #
+      # <tt>Criteria.parse!(Person, :all, :conditions => {})</tt>
+      #
+      # Options:
+      #
+      # klass: The klass to create the criteria for.
+      # args: An assortment of finder options.
+      #
+      # Returns:
+      #
+      # An Array with the type and criteria.
+      def parse!(klass, embedded, *args)
+        if args[0].nil?
+          Errors::InvalidOptions.new("Calling Document#find with nil is invalid")
+        end
+        type = args.delete_at(0) if args[0].is_a?(Symbol)
+        criteria = translate(klass, embedded, *args)
+        return [ type, criteria ]
       end
-      conditions = params.delete(:conditions) || {}
-      if conditions.include?(:id)
-        conditions[:_id] = conditions[:id]
-        conditions.delete(:id)
+
+      # Translate the supplied arguments into a +Criteria+ object.
+      #
+      # If the passed in args is a single +String+, then it will
+      # construct an id +Criteria+ from it.
+      #
+      # If the passed in args are a type and a hash, then it will construct
+      # the +Criteria+ with the proper selector, options, and type.
+      #
+      # Options:
+      #
+      # args: either a +String+ or a +Symbol+, +Hash combination.
+      #
+      # Example:
+      #
+      # <tt>Criteria.translate(Person, "4ab2bc4b8ad548971900005c")</tt>
+      # <tt>Criteria.translate(Person, :conditions => { :field => "value"}, :limit => 20)</tt>
+      def translate(*args)
+        klass = args[0]
+        embedded = args[1]
+        params = args[2] || {}
+        unless params.is_a?(Hash)
+          return klass.criteria(embedded).id_criteria(params)
+        end
+        conditions = params.delete(:conditions) || {}
+        if conditions.include?(:id)
+          conditions[:_id] = conditions[:id]
+          conditions.delete(:id)
+        end
+        return klass.criteria(embedded).where(conditions).extras(params)
       end
-      return klass.criteria.where(conditions).extras(params)
     end
 
     protected
 
+    # Return the entries of the other criteria or the object. Used for
+    # comparing criteria or an enumerable.
+    def comparable(other)
+      other.is_a?(Criteria) ? other.entries : other
+    end
+
     # Filters the unused options out of the options +Hash+. Currently this
     # takes into account the "page" and "per_page" options that would be passed
     # in if using will_paginate.
@@ -218,10 +258,24 @@ module Mongoid #:nodoc:
       end
     end
 
-    # Return the entries of the other criteria or the object. Used for
-    # comparing criteria or an enumerable.
-    def comparable(other)
-      other.is_a?(Criteria) ? other.entries : other
+    # Clone or dup the current +Criteria+. This will return a new criteria with
+    # the selector, options, klass, embedded options, etc intact.
+    #
+    # Example:
+    #
+    # <tt>criteria.clone</tt>
+    # <tt>criteria.dup</tt>
+    #
+    # Options:
+    #
+    # other: The criteria getting cloned.
+    #
+    # Returns:
+    #
+    # A new identical criteria
+    def initialize_copy(other)
+      @selector = other.selector.dup
+      @options = other.options.dup
     end
 
     # Update the selector setting the operator on the value for each key in the
@@ -231,20 +285,20 @@ module Mongoid #:nodoc:
     #
     # <tt>criteria.update_selector({ :field => "value" }, "$in")</tt>
     def update_selector(attributes, operator)
-      attributes.each do |key, value|
-        unless @selector[key]
-          @selector[key] = { operator => value }
-        else
-          if @selector[key].has_key?(operator)
-            # add the value to the current operator
-            new_value = @selector[key].values.first + value
-            @selector[key] = { operator => new_value }
+      clone.tap do |crit|
+        attributes.each do |key, value|
+          unless crit.selector[key]
+            crit.selector[key] = { operator => value }
           else
-            # create a new operator on this key
-            @selector[key][operator] = value
-          end        
+            if crit.selector[key].has_key?(operator)
+              new_value = crit.selector[key].values.first + value
+              crit.selector[key] = { operator => new_value }
+            else
+              crit.selector[key][operator] = value
+            end
+          end
         end
-      end; self
+      end
     end
   end
 end