mongo 0.15.1 → 0.16

data/lib/mongo/errors.rb

@@ -15,6 +15,12 @@
 # Exceptions raised by the MongoDB driver.
 
 module Mongo
+  # Generic Mongo Ruby Driver exception class.
+  class MongoRubyError < StandardError; end
+
+  # Raised when configuration options cause connections, queries, etc., to fail.
+  class ConfigurationError < MongoRubyError; end
+
   # Raised when a database operation fails.
   class OperationFailure < RuntimeError; end
 
@@ -25,5 +31,5 @@ module Mongo
   class InvalidName < RuntimeError; end
 
   # Raised when the client supplies an invalid value to sort by.
-  class InvalidSortValueError < RuntimeError; end
+  class InvalidSortValueError < MongoRubyError; end
 end

data/lib/mongo/types/objectid.rb

@@ -42,6 +42,11 @@ module Mongo
       str && str.length == len && match == str
     end
 
+    # Adds a primary key to the given document if needed.
+    def self.create_pk(doc)
+      doc[:_id] || doc['_id'] ? doc : doc.merge!(:_id => self.new)
+    end
+
     # +data+ is an array of bytes. If nil, a new id will be generated.
     def initialize(data=nil)
       @data = data || generate

data/lib/mongo/util/byte_buffer.rb

@@ -54,6 +54,18 @@ class ByteBuffer
   end
   alias_method :length, :size
 
+  # Appends a second ByteBuffer object, +buffer+, to the current buffer.
+  def append!(buffer)
+    @buf = @buf + buffer.to_a
+    self
+  end
+
+  # Prepends a second ByteBuffer object, +buffer+, to the current buffer.
+  def prepend!(buffer)
+    @buf = buffer.to_a + @buf
+    self
+  end
+
   def put(byte, offset=nil)
     @cursor = offset if offset
     @buf[@cursor] = byte

data/lib/mongo/util/server_version.rb

@@ -0,0 +1,69 @@
+# --
+# Copyright (C) 2008-2009 10gen Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ++
+module Mongo
+  # Simple class for comparing server versions.
+  class ServerVersion
+    include Comparable
+
+    def initialize(version)
+      @version = version
+    end
+
+    # Implements comparable.
+    def <=>(new)
+      local, new  = self.to_a, to_array(new)
+      for n in 0...local.size do 
+        break if elements_include_mods?(local[n], new[n])
+        if local[n] < new[n].to_i
+          result = -1
+          break;
+        elsif local[n] > new[n].to_i
+          result = 1
+          break;
+        end
+      end
+      result || 0
+    end
+
+    # Return an array representation of this server version.
+    def to_a
+      to_array(@version)
+    end
+
+    # Return a string representation of this server version.
+    def to_s
+      @version
+    end
+
+    private
+
+    # Returns true if any elements include mod symbols (-, +)
+    def elements_include_mods?(*elements)
+      elements.any? { |n| n =~ /[\-\+]/ } 
+    end
+
+    # Converts argument to an array of integers, 
+    # appending any mods as the final element.
+    def to_array(version)
+      array = version.split(".").map {|n| (n =~ /^\d+$/) ? n.to_i : n }
+      if array.last =~ /(\d+)([\-\+])/
+        array[array.length-1] = $1.to_i
+        array << $2
+      end
+      array
+    end
+  end
+end

data/lib/mongo/{message.rb → util/support.rb}

@@ -13,8 +13,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ++
+class Object
 
-%w(get_more_message insert_message kill_cursors_message message_header
-   msg_message query_message remove_message update_message).each { |f|
-  require "mongo/message/#{f}"
-}
+  def returning(value)
+    yield value
+    value
+  end
+
+end

data/mongo-ruby-driver.gemspec

@@ -1,99 +1,22 @@
-# We need to list all of the included files because we aren't allowed to use
-# Dir[...] in the github sandbox.
-PACKAGE_FILES = ['README.rdoc', 'Rakefile', 'mongo-ruby-driver.gemspec',
-                 'bin/bson_benchmark.rb',
-                 'bin/mongo_console',
-                 'bin/run_test_script',
-                 'bin/standard_benchmark',
-                 'examples/admin.rb',
-                 'examples/benchmarks.rb',
-                 'examples/blog.rb',
-                 'examples/capped.rb',
-                 'examples/cursor.rb',
-                 'examples/gridfs.rb',
-                 'examples/index_test.rb',
-                 'examples/info.rb',
-                 'examples/queries.rb',
-                 'examples/simple.rb',
-                 'examples/strict.rb',
-                 'examples/types.rb',
-                 'lib/mongo/admin.rb',
-                 'lib/mongo/collection.rb',
-                 'lib/mongo/connection.rb',
-                 'lib/mongo/cursor.rb',
-                 'lib/mongo/db.rb',
-                 'lib/mongo/gridfs/chunk.rb',
-                 'lib/mongo/gridfs/grid_store.rb',
-                 'lib/mongo/gridfs.rb',
-                 'lib/mongo/errors.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/query.rb',
-                 'lib/mongo/types/binary.rb',
-                 'lib/mongo/types/code.rb',
-                 'lib/mongo/types/dbref.rb',
-                 'lib/mongo/types/objectid.rb',
-                 'lib/mongo/types/regexp_of_holding.rb',
-                 'lib/mongo/util/bson.rb',
-                 'lib/mongo/util/byte_buffer.rb',
-                 'lib/mongo/util/conversions.rb',
-                 'lib/mongo/util/ordered_hash.rb',
-                 'lib/mongo/util/xml_to_ruby.rb',
-                 'lib/mongo.rb']
-TEST_FILES = ['test/mongo-qa/_common.rb',
-              'test/mongo-qa/admin',
-              'test/mongo-qa/capped',
-              'test/mongo-qa/count1',
-              'test/mongo-qa/dbs',
-              'test/mongo-qa/find',
-              'test/mongo-qa/find1',
-              'test/mongo-qa/gridfs_in',
-              'test/mongo-qa/gridfs_out',
-              'test/mongo-qa/indices',
-              'test/mongo-qa/remove',
-              'test/mongo-qa/stress1',
-              'test/mongo-qa/test1',
-              'test/mongo-qa/update',
-              'test/test_admin.rb',
-              'test/test_bson.rb',
-              'test/test_byte_buffer.rb',
-              'test/test_chunk.rb',
-              'test/test_collection.rb',
-              'test/test_connection.rb',
-              'test/test_conversions.rb',
-              'test/test_cursor.rb',
-              'test/test_db.rb',
-              'test/test_db_api.rb',
-              'test/test_db_connection.rb',
-              'test/test_grid_store.rb',
-              'test/test_message.rb',
-              'test/test_objectid.rb',
-              'test/test_ordered_hash.rb',
-              'test/test_threading.rb',
-              'test/test_round_trip.rb']
+require "lib/mongo"
 
 Gem::Specification.new do |s|
   s.name = 'mongo'
 
-  # be sure to change this constant in lib/mongo.rb as well
-  s.version = '0.15.1'
+  s.version = Mongo::VERSION
 
   s.platform = Gem::Platform::RUBY
   s.summary = 'Ruby driver for the MongoDB'
   s.description = 'A Ruby driver for MongoDB. For more information about Mongo, see http://www.mongodb.org.'
 
   s.require_paths = ['lib']
-  s.files = PACKAGE_FILES
-  s.test_files = TEST_FILES
+
+  s.files  = ['README.rdoc', 'Rakefile', 'mongo-ruby-driver.gemspec', 'LICENSE.txt']
+  s.files += Dir['lib/**/*.rb'] + Dir['examples/**/*.rb'] + Dir['bin/**/*.rb']
+  s.test_files = Dir['test/**/*.rb']
+
+  s.has_rdoc = true
+  s.test_files = Dir['test/**/*.rb']
 
   s.has_rdoc = true
   s.rdoc_options = ['--main', 'README.rdoc', '--inline-source']

data/test/test_admin.rb

@@ -13,7 +13,7 @@ class AdminTest < Test::Unit::TestCase
 
   def setup
     # Insert some data to make sure the database itself exists.
-    @@coll.clear
+    @@coll.remove
     @r1 = @@coll.insert('a' => 1) # collection not created until it's used
     @@coll_full_name = 'ruby-mongo-test.test'
     @admin = @@db.admin
@@ -21,7 +21,7 @@ class AdminTest < Test::Unit::TestCase
 
   def teardown
     @admin.profiling_level = :off
-    @@coll.clear if @@coll
+    @@coll.remove if @@coll
     @@db.error
   end
 

data/test/test_bson.rb

@@ -265,4 +265,18 @@ class BSONTest < Test::Unit::TestCase
     assert val.keys.include?(:_id)
   end
 
+  # note we only test for _id here because in the general case we will
+  # write duplicates for :key and "key". _id is a special case because
+  # we call has_key? to check for it's existance rather than just iterating
+  # over it like we do for the rest of the keys. thus, things like
+  # HashWithIndifferentAccess can cause problems for _id but not for other
+  # keys. rather than require rails to test with HWIA directly, we do this
+  # somewhat hacky test.
+  def test_no_duplicate_id
+    dup = {"_id" => "foo", :_id => "foo"}
+    one = {"_id" => "foo"}
+
+    assert_equal @b.serialize(one).to_a, @b.serialize(dup).to_a
+  end
+
 end

data/test/test_byte_buffer.rb

@@ -66,4 +66,18 @@ class ByteBufferTest < Test::Unit::TestCase
     assert_equal 4, @buf.position
   end
 
+  def test_prepend_byte_buffer
+    @buf.put_int(4)
+    new_buf = ByteBuffer.new([5, 0, 0, 0])
+    @buf.prepend!(new_buf)
+    assert_equal [5, 0, 0, 0, 4, 0, 0, 0], @buf.to_a
+  end
+
+  def test_append_byte_buffer
+    @buf.put_int(4)
+    new_buf = ByteBuffer.new([5, 0, 0, 0])
+    @buf.append!(new_buf)
+    assert_equal [4, 0, 0, 0, 5, 0, 0, 0], @buf.to_a
+  end
+
 end

data/test/test_chunk.rb

@@ -14,16 +14,16 @@ class ChunkTest < Test::Unit::TestCase
   @@chunks = @@db.collection('gridfs.chunks')
 
   def setup
-    @@chunks.clear
-    @@files.clear
+    @@chunks.remove
+    @@files.remove
 
     @f = GridStore.new(@@db, 'foobar', 'w')
     @c = @f.instance_variable_get('@curr_chunk')
   end
 
   def teardown
-    @@chunks.clear
-    @@files.clear
+    @@chunks.remove
+    @@files.remove
     @@db.error
   end
 

data/test/test_collection.rb

@@ -14,22 +14,33 @@
 # limitations under the License.
 # ++
 
-$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
-require 'mongo'
-require 'test/unit'
-
-# NOTE: assumes Mongo is running
+require 'test/test_helper'
 class TestCollection < Test::Unit::TestCase
-  include Mongo
-
-  @@db = Connection.new(ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost',
-                        ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT).db('ruby-mongo-test')
+  @@connection = Connection.new(ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost', ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT)
+  @@db   = @@connection.db('ruby-mongo-test')
   @@test = @@db.collection("test")
+  @@version = @@connection.server_version
 
   def setup
     @@test.drop()
   end
 
+  def test_optional_pk_factory
+    @coll_default_pk = @@db.collection('stuff')
+    assert_equal Mongo::ObjectID, @coll_default_pk.pk_factory
+    @coll_default_pk = @@db.create_collection('more-stuff')
+    assert_equal Mongo::ObjectID, @coll_default_pk.pk_factory
+
+    # Create a db with a pk_factory.
+    @db = Connection.new(ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost',
+                         ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT).db('ruby-mongo-test', :pk => Object.new)
+    @coll = @db.collection('coll-with-pk')
+    assert @coll.pk_factory.is_a?(Object)
+
+    @coll = @db.create_collection('created_coll_with_pk')
+    assert @coll.pk_factory.is_a?(Object)
+  end
+
   def test_collection
     assert_raise InvalidName do
       @@db["te$t"]
@@ -43,7 +54,7 @@ class TestCollection < Test::Unit::TestCase
     assert_equal @@db["test"]["foo"].name(), @@db.collection("test.foo").name()
     assert_equal @@db["test"]["foo"].name(), @@db["test.foo"].name()
 
-    @@db["test"]["foo"].clear
+    @@db["test"]["foo"].remove
     @@db["test"]["foo"].insert("x" => 5)
     assert_equal 5, @@db.collection("test.foo").find_one()["x"]
   end
@@ -79,15 +90,33 @@ class TestCollection < Test::Unit::TestCase
     assert_equal 2, @@test.find_one()["count"]
   end
 
-  def test_safe_update
-    @@test.create_index("x")
-    @@test.insert("x" => 5)
+  if @@version < "1.1.3"
+    def test_safe_update
+      @@test.create_index("x")
+      @@test.insert("x" => 5)
 
-    @@test.update({}, {"$inc" => {"x" => 1}})
-    assert @@db.error?
+      @@test.update({}, {"$inc" => {"x" => 1}})
+      assert @@db.error?
 
-    assert_raise OperationFailure do
-      @@test.update({}, {"$inc" => {"x" => 1}}, :safe => true)
+      # Can't change an index.
+      assert_raise OperationFailure do
+        @@test.update({}, {"$inc" => {"x" => 1}}, :safe => true)
+      end
+    end
+  else
+    def test_safe_update
+      @@test.create_index("x", true)
+      @@test.insert("x" => 5)
+      @@test.insert("x" => 10)
+
+      # Can update an indexed collection.
+      @@test.update({}, {"$inc" => {"x" => 1}})
+      assert !@@db.error?
+
+      # Can't duplicate an index.
+      assert_raise OperationFailure do
+        @@test.update({}, {"x" => 10}, :safe => true, :upsert => true)
+      end
     end
   end
 
@@ -112,6 +141,35 @@ class TestCollection < Test::Unit::TestCase
     assert_equal 2, @@test.count
   end
 
+  # Note: #size is just an alias for #count.
+  def test_size
+    @@test.drop
+
+    assert_equal 0, @@test.count
+    assert_equal @@test.size, @@test.count
+    @@test.save("x" => 1)
+    @@test.save("x" => 2)
+    assert_equal @@test.size, @@test.count
+  end
+
+  def test_no_timeout_option
+    @@test.drop
+
+    assert_raise ArgumentError, "Timeout can be set to false only when #find is invoked with a block." do
+      @@test.find({}, :timeout => false)
+    end
+
+    @@test.find({}, :timeout => false) do |cursor|
+      assert_equal 0, cursor.count
+    end
+
+    @@test.save("x" => 1)
+    @@test.save("x" => 2)
+    @@test.find({}, :timeout => false) do |cursor|
+      assert_equal 2, cursor.count
+    end
+  end
+
   def test_find_one
     id = @@test.save("hello" => "world", "foo" => "bar")
 
@@ -278,5 +336,37 @@ class TestCollection < Test::Unit::TestCase
 #     assert_equal 1, @@test.group([], {}, {"count" => 0},
 #                                  Code.new(reduce_function,
 #                                           {"inc_value" => 0.5}), true)[0]["count"]
+    end
+
+  context "A collection with two records" do 
+    setup do 
+      @collection = @@db.collection('test-collection')
+      @collection.insert({:name => "Jones"})
+      @collection.insert({:name => "Smith"})
+    end
+
+    should "have two records" do 
+      assert_equal 2, @collection.size
+    end
+
+    should "remove the two records" do 
+      @collection.remove()
+      assert_equal 0, @collection.size
+    end
+
+    should "remove all records if an empty document is specified" do 
+      @collection.remove({})
+      assert_equal 0, @collection.find.count
+    end
+
+    should "remove all records if deprecated clear is used" do 
+      @collection.clear
+      assert_equal 0, @collection.find.count
+    end
+
+    should "remove only matching records" do 
+      @collection.remove({:name => "Jones"})
+      assert_equal 1, @collection.size
+    end
   end
 end