mongo 0.0.1 → 0.0.2

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
 GEM = "mongo"
-GEM_VERSION = '0.0.1'
+GEM_VERSION = '0.0.2'
 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.rb

@@ -1,5 +1,6 @@
 require 'mongo/mongo'
 require 'mongo/objectid'
+require 'mongo/dbref'
 require 'mongo/message'
 require 'mongo/db'
 require 'mongo/cursor'

data/lib/mongo/dbref.rb

@@ -0,0 +1,37 @@
+# --
+# 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/>.
+# ++
+
+module XGen
+  module Mongo
+    module Driver
+
+      class DBRef
+
+        attr_reader :parent, :field_name, :db, :namespace, :object_id
+
+        def initialize(parent, field_name, db, namespace, object_id)
+          @parent, @field_name, @db, @namespace, @object_id =
+            parent, field_name, db, namespace, object_id
+        end
+
+        def to_s
+          "ns: #{namespace}, id: #{object_id}"
+        end
+
+      end
+    end
+  end
+end

data/lib/mongo/objectid.rb

@@ -53,6 +53,18 @@ module XGen
         @@index_time = Time.new.to_i
         @@index = 0
 
+        # Given a string representation of an ObjectID, return a new ObjectID
+        # with that value.
+        def self.from_string(str)
+          data = []
+          i = str.to_i(16)
+          while i > 0
+            data << (i & 0xff)
+            i >>= 8
+          end
+          self.new(data.reverse)
+        end
+
         # +data+ is an array of bytes. If nil, a new id will be generated.
         # The time +t+ is only used for testing; leave it nil.
         def initialize(data=nil, t=nil)

data/lib/mongo/util/bson.rb

@@ -17,6 +17,7 @@
 require 'mongo/util/byte_buffer'
 require 'mongo/util/ordered_hash'
 require 'mongo/objectid'
+require 'mongo/dbref'
 
 # A BSON seralizer/deserializer.
 class BSON
@@ -81,7 +82,9 @@ class BSON
         serialize_date_element(@buf, k, v)
       when NULL
         serialize_null_element(@buf, k)
-      when BINARY, UNDEFINED, REF, SYMBOL, CODE_W_SCOPE
+      when REF
+        serialize_dbref_element(@buf, k, v)
+      when BINARY, UNDEFINED, SYMBOL, CODE_W_SCOPE
         # TODO
         raise "unimplemented type #{type}"
       else
@@ -104,36 +107,39 @@ class BSON
       type = @buf.get
       case type
       when STRING, CODE
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_string_data(@buf)
       when NUMBER
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_number_data(@buf)
       when NUMBER_INT
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_number_int_data(@buf)
       when OID
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_oid_data(@buf)
       when ARRAY
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_array_data(@buf)
       when REGEX
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_regex_data(@buf)
       when OBJECT
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_object_data(@buf)
       when BOOLEAN
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_boolean_data(@buf)
       when DATE
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = deserialize_date_data(@buf)
       when NULL
-        key = deserialize_element_name(@buf)
+        key = deserialize_cstr(@buf)
         doc[key] = nil
-      when BINARY, UNDEFINED, REF, SYMBOL, CODE_W_SCOPE
+      when REF
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_dbref_data(@buf)
+      when BINARY, UNDEFINED, SYMBOL, CODE_W_SCOPE
         # TODO
         raise "unimplemented type #{type}"
       when EOO
@@ -191,8 +197,8 @@ class BSON
   end
 
   def deserialize_regex_data(buf)
-    str = deserialize_element_name(buf)
-    options_str = deserialize_element_name(buf)
+    str = deserialize_cstr(buf)
+    options_str = deserialize_cstr(buf)
     options = 0
     options |= Regexp::IGNORECASE if options_str.include?('i')
     options |= Regexp::MULTILINE if options_str.include?('m')
@@ -210,6 +216,14 @@ class BSON
     XGen::Mongo::Driver::ObjectID.new(buf.get(12))
   end
 
+  def deserialize_dbref_data(buf)
+    ns = deserialize_cstr(buf)
+    oid = deserialize_oid_data(buf)
+    # TODO fix parent, field_name, db of DBRef. Does that need to be done here
+    # or by the caller?
+    XGen::Mongo::Driver::DBRef.new(nil, nil, nil, ns, oid)
+  end
+
   def serialize_eoo_element(buf)
     buf.put(EOO)
   end
@@ -219,6 +233,13 @@ class BSON
     self.class.serialize_cstr(buf, key)
   end
 
+  def serialize_dbref_element(buf, key, val)
+    buf.put(REF)
+    self.class.serialize_cstr(buf, key)
+    self.class.serialize_cstr(buf, val.namespace)
+    buf.put_array(val.object_id.to_a)
+  end
+
   def serialize_boolean_element(buf, key, val)
     buf.put(BOOLEAN)
     self.class.serialize_cstr(buf, key)
@@ -298,7 +319,7 @@ class BSON
     buf.position = end_pos
   end
 
-  def deserialize_element_name(buf)
+  def deserialize_cstr(buf)
     chars = ""
     while 1
       b = buf.get
@@ -325,6 +346,8 @@ class BSON
       REGEX
     when XGen::Mongo::Driver::ObjectID
       OID
+    when XGen::Mongo::Driver::DBRef
+      REF
     when true, false
       BOOLEAN
     when Time

data/lib/mongo/util/ordered_hash.rb

@@ -51,4 +51,10 @@ class OrderedHash < Hash
     super(other)
   end
 
+  def inspect
+    str = '{'
+    str << @ordered_keys.collect { |k| "\"#{k}\"=>#{self.[](k).inspect}" }.join(", ")
+    str << '}'
+  end
+
 end

data/tests/test_bson.rb

@@ -76,4 +76,14 @@ class BSONTest < Test::Unit::TestCase
 
   def test_null
   end
+
+  def test_dbref
+    oid = ObjectID.new
+    doc = {'dbref' => DBRef.new(nil, nil, nil, 'namespace', oid)}
+    @b.serialize(doc)
+    doc2 = @b.deserialize
+    assert_equal 'namespace', doc2['dbref'].namespace
+    assert_equal oid, doc2['dbref'].object_id
+  end
+
 end

data/tests/test_objectid.rb

@@ -65,4 +65,12 @@ class ObjectIDTest < Test::Unit::TestCase
     assert_equal @o, row['_id']
   end
 
+  def test_from_string
+    hex_str = @o.to_s
+    o2 = ObjectID.from_string(hex_str)
+    assert_equal hex_str, o2.to_s
+    assert_equal @o, o2
+    assert_equal @o.to_s, o2.to_s
+  end
+
 end

data/tests/test_ordered_hash.rb

@@ -79,4 +79,8 @@ class OrderedHashTest < Test::Unit::TestCase
     assert_equal ['crab', 'apple', 3, 'foo'], @oh.values
   end
 
+  def test_inspect_retains_order
+    assert_equal '{"c"=>1, "a"=>2, "z"=>3}', @oh.inspect
+  end
+
 end

data/tests/test_round_trip.rb

@@ -0,0 +1,132 @@
+HERE = File.dirname(__FILE__)
+$LOAD_PATH[0,0] = File.join(HERE, '..', 'lib')
+require 'mongo'
+require 'rexml/document'
+require 'test/unit'
+
+# For each xml/bson file in the data subdirectory, we turn the XML into an
+# OrderedHash and then test both Ruby-to-BSON and BSON-to-Ruby translations.
+class RoundTripTest < Test::Unit::TestCase
+
+  include XGen::Mongo::Driver
+
+  @@ruby = nil
+
+  def setup
+    unless @@ruby
+      names = Dir[File.join(HERE, 'data', '*.xml')].collect {|f| File.basename(f).sub(/\.xml$/, '') }
+      @@ruby = {}
+      names.each { |name| @@ruby[name] = xml_to_ruby(name) }
+    end
+  end
+
+  def xml_to_ruby(name)
+    File.open(File.join(HERE, 'data', "#{name}.xml")) { |f|
+      doc = REXML::Document.new(f)
+      doc_to_ruby(doc.root.elements['doc'])
+    }
+  end
+
+  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 '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 '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
+
+# DEBUG
+#   def test_foo
+#     $stderr.puts "#{@@ruby['smorgasbord'].class.name}" # DEBUG
+#     $stderr.puts "@@ruby['smorgasbord'] = #{@@ruby['smorgasbord'].inspect.gsub(/, /, ",\n")}" # DEBUG
+#   end
+
+  def test_ruby_to_bson
+    @@ruby.each { |name, obj|
+      File.open(File.join(HERE, 'data', "#{name}.bson"), 'r') { |f|
+        bson = f.read
+        bson = if RUBY_VERSION >= '1.9'
+                 bson.bytes
+               else
+                 bson.split(//).collect { |c| c[0] }
+        end
+        bson_from_ruby = BSON.new.serialize(obj).to_a
+        assert_equal bson.length, bson_from_ruby.length
+        assert_equal bson, bson_from_ruby
+      }
+    }
+  end
+
+#   def test_bson_to_ruby
+#     @@ruby.each { |name, obj|
+#       File.open(File.join(HERE, 'data', "#{name}.bson"), 'r') { |f|
+#         bson = f.read
+#         obj_from_bson = BSON.new.deserialize(ByteBuffer.new(bson.split(//)))
+#         assert_equal obj, obj_from_bson
+#       }
+#     }
+#   end
+
+#   # Technically reduntant, given the other tests
+#   def test_roundtrips
+#     @@ruby.each { |name, obj|
+      
+#     }
+#   end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jim Menard
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-08 00:00:00 -05:00
+date: 2009-01-09 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -27,6 +27,7 @@ files:
 - lib/mongo/collection.rb
 - lib/mongo/cursor.rb
 - lib/mongo/db.rb
+- lib/mongo/dbref.rb
 - lib/mongo/message/get_more_message.rb
 - lib/mongo/message/insert_message.rb
 - lib/mongo/message/kill_cursors_message.rb
@@ -53,6 +54,7 @@ files:
 - tests/test_message.rb
 - tests/test_objectid.rb
 - tests/test_ordered_hash.rb
+- tests/test_round_trip.rb
 - Rakefile
 - README.rdoc
 has_rdoc: true