iprocess 3.1.2 → 3.2.0

data/.pryrc

@@ -0,0 +1 @@
+require "./lib/iprocess"

data/.yardopts

@@ -1,4 +1,5 @@
 -m markdown
+-M redcarpet
 --no-private
 --hide-void-return
 --no-cache

data/README.md

@@ -5,15 +5,16 @@ __OVERVIEW__
 |:----------------|:--------------------------------------------------
 | Homepage        | https://github.com/robgleeson/IProcess
 | Documentation   | http://rubydoc.info/gems/iprocess/frames 
+| CI              | [![Build Status](https://travis-ci.org/robgleeson/iprocess.png)](https://travis-ci.org/robgleeson/iprocess)
 | Author          | Rob Gleeson             
 
 
 __DESCRIPTION__
 
-  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.
+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__
 
@@ -59,7 +60,7 @@ A demo of how you would spawn two subprocesses asynchronously:
     end
     inbox = Inbox.new
     jobs = IProcess.spawn!(2) { Process.pid }
-    jobs.map { |job| job.report_to(inbox) }
+    jobs.each { |job| job.report_to(inbox) }
 
 __SERIALIZERS__
 
@@ -69,8 +70,8 @@ the `IProcess.serializer=` method:
 
     IProcess.serializer = JSON
 
-I know JSON & Marshal(the default) are supported out of 
-the box because they implement both of those methods. 
+I know JSON, YAML & Marshal(the default) are supported out of 
+the box because all of them implement both of those methods. 
 MessagePack does not however but you could easily write 
 a wrapper:
 

data/lib/iprocess.rb

@@ -1,66 +1,63 @@
 class IProcess
   require_relative 'iprocess/version'
   require_relative 'iprocess/channel'
-  
-  class << self
-    #
-    # @return [#load,#dump]
-    #   Returns the serializer used by IProcess.
-    #
-    def serializer 
-      @serializer || Marshal
-    end
+  #
+  # @return [#load,#dump]
+  #   Returns the serializer used by IProcess.
+  #
+  def self.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
+  #
+  # @param [#load,#dump] obj
+  #   Any object that implements #load, & #dump.
+  #   Examples could be JSON & Marshal.
+  #
+  def self.serializer=(obj)
+    @serializer = obj
+  end
 
-    #
-    # @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(s) of the unit(s) of work.
-    #     
-    def spawn(*args, &worker)
-      fork(*args, &worker).map(&:result)
-    end
+  #
+  # @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(s) of the unit(s) of work.
+  #     
+  def self.spawn(*args, &worker)
+    fork(*args, &worker).map(&:result)
+  end
 
-    #
-    # @overload
-    #   
-    #   Spawn one or more subprocesses asynchronously.
-    #
-    #   @param
-    #     (see IProcess.spawn)
-    #
-    #   @return [Array<IProcess>]
-    #     An array of IProcess objects. See {#report_to}.
-    #
-    def spawn!(*args, &worker)
-      fork *args, &worker
-    end
-  
-    def fork(number_of = 1, obj = nil, &worker)
-      worker = obj || worker
-      Array.new(number_of) do
-        IProcess.new(worker).tap { |job| job.execute }
-      end
+  #
+  # @overload
+  #   
+  #   Spawn one or more subprocesses asynchronously.
+  #
+  #   @param
+  #     (see IProcess.spawn)
+  #
+  #   @return [Array<IProcess>]
+  #     An array of IProcess objects. See {#report_to}.
+  #
+  def self.spawn!(*args, &worker)
+    fork *args, &worker
+  end
+
+  def self.fork(number_of = 1, obj = nil, &worker)
+    worker = obj || worker
+    Array.new(number_of) do
+      IProcess.new(worker).tap { |job| job.execute }
     end
-    private :fork
   end
+  private_class_method :fork
 
   #
   # @param [#call] worker
@@ -95,7 +92,8 @@ class IProcess
     end
     pid = Process.pid
     at_exit do
-      if pid == Process.pid && thr.alive?
+      is_parent = pid == Process.pid
+      if is_parent && thr.alive?
         thr.join
       end
     end

data/lib/iprocess/channel.rb

@@ -1,5 +1,5 @@
+require 'socket'
 class IProcess::Channel
-
   #
   # @param [#dump,#load}] serializer
   #   Any object that implements dump, & load.
@@ -9,7 +9,7 @@ class IProcess::Channel
   #   Yields self.
   #
   def initialize(serializer = IProcess.serializer) 
-    @reader, @writer = IO.pipe
+    @reader, @writer = UNIXSocket.pair :DGRAM
     @serializer = serializer 
     if block_given?
       yield self
@@ -17,7 +17,14 @@ class IProcess::Channel
   end
 
   #
-  # Is the channel closed?
+  # Close the channel.
+  #
+  # @return [void]
+  #
+  def close
+    [@reader.close,@writer.close]
+  end
+
   #
   # @return [Boolean]
   #   Returns true if the channel is closed.
@@ -26,8 +33,6 @@ class IProcess::Channel
     @reader.closed? && @writer.closed?
   end
 
-  #
-  # Is the channel open?
   #
   # @return [Boolean]
   #   Returns true if the channel is open.
@@ -37,18 +42,18 @@ class IProcess::Channel
   end
 
   #
-  # Write a object to the channel.
+  # Add an object to the channel.
   #
   # @param [Object] object
-  #   A object to add to the channel.
+  #   An object to add to the channel.
   #
   def write object
-    if open?
-      @reader.close
-      @writer.write @serializer.dump(object)
-      @writer.close
+    _, writable, _ = IO.select [], [@writer], [], 0.1
+    if writable
+      @writer.send @serializer.dump(object), 0
     end
   end
+  alias_method :put, :write
 
   #
   # Receive a object from the channel.
@@ -57,12 +62,11 @@ class IProcess::Channel
   #   The object added to the channel.
   #
   def recv
-    if open?
-      @writer.close
-      obj = @serializer.load @reader.read
-      @reader.close
-      obj
+    readable, _ = IO.select [@reader], [], [], 0.1
+    if readable
+      msg, _ = @reader.recvmsg
+      @serializer.load msg
     end
   end
-
+  alias_method :get, :recv
 end

data/lib/iprocess/version.rb

@@ -1,3 +1,3 @@
 class IProcess
-  VERSION = '3.1.2'
+  VERSION = '3.2.0'
 end

data/test/setup.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprocess
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -83,6 +83,7 @@ extra_rdoc_files: []
 files:
 - .gemtest
 - .gitignore
+- .pryrc
 - .travis.yml
 - .yardopts
 - Gemfile