actionpool 0.2.2

data/CHANGELOG

@@ -0,0 +1,13 @@
+0.2.2
+    - Better thread management within the pool
+    - Restart thread timeouts when modified
+    - Fix argument passing
+0.2.1
+    - Set minimum pool size properly when initialized to avoid
+      creating extra threads (thanks to Roger Pack)
+0.2.0
+    - Added argument support for passed tasks (thanks simonmenke)
+    - Faster pool resizing
+    - Smarter thread creation to limit unneeded creation
+    - Allow floats for timeouts to provide better control
+    - Test verified support for 1.8.6, 1.8.7, 1.9.1 and JRuby 1.4.0RC1

data/LICENSE

@@ -0,0 +1,165 @@
+           GNU LESSER GENERAL PUBLIC LICENSE
+                Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.rdoc

@@ -0,0 +1,192 @@
+== ActionPool
+
+ActionPool is just a simple thread pool. It allows for various constraints and resizing in a pretty easy and unobtrusive manner. You can set limits on how long tasks are worked on, as well as on the life of a thread. For things that like to use lots threads, it can be helpful to reuse threads instead of constantly recreating them.
+
+=== install (easy):
+
+    gem install ActionPool
+
+=== install (less easy):
+
+    git clone http://github.com/spox/actionpool.git
+    cd actionpool
+    gem build *.gemspec
+    gem install ./
+
+=== install (less easy that's a little easier)
+
+{rip}[http://hellorip.com/about.html] makes it easy to install directly from a github repository.
+
+== Documentation
+
+{rdocs}[http://allgems.ruby-forum.com/gems/ActionPool/]
+
+== Example
+
+=== Code:
+
+    require 'actionpool'
+    
+    pool = ActionPool::Pool.new
+    pool.process do
+        sleep(2)
+        raise 'Wakeup main thread'
+    end
+    20.times do
+        pool.process do
+            puts "Thread: #{Thread.current}"
+            sleep(0.1)
+        end
+    end
+    begin
+        sleep
+    rescue Exception => e
+        puts "Thread pool woke me up: #{e}"
+    end
+
+
+=== Result:
+
+    Thread: #<Thread:0x93ebeb8>
+    Thread: #<Thread:0x93eb92c>
+    Thread: #<Thread:0x93eb8a0>
+    Thread: #<Thread:0x93eb814>
+    Thread: #<Thread:0x93eb788>
+    Thread: #<Thread:0x93eb670>
+    Thread: #<Thread:0x93eb5e4>
+    Thread: #<Thread:0x93eb558>
+    Thread: #<Thread:0x93eb4cc>
+    Thread: #<Thread:0x93ebeb8>
+    Thread: #<Thread:0x93eb92c>
+    Thread: #<Thread:0x93eb8a0>
+    Thread: #<Thread:0x93eb814>
+    Thread: #<Thread:0x93eb788>
+    Thread: #<Thread:0x93eb670>
+    Thread: #<Thread:0x93eb5e4>
+    Thread: #<Thread:0x93eb558>
+    Thread: #<Thread:0x93eb4cc>
+    Thread: #<Thread:0x93eb92c>
+    Thread: #<Thread:0x93eb8a0>
+    Thread pool woke me up: Wakeup main thread
+
+=== Important note
+
+The worker threads in the ActionPool will catch all Exception objects that your block fails to catch. Instead of just eating these exceptions, they are passed back to the creating thread of the pool (generally the main thread). This is important to note if you care about processing unexpected exceptions and what allows the example code above to be woken up from its sleep.
+
+== The internals
+==== Probably more information than you really want
+
+ActionPool has some simple settings that make things work. First, the pool has a minimum and maximum number of allowed threads. On initialization, the minimum number of threads are created and put into the pool. By default, this is 10 threads. As the number of tasks added to the pool increases, the pool will grow as needed. When more tasks are in the pool than threads to process them, new threads will be added into the pool, until the maximum thread threshold is reached. Taking the example above, we can demonstrate this easily by adjusting our limits:
+
+    require 'actionpool'
+
+    pool = ActionPool::Pool.new(:min_threads => 1, :max_threads => 3)
+    pool.process do
+        sleep(10)
+        raise 'Wakeup main thread'
+    end
+    20.times do
+        pool.process do
+            puts "Thread: #{Thread.current}"
+            sleep(rand(0.0))
+        end
+    end
+    begin
+        sleep
+    rescue Exception => e
+        puts "Thread pool woke me up: #{e}"
+    end
+
+Which results in:
+
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1080>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1760>
+    Thread: #<Thread:0x86c1080>
+    Thread pool woke me up: Wakeup main thread
+
+Our pool starts with a single thread that is occupied by the sleeping task waiting to raise an exception. As we begin to add new tasks, the pool grows to accommodate the growing number of tasks, until it reaches the maximum threshold of 3. At that point, the pool simply processes the tasks until the task list is empty.
+
+The pool also has the ability to limit the amount of time a thread spends working on a given task. By default, a thread will work on a given task until the task is completed, or the pool is shutdown. However, as the following example shows, it is very easy to limit this time to avoid the pool being bogged down on long running tasks:
+
+    require 'actionpool'
+
+    pool = ActionPool::Pool.new(:min_threads => 1, :max_threads => 1, :a_to => 1)
+    pool.process do
+        puts "#{Time.now}: I'm a long running task"
+        sleep(100)
+        raise 'Wakeup main thread'
+    end
+    pool.process do
+        puts "#{Time.now}: Waiting for my turn"
+        raise "I'm waking up the main thread"
+    end
+    begin
+        sleep
+    rescue Exception => e
+        puts "Thread pool woke me up: #{e}"
+    end
+
+Results:
+
+    2009-10-10 08:47:08 -0700: I'm a long running task
+    2009-10-10 08:47:09 -0700: Waiting for my turn
+    Thread pool woke me up: I'm waking up the main thread
+
+If you have a number of tasks you would like to schedule at once, it is easy with the add_jobs method:
+
+    require 'actionpool'
+
+    pool = ActionPool::Pool.new
+    a = 0
+    lock = Mutex.new
+    tasks = [].fill(lambda{ lock.synchronize{ a += 1 } }, 0..19)
+    pool.add_jobs(tasks)
+    pool.shutdown
+    puts "Result: #{a}"
+
+Results:
+
+    Result: 20
+
+Passing arguments to tasks is now available as well:
+
+    require 'actionpool'
+
+    pool = ActionPool::Pool.new
+    string = 'Hello world'
+    puts "Original: #{string}. ID: #{string.object_id}"
+    pool << [lambda{|var| puts "Passed: #{var}. ID: #{var.object_id}"}, [string.dup]]
+    pool << [lambda{|a,b| puts "Passed: #{a} | #{b}. ID: #{a.object_id} | #{b.object_id}"}, [string, string.dup]]
+    pool.shutdown
+
+Results:
+
+    Original: Hello world. ID: 70651630
+    Passed: Hello world. ID: 70651250
+    Passed: Hello world | Hello world. ID: 70651630 | 70651100
+
+== Last remarks
+
+If you find any bugs, please report them through {github}[http://github.com/spox/actionpool/issues]. If you are in need of any help, you can generally find me on DALnet and Freenode.
+
+== License
+
+    ActionPool is licensed under the LGPLv3
+    Copyright (c) 2009 spox <spox@modspox.com>

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'rake'
+
+begin
+    require 'jeweler'
+    Jeweler::Tasks.new do |s|
+        s.name              = 'ActionPool'
+        s.author            = %q(spox)
+        s.email             = %q(spox@modspox.com)
+        s.version           = '0.0.1'
+        s.summary           = %q(Thread Pooling Library)
+        s.platform          = Gem::Platform::RUBY
+        s.files             = Dir['**/*']
+        s.rdoc_options      = %w(--title ActionPool --main README.rdoc --line-numbers)
+        s.extra_rdoc_files  = %w(README.rdoc)
+        s.require_paths     = %w(lib)
+        s.required_ruby_version = '>= 1.8.6'
+        s.rubyforge_project = 'ActionPool'
+        s.add_development_dependency 'thoughtbot-shoulda'
+        s.homepage          = %q(http://dev.modspox.com/trac/ActionPool)
+        description         = []
+        File.open("README.rdoc") do |file|
+            file.each do |line|
+                line.chomp!
+                break if line.empty?
+                description << "#{line.gsub(/\[\d\]/, '')}"
+            end
+        end
+        s.description = description[1..-1].join(" ")
+    end
+    Jeweler::RubyforgeTasks.new do |rubyforge|
+        rubyforge.doc_task = 'rdoc'
+    end
+rescue LoadError
+    puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test_repo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/actionpool.gemspec

@@ -0,0 +1,15 @@
+spec = Gem::Specification.new do |s|
+    s.name              = 'actionpool'
+    s.author            = %q(spox)
+    s.email             = %q(spox@modspox.com)
+    s.version           = '0.2.2'
+    s.summary           = %q(Thread Pool)
+    s.platform          = Gem::Platform::RUBY
+    s.files             = Dir['**/*']
+    s.rdoc_options      = %w(--title ActionPool --main README.rdoc --line-numbers)
+    s.extra_rdoc_files  = %w(README.rdoc CHANGELOG)
+    s.require_paths     = %w(lib)
+    s.required_ruby_version = '>= 1.8.6'
+    s.homepage          = %q(http://github.com/spox/actionpool)
+    s.description         = "The ActionPool is an easy to use thread pool for ruby."
+end

data/lib/actionpool/LogHelper.rb

@@ -0,0 +1,25 @@
+module ActionPool
+    class LogHelper
+    
+        def initialize(logger=nil)
+            require 'logger'
+            @logger = logger
+        end
+
+        def info(m)
+            @logger.info(m) unless @logger.nil?
+        end
+
+        def warn(m)
+            @logger.warn(m) unless @logger.nil?
+        end
+
+        def fatal(m)
+            @logger.fatal(m) unless @logger.nil?
+        end
+
+        def error(m)
+            @logger.error(m) unless @logger.nil?
+        end
+    end
+end