stouset-threadpool 1.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Stephen Touset
+
+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,7 @@
+= threadpool
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Stephen Touset. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "threadpool"
+    gem.summary = %Q{Parallelized, threaded enumeration, in Ruby}
+    gem.email = "stephen@touset.org"
+    gem.homepage = "http://github.com/stouset/threadpool"
+    gem.authors = ["Stephen Touset"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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 :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "threadpool #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/threadpool.rb

@@ -0,0 +1,74 @@
+class ThreadPool
+  attr_reader :size
+  attr_reader :queue
+    
+  #
+  # Creates a new ThreadPool with +size+ threads, waiting at your beck and
+  # call.
+  #
+  def initialize(size)
+    self.size  = size
+    self.queue = Queue.new
+    
+    # create a pool of threads the size requested
+    self.pool = Array.new(size) { thread }
+  end
+  
+  #
+  # Schedules a +job+ to be run with the given +args+. Returns immediately.
+  #
+  def schedule(*args, &job)
+    self.queue.push [job, args]
+  end
+  
+  #
+  # Schedules a +job+ to be run with the given +args+. Returns only once the
+  # queue of jobs to be performed is empty.
+  #
+  # This is primarily intended for preventing front-loading an arbitraril
+  # large number of jobs into the queue. However, it works simply by calling
+  # Thread.pass until the queue is empty. This has the disadvantage of
+  # spinning the processor the all the threads are mostly waiting on I/O or
+  # sleeping. It also means that if other threads are scheduling jobs, this
+  # may never return.
+  #
+  # Ideally, this method would pause the current thread until the job has
+  # begun execution, but this is surprisingly difficult to do with the Ruby
+  # built-in Queue class, which we use for the job queue.
+  #
+  def execute(*args, &job)
+    self.schedule(*args, &job)
+    
+    Thread.pass until self.queue.empty?
+  end
+  
+  #
+  # Cleans up after the ThreadPool, quitting and joining all remaining
+  # threads. No more jobs can be run in the pool once this method has been
+  # called.
+  #
+  def shutdown
+    self.size.times { self.schedule { Thread.exit } }
+    self.pool.each  {|thread| thread.join }
+  end
+  
+  protected
+  
+  attr_writer   :size
+  attr_writer   :queue
+  attr_accessor :pool
+  
+  #
+  # Instantiates a new thread. Each thread simply waits until there's a job
+  # on the queue, runs it, then returns back to the queue for more work. If
+  # the queue is empty, the thread sleeps until there is an available job.
+  #
+  def thread
+    Thread.new do
+      loop do
+        job, args = self.queue.pop
+        job[*args]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/threadpool_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ThreadPool do
+  subject { ThreadPool.new(4) }
+  
+  it 'should report its size' do
+    subject.size.should == 4
+  end
+  
+  it 'should have an empty queue of tasks' do
+    subject.queue.should be_empty
+  end
+  
+  it 'should allow cleanup of its threads' do
+    subject.shutdown.each {|thread| thread.status.should be_false }
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: stouset-threadpool
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Stephen Touset
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: stephen@touset.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/threadpool.rb
+- spec/spec_helper.rb
+- spec/threadpool_spec.rb
+has_rdoc: false
+homepage: http://github.com/stouset/threadpool
+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: Parallelized, threaded enumeration, in Ruby
+test_files: 
+- spec/spec_helper.rb
+- spec/threadpool_spec.rb