mongo 0.0.4 → 0.1.0

data/README.rdoc

@@ -111,11 +111,6 @@ See the git log comments.
   current thinking is that Mongo will allow a subset of JavaScript (which we
   would have to send as a string), but this is still under discussion.
 
-* Add explain and hint support.
-
-* Only update message sizes once, not after every write of a value. This will
-  require an explicit call to update_message_length in each message subclass.
-
 * Tests for update and repsert.
 
 * Add a way to specify a collection of databases on startup (a simple array of
@@ -123,17 +118,18 @@ See the git log comments.
   then find the master and, on each subsequent command, ask that machine if it
   is the master before proceeding.
 
-* Tests that prove that this driver's ObjectID and Geir's Java version do the
-  same thing. (I've done so manually.)
-
-* Support more types: REF, SYMBOL, CODE_W_SCOPE, etc.
-
 * Introduce optional per-database and per-collection PKInjector.
 
 * More tests.
 
-* Study src/main/ed/db/{dbcollection,dbcursor,db}.js and ByteEncoder.java in
-  the Babble code. That's what I should be writing to.
+== Optimizations
+
+* Only update message sizes once, not after every write of a value. This will
+  require an explicit call to update_message_length in each message subclass.
+
+* ensure_index commands should be cached to prevent excessive communication
+  with the database. (Or, the driver user should be informed that ensure_index
+  is not a lightweight operation for the particular driver.)
 
 
 = Credits

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
 GEM = "mongo"
-GEM_VERSION = '0.0.4'
+GEM_VERSION = '0.1.0'
 SUMMARY = 'Simple pure-Ruby driver for the 10gen Mongo DB'
 DESCRIPTION = 'This is a simple pure-Ruby driver for the 10gen Mongo DB. For more information about Mongo, see http://www.mongodb.org.'
 AUTHOR = 'Jim Menard'

data/lib/mongo/collection.rb

@@ -31,11 +31,19 @@ module XGen
         end
 
         # Set hint fields to use and return +self+. hint_fields may be a
-        # single field name or array of field names. May be +nil+. If no hint
-        # fields are specified, the ones in the collection are used if they
-        # exist.
+        # single field name, array of field names, or a hash whose keys will
+        # become the hint field names. May be +nil+.
         def hint(hint_fields)
-          @hint_fileds = hint_fileds
+          @hint_fields = case hint_fields
+                         when String
+                           [hint_fields]
+                         when Hash
+                           hint_fields.keys
+                         when nil
+                           nil
+                         else
+                           hint_fields.to_a
+                         end
           self
         end
 

data/lib/mongo/cursor.rb

@@ -43,11 +43,20 @@ module XGen
         def closed?; @closed; end
 
         # Set hint fields to use and return +self+. hint_fields may be a
-        # single field name or array of field names. May be +nil+. If no hint
-        # fields are specified, the ones in the collection are used if they
-        # exist.
+        # single field name, array of field names, or a hash whose keys will
+        # become the hint field names. May be +nil+. If no hint fields are
+        # specified, the ones in the collection are used if they exist.
         def hint(hint_fields)
-          @hint_fields = hint_fields
+          @hint_fields = case hint_fields
+                         when String
+                           [hint_fields]
+                         when Hash
+                           hint_fields.keys
+                         when nil
+                           nil
+                         else
+                           hint_fields.to_a
+                         end
           self
         end
 
@@ -61,7 +70,7 @@ module XGen
         def next_object
           refill_via_get_more if num_remaining == 0
           o = @cache.shift
-          raise o['$err'] if o['$err']
+          raise o['$err'] if o && o['$err']
           o
         end
 
@@ -116,13 +125,15 @@ module XGen
 
         # Returns an explain plan record.
         def explain
-          sel = OrderedHash.new
-          sel['query'] = @query.selector
-          sel['$explain'] = true
-          c = Cursor.new(@db, @collection, Query.new(sel))
-          e = c.next_object
+          old_val = @query.explain
+          @query.explain = true
+
+          c = Cursor.new(@db, @collection, @query)
+          explanation = c.next_object
           c.close
-          e
+
+          @query.explain = old_val
+          explanation
         end
 
         # Close the cursor.
@@ -201,19 +212,11 @@ module XGen
           # Run query first time we request an object from the wire
           unless @query_run
             hints = @hint_fields || @collection.hint_fields
-            hints = [hints] if hints.kind_of?(String)
-            query = if hints
-                      h = {}
-                      hints.each { |field| h[field] = 1 }
-                      sel = OrderedHash.new
-                      sel['query'] = @query.selector
-                      sel['$hint'] = h
-                      Query.new(sel)
-                    else
-                      @query
-                    end
-            @db.send_query_message(QueryMessage.new(@db.name, @collection.name, query))
+            old_hints = @query.hint_fields
+            @query.hint_fields = hints
+            @db.send_query_message(QueryMessage.new(@db.name, @collection.name, @query))
             @query_run = true
+            @query.hint_fields = old_hints
             read_all
           end
         end

data/lib/mongo/db.rb

@@ -16,7 +16,6 @@
 
 require 'socket'
 require 'mutex_m'
-require 'mongo/mongo'
 require 'mongo/collection'
 require 'mongo/message'
 require 'mongo/query'
@@ -49,25 +48,47 @@ module XGen
         # The name of the database.
         attr_reader :name
 
-        attr_reader :host, :port
+        # Host to which we are currently connected.
+        attr_reader :host
+        # Port to which we are currently connected.
+        attr_reader :port
 
-        # The database's socket. For internal use only.
+        # An array of [host, port] pairs.
+        attr_reader :nodes
+
+        # The database's socket. For internal (and Cursor) use only.
         attr_reader :socket
 
         # db_name :: The database name
         #
-        # host :: The database host name or IP address. Defaults to 'localhost'.
-        #
-        # port :: The database port number. Defaults to
-        #         XGen::Mongo::Driver::Mongo::DEFAULT_PORT.
+        # nodes :: An array of [host, port] pairs.
         #
-        def initialize(db_name, host='localhost', port=XGen::Mongo::Driver::Mongo::DEFAULT_PORT)
+        # When a DB object first connects, it tries the first node. If that
+        # fails, it keeps trying to connect to the remaining nodes until it
+        # sucessfully connects.
+        def initialize(db_name, nodes)
           raise "Invalid DB name" if !db_name || (db_name && db_name.length > 0 && db_name.include?("."))
-          @name, @host, @port = db_name, host, port
-          @socket = TCPSocket.new(@host, @port)
+          @name, @nodes = db_name, nodes
           @strict = false
           @semaphore = Object.new
           @semaphore.extend Mutex_m
+          connect_to_first_available_host
+        end
+
+        def connect_to_first_available_host
+          close if @socket
+          @host = @port = nil
+          @nodes.detect { |hp|
+            @host, @port = *hp
+            begin
+              @socket = TCPSocket.new(@host, @port)
+              break if ok?(db_command(:ismaster => 1)) # success
+            rescue => ex
+              close if @socket
+            end
+            @socket
+          }
+          raise "error: failed to connect to any given host:port" unless @socket
         end
 
         # Returns an array of collection names. Each name is of the form
@@ -167,9 +188,28 @@ module XGen
           end
         end
 
+        # Switches our socket to the master database. If we are already the
+        # master, no change is made.
+        def switch_to_master
+          master_str = master()
+          unless master_str == "#@host:#@port"
+            @semaphore.synchronize {
+              master_str =~ /(.+):(\d+)/
+              @host, @port = $1, $2
+              close()
+              @socket = TCPSocket.new(@host, @port)
+            }
+          end
+        end
+
         # Close the connection to the database.
         def close
-          @socket.close
+          @socket.close if @socket
+          @socket = nil
+        end
+
+        def connected?
+          @socket != nil
         end
 
         # Send a MsgMessage to the database.

data/lib/mongo/message/query_message.rb

@@ -18,21 +18,31 @@ module XGen
           write_int(query.number_to_skip)
           write_int(query.number_to_return)
           sel = query.selector
-          if query.order_by && query.order_by.length > 0
+          if query.contains_special_fields
             sel = OrderedHash.new
             sel['query'] = query.selector
-            sel['orderby'] = case query.order_by
-                             when String
-                               {query.order_by => 1}
-                             when Array
-                               h = OrderedHash.new
-                               query.order_by.each { |ob| h[ob] = 1 }
-                               h
-                             when Hash # Should be an ordered hash, but this message doesn't care
-                               query.order_by
-                             else
-                               raise "illegal order_by: is a #{query.order_by.class.name}, must be String, Array, Hash, or OrderedHash"
-                             end
+            if query.order_by && query.order_by.length > 0
+              sel['orderby'] = case query.order_by
+                               when String
+                                 {query.order_by => 1}
+                               when Array
+                                 h = OrderedHash.new
+                                 query.order_by.each { |ob| h[ob] = 1 }
+                                 h
+                               when Hash # Should be an ordered hash, but this message doesn't care
+                                 query.order_by
+                               else
+                                 raise "illegal order_by: is a #{query.order_by.class.name}, must be String, Array, Hash, or OrderedHash"
+                               end
+            end
+            if query.hint_fields && query.hint_fields.length > 0
+              hints = OrderedHash.new
+              query.hint_fields.each { |hf| hints[hf] = 1 }
+              sel['$hint'] = hints
+            end
+            if query.explain
+              sel['$explain'] = true
+            end
                                
           end
           write_doc(sel)

data/lib/mongo/mongo.rb

@@ -25,14 +25,36 @@ module XGen
 
         DEFAULT_PORT = 27017
 
-        # Host default is 'localhost', port default is DEFAULT_PORT.
-        def initialize(host='localhost', port=DEFAULT_PORT)
-          @host, @port = host, port
+        # Either nodes_or_host is a host name string and port is an optional
+        # port number that defaults to DEFAULT_PORT, or nodes_or_host is an
+        # array of arrays, where each is a host/port pair (or a host with no
+        # port). Finally, if nodes_or_host is nil then host is 'localhost' and
+        # port is DEFAULT_PORT. Since that's so confusing, here are a few
+        # examples:
+        #
+        #  Mongo.new                         # localhost, DEFAULT_PORT
+        #  Mongo.new("localhost")            # localhost, DEFAULT_PORT
+        #  Mongo.new("localhost", 3000)      # localhost, 3000
+        #  Mongo.new([["localhost"]])        # localhost, DEFAULT_PORT
+        #  Mongo.new([["localhost", 3000]])  # localhost, 3000
+        #  Mongo.new([["db1.example.com", 3000], ["db2.example.com", 3000]]])
+        #
+        # When a DB object first connects, it tries nodes and stops at the
+        # first one it connects to.
+        def initialize(nodes_or_host=nil, port=nil)
+          @nodes = case nodes_or_host
+                   when String
+                     [[nodes_or_host, port || DEFAULT_PORT]]
+                   when Array
+                     nodes_or_host.collect { |nh| [nh[0], nh[1] || DEFAULT_PORT] }
+                   when nil
+                     [['localhost', DEFAULT_PORT]]
+                   end
         end
 
         # Return the XGen::Mongo::Driver::DB named +db_name+.
         def db(db_name)
-          XGen::Mongo::Driver::DB.new(db_name, @host, @port)
+          XGen::Mongo::Driver::DB.new(db_name, @nodes)
         end
 
         # Not implemented.

data/lib/mongo/query.rb

@@ -14,7 +14,6 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 # ++
 
-require 'socket'
 require 'mongo/collection'
 require 'mongo/message'
 
@@ -27,6 +26,10 @@ module XGen
       class Query
 
         attr_accessor :number_to_skip, :number_to_return, :order_by
+        # If true, $explain will be set in QueryMessage that uses this query.
+        attr_accessor :explain
+        # Either +nil+ or an array of hint field names.
+        attr_accessor :hint_fields
         attr_reader :selector   # writer defined below
 
         # sel :: A hash describing the query. See the Mongo docs for details.
@@ -97,6 +100,10 @@ module XGen
             nil
           end
         end
+
+        def contains_special_fields
+          (@order_by != nil && @order_by.length > 0) || @explain || @hint_fields
+        end
       end
     end
   end

data/tests/test_admin.rb

@@ -20,9 +20,10 @@ class AdminTest < Test::Unit::TestCase
   end
 
   def teardown
-    unless @db.socket.closed?
+    if @db.connected?
       @admin.profiling_level = :off
-      @coll.clear unless @coll == nil
+      @coll.clear if @coll
+      @db.close
     end
   end
 

data/tests/test_bson.rb

@@ -2,7 +2,6 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo'
 require 'test/unit'
 
-# NOTE: assumes Mongo is running
 class BSONTest < Test::Unit::TestCase
 
   include XGen::Mongo::Driver

data/tests/test_cursor.rb

@@ -18,7 +18,10 @@ class CursorTest < Test::Unit::TestCase
   end
 
   def teardown
-    @coll.clear unless @coll == nil || @db.socket.closed?
+    if @db.connected?
+      @coll.clear if @coll
+      @db.close
+    end
   end
 
   def test_explain

data/tests/test_db.rb

@@ -0,0 +1,51 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'test/unit'
+
+# NOTE: assumes Mongo is running
+class DBAPITest < Test::Unit::TestCase
+
+  include XGen::Mongo::Driver
+
+  def setup
+    @host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
+    @port = ENV['MONGO_RUBY_DRIVER_PORT'] || Mongo::DEFAULT_PORT
+    @db = Mongo.new(@host, @port).db('ruby-mongo-test')
+  end
+
+  def teardown
+    if @db.connected?
+      @db.close
+    end
+  end
+
+  def test_close
+    @db.close
+    assert !@db.connected?
+    begin
+      @db.collection('test').insert('a' => 1)
+      fail "expected 'NilClass' exception"
+    rescue => ex
+      assert_match /NilClass/, ex.to_s
+    end
+  end
+
+  def test_full_coll_name
+    coll = @db.collection('test')
+    assert_equal 'ruby-mongo-test.test', @db.full_coll_name(coll.name)
+  end
+
+  def test_master
+    # Doesn't really test anything since we probably only have one database
+    # during this test.
+    @db.switch_to_master
+    assert @db.connected?
+  end
+
+  def test_array
+    @db.close
+    @db = Mongo.new([["nosuch.example.com"], [@host, @port]]).db('ruby-mongo-test')
+    assert @db.connected?
+  end
+
+end

data/tests/test_db_api.rb

@@ -18,7 +18,10 @@ class DBAPITest < Test::Unit::TestCase
   end
 
   def teardown
-    @coll.clear unless @coll == nil || @db.socket.closed?
+    if @db.connected?
+      @coll.clear unless @coll == nil
+      @db.close
+    end
   end
 
   def test_clear
@@ -196,17 +199,6 @@ class DBAPITest < Test::Unit::TestCase
     assert_equal 4, docs.size
   end
 
-  def test_close
-    @db.close
-    assert @db.socket.closed?
-    begin
-      @coll.insert('a' => 1)
-      fail "expected IOError exception"
-    rescue IOError => ex
-      assert_match /closed stream/, ex.to_s
-    end
-  end
-
   def test_drop_collection
     assert @db.drop_collection(@coll.name), "drop of collection #{@coll.name} failed"
     assert !@db.collection_names.include?(@coll_full_name)
@@ -253,10 +245,6 @@ class DBAPITest < Test::Unit::TestCase
     end
   end
 
-  def test_full_coll_name
-    assert_equal @coll_full_name, @db.full_coll_name(@coll.name)
-  end
-
   def test_index_information
     @db.create_index(@coll.name, 'index_name', ['a'])
     list = @db.index_information(@coll.name)

data/tests/test_ordered_hash.rb

@@ -2,7 +2,6 @@ $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
 require 'mongo/util/ordered_hash'
 require 'test/unit'
 
-# NOTE: assumes Mongo is running
 class OrderedHashTest < Test::Unit::TestCase
 
   def setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jim Menard
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-14 00:00:00 -05:00
+date: 2009-01-15 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -55,6 +55,7 @@ files:
 - tests/test_bson.rb
 - tests/test_byte_buffer.rb
 - tests/test_cursor.rb
+- tests/test_db.rb
 - tests/test_db_api.rb
 - tests/test_db_connection.rb
 - tests/test_message.rb