xpool 0.9.0 → 0.9.0.1

data/ChangeLog.txt

@@ -1,3 +1,7 @@
+== v0.9.0.1
+	- doc improvements
+	revised & improved the README & API documentation.
+
 == v0.9.0
 	- upgrade to ichannel v5.1.1
 	Which in turn fixes a performance bug in XPool#schedule. With ichannel v5.0.1 

data/README.md

@@ -17,11 +17,12 @@ that are used when the pool is asked to dispatch a 'unit of work'. A
 All subprocesses in the pool have their own message queue that the pool places
 work onto according to a very simple algorithm: the subprocess who has scheduled
 the least amount of work is the subprocess who is asked to put the work on its
-queue. The message queue that each subprocess has is also  what ensures work 
-can be queued when the pool becomes dry (all subprocesses are busy). 
+queue. This helps ensure an even distribution of work among all subprocesses in 
+the pool. The message queue that each subprocess has is also what ensures 
+work can be queued when the pool becomes dry (all subprocesses are busy). 
 
 Incase a unit of work raises an exception that it does not handle xpool will
-catch the exception and mark the process as 'failed'. A failed process can be
+rescue the exception and mark the process as 'failed'. A failed process can be
 restarted, and it is also possible to access the backtrace of a failed process 
 through `XPool` and `XPool::Process` objects. The exception is also re-raised 
 so that you can see a process has failed from the output ruby prints when an 
@@ -76,6 +77,7 @@ end
 pool = XPool.new 2
 subprocess = pool.schedule Unit.new 
 p subprocess.busy? # => true
+pool.shutdown
 ```
 
 _3._

data/lib/xpool.rb

@@ -33,6 +33,7 @@ class XPool
   #
   # @param [Fixnum] size
   #   The number of subprocesses to spawn.
+  #   Defaults to the number of cores on your CPU.
   #
   # @return [XPool]
   #
@@ -54,6 +55,7 @@ class XPool
   # @example
   #   pool = XPool.new 5
   #   pool.broadcast unit
+  #   pool.shutdown
   #
   # @raise [RuntimeError]
   #   When a subprocess in the pool is dead.
@@ -77,8 +79,6 @@ class XPool
   #   An optional amount of seconds to wait before forcing a shutdown through
   #   {#shutdown!}.
   #
-  # @see XPool::Process#spawn
-  #
   # @return [void]
   #
   def shutdown(timeout=nil)

data/lib/xpool/process.rb

@@ -62,7 +62,7 @@ class XPool::Process
 
   #
   # @return [Boolean]
-  #   Returns true when the process is executing work.
+  #   Returns true when the process is executing a unit of work.
   #
   def busy?
     synchronize!
@@ -79,8 +79,7 @@ class XPool::Process
 
   #
   # @return [Boolean]
-  #   Returns true when a subprocess has failed due to an unhandled
-  #   exception.
+  #   Returns true when the process has failed due to an unhandled exception.
   #
   def failed?
     synchronize!
@@ -89,7 +88,7 @@ class XPool::Process
 
   #
   # @return [Boolean]
-  #   Returns true when the process is alive.
+  #   Returns true when the process is still running.
   #
   def alive?
     !dead?
@@ -97,7 +96,7 @@ class XPool::Process
 
   #
   # @return [Boolean]
-  #   Returns true when the process is no longer running.
+  #   Returns true when the process has shutdown.
   #
   def dead?
     synchronize!
@@ -105,7 +104,7 @@ class XPool::Process
   end
 
   #
-  # If a process has failed (see #failed?) this method returns the backtrace of
+  # If a process has failed (see {#failed?}) this method returns the backtrace of
   # the exception that caused the process to fail.
   #
   # @return [Array<String>]

data/lib/xpool/version.rb

@@ -1,3 +1,3 @@
 class XPool
-  VERSION = "0.9.0"
+  VERSION = "0.9.0.1"
 end

data/test/support/io_writer.rb

@@ -9,14 +9,13 @@ class IOWriter
   def run
     File.open @path, 'w' do |f|
       f.write 'true'
-      sleep 0.1
     end
   end
 
-  def run?
-    return @run if defined?(@run)
-    @run = File.read(@path) == 'true'
+  def wrote_to_disk?
+    return @wrote_to_disk if defined?(@wrote_to_disk)
+    @wrote_to_disk = File.read(@path) == 'true'
     FileUtils.rm_rf @path
-    @run
+    @wrote_to_disk
   end
 end

data/test/xpool_process_test.rb

@@ -34,13 +34,10 @@ class XPoolProcessTest < Test::Unit::TestCase
   end
 
   def test_queue
-    unit1 = IOWriter.new
-    unit2 = IOWriter.new
-    @process.schedule unit1
-    @process.schedule unit2
+    writers = Array.new(5) { IOWriter.new }
+    writers.each { |writer| @process.schedule writer }
     @process.shutdown
-    assert unit1.run?
-    assert unit2.run?
+    writers.each { |writer| assert writer.wrote_to_disk? }
   end
 
   def test_failed_on_failed_process

data/test/xpool_test.rb

@@ -27,9 +27,10 @@ class XPoolTest < Test::Unit::TestCase
 
   def test_queue
     @pool.resize! 1..1
-    subprocesses = Array.new(5) { @pool.schedule Sleeper.new(0.1) }.uniq!
-    assert_equal 1, subprocesses.size
-    assert_equal 5, subprocesses[0].frequency
+    writers = Array.new(5) { IOWriter.new }
+    writers.each { |writer| @pool.schedule writer }
+    @pool.shutdown
+    writers.each { |writer| assert writer.wrote_to_disk? }
   end
 
   def test_distribution_of_work

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xpool
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ichannel
@@ -68,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -372428872314676490
+      hash: 761478267261192258
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -372428872314676490
+      hash: 761478267261192258
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23