iprocess 5.1.3 → 6.0.0

data/ChangeLog.txt

@@ -0,0 +1,9 @@
+= v6.0.0
+	- Tidy up the test suite
+	Not a lot to say about that :-) The suite is smaller, so I've defined support
+	classes inline with the tests instead of in separate files.
+
+	- Remove the async API.
+	The async API creates multiple threads that all call out to a method on a 
+	single object. I don't think this is a good API because it forces its users
+	to deal with thread safety.

data/README.md

@@ -12,57 +12,41 @@ __OVERVIEW__
 __DESCRIPTION__
 
 Provides a number of abstractions on top of spawning subprocesses and 
-interprocess communication. The API is simple and supports both synchronous and
-asynchronous(non-blocking) types of programming. It also supports implicit 
-interprocess communication that can be easily  configured to use the serializer 
-of your choice(default is the [Marshal](http://rdoc.info/stdlib/core/Marshal) 
-module). 
+interprocess communication. The API is simple and can be easily used to
+spawn multiple subprocesses that can return Ruby objects back to the parent
+process. Ruby objects are serialized before being sent between processes, and 
+you have the option to choose what serializer to use.The default is the 
+[Marshal](http://rdoc.info/stdlib/core/Marshal) module. 
 
 __EXAMPLES__
 
 __1.__
 
-A demo of how to spawn three subprocesses. Although the block is executed in a 
-subprocess its return value is returned to the parent process.
+A demo of how to spawn two subprocesses.
 
 ```ruby
-messages = IProcess.spawn(3) { {msg: "hello"} }
-p messages # => [{msg: "hello"}, {msg: "hello"}, {msg: "hello"}]
+messages = IProcess.spawn(2) { {msg: "hello"} }
+p messages # => [{msg: "hello"}, {msg: "hello"}]
 ```
-
 __2.__
 
 You can spawn a subprocess with a block or with any object that responds to 
-`#call`. If you had a worker that was too complicated as a block you could 
-try this:
+`call`. If you had a block that had become too complicated you could try
+refactoring it into a class:
 
 ```ruby
-class Worker
+class Unit
   def initialize
     @num = 1
   end
 
   def call
-    @num + 1
+    @num += 1
   end
 end
-IProcess.spawn 5, Worker.new # => [2, 2, 2, 2, 2]
+IProcess.spawn 3, Unit.new # => [2,2,2]
 ```
-__3.__
-
-A demo of how to spawn two subprocesses asynchronously.
-The `Inbox#recv` method is a callback that XPool calls when a subprocess has 
-finished executing. The example may not be the best, though:
 
-```ruby
-class Inbox
-  def recv(pid)
-    puts "'#{pid}' has finished!"
-  end
-end
-inbox = Inbox.new
-IProcess.spawn!(2, inbox) { Process.pid }
-```
 
 __SERIALIZERS__
 

data/lib/iprocess.rb

@@ -40,25 +40,6 @@ class IProcess
     fork(number_of, obj, &worker).map(&:result)
   end
 
-  #
-  # Spawn one or more subprocesse(s) asynchronously.
-  #
-  # @param [#recv] inbox
-  #   An object who can receive messages through the {#recv} method.
-  #
-  # @param
-  #   (see IProcess.spawn)
-  #
-  # @return [Array<IProcess>]
-  #
-  def self.spawn!(number_of, inbox, obj = nil, &worker)
-    forks = fork number_of, obj, &worker
-    forks.each do |subprocess|
-      t = Thread.new { inbox.recv subprocess.result }
-      at_exit { t.join }
-    end
-  end
-
   def self.fork(number_of = 1, obj = nil, &worker)
     worker = obj || worker
     Array.new(number_of) do

data/lib/iprocess/version.rb

@@ -1,3 +1,3 @@
 class IProcess
-  VERSION = '5.1.3'
+  VERSION = '6.0.0'
 end

data/test/test_IProcess_class.rb

@@ -1,31 +1,18 @@
 require_relative 'setup'
 class IProcessTest < Test::Unit::TestCase
-  def test_spawn
-    results = IProcess.spawn(2) { :ok }
-    assert_equal [:ok, :ok], results
-  end
-
-  def test_spawn_with_non_proc_worker
-    klass = Class.new do
-      def call
-        :ok
-      end
+  class Unit
+    def call
+      42
     end
-    results = IProcess.spawn 2, klass.new
-    assert_equal [:ok, :ok], results
   end
 
-  def test_async_spawn!
-    inbox = Inbox.new
-    IProcess.spawn!(2, inbox) { {ok: true} }
-    sleep 0.1
-    assert_equal [{ok: true}, {ok: true}], inbox.messages
+  def test_spawn
+    results = IProcess.spawn(2) { 42 }
+    assert_equal [42, 42], results
   end
 
-  def test_async_spawn_with_raise
-    inbox = Inbox.new
-    IProcess.spawn!(2, inbox) { raise RuntimeError, "", [] }
-    sleep 0.1
-    assert_equal [nil, nil] inbox.messages
+  def test_spawn_with_non_proc_worker
+    results = IProcess.spawn 2, Unit.new
+    assert_equal [42, 42], results
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprocess
 version: !ruby/object:Gem::Version
-  version: 5.1.3
+  version: 6.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ichannel
@@ -39,6 +39,7 @@ files:
 - .pryrc
 - .travis.yml
 - .yardopts
+- ChangeLog.txt
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -47,7 +48,6 @@ files:
 - lib/iprocess.rb
 - lib/iprocess/version.rb
 - test/setup.rb
-- test/support/inbox.rb
 - test/test_IProcess_class.rb
 homepage: https://github.com/robgleeson/iprocess
 licenses: []
@@ -76,6 +76,5 @@ summary: A number of abstractions on top of spawning subprocesses and interproce
   communication.
 test_files:
 - test/setup.rb
-- test/support/inbox.rb
 - test/test_IProcess_class.rb
 has_rdoc: 

data/test/support/inbox.rb

@@ -1,13 +0,0 @@
-class Inbox
-  def initialize
-    @msgs = []
-  end
-
-  def messages
-    @msgs
-  end
-
-  def recv(msg)
-    @msgs << msg
-  end
-end