mongo 1.7.1 → 1.8.0

data/lib/mongo/cursor.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,7 +26,8 @@ module Mongo
     attr_reader :collection, :selector, :fields,
       :order, :hint, :snapshot, :timeout,
       :full_collection_name, :transformer,
-      :options, :cursor_id, :show_disk_loc
+      :options, :cursor_id, :show_disk_loc,
+      :comment
 
     # Create a new cursor.
     #
@@ -38,7 +39,6 @@ module Mongo
     # @core cursors constructor_details
     def initialize(collection, opts={})
       @cursor_id  = nil
-
       @db         = collection.db
       @collection = collection
       @connection = @db.connection
@@ -55,6 +55,7 @@ module Mongo
       @max_scan   = opts.fetch(:max_scan, nil)
       @return_key = opts.fetch(:return_key, nil)
       @show_disk_loc = opts.fetch(:show_disk_loc, nil)
+      @comment    = opts[:comment]
 
       # Wire-protocol settings
       @fields     = convert_fields_for_query(opts[:fields])
@@ -209,9 +210,7 @@ module Mongo
     # @raise [InvalidSortValueError] if the specified order is invalid.
     def sort(order, direction=nil)
       check_modifiable
-
       order = [[order, direction]] unless direction.nil?
-
       @order = order
       self
     end
@@ -229,7 +228,6 @@ module Mongo
     def limit(number_to_return=nil)
       return @limit unless number_to_return
       check_modifiable
-
       @limit = number_to_return
       self
     end
@@ -255,7 +253,7 @@ module Mongo
     #
     # Note that the batch size will take effect only on queries
     # where the number to be returned is greater than 100.
-    # 
+    #
     # This can not override MongoDB's limit on the amount of data it will
     # return to the client. Depending on server version this can be 4-16mb.
     #
@@ -276,7 +274,7 @@ module Mongo
     end
 
     # Iterate over each document in this cursor, yielding it to the given
-    # block.
+    # block, if provided. An Enumerator is returned if no block is given.
     #
     # Iterating over an entire cursor will close it.
     #
@@ -287,11 +285,18 @@ module Mongo
     #     puts doc['user']
     #   end
     def each
-      while doc = self.next
-        yield doc
+      if block_given? || !defined?(Enumerator)
+        while doc = self.next
+          yield doc
+        end
+      else
+        Enumerator.new do |yielder|
+          while doc = self.next
+            yielder.yield doc
+          end
+        end
       end
     end
-
     # Receive all the documents from this cursor as an array of hashes.
     #
     # Notes:
@@ -411,7 +416,8 @@ module Mongo
         :timeout  => @timeout,
         :max_scan => @max_scan,
         :return_key => @return_key,
-        :show_disk_loc => @show_disk_loc }
+        :show_disk_loc => @show_disk_loc,
+        :comment  => @comment }
     end
 
     # Clean output for inspect.
@@ -528,7 +534,7 @@ module Mongo
       ensure
         checkin_socket(sock) unless @socket
       end
-      
+
       @returned += @n_received
       @cache += results
       close_cursor_if_query_complete
@@ -583,13 +589,14 @@ module Mongo
       spec['$maxScan']  = @max_scan if @max_scan
       spec['$returnKey']   = true if @return_key
       spec['$showDiskLoc'] = true if @show_disk_loc
+      spec['$comment']  = @comment if @comment
       spec
     end
 
     # Returns true if the query contains order, explain, hint, or snapshot.
     def query_contains_special_fields?
       @order || @explain || @hint || @snapshot || @show_disk_loc ||
-        @max_scan || @return_key
+        @max_scan || @return_key || @comment
     end
 
     def close_cursor_if_query_complete

data/lib/mongo/db.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,13 +23,14 @@ module Mongo
 
   # A MongoDB database.
   class DB
+    include Mongo::WriteConcern
 
-    SYSTEM_NAMESPACE_COLLECTION = "system.namespaces"
-    SYSTEM_INDEX_COLLECTION = "system.indexes"
-    SYSTEM_PROFILE_COLLECTION = "system.profile"
-    SYSTEM_USER_COLLECTION = "system.users"
-    SYSTEM_JS_COLLECTION = "system.js"
-    SYSTEM_COMMAND_COLLECTION = "$cmd"
+    SYSTEM_NAMESPACE_COLLECTION = 'system.namespaces'
+    SYSTEM_INDEX_COLLECTION     = 'system.indexes'
+    SYSTEM_PROFILE_COLLECTION   = 'system.profile'
+    SYSTEM_USER_COLLECTION      = 'system.users'
+    SYSTEM_JS_COLLECTION        = 'system.js'
+    SYSTEM_COMMAND_COLLECTION   = '$cmd'
 
     # Counter for generating unique request ids.
     @@current_request_id = 0
@@ -44,10 +45,10 @@ module Mongo
     # Returns the value of the +strict+ flag.
     def strict?; @strict; end
 
-    # The name of the database and the local safe option.
-    attr_reader :name, :safe
+    # The name of the database and the local write concern options.
+    attr_reader :name, :write_concern
 
-    # The Mongo::Connection instance connecting to the MongoDB server.
+    # The Mongo::MongoClient instance connecting to the MongoDB server.
     attr_reader :connection
 
     # The length of time that Collection.ensure_index should cache index calls
@@ -59,8 +60,8 @@ module Mongo
     # Instances of DB are normally obtained by calling Mongo#db.
     #
     # @param [String] name the database name.
-    # @param [Mongo::Connection] connection a connection object pointing to MongoDB. Note
-    #   that databases are usually instantiated via the Connection class. See the examples below.
+    # @param [Mongo::MongoClient] client a connection object pointing to MongoDB. Note
+    #   that databases are usually instantiated via the MongoClient class. See the examples below.
     #
     # @option opts [Boolean] :strict (False) If true, collections must exist to be accessed and must
     #   not exist to be created. See DB#collection and DB#create_collection.
@@ -70,21 +71,23 @@ module Mongo
     #   fields the factory wishes to inject. (NOTE: if the object already has a primary key,
     #   the factory should not inject a new key).
     #
-    # @option opts [Boolean, Hash] :safe (false) Set the default safe-mode options
-    #   propagated to Collection objects instantiated off of this DB. If no
-    #   value is provided, the default value set on this instance's Connection object will be used. This
-    #   default can be overridden upon instantiation of any collection by explicity setting a :safe value
+    # @option opts [Hash] :w, :j, :wtimeout, :fsync Set the default write concern for this database.
+    #   Propagated to Collection objects instantiated off of this DB. If no
+    #   options are provided, the default write concern set on this instance's MongoClient object will be used. This
+    #   default can be overridden upon instantiation of any collection by explicitly setting write concern values
     #   on initialization
     #
     # @option opts [Integer] :cache_time (300) Set the time that all ensure_index calls should cache the command.
     #
     # @core databases constructor_details
-    def initialize(name, connection, opts={})
+    def initialize(name, client, opts={})
       @name       = Mongo::Support.validate_db_name(name)
-      @connection = connection
+      @connection = client
       @strict     = opts[:strict]
       @pk_factory = opts[:pk]
-      @safe       = opts.fetch(:safe, @connection.safe)
+
+      @write_concern = get_write_concern(opts, client)
+
       if value = opts[:read]
         Mongo::Support.validate_read_preference(value)
       else
@@ -102,7 +105,7 @@ module Mongo
     # @param [String] username
     # @param [String] password
     # @param [Boolean] save_auth
-    #   Save this authentication to the connection object using Connection#add_auth. This
+    #   Save this authentication to the client object using MongoClient#add_auth. This
     #   will ensure that the authentication will be applied on database reconnect. Note
     #   that this value must be true when using connection pooling.
     #
@@ -173,7 +176,7 @@ module Mongo
     # @return [Boolean]
     def remove_stored_function(function_name)
       if self[SYSTEM_JS_COLLECTION].find_one({"_id" => function_name})
-        self[SYSTEM_JS_COLLECTION].remove({"_id" => function_name}, :safe => true)
+        self[SYSTEM_JS_COLLECTION].remove({"_id" => function_name}, :w => 1)
       else
         return false
       end
@@ -205,14 +208,14 @@ module Mongo
     # @return [Boolean]
     def remove_user(username)
       if self[SYSTEM_USER_COLLECTION].find_one({:user => username})
-        self[SYSTEM_USER_COLLECTION].remove({:user => username}, :safe => true)
+        self[SYSTEM_USER_COLLECTION].remove({:user => username}, :w => 1)
       else
         return false
       end
     end
 
-    # Deauthorizes use for this database for this connection. Also removes
-    # any saved authentication in the connection class associated with this
+    # Deauthorizes use for this database for this client connection. Also removes
+    # any saved authentication in the MongoClient class associated with this
     # database.
     #
     # @raise [MongoDBError] if logging out fails.
@@ -258,7 +261,7 @@ module Mongo
     # a cursor which can be iterated over. For each collection, a hash
     # will be yielded containing a 'name' string and, optionally, an 'options' hash.
     #
-    # @param [String] coll_name return info for the specifed collection only.
+    # @param [String] coll_name return info for the specified collection only.
     #
     # @return [Mongo::Cursor]
     def collections_info(coll_name=nil)
@@ -323,7 +326,6 @@ module Mongo
           "Currently in strict mode."
       else
         opts = opts.dup
-        opts[:safe] = opts.fetch(:safe, @safe)
         opts.merge!(:pk => @pk_factory) unless opts[:pk]
         Collection.new(name, self, opts)
       end
@@ -368,9 +370,9 @@ module Mongo
       get_last_error['err'] != nil
     end
 
-    # Get the most recent error to have occured on this database.
+    # Get the most recent error to have occurred on this database.
     #
-    # This command only returns errors that have occured since the last call to
+    # This command only returns errors that have occurred since the last call to
     # DB#reset_error_history - returns +nil+ if there is no such error.
     #
     # @return [String, Nil] the text of the error or +nil+ if no error has occurred.

data/lib/mongo/exceptions.rb

@@ -2,7 +2,7 @@
 
 #
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/gridfs/grid.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -40,8 +40,8 @@ module Mongo
 
       # Create indexes only if we're connected to a primary node.
       connection = @db.connection
-      if (connection.class == Connection && connection.read_primary?) ||
-          (connection.class == ReplSetConnection && connection.primary)
+      if (connection.class == MongoClient && connection.read_primary?) ||
+          (connection.class == MongoReplicaSetClient && connection.primary)
         @chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
       end
     end
@@ -49,7 +49,7 @@ module Mongo
     # Store a file in the file store. This method is designed only for writing new files;
     # if you need to update a given file, first delete it using Grid#delete.
     #
-    # Note that arbitary metadata attributes can be saved to the file by passing
+    # Note that arbitrary metadata attributes can be saved to the file by passing
     # them in as options.
     #
     # @param [String, #read] data a string or io-like object to store.
@@ -62,8 +62,9 @@ module Mongo
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
     # @option opts [Integer] (262144) :chunk_size size of file chunks in bytes.
-    # @option opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
-    #   will be validated using an md5 hash. If validation fails, an exception will be raised.
+    # @option opts [Boolean] :w (1) Set the write concern
+    #   When :w > 0, the chunks sent to the server are validated using an md5 hash. 
+    #   If validation fails, an exception will be raised.
     #
     # @return [BSON::ObjectId] the file's id.
     def put(data, opts={})
@@ -72,7 +73,7 @@ module Mongo
       opts.merge!(default_grid_io_opts)
       file = GridIO.new(@files, @chunks, filename, 'w', opts)
       file.write(data)
-      file.close
+      file.close  
       file.files_id
     end
 

data/lib/mongo/gridfs/grid_ext.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/gridfs/grid_file_system.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -41,8 +41,8 @@ module Mongo
 
       # Create indexes only if we're connected to a primary node.
       connection = @db.connection
-      if (connection.class == Connection && connection.read_primary?) ||
-          (connection.class == ReplSetConnection && connection.primary)
+      if (connection.class == MongoClient && connection.read_primary?) ||
+          (connection.class == MongoReplicaSetClient && connection.primary)
         @files.create_index([['filename', 1], ['uploadDate', -1]])
         @chunks.create_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
       end
@@ -51,7 +51,7 @@ module Mongo
     # Open a file for reading or writing. Note that the options for this method only apply
     # when opening in 'w' mode.
     #
-    # Note that arbitary metadata attributes can be saved to the file by passing
+    # Note that arbitrary metadata attributes can be saved to the file by passing
     # them is as options.
     #
     # @param [String] filename the name of the file.
@@ -69,7 +69,8 @@ module Mongo
     # @option opts [Boolean] :delete_old (false) ensure that old versions of the file are deleted. This option
     #  only work in 'w' mode. Certain precautions must be taken when deleting GridFS files. See the notes under
     #  GridFileSystem#delete.
-    # @option opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
+    # @option opts [Hash] :w (1) Set the write concern
+    #   When :w > 0, the chunks sent to the server
     #   will be validated using an md5 hash. If validation fails, an exception will be raised.
     # @option opts [Integer] :versions (false) deletes all versions which exceed the number specified to 
     #   retain ordered by uploadDate. This option only works in 'w' mode. Certain precautions must be taken when 

data/lib/mongo/gridfs/grid_io.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,7 +22,9 @@ module Mongo
 
   # GridIO objects represent files in the GridFS specification. This class
   # manages the reading and writing of file chunks and metadata.
-  class GridIO
+  class GridIO 
+    include Mongo::WriteConcern
+    
     DEFAULT_CHUNK_SIZE   = 256 * 1024
     DEFAULT_CONTENT_TYPE = 'binary/octet-stream'
     PROTECTED_ATTRS      = [:files_id, :file_length, :client_md5, :server_md5]
@@ -48,20 +50,21 @@ module Mongo
     # @option opts [String] :content_type ('binary/octet-stream') If no content type is specified,
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
-    # @option opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
+    # @option opts [Hash] :w (1) Set the default write concern
+    #   When :w > 0, the chunks sent to the server
     #   will be validated using an md5 hash. If validation fails, an exception will be raised.
     def initialize(files, chunks, filename, mode, opts={})
-      @files        = files
-      @chunks       = chunks
-      @filename     = filename
-      @mode         = mode
-      opts          = opts.dup
-      @query        = opts.delete(:query) || {}
-      @query_opts   = opts.delete(:query_opts) || {}
-      @fs_name      = opts.delete(:fs_name) || Grid::DEFAULT_FS_NAME
-      @safe         = opts.delete(:safe) || false
-      @local_md5    = Digest::MD5.new if @safe
-      @custom_attrs = {}
+      @files          = files
+      @chunks         = chunks
+      @filename       = filename
+      @mode           = mode
+      opts            = opts.dup
+      @query          = opts.delete(:query) || {}
+      @query_opts     = opts.delete(:query_opts) || {}
+      @fs_name        = opts.delete(:fs_name) || Grid::DEFAULT_FS_NAME
+      @write_concern  = get_write_concern(opts)
+      @local_md5      = Digest::MD5.new if Mongo::WriteConcern.gle?(@write_concern)
+      @custom_attrs   = {}
 
       case @mode
         when 'r' then init_read
@@ -113,13 +116,13 @@ module Mongo
     def write(io)
       raise GridError, "file not opened for write" unless @mode[0] == ?w
       if io.is_a? String
-        if @safe
+        if Mongo::WriteConcern.gle?(@write_concern)
           @local_md5.update(io)
         end
         write_string(io)
       else
         length = 0
-        if @safe
+        if Mongo::WriteConcern.gle?(@write_concern)
           while(string = io.read(@chunk_size))
             @local_md5.update(string)
             length += write_string(string)
@@ -428,7 +431,7 @@ module Mongo
       @aliases       = opts.delete(:aliases)
       @file_length   = 0
       opts.each {|k, v| self[k] = v}
-      check_existing_file if @safe
+      check_existing_file if Mongo::WriteConcern.gle?(@write_concern)
 
       @current_chunk = create_chunk(0)
       @file_position = 0
@@ -455,13 +458,13 @@ module Mongo
       h
     end
 
-    # Get a server-side md5 and validate against the client if running in safe mode.
+    # Get a server-side md5 and validate against the client if running with acknowledged writes
     def get_md5
       md5_command            = BSON::OrderedHash.new
       md5_command['filemd5'] = @files_id
       md5_command['root']    = @fs_name
       @server_md5 = @files.db.command(md5_command)['md5']
-      if @safe
+      if Mongo::WriteConcern.gle?(@write_concern)
         @client_md5 = @local_md5.hexdigest
         if @local_md5 == @server_md5
           @server_md5