connection_pool 0.0.1 → 0.0.2

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in connection_pool.gemspec
 gemspec
+
+gem 'minitest'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mike Perham
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+connection_pool
+======================
+
+Generic connection pooling for Ruby.
+
+MongoDB has its own connection pool.  ActiveRecord has its own connection pool.  This is a generic connection pool that can be used with anything, e.g. Redis, Dalli and other Ruby network clients.
+
+Install
+------------
+
+    gem install connection_pool
+
+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 }
+
+Then use the pool in your application:
+
+    @memcached.with_connection do |dalli|
+      dalli.get('some-count')
+    end
+
+
+Author
+--------------
+
+Mike Perham, [@mperham](https://twitter.com/mperham), <http://mikeperham.com>

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.warning = true
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/lib/connection_pool.rb

@@ -8,7 +8,7 @@ require 'connection_pool/timed_queue'
 #    @pool = ConnectionPool.new { Redis.new }
 #
 #    @pool.with do |redis|
-#      redis.lpop if redis.llen('my-list') > 0
+#      redis.lpop('my-list') if redis.llen('my-list') > 0
 #    end
 #
 # Example usage replacing a global connection (slower):
@@ -16,7 +16,7 @@ require 'connection_pool/timed_queue'
 #    REDIS = ConnectionPool.new { Redis.new }
 #
 #    def do_work
-#      REDIS.lpop if REDIS.llen('my-list') > 0
+#      REDIS.lpop('my-list') if REDIS.llen('my-list') > 0
 #    end
 #
 # Accepts the following options:
@@ -42,6 +42,7 @@ class ConnectionPool
   ensure
     checkin
   end
+  alias_method :with_connection, :with
 
   def method_missing(name, *args)
     checkout.send(name, *args)
@@ -62,9 +63,10 @@ class ConnectionPool
   def checkin
     conn = Thread.current[:"current-#{self.object_id}"]
     Thread.current[:"current-#{self.object_id}"] = nil
+    return unless conn
     @busy.delete(conn)
     @available << conn
     nil
   end
 
-end
+end

data/lib/connection_pool/timed_queue.rb

@@ -4,7 +4,6 @@ require 'timeout'
 class TimedQueue
   def initialize
     @que = []
-    @waiting = []
     @mutex = Mutex.new
     @resource = ConditionVariable.new
   end
@@ -15,22 +14,15 @@ class TimedQueue
       @resource.signal
     end
   end
-  alias << push
+  alias_method :<<, :push
 
   def timed_pop(timeout=0.5)
-    while true
-      @mutex.synchronize do
-        @waiting.delete(Thread.current)
-        if @que.empty?
-          @waiting.push Thread.current
-          @resource.wait(@mutex, timeout)
-          raise TimeoutError if @que.empty?
-        else
-          retval = @que.shift
-          @resource.signal
-          return retval
-        end
+    @mutex.synchronize do
+      if @que.empty?
+        @resource.wait(@mutex, timeout)
+        raise Timeout::Error if @que.empty?
       end
+      return @que.shift
     end
   end
 

data/lib/connection_pool/version.rb

@@ -1,3 +1,3 @@
 module ConnectionPool
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'minitest/autorun'
+
+require 'connection_pool'
+
+puts RUBY_DESCRIPTION
+
+class MiniTest::Unit::TestCase
+
+  def async_test(time=0.5)
+    q = TimedQueue.new
+    yield Proc.new { q << nil }
+    q.timed_pop(time)
+  end
+
+end

data/test/test_connection_pool.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+class TestConnectionPool < MiniTest::Unit::TestCase
+
+  class NetworkConnection
+    def initialize
+      @x = 0
+    end
+    def do_something
+      @x += 1
+      sleep 0.05
+      @x
+    end
+    def fast
+      @x += 1
+    end
+  end
+
+  def test_basic_multithreaded_usage
+    pool = ConnectionPool.new(:size => 5) { NetworkConnection.new }
+    threads = []
+    15.times do
+      threads << Thread.new do
+        pool.with_connection do |net|
+          net.do_something
+        end
+      end
+    end
+    
+    a = Time.now
+    result = threads.map(&:value)
+    b = Time.now
+    assert_operator((b - a), :>, 0.125)
+    assert_equal(result, [1,2,3].cycle(5).sort)
+  end
+
+  def test_timeout
+    pool = ConnectionPool.new(:timeout => 0.05, :size => 1) { NetworkConnection.new }
+    Thread.new do
+      pool.with do |net|
+        net.do_something
+        sleep 0.1
+      end
+    end
+    sleep 0.05
+    assert_raises Timeout::Error do
+      pool.do_something
+    end
+
+    pool.with do |conn|
+      refute_nil conn
+    end
+  end
+
+  def test_passthru
+    pool = ConnectionPool.new(:timeout => 0.1, :size => 1) { NetworkConnection.new }
+    assert_equal 1, pool.do_something
+    assert_equal 2, pool.do_something
+  end
+
+  def test_return_value
+    pool = ConnectionPool.new(:timeout => 0.1, :size => 1) { NetworkConnection.new }
+    result = pool.with_connection do |net|
+      net.fast
+    end
+    assert_equal 1, result
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: connection_pool
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mike Perham
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-14 00:00:00 -07:00
+date: 2011-09-09 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,11 +26,15 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - connection_pool.gemspec
 - lib/connection_pool.rb
 - lib/connection_pool/timed_queue.rb
 - lib/connection_pool/version.rb
+- test/helper.rb
+- test/test_connection_pool.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -50,18 +49,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
@@ -70,5 +63,6 @@ rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Generic connection pool for Ruby
-test_files: []
-
+test_files: 
+- test/helper.rb
+- test/test_connection_pool.rb