RUBY-494 cleaning up all references to Connection, ReplSetConnection, and ShardedConnection

Author: Brandon Black

README.md

@@ -44,9 +44,9 @@ Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](https://githu
     require 'rubygems'
     require 'mongo'
 
-    @conn = Mongo::Connection.new('localhost', 27017, :safe => true)
-    @db   = @conn['sample-db']
-    @coll = @db['test']
+    @client = Mongo::Client.new('localhost', 27017, :safe => true)
+    @db     = @client['sample-db']
+    @coll   = @db['test']
 
     @coll.remove
     3.times do |i|
@@ -164,7 +164,7 @@ timeout for waiting for old connections to be released to the pool.
 
 To set up a pooled connection to a single MongoDB instance:
 
-    @conn = Connection.new("localhost", 27017, :safe => true, :pool_size => 5, :timeout => 5)
+    @client = Client.new("localhost", 27017, :safe => true, :pool_size => 5, :timeout => 5)
 
 Though the pooling architecture will undoubtedly evolve, it currently owes much credit
 to the connection pooling implementations in ActiveRecord and PyMongo.
@@ -177,13 +177,13 @@ of v1.3.0, the Ruby driver detects forking and reconnects automatically.
 
 ## Environment variable `MONGODB_URI`
 
-`Mongo::Connection.from_uri`, `Mongo::Connection.new` and `Mongo::ReplSetConnection.new` will use <code>ENV["MONGODB_URI"]</code> if no other args are provided.
+`Mongo::Client.from_uri`, `Mongo::Client.new` and `Mongo::ReplSetClient.new` will use <code>ENV["MONGODB_URI"]</code> if no other args are provided.
 
 The URI must fit this specification:
 
     mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
 
-If the type of connection (direct or replica set) should be determined entirely from <code>ENV["MONGODB_URI"]</code>, you may want to use `Mongo::Connection.from_uri` because it will return either `Mongo::Connection` or a `Mongo::ReplSetConnection` depending on how many hosts are specified. Trying to use `Mongo::Connection.new` with multiple hosts in <code>ENV["MONGODB_URI"]</code> will raise an exception.
+If the type of connection (direct or replica set) should be determined entirely from <code>ENV["MONGODB_URI"]</code>, you may want to use `Mongo::Client.from_uri` because it will return either `Mongo::Client` or a `Mongo::ReplSetClient` depending on how many hosts are specified. Trying to use `Mongo::Client.new` with multiple hosts in <code>ENV["MONGODB_URI"]</code> will raise an exception.
 
 ## String Encoding
 
@@ -213,9 +213,9 @@ generate _id values. If you want to control _id values or even their types,
 using a PK factory lets you do so.
 
 You can tell the Ruby Mongo driver how to create primary keys by passing in
-the :pk option to the Connection#db method.
+the :pk option to the Client#db method.
 
-    db = Mongo::Connection.new('localhost', 27017, :safe => true).db('dbname', :pk => MyPKFactory.new)
+    db = Mongo::Client.new('localhost', 27017, :safe => true).db('dbname', :pk => MyPKFactory.new)
 
 A primary key factory object must respond to :create_pk, which should
 take a hash and return a hash which merges the original hash with any
@@ -268,7 +268,7 @@ completely harmless; strict mode is a programmer convenience only.
 To turn on strict mode, either pass in :strict => true when obtaining a DB
 object or call the `:strict=` method:
 
-    db = Connection.new('localhost', 27017, :safe => true).db('dbname', :strict => true)
+    db = Client.new('localhost', 27017, :safe => true).db('dbname', :strict => true)
     # I'm feeling lax
     db.strict = false
     # No, I'm not!
@@ -291,10 +291,10 @@ Notes:
 ## Socket timeouts
 
 The Ruby driver support timeouts on socket read operations. To enable them, set the
-`:op_timeout` option when you create a `Mongo::Connection` object.
+`:op_timeout` option when you create a `Mongo::Client` object.
 
 If implementing higher-level timeouts, using tools like `Rack::Timeout`, it's very important
-to call `Mongo::Connection#close` to prevent the subsequent operation from receiving the previous
+to call `Mongo::Client#close` to prevent the subsequent operation from receiving the previous
 request.
 
 ### Test-Unit, Shoulda, and Mocha
@@ -306,7 +306,7 @@ Running the test suite requires test-unit, shoulda, and mocha.  You can install
     $ gem install mocha
 
 The tests assume that the Mongo database is running on the default port. You
-can override the default host (localhost) and port (Connection::DEFAULT_PORT) by
+can override the default host (localhost) and port (Client::DEFAULT_PORT) by
 using the environment variables MONGO_RUBY_DRIVER_HOST and
 MONGO_RUBY_DRIVER_PORT.
 

Rakefile

@@ -150,10 +150,10 @@ namespace :test do
   task :drop_databases => :path do |t|
     puts "Dropping test databases..."
     require 'mongo'
-    con = Mongo::Connection.new(ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost',
-      ENV['MONGO_RUBY_DRIVER_PORT'] || Mongo::Connection::DEFAULT_PORT, :safe => true)
-    con.database_names.each do |name|
-      con.drop_database(name) if name =~ /^ruby-test/
+    client = Mongo::Client.new(ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost',
+      ENV['MONGO_RUBY_DRIVER_PORT'] || Mongo::Client::DEFAULT_PORT, :safe => true)
+    client.database_names.each do |name|
+      client.drop_database(name) if name =~ /^ruby-test/
     end
   end
 end

bench/batch_size_benchmark

@@ -28,9 +28,8 @@ large = {
 }
 
 
-con = Mongo::Connection.new
-
-db  = con['benchmark']
+client = Mongo::Client.new
+db  = client['benchmark']
 col = db['bigdocs']
 
 col.remove()

bench/exp_series.rb

@@ -178,9 +178,9 @@ def test_multi_doc
   ### Mac OS X - sysctl -a hw
 
   def setup_test_set
-    @conn = Mongo::Connection.new
-    @conn.drop_database($db_name)
-    @db = @conn.db($db_name)
+    @client = Mongo::Client.new
+    @client.drop_database($db_name)
+    @db = @client.db($db_name)
     @coll = @db.collection($collection_name)
     @coll.remove
     @results = []
@@ -195,7 +195,7 @@ def teardown_test_set
     File.open($file_name, 'a'){|f|
       f.puts(@results.to_json.gsub(/\[/, "").gsub(/}[\],]/, "},\n")) if @results != []
     }
-    @conn.drop_database($db_name)
+    @client.drop_database($db_name)
   end
 
   def estimate_iterations(db, coll, doc, setup, teardown)
@@ -225,9 +225,9 @@ def measure_iterations(db, coll, doc, setup, teardown, iterations)
   end
 
   def valuate(db, coll, doc, setup, teardown)
-    @conn.drop_database($db_name) # hack to reduce paging
+    @client.drop_database($db_name) # hack to reduce paging
     iterations, etime = estimate_iterations(db, coll, doc, setup, teardown) { yield }
-    @conn.drop_database($db_name) # hack to reduce paging
+    @client.drop_database($db_name) # hack to reduce paging
     utime, rtime = measure_iterations(db, coll, doc, setup, teardown, iterations) { yield }
     return [iterations, utime, rtime, etime]
   end

bench/gridstore_benchmark

@@ -4,7 +4,7 @@ require 'mongo'
 
 include Mongo
 
-db = Connection.new['benchmark-gridfs']
+db = Client.new['benchmark-gridfs']
 sample_data = File.open(File.join(File.dirname(__FILE__), 'sample_file.pdf'), 'r').read
 db['fs.files'].remove
 db['fs.chunks'].remove

bench/profile_array.rb

@@ -73,9 +73,8 @@ def ruby_prof(iterations)
 #  system(cmd)
 #end
 
-conn = Mongo::Connection.new
-
-db  = conn['benchmark']
+client = Mongo::Client.new
+db  = client['benchmark']
 coll = db['profile']
 
 coll.remove

bench/standard_benchmark

@@ -84,9 +84,9 @@ def benchmark(str, n, coll_name, data, create_index=false, verbosity=true)
 end
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
-connection = Connection.new(host, port)
+connection = Client.new(host, port)
 connection.drop_database("benchmark")
 @db = connection.db('benchmark')
 

bin/mongo_console

@@ -10,11 +10,11 @@ require 'mongo'
 include Mongo
 
 host = org_argv[0] || ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = org_argv[1] || ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = org_argv[1] || ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 dbnm = org_argv[2] || ENV['MONGO_RUBY_DRIVER_DB']   || 'ruby-mongo-console'
 
 puts "Connecting to #{host}:#{port} (CONN) on with database #{dbnm} (DB)"
-CONN = Connection.new(host, port, :safe => true)
+CONN = Client.new(host, port, :safe => true)
 DB = CONN.db(dbnm)
 
 puts "Starting IRB session..."

examples/admin.rb

@@ -6,17 +6,17 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-con  = Mongo::Connection.new(host, port, :safe => true)
-db   = con.db('ruby-mongo-examples')
+client  = Mongo::Client.new(host, port, :safe => true)
+db   = client.db('ruby-mongo-examples')
 coll = db.create_collection('test')
 
 # Erase all records from collection, if any
 coll.remove
 
-admin = con['admin']
+admin = client['admin']
 
 # Profiling level set/get
 puts "Profiling level: #{admin.profiling_level}"

examples/capped.rb

@@ -4,10 +4,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 db.drop_collection('test')
 
 # A capped collection has a max size and, optionally, a max number of records.

examples/cursor.rb

@@ -6,10 +6,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Erase all records from collection, if any

examples/gridfs.rb

@@ -7,10 +7,10 @@ def assert
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 
 data = "hello, world!"
 

examples/index_test.rb

@@ -5,10 +5,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts ">> Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-index_test')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-index_test')
 
 class Exception
   def errmsg

examples/info.rb

@@ -5,10 +5,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Erase all records from collection, if any

examples/queries.rb

@@ -6,10 +6,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Remove all records, if any

examples/replica_set.rb

@@ -4,7 +4,7 @@
 cons = []
 
 10.times do
-  cons << Mongo::ReplSetConnection(['localhost:27017'], :read => :secondary)
+  cons << Mongo::ReplSetClient(['localhost:27017'], :read => :secondary)
 end
 
 ports = cons.map do |con|

examples/simple.rb

@@ -6,10 +6,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Erase all records from collection, if any

examples/strict.rb

@@ -5,10 +5,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 
 db.drop_collection('does-not-exist')
 db.create_collection('test')

examples/types.rb

@@ -6,10 +6,10 @@
 include Mongo
 
 host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
+port = ENV['MONGO_RUBY_DRIVER_PORT'] || Client::DEFAULT_PORT
 
 puts "Connecting to #{host}:#{port}"
-db = Connection.new(host, port, :safe => true).db('ruby-mongo-examples')
+db = Client.new(host, port, :safe => true).db('ruby-mongo-examples')
 coll = db.collection('test')
 
 # Remove all records, if any

examples/web/thin/load.rb

@@ -1,7 +1,7 @@
 require File.join(File.dirname(__FILE__), '..', '..', '..', 'lib', 'mongo')
 require 'logger'
 
-$con = Mongo::ReplSetConnection.new(['localhost:30000', 'localhost:30001'], :safe => true, :read => :secondary, :refresh_mode => :sync, :refresh_interval => 30)
+$con = Mongo::ReplSetClient.new(['localhost:30000', 'localhost:30001'], :safe => true, :read => :secondary, :refresh_mode => :sync, :refresh_interval => 30)
 $db = $con['foo']
 
 class Load < Sinatra::Base

examples/web/unicorn/load.rb

@@ -1,7 +1,7 @@
 require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'mongo')
 
-$con = Mongo::Connection.new('localhost', 27017, :safe => true)
-$db = $con['foo']
+$client = Mongo::Client.new('localhost', 27017, :safe => true)
+$db = $client['foo']
 
 class Load < Sinatra::Base
 

examples/web/unicorn/unicorn.rb.template

@@ -22,8 +22,8 @@ stdout_path "#{@dir}log/unicorn.stdout.log"
 
 # NOTE: You need this when using forking web servers!
 after_fork do |server, worker|
-  $con.close if $con
-  $con = Mongo::Connection.new('localhost', 27017, :safe => true)
-  $db = $con['foo']
+  $client.close if $client
+  $client = Mongo::Client.new('localhost', 27017, :safe => true)
+  $db = $client['foo']
   STDERR << "FORKED #{server} #{worker}"
 end