connection_pool 1.0.0 → 1.1.0

data/Changes.md

@@ -1,3 +1,12 @@
+1.1.0
+-----
+
+- New `#shutdown` method (simao)
+
+    This method accepts a block and calls the block for each
+    connection in the pool. After calling this method, trying to get a
+    connection from the pool raises `PoolShuttingDownError`.
+    
 1.0.0
 -----
 

data/connection_pool.gemspec

@@ -14,4 +14,6 @@ Gem::Specification.new do |s|
   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 'minitest', '>= 5.0.0'
 end

data/lib/connection_pool.rb

@@ -1,4 +1,5 @@
-require_relative 'connection_pool/version'
+require 'connection_pool/version'
+require 'connection_pool/timed_stack'
 
 # Generic connection pool class for e.g. sharing a limited number of network connections
 # among many threads.  Note: Connections are eager created.
@@ -73,6 +74,10 @@ class ConnectionPool
     nil
   end
 
+  def shutdown(&block)
+    @available.shutdown(&block)
+  end
+
   class Wrapper < ::BasicObject
     METHODS = [:with]
 

data/lib/connection_pool/timed_stack.rb

@@ -1,16 +1,24 @@
 require 'thread'
 require 'timeout'
 
+class ConnectionPool::PoolShuttingDownError < RuntimeError; end
+
 class ConnectionPool::TimedStack
   def initialize(size = 0)
     @que = Array.new(size) { yield }
     @mutex = Mutex.new
     @resource = ConditionVariable.new
+    @shutdown_block = nil
   end
 
   def push(obj)
     @mutex.synchronize do
-      @que.push obj
+      if @shutdown_block
+        @shutdown_block.call(obj)
+      else
+        @que.push obj
+      end
+
       @resource.broadcast
     end
   end
@@ -20,6 +28,7 @@ class ConnectionPool::TimedStack
     deadline = Time.now + timeout
     @mutex.synchronize do
       loop do
+        raise ConnectionPool::PoolShuttingDownError if @shutdown_block
         return @que.pop unless @que.empty?
         to_wait = deadline - Time.now
         raise Timeout::Error, "Waited #{timeout} sec" if to_wait <= 0
@@ -28,6 +37,20 @@ class ConnectionPool::TimedStack
     end
   end
 
+  def shutdown(&block)
+    raise ArgumentError, "shutdown must receive a block" unless block_given?
+
+    @mutex.synchronize do
+      @shutdown_block = block
+      @resource.broadcast
+
+      @que.size.times do
+        conn = @que.pop
+        block.call(conn)
+      end
+    end
+  end
+
   def empty?
     @que.empty?
   end

data/lib/connection_pool/version.rb

@@ -1,3 +1,3 @@
 class ConnectionPool
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/helper.rb

@@ -2,9 +2,9 @@ require 'rubygems'
 require 'minitest/pride'
 require 'minitest/autorun'
 
-puts RUBY_DESCRIPTION
+require 'connection_pool'
 
-class MiniTest::Unit::TestCase
+class Minitest::Unit::TestCase
 
   def async_test(time=0.5)
     q = TimedQueue.new
@@ -13,7 +13,3 @@ class MiniTest::Unit::TestCase
   end
 
 end
-
-$VERBOSE = 1
-
-require_relative '../lib/connection_pool'

data/test/test_connection_pool.rb

@@ -1,7 +1,7 @@
 Thread.abort_on_exception = true
 require 'helper'
 
-class TestConnectionPool < MiniTest::Unit::TestCase
+class TestConnectionPool < Minitest::Test
 
   class NetworkConnection
     def initialize
@@ -29,6 +29,18 @@ class TestConnectionPool < MiniTest::Unit::TestCase
     end
   end
 
+  class Recorder
+    def initialize
+      @calls = []
+    end
+
+    attr_reader :calls
+
+    def do_work(label)
+      @calls << label
+    end
+  end
+
   def test_basic_multithreaded_usage
     pool = ConnectionPool.new(:size => 5) { NetworkConnection.new }
     threads = []
@@ -112,18 +124,6 @@ class TestConnectionPool < MiniTest::Unit::TestCase
     assert_equal 1, ids.uniq.size
   end
 
-  class Recorder
-    def initialize
-      @calls = []
-    end
-
-    attr_reader :calls
-
-    def do_work(label)
-      @calls << label
-    end
-  end
-
   def test_nested_checkout
     recorder = Recorder.new
     pool = ConnectionPool.new(:size => 1) { recorder }
@@ -147,4 +147,56 @@ class TestConnectionPool < MiniTest::Unit::TestCase
 
     assert_equal ['inner', 'outer', 'other'], recorder.calls
   end
+
+  def test_shutdown_is_executed_for_all_connections
+    recorders = []
+
+    pool = ConnectionPool.new(:size => 3) do
+      Recorder.new.tap { |r| recorders << r }
+    end
+
+    pool.shutdown do |recorder|
+      recorder.do_work("shutdown")
+    end
+
+    assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
+  end
+
+  def test_raises_error_after_shutting_down
+    pool = ConnectionPool.new(:size => 1) { true }
+
+    pool.shutdown { }
+
+    assert_raises ConnectionPool::PoolShuttingDownError do
+      pool.checkout
+    end
+  end
+
+  def test_runs_shutdown_block_asynchronously_if_connection_was_in_use
+    recorders = []
+
+    pool = ConnectionPool.new(:size => 3) do
+      Recorder.new.tap { |r| recorders << r }
+    end
+
+    pool.checkout
+
+    pool.shutdown do |recorder|
+      recorder.do_work("shutdown")
+    end
+
+    assert_equal [["shutdown"], ["shutdown"], []], recorders.map { |r| r.calls }
+
+    pool.checkin
+
+    assert_equal [["shutdown"], ["shutdown"], ["shutdown"]], recorders.map { |r| r.calls }
+  end
+
+  def test_raises_an_error_if_shutdown_is_called_without_a_block
+    pool = ConnectionPool.new(:size => 1) { }
+
+    assert_raises ArgumentError do
+      pool.shutdown
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: connection_pool
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
-dependencies: []
+date: 2013-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 description: Generic connection pool for Ruby
 email:
 - mperham@gmail.com
@@ -31,7 +47,8 @@ files:
 - test/helper.rb
 - test/test_connection_pool.rb
 homepage: https://github.com/mperham/connection_pool
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -50,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Generic connection pool for Ruby