worker_pool 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sebastian Ohm <ohm.sebastian@gmail.com>
+
+MIT License
+
+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,3 @@
+# WorkerPool
+
+Playing around with synchronized concurrent task execution in Ruby.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/worker_pool.rb

@@ -0,0 +1,58 @@
+require 'thread'
+
+class WorkerPool
+  BUFFER_SIZE = 1
+
+  def initialize(worker_count)
+    @queue = SizedQueue.new(BUFFER_SIZE)
+    @workers = (1..worker_count).map { |i| start_worker(i) }
+  end
+
+  def perform(tasks, timeout, &block)
+    countdown, accumulator = CountdownLatch.new(tasks.size), Queue.new
+    tasks.each { |args| enqueue(countdown, accumulator, args, block) }
+    countdown.wait(timeout)
+    queue_to_array(accumulator)
+  end
+
+  def shutdown
+    @workers.each(&:kill)
+  end
+
+  private
+
+  def enqueue(countdown, accumulator, args, block)
+    @queue.push([ countdown, accumulator, args, block ])
+  end
+
+  def execute_task(countdown, accumulator, args, block)
+    result =
+      begin
+        block.call(*args)
+      rescue => ex
+        WorkerError.new(ex)
+      end
+    accumulator.push(result)
+  ensure
+    countdown.decrement
+  end
+
+  def queue_to_array(queue)
+    queue.length.times.map { queue.pop }
+  end
+
+  def start_worker(id)
+    Thread.new do
+      loop do
+        task = @queue.pop rescue nil
+        if Array === task
+          execute_task(*task)
+        end
+      end
+    end
+  end
+end
+
+require 'worker_pool/countdown_latch'
+require 'worker_pool/version'
+require 'worker_pool/worker_error'

data/lib/worker_pool/countdown_latch.rb

@@ -0,0 +1,29 @@
+require 'thread'
+
+class WorkerPool
+  class CountdownLatch
+    def initialize(count)
+      @count, @mutex, @resource = count, Mutex.new, ConditionVariable.new
+    end
+
+    def decrement
+      @mutex.synchronize do
+        @count -= 1
+        if @count <= 0
+          @resource.broadcast
+        end
+      end
+    end
+
+    # TODO: Implement timeouts
+    def wait(_timeout)
+      @mutex.synchronize do
+        if @count > 0
+          @resource.wait(@mutex)
+        else
+          @resource.broadcast
+        end
+      end
+    end
+  end
+end

data/lib/worker_pool/version.rb

@@ -0,0 +1,3 @@
+class WorkerPool
+  VERSION = '0.0.1'
+end

data/lib/worker_pool/worker_error.rb

@@ -0,0 +1,3 @@
+class WorkerPool
+  class WorkerError < StandardError ; end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+if ENV['COVERAGE']
+  begin
+    require 'simplecov'
+    SimpleCov.start
+  rescue LoadError
+    puts 'SimpleCov not loaded!'
+  end
+end
+
+require 'minitest/autorun'
+
+Thread.abort_on_exception = true

data/test/worker_pool_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+require 'worker_pool'
+
+class WorkerPoolTest < MiniTest::Unit::TestCase
+  TIMEOUT = 5.0
+
+  def identity(arg)
+    arg
+  end
+
+  def sleepy_identity(arg)
+    sleep(rand(0.01..0.2))
+    arg
+  end
+
+  def fail(*args)
+    raise ArgumentError, args
+  end
+
+  def test_ordered_task_execution
+    pool, args, task = WorkerPool.new(1), (0..9).to_a, method(:identity)
+    results = pool.perform(args, TIMEOUT, &task)
+    pool.shutdown
+    assert_equal(args, results)
+  end
+
+  def test_concurrent_task_execution
+    pool, args, task = WorkerPool.new(2), (0..9).to_a, method(:sleepy_identity)
+    results = pool.perform(args, TIMEOUT, &task)
+    pool.shutdown
+    assert_equal(args.size, results.size)
+    args.each { |arg| assert(results.include?(arg)) }
+  end
+
+  def test_failing_task_execution
+    pool, args, task = WorkerPool.new(3), [ :a, :a, :a ], method(:fail)
+    results = pool.perform(args, TIMEOUT, &task)
+    pool.shutdown
+    assert_equal(args.size, results.size)
+    results.each { |r| assert(r.is_a?(WorkerPool::WorkerError)) }
+    assert_equal([ :a ].inspect, results.first.message)
+  end
+end

data/worker_pool.gemspec

@@ -0,0 +1,18 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'worker_pool/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'worker_pool'
+  gem.version = WorkerPool::VERSION
+  gem.authors = [ 'Sebastian Ohm' ]
+  gem.email = [ 'ohm.sebastian@gmail.com' ]
+  gem.homepage = 'http://github.com/ohm/worker_pool'
+  gem.summary = 'Simple worker pool for (synchronized) concurrent task execution'
+  gem.files = `git ls-files`.split($/)
+  gem.test_files = gem.files.grep(%r{\Atest/})
+  gem.require_paths = [ 'lib' ]
+  gem.add_development_dependency('simplecov')
+  gem.required_ruby_version = '>= 1.9'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: worker_pool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastian Ohm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ohm.sebastian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/worker_pool.rb
+- lib/worker_pool/countdown_latch.rb
+- lib/worker_pool/version.rb
+- lib/worker_pool/worker_error.rb
+- test/test_helper.rb
+- test/worker_pool_test.rb
+- worker_pool.gemspec
+homepage: http://github.com/ohm/worker_pool
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple worker pool for (synchronized) concurrent task execution
+test_files:
+- test/test_helper.rb
+- test/worker_pool_test.rb