iprocess 3.0.1 → 3.0.2

data/README.md

@@ -10,12 +10,12 @@ __OVERVIEW__
 
 __DESCRIPTION__
 
-  The purpose of IProcess is to allow you, the developer, run units of work
-  in parallel to each other. If you were to get down to implementation details
-  you'd see I'm using Kernel#fork to spawn subproccesses that dispatch a unit of 
-  work. As a bonus the parent process can collect the return value of each unit 
-  of work as long as it is serializable (i.e: Marshal can dump & load it).  
- 
+  IProcess makes InterProcess Communication(IPC) easy by providing a number of 
+  abstractions on top of spawning subprocesses and interprocess communication.
+  It has a simple and easy to use API that supports synchronous and asynchronous
+  method calls plus a few other useful features that will become
+  obvious in the examples below. :-)
+
 __EXAMPLES__
 
 The first two examples(one & two) are using the synchronous APIs, a little below
@@ -23,15 +23,16 @@ those(3) demos the asynchronous API.
 
 __1.__
 
-A single subprocess is spawned:
+A subprocess is spawned:
   
-    message = IProcess.spawn { [:yes, :no] }
-    p message # => [[:yes, :no]]
+    messages = IProcess.spawn { {msg: "hello"} }
+    p messages # => [{msg: "hello"}]
 
 __2.__
 
-A unit of work does not need to be a block, though, and the number of 
-subprocesses you can spawn is variable (5, in this example):
+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:
 
     class Worker
       def initialize
@@ -42,21 +43,24 @@ subprocesses you can spawn is variable (5, in this example):
         @num + 1
       end
     end
-
     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.
+A subprocess is spawned asynchronously. 
 
-    obj = Object.new
-    def obj.recv(msg)
-      msg.to_s.capitalize!
-    end
+    class Inbox
+      def initialize
+        @messages = []
+      end
 
-    jobs = IProcess.spawn! { :hi }
-    jobs.map { |job| job.report_to(obj) }
+      def recv(msg)
+        @messages << msg
+      end
+    end
+    inbox = Inbox.new
+    jobs = IProcess.spawn! { Process.pid }
+    jobs.map { |job| job.report_to(inbox) }
 
 
 __PLATFORM SUPPORT__
@@ -72,6 +76,10 @@ _unsupported_
   * MacRuby
   * JRuby
 
+__LICENSE__
+
+MIT. See LICENSE.txt.
+
 __INSTALL__
 
-gem install iprocess
+    $ gem install iprocess

data/iprocess.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.authors      = ["Rob Gleeson"]
   s.email        = 'rob@flowof.info'
   s.homepage     = 'https://github.com/robgleeson/iprocess'
-  s.summary      = 'Transport Ruby objects between processes on UNIX-like operating systems'
+  s.summary      = 'IProcess makes InterProcess Communication(IPC) easy.'
   s.description  = s.summary
 
   s.files        = `git ls-files`.each_line.map(&:chomp)

data/lib/iprocess/version.rb

@@ -1,3 +1,3 @@
 class IProcess
-  VERSION = '3.0.1'
+  VERSION = '3.0.2'
 end

data/lib/iprocess.rb

@@ -6,7 +6,7 @@ class IProcess
     #
     # @overload spawn(number_of = 1, worker)
     #
-    #   Spawn one or more subprocesses.
+    #   Spawn one or more unit(s) of work.
     #
     #   @param [Integer] number_of
     #     The number of subprocesses to spawn.
@@ -24,7 +24,7 @@ class IProcess
     #
     # @overload
     #   
-    #   Spawn one or more subprocesses asynchronously.
+    #   Spawn one or more unit(s) of work asynchronously.
     #
     #   @param
     #     (see IProcess.spawn)
@@ -38,7 +38,6 @@ class IProcess
   
     def fork(number_of = 1, obj = nil, &worker)
       worker = obj || worker
-
       Array.new(number_of) do
         IProcess.new(worker).tap { |job| job.execute }
       end
@@ -51,7 +50,7 @@ class IProcess
   #   The unit of work to execute in a subprocess.
   #
   # @raise [ArgumentError]
-  #   If a worker is not given.
+  #   If a worker does not respond to _#call_.
   #
   # @return [IProcess]
   #   Returns self.
@@ -60,7 +59,6 @@ class IProcess
     @worker  = worker
     @channel = nil
     @pid     = nil
-
     unless @worker.respond_to?(:call)
       raise ArgumentError,
             "Expected worker to implement #{@worker.class}#call"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprocess
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -75,7 +75,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
-description: Transport Ruby objects between processes on UNIX-like operating systems
+description: IProcess makes InterProcess Communication(IPC) easy.
 email: rob@flowof.info
 executables: []
 extensions: []
@@ -118,7 +118,7 @@ rubyforge_project: ! '[none]'
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Transport Ruby objects between processes on UNIX-like operating systems
+summary: IProcess makes InterProcess Communication(IPC) easy.
 test_files:
 - test/setup.rb
 - test/test_IProcess_class.rb