connection_pool 0.9.2 → 0.9.3

data/Changes.md

@@ -1,3 +1,20 @@
+0.9.3
+--------
+
+- `#with_connection` is now deprecated in favor of `#with`.
+
+    A warning will be issued in the 0.9 series and the method will be
+    removed in 1.0.
+
+- We now reuse objects when possible.
+
+    This means that under no contention, the same object will be checked
+    out from the pool after subsequent calls to `ConnectionPool#with`.
+
+    This change should have no impact on end user performance. If
+    anything, it should be an improvement, depending on what objects you
+    are pooling.
+
 0.9.2
 --------
 

data/README.md

@@ -11,35 +11,57 @@ Install
 
     gem install connection_pool
 
+
+Notes
+------------
+
+- Connections are eager created when the pool is created.
+- There is no provision for repairing or checking the health of a
+  connection; connections should be self-repairing.  This is
+true of the dalli and redis clients.
+
+
 Usage
 ------------
 
 Create a pool of objects to share amongst the fibers or threads in your Ruby application:
 
-    @memcached = ConnectionPool.new(:size => 5, :timeout => 5) { Dalli::Client.new }
+``` ruby
+@memcached = ConnectionPool.new(:size => 5, :timeout => 5) { Dalli::Client.new }
+```
 
 Then use the pool in your application:
 
-    @memcached.with_connection do |dalli|
-      dalli.get('some-count')
-    end
+``` ruby
+@memcached.with do |dalli|
+  dalli.get('some-count')
+end
+```
+
+If all the objects in the connection pool are in use, `with` will block
+until one becomes available.  If no object is available within `:timeout` seconds,
+`with` will raise a `Timeout::Error`.
 
 You can use `ConnectionPool::Wrapper` to wrap a single global connection, making
 it easier to port your connection code over time:
 
-    $redis = ConnectionPool::Wrapper.new(:size => 5, :timeout => 3) { Redis.connect }
-    $redis.sadd('foo', 1)
-    $redis.smembers('foo')
+``` ruby
+$redis = ConnectionPool::Wrapper.new(:size => 5, :timeout => 3) { Redis.connect }
+$redis.sadd('foo', 1)
+$redis.smembers('foo')
+```
 
 The Wrapper uses `method_missing` to checkout a connection, run the
 requested method and then immediately check the connection back into the
 pool.  It's **not** high-performance so you'll want to port your
-performance sensitive code to use `with_connection` as soon as possible.
-
-    $redis.with_connection do |conn|
-      conn.sadd('foo', 1)
-      conn.smembers('foo')
-    end
+performance sensitive code to use `with` as soon as possible.
+
+``` ruby
+$redis.with do |conn|
+  conn.sadd('foo', 1)
+  conn.smembers('foo')
+end
+```
 
 Once you've ported your entire system to use `with`, you can simply
 remove ::Wrapper and use a simple, fast ConnectionPool.

data/Rakefile

@@ -1,5 +1,8 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|

data/connection_pool.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Mike Perham"]
   s.email       = ["mperham@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/mperham/connection_pool"
   s.description = s.summary = %q{Generic connection pool for Ruby}
 
   s.files         = `git ls-files`.split("\n")

data/lib/connection_pool.rb

@@ -1,5 +1,5 @@
-require 'connection_pool/version'
-require 'timed_queue'
+require_relative 'connection_pool/version'
+require_relative 'timed_queue'
 
 # Generic connection pool class for e.g. sharing a limited number of network connections
 # among many threads.  Note: Connections are eager created.
@@ -25,19 +25,19 @@ require 'timed_queue'
 # - :timeout - amount of time to wait for a connection if none currently available, defaults to 5 seconds
 #
 class ConnectionPool
-  DEFAULTS = { :size => 5, :timeout => 5 }
+  DEFAULTS = {size: 5, timeout: 5}
 
   def self.wrap(options, &block)
     Wrapper.new(options, &block)
   end
 
-  def initialize(options={}, &block)
+  def initialize(options = {}, &block)
     raise ArgumentError, 'Connection pool requires a block' unless block
 
     options = DEFAULTS.merge(options)
 
-    @size = options[:size]
-    @timeout = options[:timeout]
+    @size = options.fetch(:size)
+    @timeout = options.fetch(:timeout)
 
     @available = ::TimedQueue.new(@size, &block)
     @key = :"current-#{@available.object_id}"
@@ -51,7 +51,11 @@ class ConnectionPool
       checkin
     end
   end
-  alias_method :with_connection, :with
+
+  def with_connection(&block)
+    warn("ConnectionPool#with_connection is deprecated and will be removed in version 1.0. Upgrade your code to use ConnectionPool#with instead. (in #{caller[0]})")
+    with(&block)
+  end
 
   def checkout
     stack = ::Thread.current[@key] ||= []
@@ -75,7 +79,9 @@ class ConnectionPool
     nil
   end
 
-  class Wrapper
+  class Wrapper < ::BasicObject
+    METHODS = [:with]
+
     def initialize(options = {}, &block)
       @pool = ::ConnectionPool.new(options, &block)
     end
@@ -85,7 +91,15 @@ class ConnectionPool
     ensure
       @pool.checkin
     end
-    alias_method :with_connection, :with
+
+    def with_connection(&block)
+      warn("ConnectionPool::Wrapper#with_connection is deprecated and will be removed in version 1.0. Upgrade your code to use ConnectionPool::Wrapper#with instead. (in #{caller[0]})")
+      with(&block)
+    end
+
+    def respond_to?(id, *args)
+      METHODS.include?(id) || @pool.with { |c| c.respond_to?(id, *args) }
+    end
 
     def method_missing(name, *args, &block)
       @pool.with do |connection|

data/lib/connection_pool/version.rb

@@ -1,3 +1,3 @@
 class ConnectionPool
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/lib/timed_queue.rb

@@ -20,7 +20,7 @@ class TimedQueue
     deadline = Time.now + timeout
     @mutex.synchronize do
       loop do
-        return @que.shift unless @que.empty?
+        return @que.pop unless @que.empty?
         to_wait = deadline - Time.now
         raise Timeout::Error, "Waited #{timeout} sec" if to_wait <= 0
         @resource.wait(@mutex, to_wait)

data/test/helper.rb

@@ -2,8 +2,6 @@ require 'rubygems'
 require 'minitest/pride'
 require 'minitest/autorun'
 
-require 'connection_pool'
-
 puts RUBY_DESCRIPTION
 
 class MiniTest::Unit::TestCase
@@ -15,3 +13,7 @@ class MiniTest::Unit::TestCase
   end
 
 end
+
+$VERBOSE = 1
+
+require_relative '../lib/connection_pool'

data/test/test_connection_pool.rb

@@ -7,19 +7,26 @@ class TestConnectionPool < MiniTest::Unit::TestCase
     def initialize
       @x = 0
     end
+
     def do_something
       @x += 1
       sleep 0.05
       @x
     end
+
     def fast
       @x += 1
     end
+
     def do_something_with_block
       @x += yield
       sleep 0.05
       @x
     end
+
+    def respond_to?(method_id, *args)
+      method_id == :do_magic || super(method_id, *args)
+    end
   end
 
   def test_basic_multithreaded_usage
@@ -27,7 +34,7 @@ class TestConnectionPool < MiniTest::Unit::TestCase
     threads = []
     15.times do
       threads << Thread.new do
-        pool.with_connection do |net|
+        pool.with do |net|
           net.do_something
         end
       end
@@ -67,9 +74,17 @@ class TestConnectionPool < MiniTest::Unit::TestCase
     assert_equal 6, pool.with { |net| net.fast }
   end
 
+  def test_passthru_respond_to
+    pool = ConnectionPool.wrap(:timeout => 0.1, :size => 1) { NetworkConnection.new }
+    assert pool.respond_to?(:with)
+    assert pool.respond_to?(:do_something)
+    assert pool.respond_to?(:do_magic)
+    refute pool.respond_to?(:do_lots_of_magic)
+  end
+
   def test_return_value
     pool = ConnectionPool.new(:timeout => 0.1, :size => 1) { NetworkConnection.new }
-    result = pool.with_connection do |net|
+    result = pool.with do |net|
       net.fast
     end
     assert_equal 1, result
@@ -87,6 +102,16 @@ class TestConnectionPool < MiniTest::Unit::TestCase
     sleep 0.5
   end
 
+  def test_reuses_objects_when_pool_not_saturated
+    pool = ConnectionPool.new(:size => 5) { NetworkConnection.new }
+
+    ids = 10.times.map do
+      pool.with { |c| c.object_id }
+    end
+
+    assert_equal 1, ids.uniq.size
+  end
+
   class Recorder
     def initialize
       @calls = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: connection_pool
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-12-19 00:00:00.000000000 Z
 dependencies: []
 description: Generic connection pool for Ruby
 email:
@@ -30,7 +30,7 @@ files:
 - lib/timed_queue.rb
 - test/helper.rb
 - test/test_connection_pool.rb
-homepage: ''
+homepage: https://github.com/mperham/connection_pool
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -50,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Generic connection pool for Ruby