mongo 1.1.5 → 1.2.rc0

data/README.md

@@ -12,7 +12,7 @@ This documentation includes other articles of interest, include:
 6. [History](http://api.mongodb.org/ruby/current/file.HISTORY.html).
 7. [Credits](http://api.mongodb.org/ruby/current/file.CREDITS.html).
 
-Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](file.TUTORIAL.html)
+Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](http://api.mongodb.org/ruby/current/file.TUTORIAL.html)
 for much more:
 
     require 'rubygems'

data/docs/HISTORY.md

@@ -1,5 +1,13 @@
 # MongoDB Ruby Driver History
 
+1.2.rc0
+2011-1-5
+
+Lots of cleanp and minor bug fixes.
+* Issues resolved: http://jira.mongodb.org/browse/RUBY/fixforversion/10222
+* Updated Java BSON to Java driver 2.4.
+* Platform gem for JRuby bson.
+
 ### 1.1.5
 2010-12-15
 

data/docs/REPLICA_SETS.md

@@ -38,18 +38,14 @@ every half second and time out after thirty seconds.
 
     # Ensure retry upon failure
     def rescue_connection_failure(max_retries=60)
-        success = false
-        retries = 0
-        while !success
-          begin
-            yield
-            success = true
-          rescue Mongo::ConnectionFailure => ex
-            retries += 1
-            raise ex if retries >= max_retries
-            sleep(0.5)
-          end
-        end
+      retries = 0
+      begin
+        yield
+      rescue Mongo::ConnectionFailure => ex
+        retries += 1
+        raise ex if retries > max_retries
+        sleep(0.5)
+        retry
       end
     end
 

data/lib/mongo.rb

@@ -3,7 +3,7 @@
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 module Mongo
-  VERSION = "1.1.5"
+  VERSION = "1.2.rc0"
 end
 
 module Mongo
@@ -11,6 +11,8 @@ module Mongo
   DESCENDING = -1
   GEO2D      = '2d'
 
+  DEFAULT_MAX_BSON_SIZE = 4 * 1024 * 1024
+
   module Constants
     OP_REPLY        = 1
     OP_MSG          = 1000

data/lib/mongo/collection.rb

@@ -24,13 +24,13 @@ module Mongo
 
     # Initialize a collection object.
     #
-    # @param [DB] db a MongoDB database instance.
     # @param [String, Symbol] name the name of the collection.
+    # @param [DB] db a MongoDB database instance.
     #
-    # @option options [:create_pk] :pk (BSON::ObjectId) A primary key factory to use
+    # @option opts [:create_pk] :pk (BSON::ObjectId) A primary key factory to use
     #   other than the default BSON::ObjectId.
     #
-    # @option options [Boolean, Hash] :safe (false) Set the default safe-mode options
+    # @option opts [Boolean, Hash] :safe (false) Set the default safe-mode options
     #   for insert, update, and remove method called on this Collection instance. If no
     #   value is provided, the default value set on this instance's DB will be used. This
     #   default can be overridden for any invocation of insert, update, or remove.
@@ -44,7 +44,13 @@ module Mongo
     # @return [Collection]
     #
     # @core collections constructor_details
-    def initialize(db, name, options={})
+    def initialize(name, db, opts={})
+      if db.is_a?(String) && name.is_a?(Mongo::DB)
+        warn "Warning: the order of parameters to initialize a collection have changed. " +
+             "Please specify the collection name first, followed by the db."
+        db, name = name, db
+      end
+
       case name
       when Symbol, String
       else
@@ -63,10 +69,10 @@ module Mongo
         raise Mongo::InvalidNSName, "collection names must not start or end with '.'"
       end
 
-      if options.respond_to?(:create_pk) || !options.is_a?(Hash)
+      if opts.respond_to?(:create_pk) || !opts.is_a?(Hash)
         warn "The method for specifying a primary key factory on a Collection has changed.\n" +
           "Please specify it as an option (e.g., :pk => PkFactory)."
-        pk_factory = options
+        pk_factory = opts
       else
         pk_factory = nil
       end
@@ -77,9 +83,9 @@ module Mongo
       @cache_time = @db.cache_time
       @cache = Hash.new(0)
       unless pk_factory
-        @safe       = options.has_key?(:safe) ? options[:safe] : @db.safe
+        @safe = opts.fetch(:safe, @db.safe)
       end
-      @pk_factory = pk_factory || options[:pk] || BSON::ObjectId
+      @pk_factory = pk_factory || opts[:pk] || BSON::ObjectId
       @hint = nil
     end
 
@@ -96,7 +102,7 @@ module Mongo
     #   the specified sub-collection
     def [](name)
       name = "#{self.name}.#{name}"
-      return Collection.new(db, name) if !db.strict? || db.collection_names.include?(name)
+      return Collection.new(name, db) if !db.strict? || db.collection_names.include?(name)
       raise "Collection #{name} doesn't exist. Currently in strict mode."
     end
 
@@ -134,7 +140,7 @@ module Mongo
     #   to Ruby 1.8).
     #
     # @option opts [Array, Hash] :fields field names that should be returned in the result
-    #   set ("_id" will always be included). By limiting results to a certain subset of fields,
+    #   set ("_id" will be included unless explicity excluded). By limiting results to a certain subset of fields,
     #   you can cut down on network traffic and decoding time. If using a Hash, keys should be field
     #   names and values should be either 1 or 0, depending on whether you want to include or exclude
     #   the given field.
@@ -271,10 +277,10 @@ module Mongo
     # @see DB#remove for options that can be passed to :safe.
     #
     # @core insert insert-instance_method
-    def insert(doc_or_docs, options={})
+    def insert(doc_or_docs, opts={})
       doc_or_docs = [doc_or_docs] unless doc_or_docs.is_a?(Array)
       doc_or_docs.collect! { |doc| @pk_factory.create_pk(doc) }
-      safe = options.has_key?(:safe) ? options[:safe] : @safe
+      safe = opts.fetch(:safe, @safe)
       result = insert_documents(doc_or_docs, @name, true, safe)
       result.size > 1 ? result : result.first
     end
@@ -310,7 +316,7 @@ module Mongo
     # @core remove remove-instance_method
     def remove(selector={}, opts={})
       # Initial byte is 0.
-      safe = opts.has_key?(:safe) ? opts[:safe] : @safe
+      safe = opts.fetch(:safe, @safe)
       message = BSON::ByteBuffer.new("\0\0\0\0")
       BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@name}")
       message.put_int(0)
@@ -336,8 +342,8 @@ module Mongo
     #   a hash specifying the fields to be changed in the selected document,
     #   or (in the case of an upsert) the document to be inserted
     #
-    # @option [Boolean] :upsert (+false+) if true, performs an upsert (update or insert)
-    # @option [Boolean] :multi (+false+) update all documents matching the selector, as opposed to
+    # @option opts [Boolean] :upsert (+false+) if true, performs an upsert (update or insert)
+    # @option opts [Boolean] :multi (+false+) update all documents matching the selector, as opposed to
     #   just the first matching document. Note: only works in MongoDB 1.1.3 or later.
     # @option opts [Boolean] :safe (+false+) 
     #   If true, check that the save succeeded. OperationFailure
@@ -350,14 +356,14 @@ module Mongo
     #   Otherwise, returns true.
     #
     # @core update update-instance_method
-    def update(selector, document, options={})
+    def update(selector, document, opts={})
       # Initial byte is 0.
-      safe = options.has_key?(:safe) ? options[:safe] : @safe
+      safe = opts.fetch(:safe, @safe)
       message = BSON::ByteBuffer.new("\0\0\0\0")
       BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@name}")
       update_options  = 0
-      update_options += 1 if options[:upsert]
-      update_options += 2 if options[:multi]
+      update_options += 1 if opts[:upsert]
+      update_options += 2 if opts[:multi]
       message.put_int(update_options)
       message.put_binary(BSON::BSON_CODER.serialize(selector, false, true).to_s)
       message.put_binary(BSON::BSON_CODER.serialize(document, false, true).to_s)
@@ -415,6 +421,7 @@ module Mongo
       opts[:dropDups] = opts.delete(:drop_dups) if opts[:drop_dups]
       field_spec = parse_index_spec(spec)
       name = opts.delete(:name) || generate_index_name(field_spec)
+      name = name.to_s if name
 
       generate_indexes(field_spec, name, opts)
       name
@@ -437,18 +444,15 @@ module Mongo
     #
     # @return [String] the name of the index.
     def ensure_index(spec, opts={})
-      valid = BSON::OrderedHash.new
       now = Time.now.utc.to_i
       field_spec = parse_index_spec(spec)
 
-      field_spec.each do |key, value|
-        cache_key = generate_index_name({key => value})
-        timeout = @cache[cache_key] || 0
-        valid[key] = value if timeout <= now
-      end
+      name = opts.delete(:name) || generate_index_name(field_spec)
+      name = name.to_s if name
 
-      name = opts.delete(:name) || generate_index_name(valid)
-      generate_indexes(valid, name, opts) if valid.any?
+      if !@cache[name] || @cache[name] <= now
+        generate_indexes(field_spec, name, opts)
+      end
 
       # Reset the cache here in case there are any errors inserting. Best to be safe.
       @cache[name] = now + @cache_time
@@ -461,7 +465,7 @@ module Mongo
     #
     # @core indexes
     def drop_index(name)
-      @cache[name] = nil
+      @cache[name.to_s] = nil
       @db.drop_index(@name, name)
     end
 

data/lib/mongo/connection.rb

@@ -55,16 +55,16 @@ module Mongo
     # @param [String, Hash] host.
     # @param [Integer] port specify a port number here if only one host is being specified.
     #
-    # @option options [Boolean, Hash] :safe (false) Set the default safe-mode options
+    # @option opts [Boolean, Hash] :safe (false) Set the default safe-mode options
     #   propogated to DB objects instantiated off of this Connection. This
     #   default can be overridden upon instantiation of any DB by explicity setting a :safe value
     #   on initialization.
-    # @option options [Boolean] :slave_ok (false) Must be set to +true+ when connecting
+    # @option opts [Boolean] :slave_ok (false) Must be set to +true+ when connecting
     #   to a single, slave node.
-    # @option options [Logger, #debug] :logger (nil) Logger instance to receive driver operation log.
-    # @option options [Integer] :pool_size (1) The maximum number of socket connections allowed per
+    # @option opts [Logger, #debug] :logger (nil) Logger instance to receive driver operation log.
+    # @option opts [Integer] :pool_size (1) The maximum number of socket connections allowed per
     #   connection pool. Note: this setting is relevant only for multi-threaded applications.
-    # @option options [Float] :timeout (5.0) When all of the connections a pool are checked out,
+    # @option opts [Float] :timeout (5.0) When all of the connections a pool are checked out,
     #   this is the number of seconds to wait for a new connection to be released before throwing an exception.
     #   Note: this setting is relevant only for multi-threaded applications (which in Ruby are rare).
     #
@@ -86,16 +86,16 @@ module Mongo
     #   driver fails to connect to a replica set with that name.
     #
     # @core connections
-    def initialize(host=nil, port=nil, options={})
+    def initialize(host=nil, port=nil, opts={})
       @host_to_try = format_pair(host, port)
 
       # Host and port of current master.
       @host = @port = nil
 
       # slave_ok can be true only if one node is specified
-      @slave_ok = options[:slave_ok]
+      @slave_ok = opts[:slave_ok]
 
-      setup(options)
+      setup(opts)
     end
 
     # DEPRECATED
@@ -109,9 +109,9 @@ module Mongo
     # @param nodes [Array] An array of arrays, each of which specifies a host and port.
     # @param opts [Hash] Any of the available options that can be passed to Connection.new.
     #
-    # @option options [String] :rs_name (nil) The name of the replica set to connect to. An exception will be
+    # @option opts [String] :rs_name (nil) The name of the replica set to connect to. An exception will be
     #   raised if unable to connect to a replica set with this name.
-    # @option options [Boolean] :read_secondary (false) When true, this connection object will pick a random slave
+    # @option opts [Boolean] :read_secondary (false) When true, this connection object will pick a random slave
     #   to send reads to.
     #
     # @example
@@ -138,15 +138,19 @@ module Mongo
     #
     # @param opts Any of the options available for Connection.new
     #
-    # @return [Mongo::Connection]
-    def self.from_uri(uri, opts={})
-      nodes, auths = Mongo::URIParser.parse(uri)
-      opts.merge!({:auths => auths})
-      if nodes.length == 1
-        Connection.new(nodes[0][0], nodes[0][1], opts)
-      elsif nodes.length > 1
-        nodes << opts
-        ReplSetConnection.new(*nodes)
+    # @return [Mongo::Connection, Mongo::ReplSetConnection]
+    def self.from_uri(string, extra_opts={})
+      uri = URIParser.new(string)
+      opts = uri.connection_options
+      opts.merge!(extra_opts)
+
+      if uri.nodes.length == 1
+        opts.merge!({:auths => uri.auths})
+        Connection.new(uri.nodes[0][0], uri.nodes[0][1], opts)
+      elsif uri.nodes.length > 1
+        nodes = uri.nodes.clone
+        nodes_with_opts = nodes << opts
+        ReplSetConnection.new(*nodes_with_opts)
       else
         raise MongoArgumentError, "No nodes specified. Please ensure that you've provided at least one node."
       end
@@ -259,12 +263,13 @@ module Mongo
     # See DB#new for valid options hash parameters.
     #
     # @param [String] db_name a valid database name.
+    # @param [Hash] opts options to be passed to the DB constructor.
     #
     # @return [Mongo::DB]
     #
     # @core databases db-instance_method
-    def db(db_name, options={})
-      DB.new(db_name, self, options)
+    def db(db_name, opts={})
+      DB.new(db_name, self, opts)
     end
 
     # Shortcut for returning a database. Use DB#db to accept options.
@@ -430,11 +435,19 @@ module Mongo
       reset_connection
 
       config = check_is_master(@host_to_try)
-      if is_primary?(config)
+      if config
+        if config['ismaster'] == 1 || config['ismaster'] == true
+          @read_primary = true
+        elsif @slave_ok
+          @read_primary = false
+        end
+
         set_primary(@host_to_try)
       end
 
-      if !connected?
+      if connected?
+        BSON::BSON_CODER.update_max_bson_size(self)
+      else
         raise ConnectionFailure, "Failed to connect to a master node at #{@host_to_try[0]}:#{@host_to_try[1]}"
       end
     end
@@ -450,12 +463,29 @@ module Mongo
       @primary_pool && @primary_pool.host && @primary_pool.port
     end
 
+    # Determine whether we're reading from a primary node. If false,
+    # this connection connects to a secondary node and @slave_ok is true.
+    #
+    # @return [Boolean]
+    def read_primary?
+      @read_primary
+    end
+
     # Close the connection to the database.
     def close
       @primary_pool.close if @primary_pool
       @primary_pool = nil
     end
 
+    # Returns the maximum BSON object size as returned by the core server.
+    # Use the 4MB default when the server doesn't report this.
+    #
+    # @return [Integer]
+    def max_bson_size
+      config = self['admin'].command({:ismaster => 1})
+      config['maxBsonObjectSize'] || Mongo::DEFAULT_MAX_BSON_SIZE
+    end
+
     # Checkout a socket for reading (i.e., a secondary node).
     # Note: this is overridden in ReplSetConnection.
     def checkout_reader
@@ -489,23 +519,22 @@ module Mongo
     protected
 
     # Generic initialization code.
-    # @protected
-    def setup(options)
+    def setup(opts)
       # Authentication objects
-      @auths = options.fetch(:auths, [])
+      @auths = opts.fetch(:auths, [])
 
       # Lock for request ids.
       @id_lock = Mutex.new
 
       # Pool size and timeout.
-      @pool_size = options[:pool_size] || 1
-      @timeout   = options[:timeout]   || 5.0
+      @pool_size = opts[:pool_size] || 1
+      @timeout   = opts[:timeout]   || 5.0
 
       # Mutex for synchronizing pool access
       @connection_mutex = Mutex.new
 
       # Global safe option. This is false by default.
-      @safe = options[:safe] || false
+      @safe = opts[:safe] || false
 
       # Create a mutex when a new key, in this case a socket,
       # is added to the hash.
@@ -518,9 +547,9 @@ module Mongo
       @primary      = nil
       @primary_pool = nil
 
-      @logger   = options[:logger] || nil
+      @logger   = opts[:logger] || nil
 
-      should_connect = options.fetch(:connect, true)
+      should_connect = opts.fetch(:connect, true)
       connect if should_connect
     end
 
@@ -552,16 +581,6 @@ module Mongo
       @primary = nil
     end
 
-    # Primary is defined as either a master node or a slave if
-    # :slave_ok has been set to +true+.
-    #
-    # If a primary node is discovered, we set the the @host and @port and
-    # apply any saved authentication.
-    # TODO: simplify
-    def is_primary?(config)
-      config && (config['ismaster'] == 1 || config['ismaster'] == true) || @slave_ok
-    end
-
     def check_is_master(node)
       begin
         host, port = *node
@@ -673,7 +692,7 @@ module Mongo
     #
     # Note: this method modifies message by reference.
     #
-    # @returns [Integer] the request id used in the header
+    # @return [Integer] the request id used in the header
     def add_message_headers(message, operation)
       headers = [
         # Message size.

data/lib/mongo/cursor.rb

@@ -33,26 +33,26 @@ module Mongo
     # @return [Cursor]
     #
     # @core cursors constructor_details
-    def initialize(collection, options={})
+    def initialize(collection, opts={})
       @db         = collection.db
       @collection = collection
       @connection = @db.connection
       @logger     = @connection.logger
 
-      @selector   = options[:selector] || {}
-      @fields     = convert_fields_for_query(options[:fields])
-      @skip       = options[:skip]     || 0
-      @limit      = options[:limit]    || 0
-      @order      = options[:order]
-      @hint       = options[:hint]
-      @snapshot   = options[:snapshot]
-      @timeout    = options.has_key?(:timeout) ? options[:timeout] : true
-      @explain    = options[:explain]
-      @socket     = options[:socket]
-      @tailable   = options[:tailable] || false
+      @selector   = opts[:selector] || {}
+      @fields     = convert_fields_for_query(opts[:fields])
+      @skip       = opts[:skip]     || 0
+      @limit      = opts[:limit]    || 0
+      @order      = opts[:order]
+      @hint       = opts[:hint]
+      @snapshot   = opts[:snapshot]
+      @timeout    = opts.fetch(:timeout, true)
+      @explain    = opts[:explain]
+      @socket     = opts[:socket]
+      @tailable   = opts[:tailable] || false
       @closed       = false
       @query_run    = false
-      batch_size(options[:batch_size] || 0)
+      batch_size(opts[:batch_size] || 0)
 
       @full_collection_name = "#{@collection.db.name}.#{@collection.name}"
       @cache        = []