connection_pool 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eead858733d8dbd69d9ce236f18977ea847b3a83
+  data.tar.gz: a686e2981051d33b6b170d2f7aac5709a78bb0cc
+SHA512:
+  metadata.gz: 268fe355fb087c14e1820ae8e3f5d903ddf6d2bc9b762091df9e14daa4a20ebf162766f54185c03857ca752f6f15e31a60b4e18c434798950c563a9b17865a73
+  data.tar.gz: 9cc05e0c0b554dd131add7a31b328a85d768141be6e250d34472dc8db7bdd1a46f7fca30cf71fc5edb4b33d1d24403a98bc71a3696dec896918f8af05d8e0653

data/Changes.md

@@ -1,3 +1,13 @@
+1.2.0
+-----
+
+- Add `with(options)` and `checkout(options)`. [mattcamuto]
+  Allows the caller to override the pool timeout.
+```ruby
+@pool.with(:timeout => 2) do |conn|
+end
+```
+
 1.1.0
 -----
 

data/Gemfile

@@ -1,7 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in connection_pool.gemspec
-gemspec
-
-gem 'rake'
-gem 'minitest'
+gemspec(development_group: :runtime)

data/README.md

@@ -42,6 +42,19 @@ 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`.
 
+Optionally, you can specify a timeout override using the with-block semantics:
+
+``` ruby
+@memcached.with(:timeout => 2.0) do |dalli|
+  dalli.get('some-count')
+end
+```
+
+This will only modify the resource-get timeout for this particular invocation. This
+is useful if you want to fail-fast on certain non critical 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.
+
 You can use `ConnectionPool::Wrapper` to wrap a single global connection, making
 it easier to port your connection code over time:
 

data/connection_pool.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.name        = "connection_pool"
   s.version     = ConnectionPool::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Mike Perham"]
-  s.email       = ["mperham@gmail.com"]
+  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}
 
@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.license = "MIT"
   s.add_development_dependency 'minitest', '>= 5.0.0'
+  s.add_development_dependency 'rake'
 end

data/lib/connection_pool.rb

@@ -12,6 +12,12 @@ require 'connection_pool/timed_stack'
 #      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|
+#      redis.lpop('my-list') if redis.llen('my-list') > 0
+#    end
+#
 # Example usage replacing an existing connection (slower):
 #
 #    $redis = ConnectionPool.wrap { Redis.new }
@@ -43,8 +49,8 @@ class ConnectionPool
     @key = :"current-#{@available.object_id}"
   end
 
-  def with
-    conn = checkout
+  def with(options = {})
+    conn = checkout(options)
     begin
       yield conn
     ensure
@@ -52,11 +58,12 @@ class ConnectionPool
     end
   end
 
-  def checkout
+  def checkout(options = {})
     stack = ::Thread.current[@key] ||= []
 
     if stack.empty?
-      conn = @available.pop(@timeout)
+      timeout = options[:timeout] || @timeout
+      conn = @available.pop(timeout)
     else
       conn = stack.last
     end
@@ -79,7 +86,7 @@ class ConnectionPool
   end
 
   class Wrapper < ::BasicObject
-    METHODS = [:with]
+    METHODS = [:with, :pool_shutdown]
 
     def initialize(options = {}, &block)
       @pool = ::ConnectionPool.new(options, &block)
@@ -91,6 +98,10 @@ class ConnectionPool
       @pool.checkin
     end
 
+    def pool_shutdown(&block)
+      @pool.shutdown(&block)
+    end
+
     def respond_to?(id, *args)
       METHODS.include?(id) || @pool.with { |c| c.respond_to?(id, *args) }
     end
@@ -102,5 +113,3 @@ class ConnectionPool
     end
   end
 end
-
-require_relative 'connection_pool/timed_stack'

data/lib/connection_pool/timed_stack.rb

@@ -4,6 +4,7 @@ require 'timeout'
 class ConnectionPool::PoolShuttingDownError < RuntimeError; end
 
 class ConnectionPool::TimedStack
+
   def initialize(size = 0)
     @que = Array.new(size) { yield }
     @mutex = Mutex.new
@@ -55,10 +56,6 @@ class ConnectionPool::TimedStack
     @que.empty?
   end
 
-  def clear
-    @que.clear
-  end
-
   def length
     @que.length
   end

data/lib/connection_pool/version.rb

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

data/test/helper.rb

@@ -1,15 +1,6 @@
-require 'rubygems'
 require 'minitest/pride'
 require 'minitest/autorun'
 
-require 'connection_pool'
+$VERBOSE = 1
 
-class Minitest::Unit::TestCase
-
-  def async_test(time=0.5)
-    q = TimedQueue.new
-    yield Proc.new { q << nil }
-    q.timed_pop(time)
-  end
-
-end
+require_relative '../lib/connection_pool'

data/test/test_connection_pool.rb

@@ -77,7 +77,39 @@ class TestConnectionPool < Minitest::Test
       refute_nil conn
     end
   end
+  
+  def test_with_timeout_override 
+    pool = ConnectionPool.new(:timeout => 0.05, :size => 1) { NetworkConnection.new }
+    Thread.new do
+      pool.with do |net|
+        net.do_something
+        sleep 0.3
+      end
+    end
+    sleep 0.05
+    assert_raises Timeout::Error do
+      pool.with { |net| net.do_something }
+    end    
+    pool.with(:timeout => 0.4) do |conn|
+      refute_nil conn
+    end     
+  end
 
+  def test_checkout_timeout_override
+    pool = ConnectionPool.new(:timeout => 0.05, :size => 1) { NetworkConnection.new }
+    Thread.new do
+      pool.with do |net|
+        net.do_something
+        sleep 0.2
+      end
+    end 
+    sleep 0.05
+    assert_raises Timeout::Error do
+      pool.checkout 
+    end
+    assert pool.checkout :timeout => 0.3    
+  end
+  
   def test_passthru
     pool = ConnectionPool.wrap(:timeout => 0.1, :size => 1) { NetworkConnection.new }
     assert_equal 1, pool.do_something
@@ -199,4 +231,18 @@ class TestConnectionPool < Minitest::Test
       pool.shutdown
     end
   end
+
+  def test_shutdown_is_executed_for_all_connections_in_wrapped_pool
+    recorders = []
+
+    wrapper = ConnectionPool::Wrapper.new(:size => 3) do
+      Recorder.new.tap { |r| recorders << r }
+    end
+
+    wrapper.pool_shutdown do |recorder|
+      recorder.do_work("shutdown")
+    end
+
+    assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
+  end
 end

metadata

@@ -1,35 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: connection_pool
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Perham
+- Damian Janowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-11-26 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
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generic connection pool for Ruby
 email:
 - mperham@gmail.com
+- damian@educabilia.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -49,27 +62,26 @@ files:
 homepage: https://github.com/mperham/connection_pool
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generic connection pool for Ruby
 test_files:
 - test/helper.rb