objectpool 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gem
+.yardoc
+doc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kriss Kowalik
+
+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,47 @@
+# Object Pool
+
+Little bit different and magical implementation of thread pool pattern in ruby.
+
+## Installation
+
+    gem install objectpool
+
+## Examples
+
+    require 'objectpool'
+
+    class MyClass 
+      pool_methods :one, :two
+      
+      def one; sleep 1; end
+      def two(arg) sleep 2; return arg end
+    end 
+    
+    pool = MyClass.to_pool(10).new
+    pool.one.async    # the `one` method will be called asynchronously
+    pool.two(2).sync  # this will be called synchronously and it will return result
+    # Result can be handled inside the asynchronous block
+    pool.two(2).async {|result| puts result }
+    
+    # Now you can wait for results
+    pool.wait
+    
+    # "Join" infinity loop with main thread...
+    pool.join
+    
+    # ... or close this object pool
+    pool.close
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kriss Kowalik. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "objectpool"
+    gem.summary = %Q{Magical thread pool implementation}
+    gem.description = %Q{Little bit different and magical implementation of thread pool pattern in ruby.}
+    gem.email = "kriss.kowalik@gmail.com"
+    gem.homepage = "http://github.com/kriss/objectpool"
+    gem.authors = ["Kriss Kowalik"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    version   = File.exist?('VERSION') ? File.read('VERSION') : ""
+    title     = "Leech #{version}"
+    t.files   = ['lib/**/*.rb', 'README*']
+    t.options = ['--title', title, '--markup', 'markdown']
+  end
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+desc "Benchmarking reports"
+task :benchmark do 
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+  require 'rubygems'
+  require 'objectpool'
+  require 'benchmark'
+  
+  class BenchObject
+    pool_methods :test
+    
+    def test(arg)
+      sleep 0.01
+    end
+  end
+  
+  p5 = BenchObject.to_pool(5)
+  p10 = BenchObject.to_pool(10)
+  p20 = BenchObject.to_pool(20)
+  p35 = BenchObject.to_pool(35)
+  
+  op5, op10, op20, op35 = nil, nil, nil, nil
+  
+  puts "-- Preparation time -------------------------------------"
+  Benchmark.bm(7) do |x|
+    x.report("5 workers ") { op5  = p5.new  }
+    x.report("10 workers") { op10 = p10.new }
+    x.report("20 workers") { op20 = p20.new }
+    x.report("35 workers") { op35 = p35.new }
+  end
+  
+  n = 5000
+  
+  puts "-- Execution time (5000 calls) --------------------------"
+  Benchmark.bm(7) do |x|
+    x.report("5 workers ") { n.times {|n| op5.test(n).async  };}
+    x.report("10 workers") { n.times {|n| op10.test(n).async };}
+    x.report("20 workers") { n.times {|n| op20.test(n).async };}
+    x.report("35 workers") { n.times {|n| op35.test(n).async };}
+  end
+  n = 50000
+end 

data/lib/objectpool.rb

@@ -0,0 +1,250 @@
+require 'logger'
+require 'timeout'
+
+begin
+  require 'fastthread' 
+rescue LoadError
+  require 'thread'
+  $stderr.puts("The fastthread gem not found. Using standard ruby threads.")
+end
+
+module ObjectPool
+  class Error < StandardError; end
+  class StopWorker < Error; end
+
+  def self.create(klass, size, opts={})
+    (pool_klass = Class.new(klass)).class_eval do
+      @__op__size        = size
+      @__op__orig_class  = klass
+      @__op__queue_limit = opts[:limit].to_i
+      extend ClassMethods
+      include InstanceMethods
+      __op__redefine_pool_methods
+    end
+    pool_klass
+  end
+  
+  module InstanceMethods
+    def initialize(*args, &block)
+      @__op__mx      = Mutex.new
+      @__op__cv      = ConditionVariable.new
+      @__op__queue   = Queue.new
+      @__op__workers = ThreadGroup.new
+      
+      self.class.pool_size.times do
+        __op__create_worker(*args, &block)
+      end
+    end
+    
+    def join
+      sleep 0.01 until @__op__workers.list.all? {|w| !w.alive?}
+    end
+    
+    def wait
+      sleep 0.01 until @__op__mx.synchronize { @__op__queue.empty? && @__op__workers.list.all? {|w| !w.busy?} }
+    end
+
+    def size
+      @__op__workers.list.size
+    end
+    
+    def busy?
+      @__op__mx.synchronize { @__op__queue.size < @__op__workers.list.size }
+    end
+    
+    def close
+      @__op__workers.list.each {|worker| worker.raise(StopWorker)}
+      @__op__workers = ThreadGroup.new
+    end
+    
+    private
+    
+    def __op__create_worker(*args, &block)
+      @__op__workers.add(Thread.new do
+        executor = self.class.pool_orig_class.new(*args, &block)
+        action   = nil
+        loop do
+          begin
+            @__op__mx.synchronize do 
+              @__op__cv.wait(@__op__mx)
+              if action = @__op__queue.shift
+                Thread.current.lock_at_pool!
+                @__op__mx.unlock 
+                result = executor.send(action.method.to_sym, action.args, &action.block)
+                action.complete!(result)
+                @__op__mx.lock
+                Thread.current.release_at_pool!
+              end
+            end
+          rescue StopWorker
+            break
+          end
+        end
+      end)
+    end
+    
+    def __op__call_at_pool(meth, *args, &block)
+      if self.class.pool_queue_limit > 0
+        sleep 0.01 until @__op__mx.synchronize { self.class.pool_queue_limit > @__op__queue.size }
+      end
+      Method.new(meth, args, block, @__op__mx, @__op__cv, @__op__queue)
+    end
+  end
+  
+  class Method
+    class Error < StandardError; end
+    class TerminatedError < Error; end
+    
+    attr_reader :method, :args, :block, :callback
+    
+    def initialize(method, args, block, mx, cv, queue)
+      @method, @args, @block = method, args, block
+      @mx, @cv, @queue = mx, cv, queue
+      @complete = false
+      @result = nil
+    end
+    
+    def complete?
+      @complete
+    end
+    
+    def complete!(*opts)
+      @callback.call(*opts)
+      @complete = true
+    end
+    
+    def async(&block)
+      call_at_pool(false, &block)
+    end
+    alias_method :asynchronous, :async
+    
+    def sync
+      call_at_pool(true)
+    end
+    alias_method :synchronous, :sync
+    
+    private
+    
+    def terminated?
+      !!@terminated
+    end
+    
+    def call_at_pool(synchronous=false, &block)
+      unless terminated?
+        @callback = block_given? && !synchronous ? block : proc {|r| @result = r}
+        @mx.synchronize do 
+          @queue << self
+          @cv.signal
+          @terminated = true
+        end
+        if synchronous
+          sleep 0.01 until complete?
+          return @result
+        end
+        return self
+      end
+      raise TerminatedError, "Can't run terminated method" 
+    end
+  end
+  
+  class Thread < ::Thread
+    def busy?
+      !!self[:busy]
+    end
+    
+    def lock_at_pool!
+      self[:busy] = true
+    end
+    
+    def release_at_pool!
+      self[:busy] = false
+    end
+  end
+  
+  module ClassMethods
+    def __op__redefine_pool_methods
+      pool_methods.each do |method|
+        class_eval <<-EVAL
+          def #{method.to_s}(*args, &block)
+            __op__call_at_pool(:#{method.to_s}.to_sym, args, block)
+          end
+        EVAL
+      end 
+    end
+  
+    def pool?
+      true
+    end 
+    
+    def pool_size
+      @__op__size
+    end
+    
+    def pool_orig_class
+      @__op__orig_class
+    end
+    
+    def pool_queue_limit
+      @__op__queue_limit
+    end
+  end
+end
+
+class Class
+  def to_pool(size, opts={})
+    ObjectPool.create(self, size, opts)
+  end
+  
+  def pool?
+    false
+  end
+  
+  def pool_methods(*methods)
+    if methods.size > 0
+      __op__add_pool_methods(methods)
+    else
+      unless @pool_methods
+        @pool_methods ||= []
+        self.ancestors.each do |ancestor|
+          @pool_methods.concat(ancestor.pool_methods) if ancestor.is_a?(Class)
+        end
+      end
+    end
+    @pool_methods
+  end
+  
+  protected
+  
+  def __op__add_pool_methods(*methods)
+    if pool_methods && methods.size > 0
+      case m = methods.first
+      when Array
+        m.uniq.each { |method| __op__add_pool_methods(method) }
+      when Symbol, String    
+        @pool_methods << m unless pool_methods.include?(m)
+      else
+        raise ArgumentError, "Invalid method name"
+      end
+    end
+  end
+  
+  def __op__remove_pool_methods(*methods)
+    if pool_methods && methods.size > 0
+      case m = methods.first
+      when Array
+        m.uniq.each { |method| __op__remove_pool_methods(method) }
+      when Symbol, String    
+        @pool_methods.delete(m)
+      else
+        raise ArgumentError, "Invalid method name"
+      end
+    end
+  end
+end
+
+class Object
+  def pool?
+    false
+  end
+end
+

data/spec/objectpool_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Core extensions" do 
+  it "should add #to_pool instance method to Class" do 
+    Class.new.should respond_to :to_pool
+  end 
+  
+  it "should add #pool? instance method to Class and Object" do 
+    Class.new.should respond_to :pool?
+    Object.new.should respond_to :pool?
+    Class.new.pool?.should == false
+    Object.new.pool?.should == false
+  end
+end
+
+describe "An Class" do 
+  context "on #to_pool call" do
+    before do 
+      @test_class = Class.new(Object)
+      @pool = @test_class.to_pool(10)
+    end
+    
+    it "should return itself ObjectPool powered when #to_pool method is called" do 
+      @pool.pool?.should == true
+      @pool.should include ObjectPool::InstanceMethods
+      @pool.ancestors.should include @test_class
+    end
+    
+    it "should save pool size in returned object" do 
+      @pool.should respond_to :pool_size
+      @pool.pool_size.should == 10
+    end
+    
+    it "should save original class in returned object" do 
+      @pool.should respond_to :pool_orig_class
+      @pool.pool_orig_class.should == @test_class
+    end
+  end
+end
+
+describe "An ObjectPool powered class" do 
+  before do 
+    unless defined?(TestClass1)
+      class TestClass1
+        pool_methods :hello
+        def hello(args)
+          "Hello #{args}!"
+        end
+      end
+    end 
+  end
+
+  context "on create" do 
+    it "should start all workers in separated threads" do
+      @pool = TestClass1.to_pool(10)
+      @obj = @pool.new
+      @obj.size.should == @obj.class.pool_size
+    end
+  end
+  
+  it "should allow to synchronously execute method in pool" do 
+    @pool = TestClass1.to_pool(10)
+    @obj = @pool.new
+    result1 = @obj.hello("world").sync
+    result2 = @obj.hello("again").sync
+    result1.should == "Hello world!"
+    result2.should == "Hello again!"
+  end
+  
+  it "should allow to asynchronously execute method in pool" do 
+    @pool = TestClass1.to_pool(10)
+    @obj = @pool.new
+    results = []
+    20.times do |n|
+      @obj.hello(n).async {|result| results << result; }
+    end
+    @obj.wait
+    results.size.should == 20
+    results.first.should match /^Hello \d+\!$/
+  end
+  
+  it "should respect queue limit on methods execution" do 
+    @pool = TestClass1.to_pool(20, :limit => 1)
+    @obj = @pool.new
+    @num = 0
+    lambda do 
+      Timeout::timeout(0.3) do 
+        100.times do |n|
+          @obj.hello(n).async { sleep 2 }
+          @num += 1
+        end
+      end
+    end.should raise_error(Timeout::Error)
+    @num.should == @pool.pool_size + @pool.pool_queue_limit
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'objectpool'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: objectpool
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kriss Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Little bit different and magical implementation of thread pool pattern in ruby.
+email: kriss.kowalik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/objectpool.rb
+- spec/objectpool_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kriss/objectpool
+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: Magical thread pool implementation
+test_files: 
+- spec/objectpool_spec.rb
+- spec/spec_helper.rb