iprocess 3.0.2 → 3.1.0

data/README.md

@@ -10,11 +10,10 @@ __OVERVIEW__
 
 __DESCRIPTION__
 
-  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. :-)
+  Provides 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 one or two other useful features shown in the 
+  examples below.
 
 __EXAMPLES__
 
@@ -23,10 +22,12 @@ those(3) demos the asynchronous API.
 
 __1.__
 
-A subprocess is spawned:
+Three subprocesses are spawned. The return value of the block, even though executed 
+in a subprocess, is returned to the parent process as long as it may be serialized 
+by Marshal:
   
-    messages = IProcess.spawn { {msg: "hello"} }
-    p messages # => [{msg: "hello"}]
+    messages = IProcess.spawn(3) { {msg: "hello"} }
+    p messages # => [{msg: "hello"}, {msg: "hello"}, {msg: "hello"}]
 
 __2.__
 
@@ -62,6 +63,13 @@ A subprocess is spawned asynchronously.
     jobs = IProcess.spawn! { Process.pid }
     jobs.map { |job| job.report_to(inbox) }
 
+__SERIALIZERS__
+
+A serializer is any object that implements load & dump. 
+You can choose what serializer you'd like to use through 
+the `IProcess.serializer=` method:
+
+    IProcess.serializer = JSON
 
 __PLATFORM SUPPORT__
 

data/lib/iprocess/channel.rb

@@ -1,12 +1,16 @@
 class IProcess::Channel
 
+  #
+  # @param [#dump,#load}] serializer
+  #   Any object that implements dump, & load.
+  #   Defaults to {IProcess.serializer}.
   #
   # @yieldparam [IProcess::Channel] _self
   #   Yields self.
   #
-  def initialize
+  def initialize(serializer = IProcess.serializer) 
     @reader, @writer = IO.pipe
-
+    @serializer = serializer 
     if block_given?
       yield self
     end
@@ -41,7 +45,7 @@ class IProcess::Channel
   def write object
     if open?
       @reader.close
-      @writer.write Marshal.dump(object)
+      @writer.write @serializer.dump(object)
       @writer.close
     end
   end
@@ -55,7 +59,7 @@ class IProcess::Channel
   def recv
     if open?
       @writer.close
-      obj = Marshal.load(@reader.read)
+      obj = @serializer.load @reader.read
       @reader.close
       obj
     end

data/lib/iprocess/version.rb

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

data/lib/iprocess.rb

@@ -3,6 +3,23 @@ class IProcess
   require_relative 'iprocess/channel'
   
   class << self
+    #
+    # @return [#load,#dump]
+    #   Returns the serializer used by IProcess.
+    #
+    def serializer 
+      @serializer || Marshal
+    end
+
+    #
+    # @param [#load,#dump] obj
+    #   Any object that implements #load, & #dump.
+    #   Examples could be JSON & Marshal.
+    #
+    def serializer=(obj)
+      @serializer = obj
+    end
+
     #
     # @overload spawn(number_of = 1, worker)
     #
@@ -47,10 +64,10 @@ class IProcess
 
   #
   # @param [#call] worker
-  #   The unit of work to execute in a subprocess.
+  #   A block or any object that responds to #call.
   #
   # @raise [ArgumentError]
-  #   If a worker does not respond to _#call_.
+  #   If 'worker' does not respond to #call.
   #
   # @return [IProcess]
   #   Returns self.
@@ -58,7 +75,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"
@@ -67,7 +84,7 @@ class IProcess
 
   #
   # @param [#recv] obj
-  #   An object that will receive a msg.
+  #   An object that will receive messages.
   #
   # @return [void]
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprocess
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard