babypool 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+doc
+coverage

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Jeremy Hopple
+
+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,25 @@
+= Baby Pool: _Simple_ thread pool.
+
+Baby Pool is a simple, but solid implementation of a thread pool using Ruby green threads.
+Pools are initialized with a thread count and an execution limit.  Baby Pool creates an array or workers
+each in their own thread that listen for incoming jobs.
+
+The pool will continue to accept work until it is drained by calling the drain method.
+
+A quick example:
+
+* Initialize the pool with a thread count and an execution limit.  Each thread's worker will timeout it's current job when it reaches the pool's execution limit.
+
+	pool = Babypool.new(:thread_count => 10, :execution_limit => 20)
+	
+* Give the pool 20 jobs to do.
+
+	(0..20).each do |job|
+	  pool.work(job) do
+	    puts "Running job #{job}."
+	  end
+	end
+
+* When you are done, shut down the pool by calling the drain method
+
+	pool.drain

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+ 
+$LOAD_PATH.unshift('lib')
+ 
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'babypool'
+    gemspec.summary = "A ruby thread pool."
+    gemspec.description = "Simple thread pool implementation for Ruby green threads."
+    gemspec.authors = ["Jeremy T Hopple", "Benjamin P Blackburne"]
+    gemspec.email = "jeremy@jthopple.com"
+    gemspec.homepage = "http://github.com/jthopple/babypool"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+test_files_pattern = 'test/**/*_test.rb'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = test_files_pattern
+  t.verbose = true
+end 
+ 
+desc "Run code-coverage analysis using rcov"
+task :rcov do
+  rm_rf "coverage"
+  files = Dir[test_files_pattern]
+  system "rcov -T --sort coverage -x shoulda,rcov -Ilib #{files.join(' ')}"
+end
+
+desc 'Default: run tests.'
+task :default => ['test']

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/babypool.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{babypool}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy T Hopple", "Benjamin P Blackburne"]
+  s.date = %q{2009-10-16}
+  s.description = %q{Simple thread pool implementation for Ruby green threads.}
+  s.email = %q{jeremy@jthopple.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENCE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "babypool.gemspec",
+     "lib/babypool.rb",
+     "test/babypool_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jthopple/babypool}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A ruby thread pool.}
+  s.test_files = [
+    "test/babypool_test.rb",
+     "test/test_helper.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/babypool.rb

@@ -0,0 +1,75 @@
+require "thread"
+require "timeout"
+
+# Babypool implements a simple thread pool.
+# 
+# == Options
+# * :thread_count - The number of threads in the pool.  Each thread has its own worker listening for jobs.
+# * :execution_limit - This specifies how long the worker should attempt to complete its job.  The job is terminated when it reaches this limt
+
+class Babypool
+  attr_reader :queue, :busy_threads, :execution_limit
+
+  # Constructs a Babypool object and initializes the pool of workers
+  def initialize(options={})
+    @draining = false
+    @queue = Queue.new
+    @busy_threads = Queue.new
+    @execution_limit = options[:execution_limit] || 120
+    @thread_count = options[:thread_count] || 10
+    @verbose = options[:verbose] || false
+  
+    @threads = Array.new(@thread_count){ Thread.new{ Worker.new(self) } }
+  end
+
+  # Accepts work items, or jobs, as blocks and adds them to the queue.
+  def work(*args,&block)
+    if (@draining)
+      raise "Pool is shutting down and not accepting more work"
+    end
+  
+    @queue << [ args, block ]
+  end
+
+  # Returns true if the pool is still busy handling items, false otherwise.
+  def busy?
+    puts "Busy Check (items in queue: #{@queue.size}, busy threads: #{@busy_threads.size})" if @verbose
+    !@queue.empty? || !@busy_threads.empty?
+  end
+
+  # Sends a message to each thread telling it to exit, puts the pool in "draining" mode so that it does not accept any more work, and 
+  # then waits for each thread to complete.
+  def drain
+    puts "Draining the pool..." if @verbose
+    @threads.each{ work{ Thread.exit } }
+    @draining = true
+    @threads.each{ |t| t.join }
+    puts "Pool Drained." if @verbose
+  end
+
+  # Implements a worker object that listens for work until it is told to exit.
+  class Worker
+    
+    # Initializes a worker for a given pool.
+    def initialize(pool)
+      puts "#{self.to_s} Initialized" if @verbose
+      loop do
+        # Listen for work on the pool's queue. If the queue is empty, the calling thread is suspended until data is pushed onto the queue.
+        args,block = pool.queue.deq
+        
+        # Punch in - add a marker to the busy_thread queue indicating that we're working
+        pool.busy_threads.push(:marker) 
+        
+        # Do the work by calling the block.
+        begin
+          Timeout::timeout(pool.execution_limit){ block.call(*args) }
+        rescue Timeout::Error => e
+          puts "#{self.to_s} - Worker timed out." if @verbose
+        end
+        
+        # Punch out - Remove our marker indicating we're finished and idle. Do not suspend if busy_threads queue is empty (the "true" passed in).
+        pool.busy_threads.pop(true)
+      end
+    end
+  end
+end

data/test/babypool_test.rb

@@ -0,0 +1,65 @@
+require 'test/test_helper'
+ 
+class TestBabypool < Test::Unit::TestCase  
+  should "setup a pool and do some work" do
+    pool = Babypool.new(:thread_count => 10, :execution_limit => 2)
+
+    completed = 0
+    20.times do |job|
+      pool.work(job) do
+        completed += 1
+      end
+    end
+
+    pool.drain    
+    
+    assert_equal completed, 20
+  end
+  
+  should "only finish jobs that take less than 2 seconds" do
+    pool = Babypool.new(:thread_count => 10, :execution_limit => 1)
+
+    completed = 0
+    
+    # Try 20 jobs, but even jobs should timeout because they take longer than 2 seconds.  10 should complete
+    20.times do |job|
+      pool.work(job) do
+        sleep(2) if job % 2 == 0
+        completed += 1
+      end
+    end
+
+    pool.drain    
+    
+    assert_equal completed, 10
+  end
+  
+  should "have been busy while work was being done" do
+    pool = Babypool.new(:thread_count => 10)
+    completed = 0
+    was_busy = false
+    
+    # Do 10 jobs, each should sleep for a few seconds allowing busy? to return true
+    10.times{ |job| pool.work(job){ sleep(1) } }
+    
+    was_busy = pool.busy?
+    pool.drain    
+    assert was_busy
+  end
+  
+  should "have been done by the time we checked if it was busy" do
+    pool = Babypool.new(:thread_count => 10)
+    completed = 0
+    was_busy = false
+    
+    # Do 10 jobs, each should sleep for a few seconds allowing busy? to return true
+    10.times{ |job| pool.work(job){ completed += 1 } }
+    
+    # Sleep for a second to let the jobs finish
+    sleep(1)
+    was_busy = pool.busy?
+    
+    pool.drain    
+    assert !was_busy
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'babypool'

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: babypool
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy T Hopple
+- Benjamin P Blackburne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-16 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Simple thread pool implementation for Ruby green threads.
+email: jeremy@jthopple.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- LICENCE
+- README.rdoc
+- Rakefile
+- VERSION
+- babypool.gemspec
+- lib/babypool.rb
+- test/babypool_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jthopple/babypool
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby thread pool.
+test_files: 
+- test/babypool_test.rb
+- test/test_helper.rb