gene_pool 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f8bc24d422c5746e94dc1e295908b58da9220f
-  data.tar.gz: 9784d1f48c019d0e713b220150354973bf80b11c
+  metadata.gz: ed271080c3002e5df818bb015aa625dde4241778
+  data.tar.gz: 4a48d03387d5f76edb87eec64acb1b7d5dbe9d63
 SHA512:
-  metadata.gz: 94e48da354cfadc86e17640d18a926525f748659d9e5ed2b1571ad0be4a2f1be552901aa6d4d585c2c7f211687f784b54fa3b8299788820577985a150e4c1d46
-  data.tar.gz: 767e6165d9704693e62d4b70ae0f8aa8765fd1163f726e6cdede4f3a22afcb8030600a7c0097afc5122b37fb6397f9679d9f5eb8291029aaf54babf64c79a27b
+  metadata.gz: 37d9bc6cf14105a9cecf3f82bcdb44debaba13009edde4258a486fc2336284e9443a07bec236266b6fe5e96f4d20bdd3b8c1209593e0cc73cacdf142fb4d3321
+  data.tar.gz: e2517b7333784fbaf97279a908fbc9b3b755b71a08e12474c8e499113391fade9608a1156d706d26ae9d643012fe2b07dc44c23deff10acf22bb92b655d514d2

data/{History.md → CHANGELOG.md}

@@ -1,6 +1,11 @@
 GenePool Changelog
 =====================
 
+1.5.0 / 2019-02-11
+  - Replace deprecated `thread_safe` gem with `concurrent-ruby`.
+  - Update tests with latest mini-test spec.
+  - Update Readme.
+
 1.4.1 / 2014-04-29
   - Close connection outside of the mutex.
   - When iterating over the connections, don't include connections still in the process of being created (set to the reserved_placeholder).

data/Gemfile

@@ -1,18 +1,7 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubysl-test-unit'
-end
-
-group :development do
-  gem 'rake'
-  gem 'rdoc'
-end
-
-group :test do
-  gem 'minitest', "~> 4.0"
-  gem 'shoulda'
-end
+gem 'rake'
+gem 'awesome_print'
+gem 'minitest'

data/README.md

@@ -2,61 +2,65 @@
 
 * http://github.com/bpardee/gene_pool
 
-## DESCRIPTION:
+## Description:
 
-Generic pooling library for connection pools.
+Highly performant Ruby connection pooling library.
 
-## FEATURES/PROBLEMS:
+## Features:
 
 * Thread-safe
 * Pure ruby
 
-## INSTALL:
+## Installation:
 
   gem install gene_pool
 
-## EXAMPLE USAGE:
-
-      class MyClient
-        # Print a logger warning if it requires more than 0.25 seconds to acquire a connection.
-        # Close and reopen the connection if it hasn't been used for 10 seconds.
-        # Raise Timeout::Error if waiting for a connection more than 3 seconds.
-        @@gene_pool = GenePool.new(:name         => 'MyClient',
-                                   :pool_size    => 10,
-                                   :timeout      => 3,
-                                   :warn_timeout => 0.25,
-                                   :idle_timeout => 10,
-                                   :logger       => Rails.logger,
-                                   :close_proc   => :close) do
-          TCPSocket.new('myserver', 4321)
-        end
-
-        def send_message
-          @@gene_pool.with_connection do |socket|
-            begin
-              # use socket here
-            rescue Exception => e
-              # If the socket gets closed, remove it from the pool
-              @@gene_pool.remove(socket)
-            end
-          end
-        end
-
-        # Equivalent to send_message above
-        def send_message_auto_remove
-          # On exception, close and reopen socket and perform retry
-          @@gene_pool.with_connection_auto_remove do |socket|
-            # use socket here,
-          end
-        end
-
-        def send_message_auto_retry
-          # On exception, close and reopen socket and perform retry
-          @@gene_pool.with_connection_auto_retry do |socket|
-            # use socket here,
-          end
-        end
+## Example Usage:
+
+~~~ruby
+class MyClient
+  # Print a logger warning if it requires more than 0.25 seconds to acquire a connection.
+  # Close and reopen the connection if it hasn't been used for 10 seconds.
+  # Raise Timeout::Error if waiting for a connection more than 3 seconds.
+  @gene_pool = GenePool.new(
+    name:         'MyClient',
+    pool_size:    10,
+    timeout:      3,
+    warn_timeout: 0.25,
+    idle_timeout: 10,
+    logger:       Rails.logger,
+    close_proc:   :close) do
+    
+    TCPSocket.new('myserver', 4321)
+  end
+
+  def send_message
+    @gene_pool.with_connection do |socket|
+      begin
+        # use socket here
+      rescue Exception => e
+        # If the socket gets closed, remove it from the pool
+        @gene_pool.remove(socket)
       end
+    end
+  end
+
+  # Equivalent to send_message above
+  def send_message_auto_remove
+    # On exception, close and remeove socket from pool
+    @gene_pool.with_connection_auto_remove do |socket|
+      # use socket here,
+    end
+  end
+
+  def send_message_auto_retry
+    # On exception, close and reopen socket and perform retry
+    @gene_pool.with_connection_auto_retry do |socket|
+      # use socket here,
+    end
+  end
+end
+~~~
 
 ## Copyright
 

data/lib/gene_pool.rb

@@ -1,6 +1,6 @@
 require 'logger'
 require 'thread'
-require 'thread_safe'
+require 'concurrent-ruby'
 require 'monitor'
 
 # Generic connection pool class
@@ -42,7 +42,7 @@ class GenePool
     @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    = ThreadSafe::Hash.new
+    @with_map    = Concurrent::Hash.new
 
     setup_mutex
   end

data/test/gene_pool_test.rb

@@ -1,14 +1,11 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'gene_pool'
+require_relative 'test_helper.rb'
 require 'stringio'
 require 'logger'
 require 'timeout'
 
 # Increase visibility
 class GenePool
-  attr_reader :connections, :checked_out, :with_map
+  attr_reader :checked_out, :with_map
 end
 
 class MyTimeoutError < RuntimeError; end
@@ -51,15 +48,13 @@ class DummyConnection
   end
 end
 
-
-class GenePoolTest < Test::Unit::TestCase
-
-  context 'on default setup' do
-    setup do
+class GenePoolTest < Minitest::Test
+  describe 'on default setup' do
+    before do
       @gene_pool = GenePool.new { Object.new }
     end
 
-    should 'have default options set' do
+    it '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
@@ -67,8 +62,8 @@ class GenePoolTest < Test::Unit::TestCase
     end
   end
 
-  context '' do
-    setup do
+  describe GenePool do
+    before do
       #@stringio = StringIO.new
       #@logger = Logger.new($stdout)
       #@logger = Logger.new(@stringio)
@@ -88,14 +83,14 @@ class GenePoolTest < Test::Unit::TestCase
       end
     end
 
-    should 'have options set' do
+    it '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
+    it 'create 1 connection' do
       (1..3).each do |i|
         @gene_pool.with_connection do |conn|
           assert_equal conn.count, 1
@@ -108,7 +103,7 @@ class GenePoolTest < Test::Unit::TestCase
       end
     end
 
-    should 'create 2 connections' do
+    it 'create 2 connections' do
       conn1 = @gene_pool.checkout
       (1..3).each do |i|
         @gene_pool.with_connection do |conn2|
@@ -127,7 +122,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert_equal 0, @gene_pool.checked_out.size
     end
 
-    should 'be able to reset multiple times' do
+    it 'be able to reset multiple times' do
       @gene_pool.with_connection do |conn1|
         conn2 = @gene_pool.renew(conn1)
         conn3 = @gene_pool.renew(conn2)
@@ -141,7 +136,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert_equal 0, @gene_pool.checked_out.size
     end
 
-    should 'be able to remove connection' do
+    it 'be able to remove connection' do
       @gene_pool.with_connection do |conn|
         @gene_pool.remove(conn)
         assert_equal 0, @gene_pool.connections.size
@@ -151,7 +146,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert_equal 0, @gene_pool.checked_out.size
     end
 
-    should 'be able to remove multiple connections' do
+    it '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|
@@ -172,7 +167,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert_equal 0, @gene_pool.checked_out.size
     end
 
-    should 'handle aborted connection' do
+    it 'handle aborted connection' do
       @gene_pool.with_connection do |conn1|
         @sleep = 2
         assert_raises RuntimeError do
@@ -195,7 +190,7 @@ class GenePoolTest < Test::Unit::TestCase
       end
     end
 
-    should 'not allow more than pool_size connections' do
+    it 'not allow more than pool_size connections' do
       conns = []
       pool_size = @gene_pool.pool_size
       (1..pool_size).each do |i|
@@ -218,7 +213,7 @@ class GenePoolTest < Test::Unit::TestCase
       end
     end
 
-    should 'handle thread contention' do
+    it 'handle thread contention' do
       conns = []
       pool_size = @gene_pool.pool_size
       # Do it with new connections and old connections
@@ -248,7 +243,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert_equal (1..pool_size).to_a, ival_conns
     end
 
-    should 'be able to auto-retry connection' do
+    it 'be able to auto-retry connection' do
       conns = []
       @gene_pool.with_connection_auto_retry do |conn|
         conns << conn
@@ -269,7 +264,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert_equal 0, @gene_pool.checked_out.size
     end
 
-    should 'fail with auto-retry on double failure' do
+    it 'fail with auto-retry on double failure' do
       e = assert_raises Exception do
         @gene_pool.with_connection_auto_retry do |conn|
           conn.fail_on(1,2)
@@ -283,7 +278,7 @@ class GenePoolTest < Test::Unit::TestCase
       end
     end
 
-    should 'not auto-retry on timeout' do
+    it 'not auto-retry on timeout' do
       assert_raises RuntimeError do
         Timeout.timeout(1, RuntimeError) do
           @gene_pool.with_connection_auto_retry do |conn|
@@ -303,7 +298,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert_equal 0, @gene_pool.checked_out.size
     end
 
-    should 'allow cleanup of idle connections' do
+    it 'allow cleanup of idle connections' do
       conn1 = @gene_pool.checkout
       conn2 = @gene_pool.checkout
       @gene_pool.checkin(conn1)
@@ -318,8 +313,8 @@ class GenePoolTest < Test::Unit::TestCase
     end
   end
 
-  context 'idle timeout' do
-    setup do
+  describe 'idle timeout' do
+    before do
       # Override sleep in individual tests
       @sleep = nil
       counter = 0
@@ -335,7 +330,7 @@ class GenePoolTest < Test::Unit::TestCase
       end
     end
 
-    should 'create a new connection if we pass the idle timeout' do
+    it 'create a new connection if we pass the idle timeout' do
       conn1, conn2, conn3 = nil
       @gene_pool.with_connection { |conn| conn1 = conn }
       @gene_pool.with_connection { |conn| conn2 = conn }
@@ -351,8 +346,8 @@ class GenePoolTest < Test::Unit::TestCase
     end
   end
 
-  context 'close_proc' do
-    should 'default to close if not specified' do
+  describe 'close_proc' do
+    it 'default to close if not specified' do
       @gene_pool = GenePool.new do
         DummyConnection.new(0, 0)
       end
@@ -363,7 +358,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert !conn.other_closed?
     end
 
-    should 'allow symbol to execute a different method from close' do
+    it 'allow symbol to execute a different method from close' do
       @gene_pool = GenePool.new(:close_proc => :other_close) do
         DummyConnection.new(0, 0)
       end
@@ -374,7 +369,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert conn.other_closed?
     end
 
-    should 'allow nil so it does not execute a close' do
+    it 'allow nil so it does not execute a close' do
       @gene_pool = GenePool.new(:close_proc => nil) do
         DummyConnection.new(0, 0)
       end
@@ -385,7 +380,7 @@ class GenePoolTest < Test::Unit::TestCase
       assert !conn.other_closed?
     end
 
-    should 'allow proc that gets executed on close' do
+    it 'allow proc that gets executed on close' do
       foo = 1
       close_conn = nil
       my_close = lambda do |conn|
@@ -405,8 +400,8 @@ class GenePoolTest < Test::Unit::TestCase
     end
   end
 
-  context 'timeout' do
-    setup do
+  describe 'timeout' do
+    before do
       @timeout_classes = [nil, MyTimeoutError]
       @gene_pools = @timeout_classes.map do |timeout_class|
         GenePool.new(:name          => 'TestGenePool',
@@ -419,7 +414,7 @@ class GenePoolTest < Test::Unit::TestCase
       end
     end
 
-    should 'timeout when the timeout period has expired' do
+    it 'timeout when the timeout period has expired' do
       @gene_pools.each_with_index do |gene_pool, class_index|
         pool_size = gene_pool.pool_size
         # Do it with new connections and old connections

metadata

@@ -1,65 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: gene_pool
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Brad Pardee
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2019-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thread_safe
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  prerelease: false
+        version: '1.0'
   type: :runtime
-description: Generic pooling library for creating a connection pool
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Threadsafe, performant library for managing pools of resources, such
+  as connections.
 email:
 - bradpardee@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/gene_pool.rb
-- LICENSE.txt
-- Rakefile
+- CHANGELOG.md
 - Gemfile
-- History.md
+- LICENSE.txt
 - README.md
+- Rakefile
+- lib/gene_pool.rb
 - test/gene_pool_test.rb
 homepage: http://github.com/bpardee/gene_pool
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
 specification_version: 4
-summary: Generic pooling library for creating a connection pool
+summary: Highly performant Ruby connection pooling library.
 test_files:
 - test/gene_pool_test.rb