connection_pool 2.1.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cba01c34d4f2ac4cd9beb4d71ade9808e66095a0
-  data.tar.gz: 541e73dc97f93b16a7a2725be6157395a76b2295
+SHA256:
+  metadata.gz: e9fefa40cd9db0f5add54482a9f980d808b5bb578e83a5a8bf287c636c41704d
+  data.tar.gz: ec25d36c42cfb863e768bf49b18316d955397edaa8862f92d27687ab2a089bf0
 SHA512:
-  metadata.gz: d2d9e0deee042e07bd04a4715c97d67bc0c6d59fc6670a307a740024d7ff38ad6fe46dbe9edc482bdef7d6ed51abaeb5297df1a3664c6ec26ba0f2d0e51512c7
-  data.tar.gz: 2dbf1090f068f706141e92aae4dfefb1f596e96be621e0ad1d4e4824c9abae734f337d7ea2e4c5d7943f612835f4ca429469347f1270359c4e604033329dabc4
+  metadata.gz: d8653437078b6334be998d16f4851e12a21e8caca8338a07559c9bfbe646dc6023a7370aad6e33be905b05d6eaab8f249387eaa72b16a478f57c9c497adbbf30
+  data.tar.gz: 2a437d085a3f11376338ee32debe5e7ff38fc28fdc8d0d318287c2890bc90ce2d282468981dde43c8391798d113e1391d7998a5f5e571f1021ae99dfff6893e2

data/.travis.yml

@@ -1,14 +1,12 @@
 ---
-sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - jruby
-  - rbx-2
-notifications:
-  email:
-    - drbrain@segment7.net
+jdk:
+  - openjdk11

data/Changes.md

@@ -1,3 +1,38 @@
+# connection_pool Changelog
+
+2.2.3
+------
+
+- Pool now throws `ConnectionPool::TimeoutError` on timeout. [#130]
+- Use monotonic clock present in all modern Rubies [Tero Tasanen, #109]
+- Remove code hacks necessary for JRuby 1.7
+- Expose wrapped pool from ConnectionPool::Wrapper [Thomas Lecavelier, #113]
+
+2.2.2
+------
+
+- Add pool `size` and `available` accessors for metrics and monitoring
+  purposes [#97, robholland]
+
+2.2.1
+------
+
+- Allow CP::Wrapper to use an existing pool [#87, etiennebarrie]
+- Use monotonic time for more accurate timeouts [#84, jdantonio]
+
+2.2.0
+------
+
+- Rollback `Timeout` handling introduced in 2.1.1 and 2.1.2.  It seems
+  impossible to safely work around the issue. Please never, ever use
+  `Timeout.timeout` in your code or you will see rare but mysterious bugs. [#75]
+
+2.1.3
+------
+
+- Don't increment created count until connection is successfully
+  created. [mylesmegyesi, #73]
+
 2.1.2
 ------
 

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
 gemspec(development_group: :runtime)
+
+gem "standard"

data/README.md

@@ -45,11 +45,13 @@ sections when a resource is not available, or conversely if you are comfortable
 blocking longer on a particular resource. This is not implemented in the below
 `ConnectionPool::Wrapper` class.
 
+## Migrating to a Connection Pool
+
 You can use `ConnectionPool::Wrapper` to wrap a single global connection,
-making it easier to port your connection code over time:
+making it easier to migrate existing connection code over time:
 
 ``` ruby
-$redis = ConnectionPool::Wrapper.new(size: 5, timeout: 3) { Redis.connect }
+$redis = ConnectionPool::Wrapper.new(size: 5, timeout: 3) { Redis.new }
 $redis.sadd('foo', 1)
 $redis.smembers('foo')
 ```
@@ -69,19 +71,36 @@ end
 Once you've ported your entire system to use `with`, you can simply remove
 `Wrapper` and use the simpler and faster `ConnectionPool`.
 
+
+## Shutdown
+
 You can shut down a ConnectionPool instance once it should no longer be used.
 Further checkout attempts will immediately raise an error but existing checkouts
 will work.
 
 ```ruby
 cp = ConnectionPool.new { Redis.new }
-cp.shutdown { |conn| conn.close }
+cp.shutdown { |conn| conn.quit }
 ```
 
 Shutting down a connection pool will block until all connections are checked in and closed.
-Note that shutting down is completely optional; Ruby's garbage collector will reclaim
+**Note that shutting down is completely optional**; Ruby's garbage collector will reclaim
 unreferenced pools under normal circumstances.
 
+## Current State
+
+There are several methods that return information about a pool.
+
+```ruby
+cp = ConnectionPool.new(size: 10) { Redis.new }
+cp.size # => 10
+cp.available # => 10
+
+cp.with do |conn|
+  cp.size # => 10
+  cp.available # => 9
+end
+```
 
 Notes
 -----
@@ -90,14 +109,10 @@ Notes
 - 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.
-
-
-Install
--------
-
-```
-$ gem install connection_pool
-```
+- **WARNING**: Don't ever use `Timeout.timeout` in your Ruby code or you will see
+  occasional silent corruption and mysterious errors.  The Timeout API is unsafe
+  and cannot be used correctly, ever.  Use proper socket timeout options as
+  exposed by Net::HTTP, Redis, Dalli, etc.
 
 
 Author

data/Rakefile

@@ -1,6 +1,7 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
+require "standard/rake"
 Rake::TestTask.new
 
-task :default => :test
+task default: :test

data/connection_pool.gemspec

@@ -1,21 +1,20 @@
-# -*- encoding: utf-8 -*-
 require "./lib/connection_pool/version"
 
 Gem::Specification.new do |s|
-  s.name        = "connection_pool"
-  s.version     = ConnectionPool::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Mike Perham", "Damian Janowski"]
-  s.email       = ["mperham@gmail.com", "damian@educabilia.com"]
-  s.homepage    = "https://github.com/mperham/connection_pool"
-  s.description = s.summary = %q{Generic connection pool for Ruby}
+  s.name = "connection_pool"
+  s.version = ConnectionPool::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Mike Perham", "Damian Janowski"]
+  s.email = ["mperham@gmail.com", "damian@educabilia.com"]
+  s.homepage = "https://github.com/mperham/connection_pool"
+  s.description = s.summary = "Generic connection pool for Ruby"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.license = "MIT"
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'minitest', '>= 5.0.0'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "minitest", ">= 5.0.0"
+  s.add_development_dependency "rake"
 end

data/lib/connection_pool.rb

@@ -1,20 +1,25 @@
-require_relative 'connection_pool/version'
-require_relative 'connection_pool/timed_stack'
+require "timeout"
+require "connection_pool/version"
 
-# Generic connection pool class for e.g. sharing a limited number of network connections
-# among many threads.  Note: Connections are lazily created.
+class ConnectionPool
+  class Error < ::RuntimeError; end
+  class PoolShuttingDownError < ::ConnectionPool::Error; end
+  class TimeoutError < ::Timeout::Error; end
+end
+
+# Generic connection pool class for sharing a limited number of objects or network connections
+# among many threads.  Note: pool elements are lazily created.
 #
 # Example usage with block (faster):
 #
 #    @pool = ConnectionPool.new { Redis.new }
-#
 #    @pool.with do |redis|
 #      redis.lpop('my-list') if redis.llen('my-list') > 0
 #    end
 #
 # Using optional timeout override (for that single invocation)
 #
-#    @pool.with(:timeout => 2.0) do |redis|
+#    @pool.with(timeout: 2.0) do |redis|
 #      redis.lpop('my-list') if redis.llen('my-list') > 0
 #    end
 #
@@ -33,60 +38,57 @@ require_relative 'connection_pool/timed_stack'
 class ConnectionPool
   DEFAULTS = {size: 5, timeout: 5}
 
-  class Error < RuntimeError
-  end
-
   def self.wrap(options, &block)
     Wrapper.new(options, &block)
   end
 
   def initialize(options = {}, &block)
-    raise ArgumentError, 'Connection pool requires a block' unless block
+    raise ArgumentError, "Connection pool requires a block" unless block
 
     options = DEFAULTS.merge(options)
 
-    @size = options.fetch(:size)
+    @size = Integer(options.fetch(:size))
     @timeout = options.fetch(:timeout)
 
     @available = TimedStack.new(@size, &block)
-    @key = :"current-#{@available.object_id}"
+    @key = :"pool-#{@available.object_id}"
+    @key_count = :"pool-#{@available.object_id}-count"
   end
 
   def with(options = {})
-    # Connections can become corrupted via Timeout::Error.  Discard
-    # any connection whose usage after checkout does not finish as expected.
-    # See #67
-    success = false
-    conn = checkout(options)
-    begin
-      result = yield conn
-      success = true # means the connection wasn't interrupted
-      result
-    ensure
-      if success
-        # everything is roses, we can safely check the connection back in
+    Thread.handle_interrupt(Exception => :never) do
+      conn = checkout(options)
+      begin
+        Thread.handle_interrupt(Exception => :immediate) do
+          yield conn
+        end
+      ensure
         checkin
-      else
-        @available.discard!(pop_connection)
       end
     end
   end
 
   def checkout(options = {})
-    conn = if stack.empty?
-      timeout = options[:timeout] || @timeout
-      @available.pop(timeout: timeout)
+    if ::Thread.current[@key]
+      ::Thread.current[@key_count] += 1
+      ::Thread.current[@key]
     else
-      stack.last
+      ::Thread.current[@key_count] = 1
+      ::Thread.current[@key] = @available.pop(options[:timeout] || @timeout)
     end
-
-    stack.push conn
-    conn
   end
 
   def checkin
-    conn = pop_connection # mutates stack, must be on its own line
-    @available.push(conn) if stack.empty?
+    if ::Thread.current[@key]
+      if ::Thread.current[@key_count] == 1
+        @available.push(::Thread.current[@key])
+        ::Thread.current[@key] = nil
+      else
+        ::Thread.current[@key_count] -= 1
+      end
+    else
+      raise ConnectionPool::Error, "no connections are checked out"
+    end
 
     nil
   end
@@ -95,43 +97,14 @@ class ConnectionPool
     @available.shutdown(&block)
   end
 
-  private
-
-  def pop_connection
-    if stack.empty?
-      raise ConnectionPool::Error, 'no connections are checked out'
-    else
-      stack.pop
-    end
-  end
-
-  def stack
-    ::Thread.current[@key] ||= []
-  end
-
-  class Wrapper < ::BasicObject
-    METHODS = [:with, :pool_shutdown]
-
-    def initialize(options = {}, &block)
-      @pool = ::ConnectionPool.new(options, &block)
-    end
-
-    def with(&block)
-      @pool.with(&block)
-    end
+  # Size of this connection pool
+  attr_reader :size
 
-    def pool_shutdown(&block)
-      @pool.shutdown(&block)
-    end
-
-    def respond_to?(id, *args)
-      METHODS.include?(id) || with { |c| c.respond_to?(id, *args) }
-    end
-
-    def method_missing(name, *args, &block)
-      with do |connection|
-        connection.send(name, *args, &block)
-      end
-    end
+  # Number of pool entries available for checkout at this instant.
+  def available
+    @available.length
   end
 end
+
+require "connection_pool/timed_stack"
+require "connection_pool/wrapper"

data/lib/connection_pool/timed_stack.rb

@@ -1,12 +1,3 @@
-require 'thread'
-require 'timeout'
-
-##
-# Raised when you attempt to retrieve a connection from a pool that has been
-# shut down.
-
-class ConnectionPool::PoolShuttingDownError < RuntimeError; end
-
 ##
 # The TimedStack manages a pool of homogeneous connections (or any resource
 # you wish to manage).  Connections are created lazily up to a given maximum
@@ -27,6 +18,7 @@ class ConnectionPool::PoolShuttingDownError < RuntimeError; end
 #    #=> raises Timeout::Error after 5 seconds
 
 class ConnectionPool::TimedStack
+  attr_reader :max
 
   ##
   # Creates a new pool with +size+ connections that are created from the given
@@ -57,7 +49,7 @@ class ConnectionPool::TimedStack
       @resource.broadcast
     end
   end
-  alias_method :<<, :push
+  alias << push
 
   ##
   # Retrieves a connection from the stack.  If a connection is available it is
@@ -72,7 +64,7 @@ class ConnectionPool::TimedStack
     options, timeout = timeout, 0.5 if Hash === timeout
     timeout = options.fetch :timeout, timeout
 
-    deadline = Time.now + timeout
+    deadline = current_time + timeout
     @mutex.synchronize do
       loop do
         raise ConnectionPool::PoolShuttingDownError if @shutdown_block
@@ -81,8 +73,8 @@ class ConnectionPool::TimedStack
         connection = try_create(options)
         return connection if connection
 
-        to_wait = deadline - Time.now
-        raise Timeout::Error, "Waited #{timeout} sec" if to_wait <= 0
+        to_wait = deadline - current_time
+        raise ConnectionPool::TimeoutError, "Waited #{timeout} sec" if to_wait <= 0
         @resource.wait(@mutex, to_wait)
       end
     end
@@ -117,30 +109,12 @@ class ConnectionPool::TimedStack
     @max - @created + @que.length
   end
 
-  ##
-  # Indicates that a connection isn't coming back, allowing a new one to be
-  # created to replace it.
-
-  def discard!(obj)
-    @mutex.synchronize do
-      if @shutdown_block
-        @shutdown_block.call(obj)
-      else
-        # try to shut down the connection before throwing it away
-        if obj.respond_to?(:close) # Dalli::Client
-          obj.close rescue nil
-        elsif obj.respond_to?(:disconnect!) # Redis
-          obj.disconnect! rescue nil
-        end
-        @created -= 1
-      end
+  private
 
-      @resource.broadcast
-    end
+  def current_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
   end
 
-  private
-
   ##
   # This is an extension point for TimedStack and is called with a mutex.
   #
@@ -188,8 +162,9 @@ class ConnectionPool::TimedStack
 
   def try_create(options = nil)
     unless @created == @max
+      object = @create_block.call
       @created += 1
-      @create_block.call
+      object
     end
   end
 end

data/lib/connection_pool/version.rb

@@ -1,3 +1,3 @@
 class ConnectionPool
-  VERSION = "2.1.2"
+  VERSION = "2.2.3"
 end

data/lib/connection_pool/wrapper.rb

@@ -0,0 +1,43 @@
+class ConnectionPool
+  class Wrapper < ::BasicObject
+    METHODS = [:with, :pool_shutdown, :wrapped_pool]
+
+    def initialize(options = {}, &block)
+      @pool = options.fetch(:pool) { ::ConnectionPool.new(options, &block) }
+    end
+
+    def wrapped_pool
+      @pool
+    end
+
+    def with(&block)
+      @pool.with(&block)
+    end
+
+    def pool_shutdown(&block)
+      @pool.shutdown(&block)
+    end
+
+    def pool_size
+      @pool.size
+    end
+
+    def pool_available
+      @pool.available
+    end
+
+    def respond_to?(id, *args)
+      METHODS.include?(id) || with { |c| c.respond_to?(id, *args) }
+    end
+
+    # rubocop:disable Style/MethodMissingSuper
+    # rubocop:disable Style/MissingRespondToMissing
+    def method_missing(name, *args, &block)
+      with do |connection|
+        connection.send(name, *args, &block)
+      end
+    end
+    # rubocop:enable Style/MethodMissingSuper
+    # rubocop:enable Style/MissingRespondToMissing
+  end
+end

data/test/helper.rb

@@ -1,8 +1,8 @@
-gem 'minitest'
+gem "minitest"
 
-require 'minitest/pride'
-require 'minitest/autorun'
+require "minitest/pride"
+require "minitest/autorun"
 
 $VERBOSE = 1
 
-require_relative '../lib/connection_pool'
+require_relative "../lib/connection_pool"

data/test/test_connection_pool.rb

@@ -1,15 +1,16 @@
-require_relative 'helper'
+require_relative "helper"
 
 class TestConnectionPool < Minitest::Test
-
   class NetworkConnection
+    SLEEP_TIME = 0.1
+
     def initialize
       @x = 0
     end
 
     def do_something
       @x += 1
-      sleep 0.05
+      sleep SLEEP_TIME
       @x
     end
 
@@ -19,7 +20,7 @@ class TestConnectionPool < Minitest::Test
 
     def do_something_with_block
       @x += yield
-      sleep 0.05
+      sleep SLEEP_TIME
       @x
     end
 
@@ -41,12 +42,12 @@ class TestConnectionPool < Minitest::Test
   end
 
   def use_pool(pool, size)
-    Array.new(size) do
+    Array.new(size) {
       Thread.new do
-        pool.with do sleep end
+        pool.with { sleep }
       end
-    end.each do |thread|
-      Thread.pass until thread.status == 'sleep'
+    }.each do |thread|
+      Thread.pass until thread.status == "sleep"
     end
   end
 
@@ -58,33 +59,38 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_basic_multithreaded_usage
-    pool = ConnectionPool.new(:size => 5) { NetworkConnection.new }
+    pool_size = 5
+    pool = ConnectionPool.new(size: pool_size) { NetworkConnection.new }
+
+    start = Time.new
 
-    threads = Array.new(15) do
+    generations = 3
+
+    result = Array.new(pool_size * generations) {
       Thread.new do
         pool.with do |net|
           net.do_something
         end
       end
-    end
+    }.map(&:value)
 
-    a = Time.now
-    result = threads.map(&:value)
-    b = Time.now
-    assert_operator((b - a), :>, 0.125)
-    assert_equal([1,2,3].cycle(5).sort, result.sort)
+    finish = Time.new
+
+    assert_equal((1..generations).cycle(pool_size).sort, result.sort)
+
+    assert_operator(finish - start, :>, generations * NetworkConnection::SLEEP_TIME)
   end
 
   def test_timeout
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { NetworkConnection.new }
-    thread = Thread.new do
+    pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
+    thread = Thread.new {
       pool.with do |net|
         net.do_something
         sleep 0.01
       end
-    end
+    }
 
-    Thread.pass while thread.status == 'run'
+    Thread.pass while thread.status == "run"
 
     assert_raises Timeout::Error do
       pool.with { |net| net.do_something }
@@ -98,79 +104,126 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_with
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { Object.new }
+    pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
 
     pool.with do
-      assert_raises Timeout::Error do
-        Thread.new { pool.checkout }.join
-      end
+      Thread.new {
+        assert_raises Timeout::Error do
+          pool.checkout
+        end
+      }.join
     end
 
     assert Thread.new { pool.checkout }.join
   end
 
-  def test_with_with_dangerous_timeouts
-    case RUBY_ENGINE.to_sym
-    when :jruby
-      skip('JRuby GC dislikes this test')
-    when :ruby
-      if RUBY_VERSION == '2.0.0' && RUBY_PATCHLEVEL == 598
-        skip("#{RUBY_VERSION}p#{RUBY_PATCHLEVEL} GC dislikes this test")
+  def test_with_timeout
+    pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
+
+    assert_raises Timeout::Error do
+      Timeout.timeout(0.01) do
+        pool.with do |obj|
+          assert_equal 0, pool.available
+          sleep 0.015
+        end
       end
     end
+    assert_equal 1, pool.available
+  end
 
-    marker_class = Class.new
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { marker_class.new }
+  def test_invalid_size
+    assert_raises ArgumentError, TypeError do
+      ConnectionPool.new(timeout: 0, size: nil) { Object.new }
+    end
+    assert_raises ArgumentError, TypeError do
+      ConnectionPool.new(timeout: 0, size: "") { Object.new }
+    end
+  end
 
-    # no "connections" allocated yet
-    assert_equal [], ObjectSpace.each_object(marker_class).to_a
+  def test_handle_interrupt_ensures_checkin
+    pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
+    def pool.checkout(options)
+      sleep 0.015
+      super
+    end
 
-    checkin_time = 0.05
+    did_something = false
 
-    assert_raises Timeout::Error do
-      Timeout.timeout(checkin_time) do
-        pool.with do
-          # a "connection" has been allocated
-          refute_equal [], ObjectSpace.each_object(marker_class).to_a
-          sleep 2 * checkin_time
+    action = lambda do
+      Timeout.timeout(0.01) do
+        pool.with do |obj|
+          did_something = true
+          # Timeout::Error will be triggered by any non-trivial Ruby code
+          # executed here since it couldn't be raised during checkout.
+          # It looks like setting the local variable above does not trigger
+          # the Timeout check in MRI 2.2.1.
+          obj.tap { obj.hash }
         end
       end
     end
 
-    GC.start
+    if RUBY_ENGINE == "ruby"
+      # These asserts rely on the Ruby implementation reaching `did_something =
+      # true` before the interrupt is detected by the thread. Interrupt
+      # detection timing is implementation-specific in practice, with JRuby,
+      # Rubinius, and TruffleRuby all having different interrupt timings to MRI.
+      # In fact they generally detect interrupts more quickly than MRI, so they
+      # may not reach `did_something = true` before detecting the interrupt.
+
+      assert_raises Timeout::Error, &action
+
+      assert did_something
+    else
+      action.call
+    end
+
+    assert_equal 1, pool.available
+  end
+
+  def test_explicit_return
+    pool = ConnectionPool.new(timeout: 0, size: 1) {
+      mock = Minitest::Mock.new
+      def mock.disconnect!
+        raise "should not disconnect upon explicit return"
+      end
+      mock
+    }
 
-    # no dangling references to this "connection" remain
-    assert_equal [], ObjectSpace.each_object(marker_class).to_a
+    pool.with do |conn|
+      return true
+    end
   end
 
   def test_with_timeout_override
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { NetworkConnection.new }
+    pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
 
-    t = Thread.new do
+    t = Thread.new {
       pool.with do |net|
         net.do_something
         sleep 0.01
       end
-    end
+    }
 
-    Thread.pass while t.status == 'run'
+    Thread.pass while t.status == "run"
 
     assert_raises Timeout::Error do
       pool.with { |net| net.do_something }
     end
 
-    pool.with(:timeout => 0.1) do |conn|
+    pool.with(timeout: 2 * NetworkConnection::SLEEP_TIME) do |conn|
       refute_nil conn
     end
   end
 
   def test_checkin
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { NetworkConnection.new }
+    pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
     conn = pool.checkout
 
-    assert_raises Timeout::Error do
-      Thread.new { pool.checkout }.join
-    end
+    Thread.new {
+      assert_raises Timeout::Error do
+        pool.checkout
+      end
+    }.join
 
     pool.checkin
 
@@ -178,22 +231,19 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_returns_value
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { Object.new }
-    assert_equal 1, pool.with {|o| 1 }
+    pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
+    assert_equal 1, pool.with { |o| 1 }
   end
 
   def test_checkin_never_checkout
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { Object.new }
-
-    e = assert_raises ConnectionPool::Error do
-      pool.checkin
-    end
+    pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
 
-    assert_equal 'no connections are checked out', e.message
+    e = assert_raises(ConnectionPool::Error) { pool.checkin }
+    assert_equal "no connections are checked out", e.message
   end
 
   def test_checkin_no_current_checkout
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { Object.new }
+    pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
 
     pool.checkout
     pool.checkin
@@ -204,18 +254,18 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_checkin_twice
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { Object.new }
+    pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
 
     pool.checkout
     pool.checkout
 
     pool.checkin
 
-    assert_raises Timeout::Error do
-      Thread.new do
+    Thread.new {
+      assert_raises Timeout::Error do
         pool.checkout
-      end.join
-    end
+      end
+    }.join
 
     pool.checkin
 
@@ -223,7 +273,7 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_checkout
-    pool = ConnectionPool.new(:size => 1) { NetworkConnection.new }
+    pool = ConnectionPool.new(size: 1) { NetworkConnection.new }
 
     conn = pool.checkout
 
@@ -233,18 +283,18 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_checkout_multithread
-    pool = ConnectionPool.new(:size => 2) { NetworkConnection.new }
+    pool = ConnectionPool.new(size: 2) { NetworkConnection.new }
     conn = pool.checkout
 
-    t = Thread.new do
+    t = Thread.new {
       pool.checkout
-    end
+    }
 
     refute_same conn, t.value
   end
 
   def test_checkout_timeout
-    pool = ConnectionPool.new(:timeout => 0, :size => 0) { Object.new }
+    pool = ConnectionPool.new(timeout: 0, size: 0) { Object.new }
 
     assert_raises Timeout::Error do
       pool.checkout
@@ -252,26 +302,26 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_checkout_timeout_override
-    pool = ConnectionPool.new(:timeout => 0, :size => 1) { NetworkConnection.new }
+    pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
 
-    thread = Thread.new do
+    thread = Thread.new {
       pool.with do |net|
         net.do_something
         sleep 0.01
       end
-    end
+    }
 
-    Thread.pass while thread.status == 'run'
+    Thread.pass while thread.status == "run"
 
     assert_raises Timeout::Error do
       pool.checkout
     end
 
-    assert pool.checkout :timeout => 0.1
+    assert pool.checkout timeout: 2 * NetworkConnection::SLEEP_TIME
   end
 
   def test_passthru
-    pool = ConnectionPool.wrap(:timeout => 0.1, :size => 1) { NetworkConnection.new }
+    pool = ConnectionPool.wrap(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
     assert_equal 1, pool.do_something
     assert_equal 2, pool.do_something
     assert_equal 5, pool.do_something_with_block { 3 }
@@ -279,7 +329,7 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_passthru_respond_to
-    pool = ConnectionPool.wrap(:timeout => 0.1, :size => 1) { NetworkConnection.new }
+    pool = ConnectionPool.wrap(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
     assert pool.respond_to?(:with)
     assert pool.respond_to?(:do_something)
     assert pool.respond_to?(:do_magic)
@@ -287,67 +337,67 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_return_value
-    pool = ConnectionPool.new(:timeout => 0.1, :size => 1) { NetworkConnection.new }
-    result = pool.with do |net|
+    pool = ConnectionPool.new(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
+    result = pool.with { |net|
       net.fast
-    end
+    }
     assert_equal 1, result
   end
 
   def test_heavy_threading
-    pool = ConnectionPool.new(:timeout => 0.5, :size => 3) { NetworkConnection.new }
+    pool = ConnectionPool.new(timeout: 0.5, size: 3) { NetworkConnection.new }
 
-    threads = Array.new(20) do
+    threads = Array.new(20) {
       Thread.new do
         pool.with do |net|
           sleep 0.01
         end
       end
-    end
+    }
 
     threads.map { |thread| thread.join }
   end
 
   def test_reuses_objects_when_pool_not_saturated
-    pool = ConnectionPool.new(:size => 5) { NetworkConnection.new }
+    pool = ConnectionPool.new(size: 5) { NetworkConnection.new }
 
-    ids = 10.times.map do
+    ids = 10.times.map {
       pool.with { |c| c.object_id }
-    end
+    }
 
     assert_equal 1, ids.uniq.size
   end
 
   def test_nested_checkout
     recorder = Recorder.new
-    pool = ConnectionPool.new(:size => 1) { recorder }
+    pool = ConnectionPool.new(size: 1) { recorder }
     pool.with do |r_outer|
-      @other = Thread.new do |t|
+      @other = Thread.new { |t|
         pool.with do |r_other|
-          r_other.do_work('other')
+          r_other.do_work("other")
         end
-      end
+      }
 
       pool.with do |r_inner|
-        r_inner.do_work('inner')
+        r_inner.do_work("inner")
       end
 
       Thread.pass
 
-      r_outer.do_work('outer')
+      r_outer.do_work("outer")
     end
 
     @other.join
 
-    assert_equal ['inner', 'outer', 'other'], recorder.calls
+    assert_equal ["inner", "outer", "other"], recorder.calls
   end
 
   def test_shutdown_is_executed_for_all_connections
     recorders = []
 
-    pool = ConnectionPool.new(:size => 3) do
+    pool = ConnectionPool.new(size: 3) {
       Recorder.new.tap { |r| recorders << r }
-    end
+    }
 
     threads = use_pool pool, 3
 
@@ -361,9 +411,9 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_raises_error_after_shutting_down
-    pool = ConnectionPool.new(:size => 1) { true }
+    pool = ConnectionPool.new(size: 1) { true }
 
-    pool.shutdown { }
+    pool.shutdown {}
 
     assert_raises ConnectionPool::PoolShuttingDownError do
       pool.checkout
@@ -373,9 +423,9 @@ class TestConnectionPool < Minitest::Test
   def test_runs_shutdown_block_asynchronously_if_connection_was_in_use
     recorders = []
 
-    pool = ConnectionPool.new(:size => 3) do
+    pool = ConnectionPool.new(size: 3) {
       Recorder.new.tap { |r| recorders << r }
-    end
+    }
 
     threads = use_pool pool, 2
 
@@ -395,7 +445,7 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_raises_an_error_if_shutdown_is_called_without_a_block
-    pool = ConnectionPool.new(:size => 1) { }
+    pool = ConnectionPool.new(size: 1) {}
 
     assert_raises ArgumentError do
       pool.shutdown
@@ -405,9 +455,9 @@ class TestConnectionPool < Minitest::Test
   def test_shutdown_is_executed_for_all_connections_in_wrapped_pool
     recorders = []
 
-    wrapper = ConnectionPool::Wrapper.new(:size => 3) do
+    wrapper = ConnectionPool::Wrapper.new(size: 3) {
       Recorder.new.tap { |r| recorders << r }
-    end
+    }
 
     threads = use_pool wrapper, 3
 
@@ -420,6 +470,11 @@ class TestConnectionPool < Minitest::Test
     assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
   end
 
+  def test_wrapper_wrapped_pool
+    wrapper = ConnectionPool::Wrapper.new { NetworkConnection.new }
+    assert_equal ConnectionPool, wrapper.wrapped_pool.class
+  end
+
   def test_wrapper_method_missing
     wrapper = ConnectionPool::Wrapper.new { NetworkConnection.new }
 
@@ -436,17 +491,17 @@ class TestConnectionPool < Minitest::Test
   end
 
   def test_wrapper_with
-    wrapper = ConnectionPool::Wrapper.new(:timeout => 0, :size => 1) { Object.new }
+    wrapper = ConnectionPool::Wrapper.new(timeout: 0, size: 1) { Object.new }
 
     wrapper.with do
-      assert_raises Timeout::Error do
-        Thread.new do
-          wrapper.with { flunk 'connection checked out :(' }
-        end.join
-      end
+      Thread.new {
+        assert_raises Timeout::Error do
+          wrapper.with { flunk "connection checked out :(" }
+        end
+      }.join
     end
 
-    assert Thread.new { wrapper.with { } }.join
+    assert Thread.new { wrapper.with {} }.join
   end
 
   class ConnWithEval
@@ -461,4 +516,38 @@ class TestConnectionPool < Minitest::Test
     assert_equal "eval'ed 1", wrapper.eval(1)
   end
 
+  def test_wrapper_with_connection_pool
+    recorder = Recorder.new
+    pool = ConnectionPool.new(size: 1) { recorder }
+    wrapper = ConnectionPool::Wrapper.new(pool: pool)
+
+    pool.with { |r| r.do_work("with") }
+    wrapper.do_work("wrapped")
+
+    assert_equal ["with", "wrapped"], recorder.calls
+  end
+
+  def test_stats_without_active_connection
+    pool = ConnectionPool.new(size: 2) { NetworkConnection.new }
+
+    assert_equal(2, pool.size)
+    assert_equal(2, pool.available)
+  end
+
+  def test_stats_with_active_connection
+    pool = ConnectionPool.new(size: 2) { NetworkConnection.new }
+
+    pool.with do
+      assert_equal(1, pool.available)
+    end
+  end
+
+  def test_stats_with_string_size
+    pool = ConnectionPool.new(size: "2") { NetworkConnection.new }
+
+    pool.with do
+      assert_equal(2, pool.size)
+      assert_equal(1, pool.available)
+    end
+  end
 end

data/test/test_connection_pool_timed_stack.rb

@@ -1,7 +1,6 @@
-require_relative 'helper'
+require_relative "helper"
 
 class TestConnectionPoolTimedStack < Minitest::Test
-
   def setup
     @stack = ConnectionPool::TimedStack.new { Object.new }
   end
@@ -34,6 +33,25 @@ class TestConnectionPoolTimedStack < Minitest::Test
     assert_equal 1, stack.length
   end
 
+  def test_object_creation_fails
+    stack = ConnectionPool::TimedStack.new(2) { raise "failure" }
+
+    begin
+      stack.pop
+    rescue => error
+      assert_equal "failure", error.message
+    end
+
+    begin
+      stack.pop
+    rescue => error
+      assert_equal "failure", error.message
+    end
+
+    refute_empty stack
+    assert_equal 2, stack.length
+  end
+
   def test_pop
     object = Object.new
     @stack.push object
@@ -44,19 +62,13 @@ class TestConnectionPoolTimedStack < Minitest::Test
   end
 
   def test_pop_empty
-    e = assert_raises Timeout::Error do
-      @stack.pop timeout: 0
-    end
-
-    assert_equal 'Waited 0 sec', e.message
+    e = assert_raises(ConnectionPool::TimeoutError) { @stack.pop timeout: 0 }
+    assert_equal "Waited 0 sec", e.message
   end
 
   def test_pop_empty_2_0_compatibility
-    e = assert_raises Timeout::Error do
-      @stack.pop 0
-    end
-
-    assert_equal 'Waited 0 sec', e.message
+    e = assert_raises(Timeout::Error) { @stack.pop 0 }
+    assert_equal "Waited 0 sec", e.message
   end
 
   def test_pop_full
@@ -69,11 +81,11 @@ class TestConnectionPoolTimedStack < Minitest::Test
   end
 
   def test_pop_wait
-    thread = Thread.start do
+    thread = Thread.start {
       @stack.pop
-    end
+    }
 
-    Thread.pass while thread.status == 'run'
+    Thread.pass while thread.status == "run"
 
     object = Object.new
 
@@ -83,7 +95,7 @@ class TestConnectionPoolTimedStack < Minitest::Test
   end
 
   def test_pop_shutdown
-    @stack.shutdown { }
+    @stack.shutdown {}
 
     assert_raises ConnectionPool::PoolShuttingDownError do
       @stack.pop
@@ -125,6 +137,4 @@ class TestConnectionPoolTimedStack < Minitest::Test
     refute_empty called
     assert_empty @stack
   end
-
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: connection_pool
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Mike Perham
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - lib/connection_pool.rb
 - lib/connection_pool/timed_stack.rb
 - lib/connection_pool/version.rb
+- lib/connection_pool/wrapper.rb
 - test/helper.rb
 - test/test_connection_pool.rb
 - test/test_connection_pool_timed_stack.rb
@@ -94,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Generic connection pool for Ruby