gene_pool 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+doc
+pkg

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2010-09-05
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brad Pardee
+
+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.rdoc

@@ -0,0 +1,37 @@
+= gene_pool
+
+* http://github.com/bpardee/gene_pool
+
+== DESCRIPTION:
+
+Generic pooling library for connection pools.
+
+== FEATURES/PROBLEMS:
+
+* Thread-safe
+* Pure ruby
+
+== INSTALL:
+
+  gem install gene_pool
+
+== EXAMPLE USAGE:
+
+  class MyClient
+    @@gene_pool = GenePool.new(:name         => 'MyClient',
+                               :pool_size    => 10,
+                               :warn_timeout => 0.25,
+                               :logger       => Rails.logger) do
+      TCPSocket.new('myserver', 4321)
+    end
+
+    def send_message
+      @@gene_pool.with_connection do |socket|
+        # use socket here
+      end
+    end
+  end
+
+== Copyright
+
+Copyright (c) 2010 Brad Pardee. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "gene_pool"
+    gemspec.summary = "Generic pooling library for creating a connection pool"
+    gemspec.description = "Generic pooling library for creating a connection pool"
+    gemspec.email = "bradpardee@gmail.com"
+    gemspec.homepage = "http://github.com/bpardee/gene_pool"
+    gemspec.authors = ["Brad Pardee"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/gene_pool.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gene_pool}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad Pardee"]
+  s.date = %q{2010-09-08}
+  s.description = %q{Generic pooling library for creating a connection pool}
+  s.email = %q{bradpardee@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "gene_pool.gemspec",
+     "lib/gene_pool.rb",
+     "test/gene_pool_test.rb"
+  ]
+  s.homepage = %q{http://github.com/bpardee/gene_pool}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Generic pooling library for creating a connection pool}
+  s.test_files = [
+    "test/gene_pool_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/gene_pool.rb

@@ -0,0 +1,134 @@
+# Generic connection pool class
+class GenePool
+
+  attr_reader :name, :pool_size, :warn_timeout, :logger
+
+  def initialize(options={}, &connect_block)
+    @connect_block = connect_block
+
+    @name         = options[:name]         || 'GenePool'
+    @pool_size    = options[:pool_size]    || 1
+    @warn_timeout = options[:warn_timeout] || 5.0
+    @logger       = options[:logger]
+
+    # Mutex for synchronizing pool access
+    @mutex = Mutex.new
+
+    # Condition variable for waiting for an available connection
+    @queue = ConditionVariable.new
+
+    @connections = []
+    @checked_out = []
+    # Map the original connections object_id within the with_connection method to the final connection.
+    # This could change if the connection is renew'ed.
+    @with_map    = {}
+  end
+
+  # Check out a connection from the pool, creating it if necessary.
+  def checkout
+    start_time = Time.now
+    connection = nil
+    reserved_connection_placeholder = Thread.current
+    begin
+      @mutex.synchronize do
+        until connection do
+          if @checked_out.size < @connections.size
+            connection = (@connections - @checked_out).first
+            @checked_out << connection
+          elsif @connections.size < @pool_size
+            # Perform the actual connection outside the mutex
+            connection = reserved_connection_placeholder
+            @connections << connection
+            @checked_out << connection
+            @logger.debug "#{@name}: Created connection ##{@connections.size} #{connection}:#{connection.object_id} for #{name}" if @logger && @logger.debug?
+          else
+            @logger.info "#{@name}: Waiting for an available connection, all #{@pool_size} connections are checked out." if @logger
+            @queue.wait(@mutex)
+          end
+        end
+      end
+    ensure
+      delta = Time.now - start_time
+      if @logger && delta > @warn_timeout
+        @logger.warn "#{@name}: It took #{delta} seconds to obtain a connection.  Consider raising the pool size which is " +
+          "currently set to #{@pool_size}."
+      end
+    end
+    if connection == reserved_connection_placeholder
+      connection = renew(reserved_connection_placeholder)
+    end
+    
+    @logger.debug "#{@name}: Checkout connection #{connection.object_id} self=#{self}" if @logger && @logger.debug?
+    return connection
+  end
+
+  # Return a connection to the pool.
+  def checkin(connection)
+    @mutex.synchronize do
+      @checked_out.delete(connection)
+      @queue.signal
+    end
+    @logger.debug "#{@name}: Checkin connection #{connection.object_id} self=#{self}" if @logger && @logger.debug?
+  end
+  
+  # Create a scope for checking out a connection
+  def with_connection
+    connection = checkout
+    @mutex.synchronize do
+      @with_map[connection.object_id] = connection
+    end
+    begin
+      yield connection
+    ensure
+      @mutex.synchronize do
+        # Update connection for any renew's that have occurred
+        connection = @with_map.delete(connection.object_id)
+      end
+      checkin(connection)
+    end
+  end
+  
+  # Remove an existing connection from the pool
+  def remove(connection)
+    @mutex.synchronize do
+      @connections.delete(connection)
+      @checked_out.delete(connection)
+      @queue.signal
+    end
+    @logger.debug "#{@name}: Removed connection #{connection.object_id} self=#{self}" if @logger && @logger.debug?
+  end
+
+  # If a connection needs to be renewed for some reason, reassign it here
+  def renew(old_connection)
+    new_connection =
+      begin
+        @connect_block.call
+      rescue Exception
+        remove old_connection
+        raise
+      end
+    @mutex.synchronize do
+      index = @checked_out.index(old_connection)
+      raise Error.new("Can't reassign non-checked out connection for #{@name}") unless index
+      @checked_out[index] = new_connection
+      @connections[@connections.index(old_connection)] = new_connection
+      # If this is part of a with_connection block, then track our new connection
+      with_key = @with_map.index(old_connection)
+      @with_map[with_key] = new_connection if with_key
+    end
+    @logger.debug "#{@name}: Renewed connection old=#{old_connection.object_id} new=#{new_connection}:#{new_connection.object_id}" if @logger && @logger.debug?
+    return new_connection
+  end
+  
+  # Perform the given block for each connection, i.e., closing each connection.
+  def each
+    @connections.each { |connection| yield connection }
+  end
+  
+  def to_s
+    conn = @connections.map{|c| c.object_id}.join(',')
+    chk  = @checked_out.map{|c| c.object_id}.join(',')
+    with = @with_map.keys.map{|k| "#{k}=#{@with_map[k].object_id}"}.join(',')
+    "connections=#{conn} checked_out=#{chk} with_map=#{with}"
+  end
+end

data/test/gene_pool_test.rb

@@ -0,0 +1,232 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'gene_pool'
+require 'stringio'
+require 'logger'
+require 'timeout'
+
+# Increase visibility
+class GenePool
+  attr_reader :connections, :checked_out, :with_map
+end
+
+class DummyConnection
+  def initialize(count, sleep_time=nil)
+    sleep sleep_time if sleep_time
+    @count = count
+  end
+  
+  def to_i
+    @count
+  end
+  
+  def to_s
+    @count.to_s
+  end
+end
+    
+
+class GenePoolTest < Test::Unit::TestCase
+
+  context 'on default setup' do
+    setup do
+      @gene_pool = GenePool.new { Object.new }
+    end
+
+    should 'have default options set' do
+      assert_equal 'GenePool', @gene_pool.name
+      assert_equal 1,          @gene_pool.pool_size
+      assert_equal 5.0,        @gene_pool.warn_timeout
+      assert_nil               @gene_pool.logger
+    end
+  end
+  
+  context '' do
+    setup do
+      #@stringio = StringIO.new
+      #@logger = Logger.new($stdout)
+      #@logger = Logger.new(@stringio)
+      @logger = nil
+      # Override sleep in individual tests
+      @sleep = nil
+      @timeout = 5
+      counter = 0
+      mutex = Mutex.new
+      @gene_pool = GenePool.new(:name         => 'TestGenePool',
+                                :pool_size    => 10,
+                                :warn_timeout => 2.0,
+                                :logger       => @logger) do
+        count = nil
+        mutex.synchronize do
+          count = counter += 1
+        end
+        Timeout.timeout(@timeout) do
+          DummyConnection.new(count, @sleep)
+        end
+      end
+    end
+
+    should 'have options set' do
+      assert_equal 'TestGenePool', @gene_pool.name
+      assert_equal 10,            @gene_pool.pool_size
+      assert_equal 2.0,            @gene_pool.warn_timeout
+      assert_same  @logger,        @gene_pool.logger
+    end
+
+    should 'create 1 connection' do
+      (1..3).each do |i|
+        @gene_pool.with_connection do |conn|
+          assert_equal conn.to_i, 1
+          assert_equal 1,         @gene_pool.connections.size
+          assert_equal 1,         @gene_pool.checked_out.size
+          assert_same  conn,      @gene_pool.connections[0]
+          assert_same  conn,      @gene_pool.checked_out[0]
+        end
+        assert_equal 0, @gene_pool.checked_out.size
+      end
+    end
+  
+    should 'create 2 connections' do
+      conn1 = @gene_pool.checkout
+      (1..3).each do |i|
+        @gene_pool.with_connection do |conn2|
+          assert_equal 1, conn1.to_i
+          assert_equal 2, conn2.to_i
+          assert_equal 2, @gene_pool.connections.size
+          assert_equal 2, @gene_pool.checked_out.size
+          assert_same  conn1, @gene_pool.connections[0]
+          assert_same  conn1, @gene_pool.checked_out[0]
+          assert_same  conn2, @gene_pool.connections[1]
+          assert_same  conn2, @gene_pool.checked_out[1]
+        end
+        assert_equal 1, @gene_pool.checked_out.size
+      end
+      @gene_pool.checkin(conn1)
+      assert_equal 0, @gene_pool.checked_out.size
+    end
+  
+    should 'be able to reset multiple times' do
+      @gene_pool.with_connection do |conn1|
+        conn2 = @gene_pool.renew(conn1)
+        conn3 = @gene_pool.renew(conn2)
+        assert_equal 1, conn1.to_i
+        assert_equal 2, conn2.to_i
+        assert_equal 3, conn3.to_i
+        assert_equal 1, @gene_pool.connections.size
+        assert_equal 1, @gene_pool.checked_out.size
+      end
+      assert_equal 1, @gene_pool.connections.size
+      assert_equal 0, @gene_pool.checked_out.size
+    end
+  
+    should 'be able to remove connection' do
+      @gene_pool.with_connection do |conn|
+        @gene_pool.remove(conn)
+        assert_equal 0, @gene_pool.connections.size
+        assert_equal 0, @gene_pool.checked_out.size
+      end
+      assert_equal 0, @gene_pool.connections.size
+      assert_equal 0, @gene_pool.checked_out.size
+    end
+  
+    should 'be able to remove multiple connections' do
+      @gene_pool.with_connection do |conn1|
+        @gene_pool.with_connection do |conn2|
+          @gene_pool.with_connection do |conn3|
+            @gene_pool.remove(conn1)
+            @gene_pool.remove(conn3)
+            assert_equal 1, @gene_pool.connections.size
+            assert_equal 1, @gene_pool.checked_out.size
+            assert_same  conn2, @gene_pool.checked_out[0]
+            assert_same  conn2, @gene_pool.connections[0]
+          end
+          assert_equal 1, @gene_pool.connections.size
+          assert_equal 1, @gene_pool.checked_out.size
+        end
+        assert_equal 1, @gene_pool.connections.size
+        assert_equal 0, @gene_pool.checked_out.size
+      end
+      assert_equal 1, @gene_pool.connections.size
+      assert_equal 0, @gene_pool.checked_out.size
+    end
+  
+    should 'handle aborted connection' do
+      @gene_pool.with_connection do |conn1|
+        @sleep = 2
+        @timeout = 1
+        begin
+          @gene_pool.with_connection { |conn2| }
+          flunk "connection should have timed out"
+        rescue  Timeout::Error => e
+          #pass
+        end
+        assert_equal 1, @gene_pool.connections.size
+        assert_equal 1, @gene_pool.checked_out.size
+      end
+      assert_equal 1, @gene_pool.connections.size
+      assert_equal 0, @gene_pool.checked_out.size
+      # Do another test just to be sure nothings hosed
+      @sleep = nil
+      @gene_pool.with_connection do |conn1|
+        assert 1, conn1.to_i
+      end
+    end
+  
+    should 'not allow more than pool_size connections' do
+      conns = []
+      pool_size = @gene_pool.pool_size
+      (1..pool_size).each do |i|
+        c = @gene_pool.checkout
+        conns << c
+        assert_equal i, c.to_i
+        assert_equal i, @gene_pool.connections.size
+        assert_equal i, @gene_pool.checked_out.size
+        assert_equal conns, @gene_pool.connections
+      end
+      begin
+        Timeout.timeout(1) do
+          @gene_pool.checkout
+        end
+        flunk "connection should have timed out"
+      rescue  Timeout::Error => e
+        #pass "successfully timed out connection"
+      end
+      (1..pool_size).each do |i|
+        @gene_pool.checkin(conns[i-1])
+        assert_equal pool_size,   @gene_pool.connections.size
+        assert_equal pool_size-i, @gene_pool.checked_out.size
+      end
+    end
+
+    should 'handle thread contention' do
+      conns = []
+      pool_size = @gene_pool.pool_size
+      # Do it with new connections and old connections
+      (1..2).each do |n|
+        (1..pool_size).each do |i|
+          Thread.new do
+            c = @gene_pool.checkout
+            conns[i-1] = c
+          end
+        end
+        # Let the threads complete
+        sleep 1
+        assert_equal pool_size,   @gene_pool.connections.size
+        assert_equal pool_size,   @gene_pool.checked_out.size
+        (1..pool_size).each do |i|
+          Thread.new do
+            @gene_pool.checkin(conns[i-1])
+          end
+        end
+        sleep 1
+        assert_equal pool_size, @gene_pool.connections.size
+        assert_equal 0,         @gene_pool.checked_out.size
+      end
+      ival_conns = []
+      @gene_pool.each { |conn| ival_conns << conn.to_i }
+      ival_conns.sort!
+      assert_equal (1..pool_size).to_a, ival_conns
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: gene_pool
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 1
+    - 0
+    - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+  - Brad Pardee
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-08 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Generic pooling library for creating a connection pool
+email: bradpardee@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - LICENSE
+  - README.rdoc
+files: 
+  - .gitignore
+  - History.txt
+  - LICENSE
+  - README.rdoc
+  - Rakefile
+  - VERSION
+  - gene_pool.gemspec
+  - lib/gene_pool.rb
+  - test/gene_pool_test.rb
+has_rdoc: true
+homepage: http://github.com/bpardee/gene_pool
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --charset=UTF-8
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Generic pooling library for creating a connection pool
+test_files: 
+  - test/gene_pool_test.rb