iprocess 1.0.1 → 1.0.2

data/README.md

@@ -4,7 +4,7 @@ __OVERVIEW__
 | Project         | IProcess    
 |:----------------|:--------------------------------------------------
 | Homepage        | https://github.com/robgleeson/IProcess
-| Documentation   | http://rubydoc.info/gems/IProcess/frames 
+| Documentation   | http://rubydoc.info/gems/iprocess/frames 
 | Author          | Rob Gleeson             
 
 
@@ -21,13 +21,21 @@ __WHY?__
 
 I wanted to be able to:  
 
-* Spawn a subprocess, apply restrictions to that subprocess, then collect   
-  and send Ruby objects back  to the parent process.  
-  (that was for a IRC bot evaluating Ruby code).
-
-* Spawn multiple parallel jobs, then collect and send back Ruby objects to the  
-  parent process.
+* Share Ruby objects between a subprocess and its parent process.
+* Share Ruby objects between multiple subprocesses running in parallel and their parent.  
 
+ 
+__COST?__
+     
+  If you're using IProcess for parallelism, a subprocess will cost you more than   
+  a thread (in terms of time to create the subprocess, and the memory it consumes   
+  - no implementation IProcess supports has a CoW-friendly garbage collector).  
+
+  Despite the GIL on CRuby, for IO bound operations it can run threads in  
+  parallel and may perform better. For long running non-IO bound operations,  
+  though, parallel subprocesses usually outperform CRuby threads. You should   
+  profile and benchmark IProcess and threads for your use-case before choosing   
+  either. IProcess may be better, or it may be worse.  
 
 __EXAMPLES__
 

data/lib/iprocess/channel.rb

@@ -15,6 +15,26 @@ class IProcess::Channel
     end
   end
 
+  #
+  # Is the channel closed?
+  #
+  # @return [Boolean]
+  #   Returns true if the channel is closed.
+  #
+  def closed?
+    @reader.closed? && @writer.closed?
+  end
+
+  #
+  # Is the channel open?
+  #
+  # @return [Boolean]
+  #   Returns true if the channel is open.
+  #
+  def open?
+    !closed?
+  end
+
   #
   # Write a object to the channel.
   #
@@ -22,9 +42,11 @@ class IProcess::Channel
   #   A object to add to the channel.
   #
   def write object
-    @reader.close
-    @writer.write Marshal.dump(object)
-    @writer.close
+    if open?
+      @reader.close
+      @writer.write Marshal.dump(object)
+      @writer.close
+    end
   end
 
   #
@@ -34,10 +56,12 @@ class IProcess::Channel
   #   The object added to the channel.
   #
   def recv
-    @writer.close
-    obj = Marshal.load(@reader.read)
-    @reader.close
-    obj
+    if open?
+      @writer.close
+      obj = Marshal.load(@reader.read)
+      @reader.close
+      obj
+    end
   end
 
 end

data/lib/iprocess/{delegate.rb → delegator.rb}

@@ -1,4 +1,4 @@
-class IProcess::Delegate
+class IProcess::Delegator
 
   #
   # @param [IProcess] delegate

data/lib/iprocess/job.rb

@@ -1,21 +1,25 @@
 class IProcess::Job
 
   #
-  # Spawn one or more jobs to be run in parallel.
+  # @overload spawn(number_of_jobs = 1, worker)
   #
-  # @param [Integer] number_of_jobs
-  #   The number of jobs to spawn.
+  #   Spawn one or more jobs to be run in parallel.
   #
-  # @param [Proc] worker
-  #   The unit of work to execute in one or more jobs.
+  #   @param [Integer] number_of_jobs
+  #     The number of jobs to spawn.
   #
-  # @return [Array<Object>]
-  #   The return value of one or more workers.
+  #   @param [#call] worker
+  #     The unit of work to execute in one or more jobs.
   #
-  def self.spawn number_of_jobs = 1, &worker
+  #   @return [Array<Object>]
+  #     The return value of one or more workers.
+  #
+  def self.spawn number_of_jobs = 1, obj = nil, &worker
+    worker = obj || worker
+
     jobs =
     Array.new(number_of_jobs) do
-      job = IProcess::Job.new(&worker)
+      job = IProcess::Job.new(worker)
       job.execute
       job
     end
@@ -26,7 +30,7 @@ class IProcess::Job
   end
 
   #
-  # @param [Proc] worker
+  # @param [#call] worker
   #   The unit of work to execute in a subprocess.
   #
   # @raise [ArgumentError]
@@ -35,14 +39,15 @@ class IProcess::Job
   # @return [IProcess::Job]
   #   Returns self.
   #
-  def initialize &worker
-    unless block_given?
-      raise ArgumentError, 'No block given.'
-    end
-
+  def initialize worker
     @worker  = worker
     @channel = nil
     @pid     = nil
+
+    unless @worker.respond_to?(:call)
+      raise ArgumentError,
+            "Expected worker to implement #{@worker.class}#call"
+    end
   end
 
   #

data/lib/iprocess/version.rb

@@ -1,3 +1,3 @@
 class IProcess
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/iprocess.rb

@@ -5,12 +5,11 @@ class IProcess
   #
   def initialize &block
     @variables = SortedSet.new
+    @scope = nil
 
     if block_given?
       @scope = block.binding
-      IProcess::Delegate.new(self).instance_eval(&block)
-    else
-      @scope = nil
+      IProcess::Delegator.new(self).instance_eval(&block)
     end
   end
 
@@ -85,6 +84,7 @@ class IProcess
       scope.eval("#{channel.name} = Thread.current[:__iprocess_obj__]")
     end
 
+    Thread.current[:__iprocess_obj__] = nil
     pid
   end
 
@@ -94,4 +94,4 @@ require 'set'
 require 'iprocess/version'
 require 'iprocess/channel'
 require 'iprocess/job'
-require 'iprocess/delegate'
+require 'iprocess/delegator'

data/test/test_IProcess_Job_class.rb

@@ -4,6 +4,30 @@ context IProcess::Job do
       topic = IProcess::Job.spawn(2) { :ok }
       topic.must_equal([:ok, :ok])
     end
+
+    it 'must spawn non-Proc workers and return the result of each.' do
+      worker = Class.new do
+        def call
+          :ok
+        end
+      end
+
+      topic = IProcess::Job.spawn(2, worker.new)
+      topic.must_equal([:ok, :ok])
+    end
+
+    it 'must accept any object responding to #call.' do
+      mock = MiniTest::Mock.new
+      mock.expect(:call, :ok)
+
+      IProcess::Job.spawn(1, mock)
+    end
+  end
+
+  context 'initialize' do
+    it "must raise a ArgumentError if not given a object responding to #call" do
+      proc { IProcess::Job.new("") }.must_raise(ArgumentError)
+    end
   end
 end
 

data/test/test_IProcess_class.rb

@@ -44,8 +44,10 @@ context IProcess do
     end
 
     it 'must raise a ArgumentError if a block is not given.' do
+      obj = IProcess.new
+
       assert_raises ArgumentError do
-        IProcess.new.fork
+        obj.fork
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprocess
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-09 00:00:00.000000000 Z
+date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70367004931520 !ruby/object:Gem::Requirement
+  requirement: &70154156887500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70367004931520
+  version_requirements: *70154156887500
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70367004931060 !ruby/object:Gem::Requirement
+  requirement: &70154156887040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.17'
   type: :development
   prerelease: false
-  version_requirements: *70367004931060
+  version_requirements: *70154156887040
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70367004930600 !ruby/object:Gem::Requirement
+  requirement: &70154156886580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70367004930600
+  version_requirements: *70154156886580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70367004930140 !ruby/object:Gem::Requirement
+  requirement: &70154156886120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70367004930140
+  version_requirements: *70154156886120
 description: A Domain Specific Language(DSL) for sharing Ruby objectsbetween processes
   on UNIX-like operating systems.
 email: rob@flowof.info
@@ -73,7 +73,7 @@ files:
 - iprocess.gemspec
 - lib/iprocess.rb
 - lib/iprocess/channel.rb
-- lib/iprocess/delegate.rb
+- lib/iprocess/delegator.rb
 - lib/iprocess/job.rb
 - lib/iprocess/version.rb
 - test/setup.rb