iprocess 2.0.2 → 2.1.0

data/README.md

@@ -12,10 +12,14 @@ __DESCRIPTION__
 
   IProcess, short for _Inter Process Communication(IPC) Process_, is a collection 
   of classes you can use to transport Ruby objects between processes running on 
-  UNIX-like operating systems. 
+  UNIX-like operating systems.  
+
 
 __EXAMPLES__
 
+The first two examples(one & two) are using the synchronous APIs, a little below
+those(3) demos the asynchronous API.
+
 __1.__
 
 A single subprocess is spawned:
@@ -40,6 +44,19 @@ subprocesses you can spawn is variable (5, in this example):
 
     IProcess.spawn(5, Worker.new) # => [2, 2, 2, 2, 2]
 
+__3.__
+
+A single subprocess is spawned asynchronously.  
+When the subprocess completes, ':hi' is sent to `obj#recv` from another thread.
+
+  obj = Object.new
+  def obj.recv(msg)
+    msg.to_s.captialize!
+  end
+
+  jobs = IProcess.spawn! { :hi }
+  jobs.map { |job| job.defer(listener) }
+
 
 __PLATFORM SUPPORT__
 

data/lib/iprocess/channel.rb

@@ -1,14 +1,11 @@
 class IProcess::Channel
 
-  attr_reader :name
-
   #
   # @yieldparam [IProcess::Channel] _self
   #   Yields self.
   #
-  def initialize name = nil
+  def initialize
     @reader, @writer = IO.pipe
-    @name = name
 
     if block_given?
       yield self
@@ -65,4 +62,3 @@ class IProcess::Channel
   end
 
 end
-

data/lib/iprocess/version.rb

@@ -1,3 +1,3 @@
 class IProcess
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 end

data/lib/iprocess.rb

@@ -1,35 +1,49 @@
 class IProcess
-
   require_relative 'iprocess/version'
   require_relative 'iprocess/channel'
   
-  #
-  # @overload spawn(number_of = 1, worker)
-  #
-  #   Spawn one or more subprocesses.
-  #
-  #   @param [Integer] number_of
-  #     The number of subprocesses to spawn.
-  #
-  #   @param [#call] worker
-  #     The unit of work to execute in a subprocess.
-  #
-  #   @return [Array<Object>]
-  #     The return value of the unit if worker.
-  #
-  def self.spawn(number_of = 1, obj = nil, &worker)
-    worker = obj || worker
+  class << self
+    #
+    # @overload spawn(number_of = 1, worker)
+    #
+    #   Spawn one or more subprocesses.
+    #
+    #   @param [Integer] number_of
+    #     The number of subprocesses to spawn.
+    #
+    #   @param [#call] worker
+    #     The unit of work to execute in a subprocess.
+    #
+    #   @return [Array<Object>]
+    #     The return value of the unit if worker.
+    #
+    def spawn(*args, &worker)
+      fork(*args, &worker).map(&:result)
+    end
 
-    jobs =
-    Array.new(number_of) do
-      job = IProcess.new(worker)
-      job.execute
-      job
+    #
+    # @overload
+    #   
+    #   Spawn one or more subprocesses asynchronously.
+    #
+    #   @param
+    #     (see IProcess.spawn)
+    #
+    #   @return [Array<IProcess>]
+    #     An array of IProcess objects. See {#defer}.
+    #
+    def spawn!(*args, &worker)
+      fork *args, &worker
     end
+  
+    def fork(number_of = 1, obj = nil, &worker)
+      worker = obj || worker
 
-    jobs.map do |job|
-      job.result
+      Array.new(number_of) do
+        IProcess.new(worker).tap { |job| job.execute }
+      end
     end
+    private :fork
   end
 
   #
@@ -53,6 +67,19 @@ class IProcess
     end
   end
 
+  #
+  # @param [#recv] listener
+  #   The listener.
+  #
+  # @return [void]
+  #
+  def defer(listener)
+    Thread.new do
+      Process.wait @pid
+      listener.recv @channel.recv
+    end
+  end
+
   #
   # Executes a unit of work in a subprocess.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprocess
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2012-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &12607260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *12607260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &12606780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '1.17'
   type: :development
   prerelease: false
-  version_requirements: *12606780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &12606220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *12606220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &12605720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +69,12 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *12605720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 description: A set of classes you can use to transport ruby objects between processes
   on UNIX-like operating systems.
 email: rob@flowof.info
@@ -96,12 +116,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: ! '[none]'
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A set of classes you can use to transport ruby objects between processes
   on UNIX-like operating systems.
 test_files:
-- test/test_IProcess_class.rb
 - test/setup.rb
+- test/test_IProcess_class.rb
 has_rdoc: