mongo 0.18 → 0.18.1

data/README.rdoc

@@ -254,16 +254,23 @@ Random cursor fun facts:
 
 = Testing
 
-If you have the source code, you can run the tests.
+If you have the source code, you can run the tests. There's a separate rake task for testing with 
+the mongo_ext c extension enabled.
 
-  $ rake test
+  $ rake test:c
 
-This will run both unit and functional tests. If you want to run these
-individually:
+Or, to test without the extension:
+
+  $ rake test:ruby
+
+These will run both unit and functional tests. To run these tests alone:
 
   $ rake test:unit
   $ rake test:functional
 
+To run any individual rake tasks with the C extenson enabled, just pass C_EXT=true to the task:
+
+  $ rake test:unit C_EXT=true
 
 If you want to test replica pairs, you can run the following tests
 individually:
@@ -276,6 +283,7 @@ It's also possible to test replica pairs with connection pooling:
 
   $ rake test:pooled_pair_insert
 
+===Shoulda and Mocha
 
 All tests now require shoulda and mocha.  You can install these gems as
 follows:

data/Rakefile

@@ -10,19 +10,37 @@ rescue LoadError
 end
 require 'rbconfig'
 include Config
+ENV['TEST_MODE'] = 'TRUE'
 
 gem_command = "gem"
 gem_command = "gem1.9" if $0.match(/1\.9$/) # use gem1.9 if we used rake1.9
 
-# NOTE: the functional tests assume MongoDB is running.
 desc "Test the MongoDB Ruby driver."
 task :test do
-  Rake::Task['test:unit'].invoke
-  Rake::Task['test:functional'].invoke
-  Rake::Task['test:pooled_threading'].invoke
+  puts "\nThis option has changed."
+  puts "\nTo test the driver with the c-extensions:\nrake test:c\n"
+  puts "To test the pure ruby driver: \nrake test:ruby"
 end
 
-namespace :test do 
+namespace :test do
+
+  desc "Test the driver with the c extension enabled."
+  task :c do
+    ENV['C_EXT'] = 'TRUE'
+    Rake::Task['test:unit'].invoke
+    Rake::Task['test:functional'].invoke
+    Rake::Task['test:pooled_threading'].invoke
+    ENV['C_EXT'] = nil
+  end
+
+  desc "Test the driver using pure ruby (no c extension)"
+  task :ruby do
+    ENV['C_EXT'] = nil
+    Rake::Task['test:unit'].invoke
+    Rake::Task['test:functional'].invoke
+    Rake::Task['test:pooled_threading'].invoke
+  end
+
   Rake::TestTask.new(:unit) do |t|
     t.test_files = FileList['test/unit/*_test.rb']
     t.verbose    = true
@@ -79,7 +97,7 @@ namespace :gem do
   task :install do
     sh <<EOS
 #{gem_command} build mongo-ruby-driver.gemspec &&
-    sudo #{gem_command} install mongo-*.gem &&
+    #{gem_command} install mongo-*.gem &&
     rm mongo-*.gem
 EOS
   end
@@ -88,7 +106,7 @@ EOS
   task :install_extensions do
     sh <<EOS
 #{gem_command} build mongo-extensions.gemspec &&
-    sudo #{gem_command} install mongo_ext-*.gem &&
+    #{gem_command} install mongo_ext-*.gem &&
     rm mongo_ext-*.gem
 EOS
   end

data/lib/mongo.rb

@@ -1,5 +1,28 @@
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+module Mongo
+  ASCENDING = 1
+  DESCENDING = -1
+
+  VERSION = "0.18.1"
+end
+
+begin
+    # Need this for running test with and without c ext in Ruby 1.9.
+    raise LoadError if ENV['TEST_MODE'] && !ENV['C_EXT']
+    require 'mongo_ext/cbson'
+    raise LoadError unless defined?(CBson::VERSION) && CBson::VERSION == Mongo::VERSION
+    require 'mongo/util/bson_c'
+    BSON            = BSON_C
+  rescue LoadError
+    require 'mongo/util/bson_ruby'
+    BSON            = BSON_RUBY
+    warn "\n**Notice: C extension not loaded. This is required for optimum MongoDB Ruby driver performance."
+    warn "  You can install the extension as follows:\n  gem install mongo_ext\n"
+    warn "  If you continue to receive this message after installing, make sure that the"
+    warn "  mongo_ext gem is in your load path and that the mongo_ext and mongo gems are of the same version.\n"
+end 
+
 require 'mongo/types/binary'
 require 'mongo/types/code'
 require 'mongo/types/dbref'
@@ -9,6 +32,7 @@ require 'mongo/types/regexp_of_holding'
 require 'mongo/util/support'
 require 'mongo/util/conversions'
 require 'mongo/util/server_version'
+require 'mongo/util/bson_ruby'
 
 require 'mongo/errors'
 require 'mongo/constants'
@@ -18,18 +42,3 @@ require 'mongo/cursor'
 require 'mongo/collection'
 require 'mongo/admin'
 
-begin
-  require 'mongo_ext/cbson'
-    BSON_SERIALIZER = CBson
-  rescue LoadError
-    BSON_SERIALIZER = BSON
-    warn "\n**Notice: C extension not detected. This is required for optimum MongoDB Ruby driver performance."
-    warn "  You can install the extension as follows:\n  gem install mongo_ext\n"
-end
-
-module Mongo
-  ASCENDING = 1
-  DESCENDING = -1
-
-  VERSION = "0.18"
-end

data/lib/mongo/admin.rb

@@ -14,8 +14,6 @@
 # limitations under the License.
 # ++
 
-require 'mongo/util/ordered_hash'
-
 module Mongo
 
   # Provide administrative database methods: those having to do with

data/lib/mongo/collection.rb

@@ -33,8 +33,8 @@ module Mongo
       if name.empty? or name.include? ".."
         raise InvalidName, "collection names cannot be empty"
       end
-      if name.include? "$" and not name.match(/^\$cmd/)
-        raise InvalidName, "collection names must not contain '$'"
+      if name.include? "$"
+        raise InvalidName, "collection names must not contain '$'" unless name =~ /((^\$cmd)|(oplog\.\$main))/
       end
       if name.match(/^\./) or name.match(/\.$/)
         raise InvalidName, "collection names must not start or end with '.'"
@@ -216,9 +216,9 @@ module Mongo
     def remove(selector={})
       message = ByteBuffer.new
       message.put_int(0)
-      BSON.serialize_cstr(message, "#{@db.name}.#{@name}")
+      BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@name}")
       message.put_int(0)
-      message.put_array(BSON_SERIALIZER.serialize(selector, false).unpack("C*"))
+      message.put_array(BSON.serialize(selector, false).unpack("C*"))
       @connection.send_message(Mongo::Constants::OP_DELETE, message,
         "db.#{@db.name}.remove(#{selector.inspect})")
     end
@@ -243,13 +243,13 @@ module Mongo
     def update(selector, document, options={})
       message = ByteBuffer.new
       message.put_int(0)
-      BSON.serialize_cstr(message, "#{@db.name}.#{@name}")
+      BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@name}")
       update_options  = 0
       update_options += 1 if options[:upsert]
       update_options += 2 if options[:multi]
       message.put_int(update_options)
-      message.put_array(BSON_SERIALIZER.serialize(selector, false).unpack("C*"))
-      message.put_array(BSON_SERIALIZER.serialize(document, false).unpack("C*"))
+      message.put_array(BSON.serialize(selector, false).unpack("C*"))
+      message.put_array(BSON.serialize(document, false).unpack("C*"))
       if options[:safe]
         @connection.send_message_with_safe_check(Mongo::Constants::OP_UPDATE, message, @db.name,
           "db.#{@name}.update(#{selector.inspect}, #{document.inspect})")
@@ -507,8 +507,8 @@ EOS
     def insert_documents(documents, collection_name=@name, check_keys=true, safe=false)
       message = ByteBuffer.new
       message.put_int(0)
-      BSON.serialize_cstr(message, "#{@db.name}.#{collection_name}")
-      documents.each { |doc| message.put_array(BSON_SERIALIZER.serialize(doc, check_keys).unpack("C*")) }
+      BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{collection_name}")
+      documents.each { |doc| message.put_array(BSON.serialize(doc, check_keys).unpack("C*")) }
       if safe
         @connection.send_message_with_safe_check(Mongo::Constants::OP_INSERT, message, @db.name,
           "db.#{collection_name}.insert(#{documents.inspect})")

data/lib/mongo/connection.rb

@@ -96,7 +96,7 @@ module Mongo
     #                  :right => ["db2.example.com", 27017]}, nil,
     #                  :pool_size => 20, :timeout => 5)
     def initialize(pair_or_host=nil, port=nil, options={})
-      @nodes = format_pair(pair_or_host)
+      @nodes = format_pair(pair_or_host, port)
 
       # Host and port of current master.
       @host = @port = nil
@@ -459,7 +459,7 @@ module Mongo
         buf.put_array(receive_message_on_socket(size - 4, sock).unpack("C*"), 4)
         number_remaining -= 1
         buf.rewind
-        docs << BSON.new.deserialize(buf)
+        docs << BSON.deserialize(buf)
       end
       [docs, number_received, cursor_id]
     end
@@ -467,10 +467,10 @@ module Mongo
     def last_error_message(db_name)
       message = ByteBuffer.new
       message.put_int(0)
-      BSON.serialize_cstr(message, "#{db_name}.$cmd")
+      BSON_RUBY.serialize_cstr(message, "#{db_name}.$cmd")
       message.put_int(0)
       message.put_int(-1)
-      message.put_array(BSON_SERIALIZER.serialize({:getlasterror => 1}, false).unpack("C*"))
+      message.put_array(BSON.serialize({:getlasterror => 1}, false).unpack("C*"))
       add_message_headers(Mongo::Constants::OP_QUERY, message)
     end
     
@@ -524,7 +524,7 @@ module Mongo
     ## Private helper methods
 
     # Returns an array of host-port pairs.
-    def format_pair(pair_or_host)
+    def format_pair(pair_or_host, port)
       case pair_or_host
         when String
           [[pair_or_host, port ? port.to_i : DEFAULT_PORT]]

data/lib/mongo/cursor.rb

@@ -12,9 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/util/byte_buffer'
-require 'mongo/util/bson'
-
 module Mongo
 
   # A cursor over query results. Returned objects are hashes.
@@ -289,7 +286,7 @@ module Mongo
 
       # DB name.
       db_name = @admin ? 'admin' : @db.name
-      BSON.serialize_cstr(message, "#{db_name}.#{@collection.name}")
+      BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
 
       # Number of results to return; db decides for now.
       message.put_int(0)
@@ -320,15 +317,15 @@ module Mongo
       message = ByteBuffer.new
       message.put_int(query_opts)
       db_name = @admin ? 'admin' : @db.name
-      BSON.serialize_cstr(message, "#{db_name}.#{@collection.name}")
+      BSON_RUBY.serialize_cstr(message, "#{db_name}.#{@collection.name}")
       message.put_int(@skip)
       message.put_int(@limit)
       selector = @selector
       if query_contains_special_fields?
         selector = selector_with_special_query_fields
       end
-      message.put_array(BSON_SERIALIZER.serialize(selector, false).unpack("C*"))
-      message.put_array(BSON_SERIALIZER.serialize(@fields, false).unpack("C*")) if @fields
+      message.put_array(BSON.serialize(selector, false).unpack("C*"))
+      message.put_array(BSON.serialize(@fields, false).unpack("C*")) if @fields
       message
     end
 

data/lib/mongo/db.rb

@@ -18,9 +18,6 @@ require 'socket'
 require 'timeout'
 require 'digest/md5'
 require 'thread'
-require 'mongo/collection'
-require 'mongo/util/ordered_hash.rb'
-require 'mongo/admin'
 
 module Mongo
 

data/lib/mongo/errors.rb

@@ -27,6 +27,9 @@ module Mongo
   # Raised when invalid arguments are sent to Mongo Ruby methods.
   class MongoArgumentError < MongoRubyError; end
 
+  # Raised when given a string is not valid utf-8 (Ruby 1.8 only).
+  class InvalidStringEncoding < MongoRubyError; end
+
   # Raised on failures in connection to the database server.
   class ConnectionError < MongoRubyError; end
 

data/lib/mongo/gridfs/chunk.rb

@@ -18,7 +18,6 @@ require 'mongo/types/objectid'
 require 'mongo/util/byte_buffer'
 require 'mongo/util/ordered_hash'
 
-
 module GridFS
 
   # A chunk stores a portion of GridStore data.

data/lib/mongo/types/objectid.rb

@@ -124,6 +124,12 @@ module Mongo
       legacy
     end
 
+    # Returns the utc time at which this ObjectID was generated. This may
+    # be used in lieu of a created_at timestamp.
+    def generation_time
+      Time.at(@data.pack("C4").unpack("N")[0])
+    end
+
     private
 
     begin

data/lib/mongo/util/bson_c.rb

@@ -0,0 +1,18 @@
+# A thin wrapper for the CBson class
+class BSON_C
+
+  def self.serialize(obj, check_keys=false)
+    ByteBuffer.new(CBson.serialize(obj, check_keys))
+  end
+
+  def self.deserialize(buf=nil)
+    if buf.is_a? String
+      to_deserialize = ByteBuffer.new(buf) if buf
+    else
+      buf = ByteBuffer.new(buf.to_a) if buf
+    end
+    buf.rewind
+    CBson.deserialize(buf.to_s)
+  end
+
+end

data/lib/mongo/util/{bson.rb → bson_ruby.rb}

@@ -22,8 +22,8 @@ require 'mongo/types/dbref'
 require 'mongo/types/objectid'
 require 'mongo/types/regexp_of_holding'
 
-# A BSON seralizer/deserializer.
-class BSON
+# A BSON seralizer/deserializer in pure Ruby.
+class BSON_RUBY
 
   include Mongo
 
@@ -49,64 +49,70 @@ class BSON
   NUMBER_LONG = 18
   MAXKEY = 127
 
+  def initialize
+    @buf = ByteBuffer.new
+  end
+
   if RUBY_VERSION >= '1.9'
     def self.to_utf8(str)
       str.encode("utf-8")
     end
   else
     def self.to_utf8(str)
-      str                       # TODO Ruby 1.8 punt for now
+      begin
+      str.unpack("U*")
+      rescue => ex
+        raise InvalidStringEncoding, "String not valid utf-8: #{str}"
+      end
+      str
     end
   end
 
   def self.serialize_cstr(buf, val)
-    buf.put_array(to_utf8(val.to_s).unpack("C*") + [0])
-  end
-
-  def initialize()
-    @buf = ByteBuffer.new
+    buf.put_array(to_utf8(val.to_s).unpack("C*") << 0)
   end
 
   def to_a
     @buf.to_a
   end
 
+  def to_s
+    @buf.to_s
+  end
+
   # Serializes an object.
-  # Implemented to ensure an API compatible with BSON extension. 
-  def self.serialize(obj, check_keys)
+  # Implemented to ensure an API compatible with BSON extension.
+  def self.serialize(obj, check_keys=false)
     new.serialize(obj, check_keys)
   end
 
-  begin
-    require 'mongo_ext/cbson'
-    def serialize(obj, check_keys=false)
-      @buf = ByteBuffer.new(CBson.serialize(obj, check_keys))
-    end
-  rescue LoadError
-    def serialize(obj, check_keys=false)
-      raise "Document is null" unless obj
-
-      @buf.rewind
-      # put in a placeholder for the total size
-      @buf.put_int(0)
-
-      # Write key/value pairs. Always write _id first if it exists.
-      if obj.has_key? '_id'
-        serialize_key_value('_id', obj['_id'], check_keys)
-      elsif obj.has_key? :_id
-        serialize_key_value('_id', obj[:_id], check_keys)
-      end
+  def self.deserialize(buf=nil)
+    new.deserialize(buf)
+  end
+
+  def serialize(obj, check_keys=false)
+    raise "Document is null" unless obj
 
-      obj.each {|k, v| serialize_key_value(k, v, check_keys) unless k == '_id' || k == :_id }
+    @buf.rewind
+    # put in a placeholder for the total size
+    @buf.put_int(0)
 
-      serialize_eoo_element(@buf)
-      @buf.put_int(@buf.size, 0)
-      self
+    # Write key/value pairs. Always write _id first if it exists.
+    if obj.has_key? '_id'
+      serialize_key_value('_id', obj['_id'], check_keys)
+    elsif obj.has_key? :_id
+      serialize_key_value('_id', obj[:_id], check_keys)
     end
+
+    obj.each {|k, v| serialize_key_value(k, v, check_keys) unless k == '_id' || k == :_id }
+
+    serialize_eoo_element(@buf)
+    @buf.put_int(@buf.size, 0)
+    self
   end
 
   # Returns the array stored in the buffer.
-  # Implemented to ensure an API compatible with BSON extension. 
+  # Implemented to ensure an API compatible with BSON extension.
   def unpack(arg)
     @buf.to_a
   end
@@ -154,93 +160,80 @@ class BSON
     end
   end
 
-  begin
-    require 'mongo_ext/cbson'
-    def deserialize(buf=nil)
-      if buf.is_a? String
-        @buf = ByteBuffer.new(buf) if buf
-      else
-        @buf = ByteBuffer.new(buf.to_a) if buf
-      end
-      @buf.rewind
-      CBson.deserialize(@buf.to_s)
+  def deserialize(buf=nil)
+    # If buf is nil, use @buf, assumed to contain already-serialized BSON.
+    # This is only true during testing.
+    if buf.is_a? String
+      @buf = ByteBuffer.new(buf) if buf
+    else
+      @buf = ByteBuffer.new(buf.to_a) if buf
     end
-  rescue LoadError
-    def deserialize(buf=nil)
-      # If buf is nil, use @buf, assumed to contain already-serialized BSON.
-      # This is only true during testing.
-      if buf.is_a? String
-        @buf = ByteBuffer.new(buf) if buf
+    @buf.rewind
+    @buf.get_int                # eat message size
+    doc = OrderedHash.new
+    while @buf.more?
+      type = @buf.get
+      case type
+      when STRING, CODE
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_string_data(@buf)
+      when SYMBOL
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_string_data(@buf).intern
+      when NUMBER
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_number_data(@buf)
+      when NUMBER_INT
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_number_int_data(@buf)
+      when NUMBER_LONG
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_number_long_data(@buf)
+      when OID
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_oid_data(@buf)
+      when ARRAY
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_array_data(@buf)
+      when REGEX
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_regex_data(@buf)
+      when OBJECT
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_object_data(@buf)
+      when BOOLEAN
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_boolean_data(@buf)
+      when DATE
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_date_data(@buf)
+      when NULL
+        key = deserialize_cstr(@buf)
+        doc[key] = nil
+      when UNDEFINED
+        key = deserialize_cstr(@buf)
+        doc[key] = nil
+      when REF
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_dbref_data(@buf)
+      when BINARY
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_binary_data(@buf)
+      when CODE_W_SCOPE
+        key = deserialize_cstr(@buf)
+        doc[key] = deserialize_code_w_scope_data(@buf)
+      when TIMESTAMP
+        key = deserialize_cstr(@buf)
+        doc[key] = [deserialize_number_int_data(@buf),
+                    deserialize_number_int_data(@buf)]
+      when EOO
+        break
       else
-        @buf = ByteBuffer.new(buf.to_a) if buf
-      end
-      @buf.rewind
-      @buf.get_int                # eat message size
-      doc = OrderedHash.new
-      while @buf.more?
-        type = @buf.get
-        case type
-        when STRING, CODE
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_string_data(@buf)
-        when SYMBOL
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_string_data(@buf).intern
-        when NUMBER
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_number_data(@buf)
-        when NUMBER_INT
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_number_int_data(@buf)
-        when NUMBER_LONG
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_number_long_data(@buf)
-        when OID
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_oid_data(@buf)
-        when ARRAY
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_array_data(@buf)
-        when REGEX
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_regex_data(@buf)
-        when OBJECT
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_object_data(@buf)
-        when BOOLEAN
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_boolean_data(@buf)
-        when DATE
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_date_data(@buf)
-        when NULL
-          key = deserialize_cstr(@buf)
-          doc[key] = nil
-        when UNDEFINED
-          key = deserialize_cstr(@buf)
-          doc[key] = nil
-        when REF
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_dbref_data(@buf)
-        when BINARY
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_binary_data(@buf)
-        when CODE_W_SCOPE
-          key = deserialize_cstr(@buf)
-          doc[key] = deserialize_code_w_scope_data(@buf)
-        when TIMESTAMP
-          key = deserialize_cstr(@buf)
-          doc[key] = [deserialize_number_int_data(@buf),
-                      deserialize_number_int_data(@buf)]
-        when EOO
-          break
-        else
-          raise "Unknown type #{type}, key = #{key}"
-        end
+        raise "Unknown type #{type}, key = #{key}"
       end
-      @buf.rewind
-      doc
     end
+    @buf.rewind
+    doc
   end
 
   # For debugging.