iprocess 4.0.0 → 5.0.0

data/README.md

@@ -12,11 +12,11 @@ __OVERVIEW__
 __DESCRIPTION__
 
 Provides a number of abstractions on top of spawning subprocesses and 
-interprocess communication. The API is simple, easy to use & supports
-both synchronous and asynchronous(non-blocking) dispatch of subprocesses.
-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) if needs be.
+interprocess communication. The API is simple and supports both synchronous and
+asynchronous(non-blocking) dispatch of subprocesses. 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) if needs be.
 
 __EXAMPLES__
 
@@ -52,17 +52,20 @@ __3.__
 A demo of how you would spawn two subprocesses asynchronously:
 
     class Inbox
+      attr_reader :msgs
+
       def initialize
-        @messages = []
+        @msgs = []
       end
 
       def recv(msg)
-        @messages << msg
+        @msgs << msg
       end
     end
     inbox = Inbox.new
-    jobs = IProcess.spawn!(2) { Process.pid }
-    jobs.each { |job| job.report_to(inbox) }
+    IProcess.spawn!(2, Inbox.new) { Process.pid }
+    sleep 0.1
+    p inbox.msgs
 
 __SERIALIZERS__
 
@@ -106,13 +109,6 @@ __INSTALL__
 
     $ gem install iprocess
 
-__SEE ALSO__
-
- - [XPool](https://github.com/robgleeson/xpool)  
- XPool is a UNIX process pool that was born inside IProcess but later extracted 
- into its own project. It might be interesting to you if you're interested in 
- concurrency and/or interprocess communication.
-
 __LICENSE__
 
 MIT. See LICENSE.txt.

data/iprocess.gemspec

@@ -7,7 +7,8 @@ Gem::Specification.new do |s|
   s.authors      = ["Rob Gleeson"]
   s.email        = 'rob@flowof.info'
   s.homepage     = 'https://github.com/robgleeson/iprocess'
-  s.summary      = 'IProcess makes InterProcess Communication(IPC) easy.'
+  s.summary      = 'A number of abstractions on top of spawning subprocesses ' \
+                   'and interprocess communication.'
   s.description  = s.summary
 
   s.files        = `git ls-files`.each_line.map(&:chomp)

data/lib/iprocess.rb

@@ -1,11 +1,12 @@
 class IProcess
   require 'ichannel'
   require_relative 'iprocess/version'
+
   #
   # @return [#load,#dump]
   #   Returns the serializer used by IProcess.
   #
-  def self.serializer 
+  def self.serializer
     @serializer || Marshal
   end
 
@@ -19,9 +20,7 @@ class IProcess
   end
 
   #
-  # @overload spawn(number_of = 1, worker)
-  #
-  #   Spawn one or more subprocesses.
+  # Spawn one or more subprocesse(s).
   #
   #   @param [Integer] number_of
   #     The number of subprocesses to spawn.
@@ -30,25 +29,35 @@ class IProcess
   #     The unit of work to execute in a subprocess.
   #
   #   @return [Array<Object>]
-  #     The return value(s) of the unit(s) of work.
-  #     
-  def self.spawn(*args, &worker)
-    fork(*args, &worker).map(&:result)
+  #     The return value of the unit of work.
+  #
+  #   @example
+  #     IProcess.spawn 2 do
+  #       {ok: true}
+  #     end
+  #
+  def self.spawn(number_of, obj = nil, &worker)
+    fork(number_of, obj, &worker).map(&:result)
   end
 
   #
-  # @overload
-  #   
-  #   Spawn one or more subprocesses asynchronously.
+  # Spawn one or more subprocesse(s) asynchronously.
   #
-  #   @param
-  #     (see IProcess.spawn)
+  # @param [#recv] inbox
+  #   An object who can receive messages through the {#recv} method.
   #
-  #   @return [Array<IProcess>]
-  #     An array of IProcess objects. See {#report_to}.
+  # @param
+  #   (see IProcess.spawn)
   #
-  def self.spawn!(*args, &worker)
-    fork *args, &worker
+  # @return [Array<IProcess>]
+  #
+  def self.spawn!(number_of, inbox, obj = nil, &worker)
+    forks = fork number_of, obj, &worker
+    forks.each do |subprocess|
+      Thread.new do
+        inbox.recv subprocess.result
+      end
+    end
   end
 
   def self.fork(number_of = 1, obj = nil, &worker)
@@ -61,10 +70,10 @@ class IProcess
 
   #
   # @param [#call] worker
-  #   Any object that implements #call.
+  #   The unit of work to execute in a subprocess.
   #
   # @raise [ArgumentError]
-  #   If 'worker' does not respond to #call.
+  #   If a worker is not given.
   #
   # @return [IProcess]
   #   Returns self.
@@ -72,7 +81,7 @@ class IProcess
   def initialize(worker)
     @worker  = worker
     @channel = nil
-    @pid = nil
+    @pid     = nil
     unless @worker.respond_to?(:call)
       raise ArgumentError,
             "Expected worker to implement #{@worker.class}#call"
@@ -80,34 +89,14 @@ class IProcess
   end
 
   #
-  # @param [#recv] obj
-  #   An object that will receive messages.
-  #
-  # @return [void]
-  #
-  def report_to(obj)
-    thr = Thread.new do
-      Process.wait @pid
-      obj.recv @channel.recv
-    end
-    pid = Process.pid
-    at_exit do
-      is_parent = pid == Process.pid
-      if is_parent && thr.alive?
-        thr.join
-      end
-    end
-  end
-
-  #
-  # Executes a subprocess.
+  # Executes a unit of work in a subprocess.
   #
   # @return [Fixnum]
   #   The process ID of the spawned subprocess.
   #
   def execute
     @channel = IChannel.new IProcess.serializer
-    @pid = fork { @channel.put(@worker.call) }
+    @pid = fork { @channel.write(@worker.call) }
   end
 
   #
@@ -116,6 +105,6 @@ class IProcess
   #
   def result
     Process.wait(@pid)
-    @channel.get
+    @channel.recv
   end
 end

data/lib/iprocess/version.rb

@@ -1,3 +1,3 @@
 class IProcess
-  VERSION = '4.0.0'
+  VERSION = '5.0.0'
 end

data/test/setup.rb

@@ -1,3 +1,5 @@
 require 'iprocess'
 require 'test/unit'
-require 'minitest/mock'
+Dir["test/*.rb", "test/support/*.rb"].each do |test|
+  require "./#{test}"
+end

data/test/support/inbox_class.rb

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

data/test/test_IProcess_class.rb

@@ -1,25 +1,24 @@
-require_relative "setup"
+require_relative 'setup'
 class IProcessTest < Test::Unit::TestCase
-  def test_serializer_default_value
-    assert_equal Marshal, IProcess.serializer
+  def test_spawn
+    results = IProcess.spawn(2) { :ok }
+    assert_equal [:ok, :ok], results
   end
 
-  def test_block_worker
-    messages = IProcess.spawn(2) { :hello }
-    assert_equal [:hello, :hello], messages
-  end
-
-  def test_duck_typed_worker 
-    messages = IProcess.spawn 2, worker.new
-    assert_equal [:hello, :hello], messages
-  end
-
-private
-  def worker
-    Class.new do
+  def test_spawn_with_non_proc_worker
+    klass = Class.new do
       def call
-        :hello
+        :ok
       end
     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
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprocess
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2013-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ichannel
@@ -91,7 +91,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: IProcess makes InterProcess Communication(IPC) easy.
+description: A number of abstractions on top of spawning subprocesses and interprocess
+  communication.
 email: rob@flowof.info
 executables: []
 extensions: []
@@ -110,6 +111,7 @@ files:
 - lib/iprocess.rb
 - lib/iprocess/version.rb
 - test/setup.rb
+- test/support/inbox_class.rb
 - test/test_IProcess_class.rb
 homepage: https://github.com/robgleeson/iprocess
 licenses: []
@@ -134,8 +136,10 @@ rubyforge_project: ! '[none]'
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: IProcess makes InterProcess Communication(IPC) easy.
+summary: A number of abstractions on top of spawning subprocesses and interprocess
+  communication.
 test_files:
 - test/setup.rb
+- test/support/inbox_class.rb
 - test/test_IProcess_class.rb
 has_rdoc: