mongo 1.3.0 → 1.3.1

data/README.md

@@ -18,17 +18,18 @@ for much more:
 
     require 'rubygems'
     require 'mongo'
-    include Mongo
 
-    db   = Connection.new.db('sample-db')
-    coll = db.collection('test')
+    @conn = Mongo::Connection.new
+    @db   = @conn['sample-db']
+    @coll = @db['test']
 
-    coll.remove
+    @coll.remove
     3.times do |i|
-      coll.insert({'a' => i+1})
+      @coll.insert({'a' => i+1})
     end
-    puts "There are #{coll.count()} records. Here they are:"
-    coll.find().each { |doc| puts doc.inspect }
+
+    puts "There are #{@coll.count} records. Here they are:"
+    @coll.find.each { |doc| puts doc.inspect }
 
 # Installation
 

data/docs/HISTORY.md

@@ -1,5 +1,24 @@
 # MongoDB Ruby Driver History
 
+### 1.3.1
+2011-5-10
+
+* Fix GridIO#gets infinite loop error (Ryan McGeary)
+* Fix BSON::OrderedHash#reject! leaving keys with null values (rpt. by Ben Poweski)
+* Minor semantic fix for OrderedHash#reject!
+* Fix Mongo::DB to allow symbols in method traversing collection names (rpt. by Chris Griego)
+* Support new server regex option "s" (dotall). This is folded in with \m in Ruby.
+* Fix so that Cursor#close hits the right node when :read_secondary is enabled.
+* Support maxScan, showDiskLoc, and returnKey cursor options.
+* Make DB#validate_collection compatible with server v1.9.1.
+* Fix so that GridIO#gets returns local md5 with md5 matches server md5 (Steve Tantra).
+* Fix bug in BSON::OrderedHash that prevents YAML.load (Ian Warshak).
+* Fix example from /examples.
+* Ensure that we do not modify hash arguments by calling Hash#dup when appropriate.
+* Ensure that JRuby deserializer preserves binary subtypes properly.
+* Fix for streaming an empty file into GridFS (Daniël van de Burgt).
+* Minor doc fixes.
+
 ### 1.3.0
 2011-4-04
 

data/lib/mongo.rb

@@ -19,7 +19,7 @@
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 module Mongo
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end
 
 module Mongo

data/lib/mongo/collection.rb

@@ -91,7 +91,7 @@ module Mongo
     # Return a sub-collection of this collection by name. If 'users' is a collection, then
     # 'users.comments' is a sub-collection of users.
     #
-    # @param [String] name
+    # @param [String, Symbol] name
     #   the collection to return
     #
     # @raise [Mongo::InvalidNSName]
@@ -101,7 +101,8 @@ module Mongo
     #   the specified sub-collection
     def [](name)
       name = "#{self.name}.#{name}"
-      return Collection.new(name, db) if !db.strict? || db.collection_names.include?(name)
+      return Collection.new(name, db) if !db.strict? ||
+        db.collection_names.include?(name.to_s)
       raise "Collection #{name} doesn't exist. Currently in strict mode."
     end
 
@@ -147,16 +148,23 @@ module Mongo
     # @option opts [Integer] :limit maximum number of documents to return
     # @option opts [Array]   :sort an array of [key, direction] pairs to sort by. Direction should
     #   be specified as Mongo::ASCENDING (or :ascending / :asc) or Mongo::DESCENDING (or :descending / :desc)
-    # @option opts [String, Array, OrderedHash] :hint hint for query optimizer, usually not necessary if using MongoDB > 1.1
+    # @option opts [String, Array, OrderedHash] :hint hint for query optimizer, usually not necessary if
+    #   using MongoDB > 1.1
     # @option opts [Boolean] :snapshot (false) if true, snapshot mode will be used for this query.
     #   Snapshot mode assures no duplicates are returned, or objects missed, which were preset at both the start and
-    #   end of the query's execution. For details see http://www.mongodb.org/display/DOCS/How+to+do+Snapshotting+in+the+Mongo+Database
-    # @option opts [Boolean] :batch_size (100) the number of documents to returned by the database per GETMORE operation. A value of 0
-    #   will let the database server decide how many results to returns. This option can be ignored for most use cases.
+    #   end of the query's execution.
+    #   For details see http://www.mongodb.org/display/DOCS/How+to+do+Snapshotting+in+the+Mongo+Database
+    # @option opts [Boolean] :batch_size (100) the number of documents to returned by the database per
+    #   GETMORE operation. A value of 0 will let the database server decide how many results to returns.
+    #   This option can be ignored for most use cases.
     # @option opts [Boolean] :timeout (true) when +true+, the returned cursor will be subject to
-    #   the normal cursor timeout behavior of the mongod process. When +false+, the returned cursor will never timeout. Note
-    #   that disabling timeout will only work when #find is invoked with a block. This is to prevent any inadvertant failure to
-    #   close the cursor, as the cursor is explicitly closed when block code finishes.
+    #   the normal cursor timeout behavior of the mongod process. When +false+, the returned cursor will
+    #   never timeout. Note that disabling timeout will only work when #find is invoked with a block.
+    #   This is to prevent any inadvertant failure to close the cursor, as the cursor is explicitly
+    #   closed when block code finishes.
+    # @option opts [Integer] :max_scan (nil) Limit the number of items to scan on both collection scans and indexed queries..
+    # @option opts [Boolean] :show_disk_loc (false) Return the disk location of each query result (for debugging).
+    # @option opts [Boolean] :return_key (false) Return the index key used to obtain the result (for debugging).
     # @option opts [Block] :transformer (nil) a block for tranforming returned documents.
     #   This is normally used by object mappers to convert each returned document to an instance of a class.
     #
@@ -168,6 +176,7 @@ module Mongo
     #
     # @core find find-instance_method
     def find(selector={}, opts={})
+      opts   = opts.dup
       fields = opts.delete(:fields)
       fields = ["_id"] if fields && fields.empty?
       skip   = opts.delete(:skip) || skip || 0
@@ -385,7 +394,7 @@ module Mongo
         if safe
           @connection.send_message_with_safe_check(Mongo::Constants::OP_UPDATE, message, @db.name, nil, safe)
         else
-          @connection.send_message(Mongo::Constants::OP_UPDATE, message, nil)
+          @connection.send_message(Mongo::Constants::OP_UPDATE, message)
         end
       end
     end
@@ -433,8 +442,9 @@ module Mongo
     #
     # @core indexes create_index-instance_method
     def create_index(spec, opts={})
-      opts[:dropDups] = opts.delete(:drop_dups) if opts[:drop_dups]
+      opts[:dropDups] = opts[:drop_dups] if opts[:drop_dups]
       field_spec = parse_index_spec(spec)
+      opts = opts.dup
       name = opts.delete(:name) || generate_index_name(field_spec)
       name = name.to_s if name
 
@@ -462,7 +472,7 @@ module Mongo
       now = Time.now.utc.to_i
       field_spec = parse_index_spec(spec)
 
-      name = opts.delete(:name) || generate_index_name(field_spec)
+      name = opts[:name] || generate_index_name(field_spec)
       name = name.to_s if name
 
       if !@cache[name] || @cache[name] <= now
@@ -555,7 +565,7 @@ module Mongo
     def map_reduce(map, reduce, opts={})
       map    = BSON::Code.new(map) unless map.is_a?(BSON::Code)
       reduce = BSON::Code.new(reduce) unless reduce.is_a?(BSON::Code)
-      raw    = opts.delete(:raw)
+      raw    = opts[:raw]
 
       hash = BSON::OrderedHash.new
       hash['mapreduce'] = self.name
@@ -867,7 +877,7 @@ module Mongo
         if safe
           @connection.send_message_with_safe_check(Mongo::Constants::OP_INSERT, message, @db.name, nil, safe)
         else
-          @connection.send_message(Mongo::Constants::OP_INSERT, message, nil)
+          @connection.send_message(Mongo::Constants::OP_INSERT, message)
         end
       end
       documents.collect { |o| o[:_id] || o['_id'] }

data/lib/mongo/connection.rb

@@ -381,15 +381,36 @@ module Mongo
     # @param [Integer] operation a MongoDB opcode.
     # @param [BSON::ByteBuffer] message a message to send to the database.
     #
+    # @option opts [Symbol] :connection (:writer) The connection to which
+    #   this message should be sent. Valid options are :writer and :reader.
+    #
     # @return [Integer] number of bytes sent
-    def send_message(operation, message, log_message=nil)
+    def send_message(operation, message, opts={})
+      if opts.is_a?(String)
+        warn "Connection#send_message no longer takes a string log message. " +
+          "Logging is now handled within the Collection and Cursor classes."
+        opts = {}
+      end
+
+      connection = opts.fetch(:connection, :writer)
+
       begin
         add_message_headers(message, operation)
         packed_message = message.to_s
-        socket = checkout_writer
+
+        if connection == :writer
+          socket = checkout_writer
+        else
+          socket = checkout_reader
+        end
+
         send_message_on_socket(packed_message, socket)
       ensure
-        checkin_writer(socket)
+        if connection == :writer
+          checkin_writer(socket)
+        else
+          checkin_reader(socket)
+        end
       end
     end
 
@@ -437,7 +458,10 @@ module Mongo
     #
     # @param [Integer] operation a MongoDB opcode.
     # @param [BSON::ByteBuffer] message a message to send to the database.
+    # @param [String] log_message this is currently a no-op and will be removed.
     # @param [Socket] socket a socket to use in lieu of checking out a new one.
+    # @param [Boolean] command (false) indicate whether this is a command. If this is a command,
+    #   the message will be sent to the primary node.
     #
     # @return [Array]
     #   An array whose indexes include [0] documents returned, [1] number of document received,

data/lib/mongo/cursor.rb

@@ -41,19 +41,31 @@ module Mongo
       @connection = @db.connection
       @logger     = @connection.logger
 
+      # Query selector
       @selector   = opts[:selector] || {}
-      @fields     = convert_fields_for_query(opts[:fields])
-      @skip       = opts[:skip]     || 0
-      @limit      = opts[:limit]    || 0
+
+      # Special operators that form part of $query
       @order      = opts[:order]
+      @explain    = opts[:explain]
       @hint       = opts[:hint]
       @snapshot   = opts[:snapshot]
+      @max_scan   = opts.fetch(:max_scan, nil)
+      @return_key = opts.fetch(:return_key, nil)
+      @show_disk_loc = opts.fetch(:show_disk_loc, nil)
+
+      # Wire-protocol settings
+      @fields     = convert_fields_for_query(opts[:fields])
+      @skip       = opts[:skip]     || 0
+      @limit      = opts[:limit]    || 0
+      @tailable   = opts[:tailable] || false
       @timeout    = opts.fetch(:timeout, true)
-      @explain    = opts[:explain]
+
+      # Use this socket for the query
       @socket     = opts[:socket]
-      @tailable   = opts[:tailable] || false
+
       @closed       = false
       @query_run    = false
+
       @transformer = opts[:transformer]
       batch_size(opts[:batch_size] || 0)
 
@@ -284,7 +296,7 @@ module Mongo
         message.put_int(1)
         message.put_long(@cursor_id)
         @logger.debug("MONGODB cursor.close #{@cursor_id}") if @logger
-        @connection.send_message(Mongo::Constants::OP_KILL_CURSORS, message, nil)
+        @connection.send_message(Mongo::Constants::OP_KILL_CURSORS, message, :connection => :reader)
       end
       @cursor_id = 0
       @closed    = true
@@ -320,7 +332,10 @@ module Mongo
         :order    => @order,
         :hint     => @hint,
         :snapshot => @snapshot,
-        :timeout  => @timeout }
+        :timeout  => @timeout,
+        :max_scan => @max_scan,
+        :return_key => @return_key,
+        :show_disk_loc => @show_disk_loc }
     end
 
     # Clean output for inspect.
@@ -429,6 +444,9 @@ module Mongo
       spec['$hint']     = @hint if @hint && @hint.length > 0
       spec['$explain']  = true if @explain
       spec['$snapshot'] = true if @snapshot
+      spec['$maxscan']  = @max_scan if @max_scan
+      spec['$returnKey']   = true if @return_key
+      spec['$showDiskLoc'] = true if @show_disk_loc
       spec
     end
 

data/lib/mongo/db.rb

@@ -251,26 +251,28 @@ module Mongo
     # new collection. If +strict+ is true, will raise an error if
     # collection +name+ already exists.
     #
-    # @param [String] name the name of the new collection.
+    # @param [String, Symbol] name the name of the new collection.
     #
     # @option opts [Boolean] :capped (False) created a capped collection.
     #
-    # @option opts [Integer] :size (Nil) If +capped+ is +true+, specifies the maximum number of
-    #   bytes for the capped collection. If +false+, specifies the number of bytes allocated
+    # @option opts [Integer] :size (Nil) If +capped+ is +true+,
+    #   specifies the maximum number of bytes for the capped collection.
+    #   If +false+, specifies the number of bytes allocated
     #   for the initial extent of the collection.
     #
-    # @option opts [Integer] :max (Nil) If +capped+ is +true+, indicates the maximum number of records
-    #   in a capped collection.
+    # @option opts [Integer] :max (Nil) If +capped+ is +true+, indicates
+    #   the maximum number of records in a capped collection.
     #
-    # @raise [MongoDBError] raised under two conditions: either we're in +strict+ mode and the collection
+    # @raise [MongoDBError] raised under two conditions:
+    #   either we're in +strict+ mode and the collection
     #   already exists or collection creation fails on the server.
     #
     # @return [Mongo::Collection]
     def create_collection(name, opts={})
-      # Does the collection already exist?
-      if collection_names.include?(name)
+      if collection_names.include?(name.to_s)
         if strict?
-          raise MongoDBError, "Collection #{name} already exists. Currently in strict mode."
+          raise MongoDBError, "Collection #{name} already exists. " +
+            "Currently in strict mode."
         else
           return Collection.new(name, self, opts)
         end
@@ -286,16 +288,19 @@ module Mongo
 
     # Get a collection by name.
     #
-    # @param [String] name the collection name.
+    # @param [String, Symbol] name the collection name.
     # @param [Hash] opts any valid options that can be passed to Collection#new.
     #
-    # @raise [MongoDBError] if collection does not already exist and we're in +strict+ mode.
+    # @raise [MongoDBError] if collection does not already exist and we're in
+    #   +strict+ mode.
     #
     # @return [Mongo::Collection]
     def collection(name, opts={})
-      if strict? && !collection_names.include?(name)
-        raise Mongo::MongoDBError, "Collection #{name} doesn't exist. Currently in strict mode."
+      if strict? && !collection_names.include?(name.to_s)
+        raise Mongo::MongoDBError, "Collection #{name} doesn't exist. " +
+          "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)
@@ -305,11 +310,11 @@ module Mongo
 
     # Drop a collection by +name+.
     #
-    # @param [String] name
+    # @param [String, Symbol] name
     #
     # @return [Boolean] +true+ on success or +false+ if the collection name doesn't exist.
     def drop_collection(name)
-      return true unless collection_names.include?(name)
+      return true unless collection_names.include?(name.to_s)
 
       ok?(command(:drop => name))
     end
@@ -590,11 +595,16 @@ module Mongo
     # @raise [MongoDBError] if the command fails or there's a problem with the validation
     #   data, or if the collection is invalid.
     def validate_collection(name)
-      doc = command({:validate => name}, :check_response => false)
-      raise MongoDBError, "Error with validate command: #{doc.inspect}" unless ok?(doc)
-      result = doc['result']
-      raise MongoDBError, "Error with validation data: #{doc.inspect}" unless result.kind_of?(String)
-      raise MongoDBError, "Error: invalid collection #{name}: #{doc.inspect}" if result =~ /\b(exception|corrupt)\b/i
+      cmd = BSON::OrderedHash.new
+      cmd[:validate] = name
+      cmd[:full] = true
+      doc = command(cmd, :check_response => false)
+      if !ok?(doc)
+        raise MongoDBError, "Error with validate command: #{doc.inspect}"
+      end
+      if (doc.has_key?('valid') && !doc['valid']) || (doc['result'] =~ /\b(exception|corrupt)\b/i)
+        raise MongoDBError, "Error: invalid collection #{name}: #{doc.inspect}"
+      end
       doc
     end
 

data/lib/mongo/gridfs/grid.rb

@@ -65,7 +65,8 @@ module Mongo
     #
     # @return [Mongo::ObjectId] the file's id.
     def put(data, opts={})
-      filename = opts.delete :filename
+      opts     = opts.dup
+      filename = opts[:filename]
       opts.merge!(default_grid_io_opts)
       file = GridIO.new(@files, @chunks, filename, 'w', opts=opts)
       file.write(data)

data/lib/mongo/gridfs/grid_file_system.rb

@@ -93,6 +93,7 @@ module Mongo
     #
     #  @return [Mongo::GridIO]
     def open(filename, mode, opts={})
+      opts = opts.dup
       opts.merge!(default_grid_io_opts(filename))
       del  = opts.delete(:delete_old) && mode == 'w'
       file = GridIO.new(@files, @chunks, filename, mode, opts)

data/lib/mongo/gridfs/grid_io.rb

@@ -55,6 +55,7 @@ module Mongo
       @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
@@ -207,43 +208,9 @@ module Mongo
       elsif separator.is_a?(Integer)
         read_length(separator)
       elsif separator.length > 1
-        result = ''
-        len = 0
-        match_idx = 0
-        match_num = separator.length - 1
-        to_match = separator[match_idx].chr
-        if length
-          matcher = lambda {|idx, num| idx < num && len < length }
-        else
-          matcher = lambda {|idx, num| idx < num}
-        end
-        while matcher.call(match_idx, match_num) && char = getc
-          result << char
-          len += 1
-          if char == to_match
-            while match_idx < match_num do
-              match_idx += 1
-              to_match = separator[match_idx].chr
-              char = getc
-              result << char
-              if char != to_match
-                match_idx = 0
-                to_match = separator[match_idx].chr
-                break
-              end
-            end
-          end
-        end
-        result
+        read_to_string(separator, length)
       else
-        result = ''
-        len = 0
-        while char = getc
-          result << char
-          len += 1
-          break if char == separator || (length ? len >= length : false)
-        end
-        result
+        read_to_character(separator, length)
       end
     end
 
@@ -284,8 +251,9 @@ module Mongo
     # @return [Mongo::GridIO] self
     def each
       return read_all unless block_given?
-      while chunk = read(chunk_size)
+      while chunk = read(chunk_size) 
         yield chunk
+        break if chunk.empty?
       end
       self
     end
@@ -316,21 +284,18 @@ module Mongo
       chunk
     end
 
-    def last_chunk_number
-      (@file_length / @chunk_size).to_i
-    end
-
     # Read a file in its entirety.
     def read_all
       buf = ''
       if @current_chunk
         buf << @current_chunk['data'].to_s
-        while chunk = get_chunk(@current_chunk['n'] + 1)
-          buf << chunk['data'].to_s
-          @current_chunk = chunk
+        while buf.size < @file_length
+          @current_chunk = get_chunk(@current_chunk['n'] + 1)
+          break if @current_chunk.nil?
+          buf << @current_chunk['data'].to_s
         end
+        @file_position = @file_length
       end
-      @file_position = @file_length
       buf
     end
 
@@ -361,6 +326,48 @@ module Mongo
       buf
     end
 
+    def read_to_character(character="\n", length=nil)
+      result = ''
+      len = 0
+      while char = getc
+        result << char
+        len += 1
+        break if char == character || (length ? len >= length : false)
+      end
+      result.length > 0 ? result : nil
+    end
+
+    def read_to_string(string="\n", length=nil)
+      result = ''
+      len = 0
+      match_idx = 0
+      match_num = string.length - 1
+      to_match = string[match_idx].chr
+      if length
+        matcher = lambda {|idx, num| idx < num && len < length }
+      else
+        matcher = lambda {|idx, num| idx < num}
+      end
+      while matcher.call(match_idx, match_num) && char = getc
+        result << char
+        len += 1
+        if char == to_match
+          while match_idx < match_num do
+            match_idx += 1
+            to_match = string[match_idx].chr
+            char = getc
+            result << char
+            if char != to_match
+              match_idx = 0
+              to_match = string[match_idx].chr
+              break
+            end
+          end
+        end
+      end
+      result.length > 0 ? result : nil
+    end
+
     def cache_chunk_data
       @current_chunk_data = @current_chunk['data'].to_s
       if @current_chunk_data.respond_to?(:force_encoding)
@@ -413,6 +420,7 @@ module Mongo
 
     # Initialize the class for writing a file.
     def init_write(opts)
+      opts           = opts.dup
       @files_id      = opts.delete(:_id) || BSON::ObjectId.new
       @content_type  = opts.delete(:content_type) || (defined? MIME) && get_content_type || DEFAULT_CONTENT_TYPE
       @chunk_size    = opts.delete(:chunk_size) || DEFAULT_CHUNK_SIZE
@@ -455,7 +463,9 @@ module Mongo
       @server_md5 = @files.db.command(md5_command)['md5']
       if @safe
         @client_md5 = @local_md5.hexdigest
-        if @local_md5 != @server_md5
+        if @local_md5 == @server_md5
+          @server_md5
+        else
           raise GridMD5Failure, "File on server failed MD5 check"
         end
       else