mongodb-mongo 0.1.3

data/lib/mongo/util/xml_to_ruby.rb

@@ -0,0 +1,102 @@
+# --
+# Copyright (C) 2008-2009 10gen Inc.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# ++
+
+require 'rexml/document'
+require 'mongo'
+
+# Converts a .xson file (an XML file that describes a Mongo-type document) to
+# an OrderedHash.
+class XMLToRuby
+
+  include XGen::Mongo::Driver
+
+  def xml_to_ruby(io)
+    doc = REXML::Document.new(io)
+    doc_to_ruby(doc.root.elements['doc'])
+  end
+
+  protected
+
+  def element_to_ruby(e)
+    type = e.name
+    child = e.elements[1]
+    case type
+    when 'oid'
+      ObjectID.from_string(e.text)
+    when 'ref'
+      dbref_to_ruby(e.elements)
+    when 'int'
+      e.text.to_i
+    when 'number'
+      e.text.to_f
+    when 'string', 'code'
+      e.text.to_s
+    when 'binary'
+      Base64.decode64(e.text.to_s).to_mongo_binary
+    when 'symbol'
+      e.text.to_s.intern
+    when 'boolean'
+      e.text.to_s == 'true'
+    when 'array'
+      array_to_ruby(e.elements)
+    when 'date'
+      Time.at(e.text.to_f / 1000.0)
+    when 'regex'
+      regex_to_ruby(e.elements)
+    when 'null'
+      nil
+    when 'undefined'
+      Undefined.new
+    when 'doc'
+      doc_to_ruby(e)
+    else
+      raise "Unknown type #{type} in element with name #{e.attributes['name']}"
+    end
+  end
+
+  def doc_to_ruby(element)
+    oh = OrderedHash.new
+    element.elements.each { |e| oh[e.attributes['name']] = element_to_ruby(e) }
+    oh
+  end
+
+  def array_to_ruby(elements)
+    a = []
+    elements.each { |e|
+      index_str = e.attributes['name']
+      a[index_str.to_i] = element_to_ruby(e)
+    }
+    a
+  end
+
+  def regex_to_ruby(elements)
+    pattern = elements['pattern'].text
+    options_str = elements['options'].text || ''
+
+    options = 0
+    options |= Regexp::IGNORECASE if options_str.include?('i')
+    options |= Regexp::MULTILINE if options_str.include?('m')
+    options |= Regexp::EXTENDED if options_str.include?('x')
+    Regexp.new(pattern, options)
+  end
+
+  def dbref_to_ruby(elements)
+    ns = elements['ns'].text
+    oid_str = elements['oid'].text
+    DBRef.new(nil, nil, nil, ns, ObjectID.from_string(oid_str))
+  end
+
+end

data/lib/mongo.rb

@@ -0,0 +1,12 @@
+require 'mongo/types/binary'
+require 'mongo/types/dbref'
+require 'mongo/types/objectid'
+require 'mongo/types/regexp_of_holding'
+require 'mongo/types/undefined'
+
+require 'mongo/mongo'
+require 'mongo/message'
+require 'mongo/db'
+require 'mongo/cursor'
+require 'mongo/collection'
+require 'mongo/admin'

data/mongo-ruby-driver.gemspec

@@ -0,0 +1,62 @@
+Gem::Specification.new do |s|
+  s.name = 'mongo'
+  s.version = '0.1.3'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Simple pure-Ruby driver for the 10gen Mongo DB'
+  s.description = 'A pure-Ruby driver for the 10gen Mongo DB. For more information about Mongo, see http://www.mongodb.org.'
+
+  s.require_paths = ['lib']
+  
+  s.files = ['bin/mongo_console', 'bin/validate',
+             'examples/benchmarks.rb',
+             'examples/blog.rb',
+             'examples/index_test.rb',
+             'examples/simple.rb',
+             'lib/mongo.rb',
+             'lib/mongo/admin.rb',
+             'lib/mongo/collection.rb',
+             'lib/mongo/cursor.rb',
+             'lib/mongo/db.rb',
+             'lib/mongo/message/get_more_message.rb',
+             'lib/mongo/message/insert_message.rb',
+             'lib/mongo/message/kill_cursors_message.rb',
+             'lib/mongo/message/message.rb',
+             'lib/mongo/message/message_header.rb',
+             'lib/mongo/message/msg_message.rb',
+             'lib/mongo/message/opcodes.rb',
+             'lib/mongo/message/query_message.rb',
+             'lib/mongo/message/remove_message.rb',
+             'lib/mongo/message/update_message.rb',
+             'lib/mongo/message.rb',
+             'lib/mongo/mongo.rb',
+             'lib/mongo/query.rb',
+             'lib/mongo/types/binary.rb',
+             'lib/mongo/types/dbref.rb',
+             'lib/mongo/types/objectid.rb',
+             'lib/mongo/types/regexp_of_holding.rb',
+             'lib/mongo/types/undefined.rb',
+             'lib/mongo/util/bson.rb',
+             'lib/mongo/util/byte_buffer.rb',
+             'lib/mongo/util/ordered_hash.rb',
+             'lib/mongo/util/xml_to_ruby.rb',
+             'README.rdoc', 'Rakefile', 'mongo-ruby-driver.gemspec']
+  s.test_files = ['tests/test_admin.rb',
+                  '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',
+                  'tests/test_objectid.rb',
+                  'tests/test_ordered_hash.rb',
+                  'tests/test_round_trip.rb']
+  
+  s.has_rdoc = true
+  s.rdoc_options = ['--main', 'README.rdoc', '--inline-source']
+  s.extra_rdoc_files = ['README.rdoc']
+
+  s.author = 'Jim Menard'
+  s.email = 'jim@10gen.com'
+  s.homepage = 'http://www.mongodb.org'
+end

data/tests/test_admin.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'test/unit'
+
+# NOTE: assumes Mongo is running
+class AdminTest < 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')
+    # Insert some data to make sure the database itself exists.
+    @coll = @db.collection('test')
+    @coll.clear
+    @r1 = @coll.insert('a' => 1) # collection not created until it's used
+    @coll_full_name = 'ruby-mongo-test.test'
+    @admin = @db.admin
+  end
+
+  def teardown
+    if @db.connected?
+      @admin.profiling_level = :off
+      @coll.clear if @coll
+      @db.close
+    end
+  end
+
+  def test_default_profiling_level
+    assert_equal :off, @admin.profiling_level
+  end
+
+  def test_change_profiling_level
+    @admin.profiling_level = :slow_only
+    assert_equal :slow_only, @admin.profiling_level
+    @admin.profiling_level = :off
+    assert_equal :off, @admin.profiling_level
+  end
+
+  def test_profiling_info
+    # Perform at least one query while profiling so we have something to see.
+    @admin.profiling_level = :all
+    @coll.find()
+    @admin.profiling_level = :off
+
+    info = @admin.profiling_info
+    assert_kind_of Array, info
+    assert info.length >= 1
+    first = info.first
+    assert_kind_of String, first['info']
+    assert_kind_of Time, first['ts']
+    assert_kind_of Numeric, first['millis']
+  end
+
+  def test_validate_collection
+    assert @admin.validate_collection(@coll.name)
+  end
+
+end

data/tests/test_bson.rb

@@ -0,0 +1,135 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'test/unit'
+
+class BSONTest < Test::Unit::TestCase
+
+  include XGen::Mongo::Driver
+
+  def setup
+    # We don't pass a DB to the constructor, even though we are about to test
+    # deserialization. This means that when we deserialize, any DBRefs will
+    # have nil @db ivars. That's fine for now.
+    @b = BSON.new
+  end
+
+  def test_string
+    doc = {'doc' => 'hello, world'}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_code
+    doc = {'$where' => 'this.a.b < this.b'}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_number
+    doc = {'doc' => 41.99}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_int
+    doc = {'doc' => 42}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_object
+    doc = {'doc' => {'age' => 42, 'name' => 'Spongebob', 'shoe_size' => 9.5}}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_oid
+    doc = {'doc' => ObjectID.new}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_array
+    doc = {'doc' => [1, 2, 'a', 'b']}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_regex
+    doc = {'doc' => /foobar/i}
+    @b.serialize(doc)
+    doc2 = @b.deserialize
+    assert_equal doc, doc2
+
+    r = doc2['doc']
+    assert_kind_of XGen::Mongo::Driver::RegexpOfHolding, r
+    assert_equal '', r.extra_options_str
+
+    r.extra_options_str << 'zywcab'
+    assert_equal 'zywcab', r.extra_options_str
+
+    b = BSON.new
+    doc = {'doc' => r}
+    b.serialize(doc)
+    doc2 = nil
+    doc2 = b.deserialize
+    assert_equal doc, doc2
+
+    r = doc2['doc']
+    assert_kind_of XGen::Mongo::Driver::RegexpOfHolding, r
+    assert_equal 'abcwyz', r.extra_options_str # must be sorted
+  end
+
+  def test_boolean
+    doc = {'doc' => true}
+    @b.serialize(doc)
+    assert_equal doc, @b.deserialize
+  end
+
+  def test_date
+    doc = {'date' => Time.now}
+    @b.serialize(doc)
+    doc2 = @b.deserialize
+    # Mongo only stores seconds, so comparing raw Time objects will fail
+    # because the fractional seconds will be different.
+    assert_equal doc['date'].to_i, doc2['date'].to_i
+  end
+
+  def test_null
+  end
+
+  def test_dbref
+    oid = ObjectID.new
+    doc = {}
+    doc['dbref'] = DBRef.new(doc, 'dbref', nil, 'namespace', oid)
+    @b.serialize(doc)
+    doc2 = @b.deserialize
+    assert_equal 'namespace', doc2['dbref'].namespace
+    assert_equal oid, doc2['dbref'].object_id
+  end
+
+  def test_symbol
+    doc = {'sym' => :foo}
+    @b.serialize(doc)
+    doc2 = @b.deserialize
+    assert_equal :foo, doc2['sym']
+  end
+
+  def test_binary
+    bin = 'binstring'.to_mongo_binary
+    assert_kind_of Binary, bin
+
+    doc = {'bin' => bin}
+    @b.serialize(doc)
+    doc2 = @b.deserialize
+    assert_equal 'binstring', doc2['bin']
+  end
+
+  def test_undefined
+    doc = {'undef' => Undefined.new}
+    @b.serialize(doc)
+    doc2 = @b.deserialize
+    assert_kind_of Undefined, doc2['undef']
+  end
+
+end

data/tests/test_byte_buffer.rb

@@ -0,0 +1,69 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'test/unit'
+
+class ByteBufferTest < Test::Unit::TestCase
+
+  def setup
+    @buf = ByteBuffer.new
+  end
+
+  def test_nil_get_returns_one_byte
+    @buf.put_array([1, 2, 3, 4])
+    @buf.rewind
+    assert_equal 1, @buf.get
+  end
+
+  def test_one_get_returns_array_length_one
+    @buf.put_array([1, 2, 3, 4])
+    @buf.rewind
+    assert_equal [1], @buf.get(1)
+  end
+
+  def test_zero_get_returns_empty_array
+    @buf.put_array([1, 2, 3, 4])
+    @buf.rewind
+    assert_equal [], @buf.get(0)
+  end
+
+  def test_empty
+    assert_equal 0, @buf.length
+  end
+
+  def test_length
+    @buf.put_int 3
+    assert_equal 4, @buf.length
+  end
+
+  def test_default_order
+    assert_equal :little_endian, @buf.order
+  end
+
+  def test_long_length
+    @buf.put_long 1027
+    assert_equal 8, @buf.length
+  end
+
+  def test_get_long
+    @buf.put_long 1027
+    @buf.rewind
+    assert_equal 1027, @buf.get_long
+  end
+
+  def test_get_double
+    @buf.put_double 41.2
+    @buf.rewind
+    assert_equal 41.2, @buf.get_double
+  end
+
+  def test_rewrite
+    @buf.put_int(0)
+    @buf.rewind
+    @buf.put_int(1027)
+    assert_equal 4, @buf.length
+    @buf.rewind
+    assert_equal 1027, @buf.get_int
+    assert_equal 4, @buf.position
+  end
+
+end

data/tests/test_cursor.rb

@@ -0,0 +1,66 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'test/unit'
+
+# NOTE: assumes Mongo is running
+class CursorTest < 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')
+    @coll = @db.collection('test')
+    @coll.clear
+    @r1 = @coll.insert('a' => 1) # collection not created until it's used
+    @coll_full_name = 'ruby-mongo-test.test'
+  end
+
+  def teardown
+    if @db.connected?
+      @coll.clear if @coll
+      @db.close
+    end
+  end
+
+  def test_explain
+    cursor = @coll.find('a' => 1)
+    explaination = cursor.explain
+    assert_not_nil explaination['cursor']
+    assert_kind_of Numeric, explaination['n']
+    assert_kind_of Numeric, explaination['millis']
+    assert_kind_of Numeric, explaination['nscanned']
+  end
+
+  def test_close_no_query_sent
+    begin
+      cursor = @coll.find('a' => 1)
+      cursor.close
+      assert cursor.closed?
+    rescue => ex
+      fail ex.to_s
+    end
+  end
+
+  def test_close_after_query_sent
+    begin
+      cursor = @coll.find('a' => 1)
+      cursor.next_object
+      cursor.close
+      assert cursor.closed?
+    rescue => ex
+      fail ex.to_s
+    end
+  end
+
+  def test_hint
+    begin
+      cursor = @coll.find('a' => 1).hint('a')
+      assert_equal 1, cursor.to_a.size
+    rescue => ex
+      fail ex.to_s
+    end
+  end
+
+end

data/tests/test_db.rb

@@ -0,0 +1,85 @@
+$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'mongo'
+require 'test/unit'
+
+class TestPKFactory
+  def create_pk(row)
+    row['_id'] ||= XGen::Mongo::Driver::ObjectID.new
+    row
+  end
+end
+
+# NOTE: assumes Mongo is running
+class DBTest < 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
+
+  def test_pk_factory
+    db = Mongo.new(@host, @port).db('ruby-mongo-test', :pk => TestPKFactory.new)
+    coll = db.collection('test')
+    coll.clear
+
+    obj = coll.insert('name' => 'Fred', 'age' => 42)
+    row = coll.find({'name' => 'Fred'}, :limit => 1).next_object
+    assert_equal obj, row
+
+    oid = XGen::Mongo::Driver::ObjectID.new
+    obj = coll.insert('_id' => oid, 'name' => 'Barney', 'age' => 41)
+    row = coll.find({'name' => 'Barney'}, :limit => 1).next_object
+    assert_equal obj, row
+
+    coll.clear
+  end
+
+  def test_pk_factory_reset
+    @db.pk_factory = Object.new # first time
+    begin
+      @db.pk_factory = Object.new
+      fail "error: expected exception"
+    rescue => ex
+      assert_match /can not change PK factory/, ex.to_s
+    end
+  end
+
+end