resource_pool 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Aaron Qian
+
+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,60 @@
+= resource_pool
+
+This is a generic connection pool / resource pool implementation. The initial code is largely taken from `ThreadedConnectionPool` class from `Sequel` gem and adapted for more general use.
+
+== Install
+
+  gem install resource_pool
+
+== Usage
+
+  require 'resource_pool'
+
+  memcache_pool = ResourcePool.new({
+      :max_size => 10,                  # Max amount of resource allowed to create. Default is 4
+      :pool_timeout => 4,               # Seconds to wait when aquiring a free resource. Default is 2
+      :pool_sleep_time => 0.1,          # Seconds to wait for retry aquiring resource. Default is 0.001
+      :delete_proc => lambda{ |res| }   # a proc used to close / delete the resource. Optional
+  }) do
+    # create your resource here.
+    # A resource can be anything such as TCP, persistent HTTP, database, nosql
+    # Note: must return the instantiated resource
+    Memcache.new MemCache.new 'host:11211'
+  end
+
+  # using defaults for redis pool
+  redis_pool = ResourcePool.new do
+    Redis.new(:host => "10.0.1.1", :port => 6380)
+  end
+
+  # Use the resource:
+  threads = []
+  50.times do
+    threads <<Thread.new do
+      # there are 4 redis connections
+      # can now be shared safely with 50 threads
+      redis_pool.hold do |redis|
+        redis.set "foo", "bar"
+        redis.get "foo"
+      end
+    end
+  end
+
+  threads.each(&:join)
+
+
+== Contributing to resource_pool
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Aaron Qian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "resource_pool"
+  gem.homepage = "http://github.com/aq1018/resource_pool"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem for generic connection pooling / resource pooling. }
+  gem.description = %Q{A gem for generic connection pooling / resource pooling. The code is mostly taken from Sequel gem's ThreadedConnectionPool class, and adapted for more general use.}
+  gem.email = "aq1018@gmail.com"
+  gem.authors = ["Aaron Qian"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = "--exclude ~\/.rvm,spec"
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resource_pool #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/resource_pool.rb

@@ -0,0 +1,100 @@
+class ResourcePool
+  class ResourcePoolError < RuntimeError; end
+  class PoolTimeout < ResourcePoolError; end
+  class BadResource < ResourcePoolError; end
+  class InvalidCreateProc < ResourcePoolError; end
+
+  attr_reader :max_size, :pool, :allocated
+
+  def initialize(opts={}, &block)
+    @max_size = opts[:max_size] || 4
+    @create_proc = block
+    @pool = []
+    @allocated = {}
+    @mutex = Mutex.new
+    @timeout = opts[:pool_timeout] || 2
+    @sleep_time = opts[:pool_sleep_time] || 0.001
+    @delete_proc = opts[:delete_proc]
+  end
+
+  def size
+    @allocated.length + @pool.length
+  end
+
+  def release_all(&block)
+    block ||= @delete_proc
+    sync do
+      @pool.each{|res| block.call(res)} if block
+      @pool.clear
+    end
+  end
+
+  def hold
+    t = Thread.current
+    if res = owned_resource(t)
+      return yield(res)
+
+    end
+    begin
+      unless res = acquire(t)
+        time = Time.now
+        timeout = time + @timeout
+        sleep_time = @sleep_time
+        sleep sleep_time
+        until res = acquire(t)
+          raise PoolTimeout if Time.now > timeout
+          sleep sleep_time
+        end
+      end
+      yield res
+    rescue BadResource
+      old_res = res
+      res = nil
+      @delete_proc.call(res) if @delete_proc && old_res
+      @allocated.delete(t)
+      raise
+    ensure
+      sync{release(t)} if res
+    end
+  end
+
+  private
+
+  def owned_resource(thread)
+    sync{ @allocated[thread] }
+  end
+
+  def acquire(thread)
+    sync do
+      res = available
+      @allocated[thread] = res if res
+    end
+  end
+
+  def release(thread)
+    @pool << @allocated.delete(thread)
+  end
+
+  def available
+    @pool.pop || make_new
+  end
+
+  def make_new
+    salvage if size >= @max_size
+    size < @max_size ? create_resource : nil
+  end
+
+  def salvage
+    @allocated.keys.each{ |t| release(t) unless t.alive? }
+  end
+
+  def create_resource
+    resource = @create_proc.call
+    raise InvalidCreateProc, "create_proc returned nil" unless resource
+    resource
+  end
+
+  def sync
+    @mutex.synchronize{yield}
+  end
+end

data/spec/resource_pool_spec.rb

@@ -0,0 +1,319 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ResourcePool" do
+
+  describe "Integration" do
+    it "should work in small multithreaded environment" do
+      pool = ResourcePool.new{ Hash.new }
+      threads = []
+      100.times do
+        threads << Thread.new do
+          pool.hold do |res|
+            Thread.pass
+            res.class.should == Hash
+          end
+        end
+      end
+
+      threads.each(&:join)
+      pool.pool.size.should be_between(1, 4)
+      pool.allocated.size.should == 0
+    end
+
+    it "should work in large multithreaded environment" do
+      pool = ResourcePool.new(:max_size => 100){ Hash.new }
+      threads = []
+      1000.times do
+        threads << Thread.new do
+          pool.hold do |res|
+            Thread.pass
+            res.class.should == Hash
+          end
+        end
+      end
+
+      threads.each(&:join)
+      pool.pool.size.should be_between(1, 1000)
+      pool.allocated.size.should == 0
+    end
+  end
+
+  describe "#size" do
+    it "should return the size of pool plus allocated" do
+      pool = ResourcePool.new{ Hash.new }
+      pool.allocated.should_receive(:length).and_return(1)
+      pool.pool.should_receive(:length).and_return(1)
+      pool.size.should == 2
+    end
+  end
+
+  describe "#create_resource" do
+    it "should create new resource" do
+      pool = ResourcePool.new{ Hash.new }
+      res = pool.send :create_resource
+      res.class.should == Hash
+    end
+
+    it "should raise error if create_proc returns nil" do
+      pool = ResourcePool.new{ nil }
+      lambda {
+        pool.send :create_resource
+      }.should raise_error(ResourcePool::InvalidCreateProc)
+    end
+  end
+
+  describe "#salvage" do
+    it "should salvage resources from dead thread" do
+      pool = ResourcePool.new{ Hash.new }
+      # create a dead thread
+      thread = Thread.new{ nil }
+      thread.join
+      pool.allocated[thread] = Hash.new
+      pool.send :salvage
+
+      pool.allocated[thread].should be_nil
+      pool.pool.length.should == 1
+    end
+  end
+
+  describe "#make_new" do
+    it "should invoke salvage if reach max size" do
+      pool = ResourcePool.new{ Hash.new }
+      pool.should_receive(:size).twice.and_return(4, 3)
+      pool.should_receive(:salvage)
+      pool.should_receive(:create_resource).and_return(Hash.new)
+
+      pool.send(:make_new).class.should == Hash
+    end
+
+    it "should not invoke salvage if max size is not reached" do
+      pool = ResourcePool.new{ Hash.new }
+      pool.should_receive(:size).twice.and_return(3, 3)
+      pool.should_not_receive(:salvage)
+      pool.should_receive(:create_resource).and_return(Hash.new)
+
+      pool.send(:make_new).class.should == Hash
+    end
+
+    it "should not invoke create_resouce if max size is reached" do
+      pool = ResourcePool.new{ Hash.new }
+      pool.should_receive(:size).twice.and_return(4, 4)
+      pool.should_receive(:salvage)
+      pool.should_not_receive(:create_resource)
+
+      pool.send(:make_new).should == nil
+    end
+  end
+
+  describe "#availabe" do
+    it "should pop from pool" do
+      pool = ResourcePool.new{ Hash.new }
+      pool.pool.should_receive(:pop)
+      pool.send(:available)
+    end
+
+    it "should use resource from pool if available" do
+      res = {}
+      pool = ResourcePool.new{ Hash.new }
+      pool.pool.should_receive(:pop).and_return(res)
+      pool.should_not_receive(:make_new)
+      pool.send(:available).should == res
+    end
+
+    it "should invoke #make_new if pool is empty" do
+      res = {}
+      pool = ResourcePool.new{ Hash.new }
+      pool.pool.should_receive(:pop).and_return(nil)
+      pool.should_receive(:make_new).and_return(res)
+      pool.send(:available).should == res
+    end
+  end
+
+  describe "#release" do
+    it "should remove resource from allocated and return to pool" do
+      mock_thread = {}
+      res = {}
+      pool = ResourcePool.new{ Hash.new }
+      pool.allocated.should_receive(:delete).
+        with(mock_thread).
+        and_return(res)
+      pool.send :release, mock_thread
+      pool.pool.first.should == res
+    end
+  end
+
+  describe "#acquire" do
+    it "should call #available" do
+      mock_thread = {}
+      res = {}
+      pool = ResourcePool.new{ Hash.new }
+      pool.should_receive(:available).once
+
+      pool.send :acquire, mock_thread
+    end
+
+    it "should mark resource in use if resource is available" do
+      mock_thread = {}
+      res = {}
+      pool = ResourcePool.new{ Hash.new }
+      pool.should_receive(:available).and_return(res)
+      pool.allocated.
+        should_receive(:[]=).
+        with(mock_thread, res).
+        and_return(res)
+
+      pool.send(:acquire, mock_thread).should == res
+    end
+  end
+
+  describe "#owned_resource" do
+    it "should return resouce of specified thread" do
+      mock_thread = {}
+      res = {}
+      pool = ResourcePool.new{ Hash.new }
+      pool.allocated.
+        should_receive(:[]).
+        with(mock_thread).
+        and_return(res)
+      pool.send(:owned_resource, mock_thread).should == res
+    end
+
+    it "should return nil if no resource was aquired" do
+      mock_thread = {}
+      pool = ResourcePool.new{ Hash.new }
+      pool.allocated.
+        should_receive(:[]).
+        with(mock_thread).
+        and_return(nil)
+      pool.send(:owned_resource, mock_thread).should == nil
+    end
+  end
+
+  describe "#release_all" do
+    before :each do
+      @pool = ResourcePool.new{ Hash.new }
+      4.times{ @pool.pool << Hash.new }
+    end
+
+    it "should remove all resource from pool" do
+      @pool.release_all
+      @pool.size.should == 0
+    end
+
+    it "should call block if available" do
+      counter = 0
+      @pool.release_all{|res| counter += 1 }
+      counter.should == 4
+    end
+
+    it "should call @delete_proc if no block given" do
+      counter = 0
+      delete_proc = lambda {|res| counter += 1 }
+      @pool.instance_variable_set(:@delete_proc, delete_proc)
+      @pool.release_all
+      counter.should == 4
+    end
+
+    it "should call block if both block and @delete_proc are avaiable" do
+      counter1 = 0
+      counter2 = 0
+      delete_proc = lambda {|res| counter1 += 1 }
+      @pool.instance_variable_set(:@delete_proc, delete_proc)
+      @pool.release_all{|res| counter2 += 1}
+      counter1.should == 0
+      counter2.should == 4
+    end
+  end
+
+  describe "#hold" do
+    before :each do
+      @res = {}
+      @pool = ResourcePool.new{ Hash.new }
+    end
+
+    it "should use already acquired resource" do
+      @pool.should_receive(:owned_resource).
+        with(Thread.current).
+        and_return(@res)
+      @pool.should_not_receive(:acquire)
+      @pool.should_not_receive(:release)
+
+      @pool.hold do |res|
+        res.should == @res
+      end
+    end
+
+    it "should aquire and release resource" do
+      @pool.should_receive(:acquire).
+        with(Thread.current).
+        and_return(@res)
+      @pool.should_receive(:release).
+        with(Thread.current)
+
+      @pool.hold do |res|
+        res.should == @res
+      end
+    end
+
+    it "should retry aquire" do
+      args = []
+      1000.times{ args << nil }
+      args << @res
+      @pool.should_receive(:acquire).
+        and_return(*args)
+
+      start = Time.now
+      @pool.hold do |res|
+        res.should == @res
+      end
+      delta = Time.now - start
+      delta.should be_between(0.8, 1.2)
+    end
+
+    it "should timeout after 2 seconds" do
+      @pool.should_receive(:acquire).
+        any_number_of_times.
+        and_return(nil)
+      @pool.should_not_receive(:release)
+
+      start = Time.now
+      lambda {
+        @pool.hold{ |res| res.should == @res }
+      }.should raise_error(ResourcePool::PoolTimeout)
+
+      delta = Time.now - start
+      delta.should be_between(1.99, 2.01)
+    end
+
+    it "should delete bad resource" do
+      @pool.should_receive(:acquire).
+        and_return(@res)
+      @pool.should_not_receive(:release)
+      @pool.allocated.should_receive(:delete).
+        with(Thread.current)
+
+      lambda {
+        @pool.hold{ |res| raise ResourcePool::BadResource }
+      }.should raise_error(ResourcePool::BadResource)
+    end
+
+    it "should call delete_proc if avaiable" do
+      delete_proc_called = false
+      @pool.should_receive(:acquire).
+        and_return(@res)
+      @pool.should_not_receive(:release)
+      @pool.allocated.should_receive(:delete).
+        with(Thread.current)
+
+      @pool.instance_variable_set(:@delete_proc, lambda{|res|
+        delete_proc_called = true
+      })
+
+      lambda {
+        @pool.hold{ |res| raise ResourcePool::BadResource }
+      }.should raise_error(ResourcePool::BadResource)
+
+      delete_proc_called.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'resource_pool'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: resource_pool
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Aaron Qian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  version_requirements: *id001
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id003
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
+  prerelease: false
+  type: :development
+description: A gem for generic connection pooling / resource pooling. The code is mostly taken from Sequel gem's ThreadedConnectionPool class, and adapted for more general use.
+email: aq1018@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/resource_pool.rb
+- spec/resource_pool_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aq1018/resource_pool
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A gem for generic connection pooling / resource pooling.
+test_files: []
+