iprocess 1.0.0

data/.gitignore

@@ -0,0 +1,8 @@
+.baretest_*
+docs/*
+doc/*
+.yardoc/*
+.DS_Store
+*.gem
+*.rbc
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm: 
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - ruby-head
+
+notifications:
+  irc: "irc.freenode.org#flowof.info"
+  recipients:
+    - rob@flowof.info

data/.yardopts

@@ -0,0 +1,8 @@
+-m markdown
+--no-private
+--hide-void-return
+--no-cache
+- 
+LICENSE.txt
+ChangeLog
+

data/Gemfile

@@ -0,0 +1,3 @@
+# This file is for Travis (travis-ci.org).
+source :rubygems
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Robert Gleeson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,84 @@
+__OVERVIEW__
+
+
+| Project         | IProcess    
+|:----------------|:--------------------------------------------------
+| Homepage        | https://github.com/robgleeson/iprocess
+| Documentation   | http://rubydoc.info/gems/iprocess/frames 
+| Author          | Rob Gleeson             
+
+
+__DESCRIPTION__
+
+  IProcess, short for _Inter Process Communication(IPC) Process_, is a    
+  Domain Specific Language(DSL) that can be used to share Ruby objects     
+  between processes on UNIX-like operating systems. The README covers the   
+  basics, and there is the API documentation for everything else.
+
+  This project was formerly known as 'Barney'.
+
+__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.
+
+
+__EXAMPLES__
+
+__1.__
+
+Sequential in nature (each subprocess must finish before another can execute):
+
+    name = "rob"
+
+    IProcess.new do
+      share :name
+      
+      fork do 
+        name.capitalize!
+      end
+    end
+
+    p name # => "Rob"
+    
+__2.__
+
+A subprocess is spawned 5 times, in parallel:
+
+    workload = IProcess::Job.spawn(5) do
+      # Replace this with heavily CPU-bound code ;-) 
+      1 + 1
+    end
+
+    p workload # [2, 2, 2, 2, 2]
+
+__PLATFORM SUPPORT__
+
+_supported_
+
+  * Rubinius (1.9 mode) 
+  * CRuby (1.9)
+
+_unsupported_
+  
+  * CRuby 1.8
+  * MacRuby
+  * JRuby
+
+__INSTALL__
+
+  gem install iprocess
+
+__LICENSE__
+
+  
+  See LICENSE.txt
+
+
+ 

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+desc 'Run test suite.'
+task :test do
+  $LOAD_PATH.unshift './lib'
+  require './test/setup'
+end
+
+task :default => :test
+

data/iprocess.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift './lib'
+require 'iprocess/version'
+
+Gem::Specification.new do |s|
+  s.name         = 'iprocess'
+  s.version      = IProcess::VERSION
+  s.authors      = ["Rob Gleeson"]
+  s.email        = 'rob@flowof.info'
+  s.homepage     = 'https://github.com/robgleeson/iprocess'
+  s.summary      = 'A Domain Specific Language(DSL) for sharing Ruby objects' \
+                   'between processes on UNIX-like operating systems.'  
+  s.description  = s.summary
+
+  s.files        = `git ls-files`.each_line.map(&:chomp)
+  s.test_files   = Dir.glob "test/**/*.rb"
+
+  s.platform                  = Gem::Platform::RUBY
+  s.require_path              = 'lib'
+  s.rubyforge_project         = '[none]'
+  s.required_rubygems_version = '>= 1.3.6'
+  s.required_ruby_version     = '~> 1.9.1'
+
+  s.add_development_dependency 'yard'     , '~> 0.7'
+  s.add_development_dependency 'redcarpet', '~> 1.17' 
+  s.add_development_dependency 'minitest' , '~> 2.6'
+  s.add_development_dependency 'rake'     , '~> 0.9.2'
+end

data/lib/iprocess/channel.rb

@@ -0,0 +1,44 @@
+class IProcess::Channel
+
+  attr_reader :name
+
+  #
+  # @yieldparam [IProcess::Channel] _self
+  #   Yields self.
+  #
+  def initialize name = nil
+    @reader, @writer = IO.pipe
+    @name = name
+
+    if block_given?
+      yield self
+    end
+  end
+
+  #
+  # Write a object to the channel.
+  #
+  # @param [Object] object
+  #   A object to add to the channel.
+  #
+  def write object
+    @reader.close
+    @writer.write Marshal.dump(object)
+    @writer.close
+  end
+
+  #
+  # Receive a object from the channel.
+  #
+  # @return [Object]
+  #   The object added to the channel.
+  #
+  def recv
+    @writer.close
+    obj = Marshal.load(@reader.read)
+    @reader.close
+    obj
+  end
+
+end
+

data/lib/iprocess/delegate.rb

@@ -0,0 +1,55 @@
+class IProcess::Delegate
+
+  #
+  # @param [IProcess] delegate
+  #   An instance of {IProcess}.
+  #
+  def initialize delegate
+    @__delegate__ = delegate
+  end
+
+  #
+  # @param
+  #   (see IProcess#share)
+  #
+  # @return
+  #   (see IProcess#share)
+  #
+  def share *args
+    @__delegate__.share *args
+  end
+
+  #
+  # @param
+  #   (see IProcess#unshare)
+  #
+  # @return
+  #   (see IProcess#unshare)
+  #
+  def unshare *args
+    @__delegate__.unshare *args
+  end
+
+  #
+  # @return
+  #   (see IProcess#variables)
+  #
+  def variables
+    @__delegate__.variables
+  end
+
+  #
+  # @param
+  #   (see IProcess#fork)
+  #
+  # @raise
+  #   (see IProcess#fork)
+  #
+  # @return
+  #   (see IProcess#fork)
+  #
+  def fork(&block)
+    @__delegate__.fork(&block)
+  end
+
+end

data/lib/iprocess/job.rb

@@ -0,0 +1,70 @@
+class IProcess::Job
+
+  #
+  # Spawn one or more jobs to be run in parallel.
+  #
+  # @param [Integer] number_of_jobs
+  #   The number of jobs to spawn.
+  #
+  # @param [Proc] worker
+  #   The unit of work to execute in one or more jobs.
+  #
+  # @return [Array<Object>]
+  #   The return value of one or more workers.
+  #
+  def self.spawn number_of_jobs = 1, &worker
+    jobs =
+    Array.new(number_of_jobs) do
+      job = IProcess::Job.new(&worker)
+      job.execute
+      job
+    end
+
+    jobs.map do |job|
+      job.result
+    end
+  end
+
+  #
+  # @param [Proc] worker
+  #   The unit of work to execute in a subprocess.
+  #
+  # @raise [ArgumentError]
+  #   If a worker is not given.
+  #
+  # @return [IProcess::Job]
+  #   Returns self.
+  #
+  def initialize &worker
+    unless block_given?
+      raise ArgumentError, 'No block given.'
+    end
+
+    @worker  = worker
+    @channel = nil
+    @pid     = nil
+  end
+
+  #
+  # Executes a unit of work in a subprocess.
+  #
+  # @return [Fixnum]
+  #   The process ID of the spawned subprocess.
+  #
+  def execute
+    @channel = IProcess::Channel.new
+    @pid = fork { @channel.write(@worker.call) }
+  end
+
+  #
+  # @return [Object]
+  #   Returns the return value of the unit of work.
+  #
+  def result
+    Process.wait(@pid)
+    @channel.recv
+  end
+
+end
+
+

data/lib/iprocess/version.rb

@@ -0,0 +1,3 @@
+class IProcess
+  VERSION = '1.0.0'
+end

data/lib/iprocess.rb

@@ -0,0 +1,97 @@
+class IProcess
+
+  #
+  # @return [IProcess]
+  #
+  def initialize &block
+    @variables = SortedSet.new
+
+    if block_given?
+      @scope = block.binding
+      IProcess::Delegate.new(self).instance_eval(&block)
+    else
+      @scope = nil
+    end
+  end
+
+  #
+  # @return [Array<Symbol>]
+  #   Returns a list of shared variables.
+  #
+  def variables
+    @variables.to_a
+  end
+
+  #
+  # Marks a variable or constant to be shared between two processes.
+  #
+  # @param [Array<#to_sym>] variables
+  #   Accepts the name(s) of the variables or constants to share.
+  #
+  # @return [Array<Symbol>]
+  #   Returns a list of all variables that are being shared.
+  #
+  def share *variables
+    @variables.merge variables.map(&:to_sym)
+    @variables.to_a
+  end
+
+  #
+  # Removes a variable or constant from being shared between two processes.
+  #
+  # @param [Array<#to_sym>] variables
+  #   Accepts the name(s) of the variables or constants to stop sharing.
+  #
+  # @return [Array<Symbol>]
+  #   Returns a list of the variables that are still being shared.
+  #
+  def unshare *variables
+    @variables.subtract variables.map(&:to_sym)
+    @variables.to_a
+  end
+
+  #
+  # Spawns a subprocess.
+  # The subprocess is waited on via Process.wait().
+  #
+  # @param [Proc] &block
+  #   A block executed within a subprocess.
+  #
+  # @raise [ArgumentError]
+  #   If no block is given.
+  #
+  # @return [Fixnum]
+  #   The Process ID(PID) of the subprocess.
+  #
+  def fork &block
+    unless block_given?
+      raise ArgumentError, "No block given."
+    end
+
+    scope = @scope || block.binding
+    channels = @variables.map { |name| IProcess::Channel.new(name) }
+
+    pid = Kernel.fork do
+      scope.eval("self").instance_eval(&block)
+      channels.each do |channel|
+        channel.write scope.eval(channel.name.to_s)
+      end
+    end
+
+    Process.wait(pid)
+
+    channels.each do |channel|
+      Thread.current[:__iprocess_obj__] = channel.recv
+      scope.eval("#{channel.name} = Thread.current[:__iprocess_obj__]")
+    end
+
+    pid
+  end
+
+end
+
+require 'set'
+require 'iprocess/version'
+require 'iprocess/channel'
+require 'iprocess/job'
+require 'iprocess/delegate'

data/test/setup.rb

@@ -0,0 +1,9 @@
+require 'iprocess'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+alias :context :describe
+
+Dir.glob("test/*.rb").each do |test|
+  require "./#{test}"
+end

data/test/test_IProcess_Job_class.rb

@@ -0,0 +1,9 @@
+context IProcess::Job do
+  context 'spawn' do
+    it 'must spawn two workers and return the result of each.' do
+      topic = IProcess::Job.spawn(2) { :ok }
+      topic.must_equal([:ok, :ok])
+    end
+  end
+end
+

data/test/test_IProcess_class.rb

@@ -0,0 +1,95 @@
+context IProcess do
+
+  context 'initialize' do
+    it 'must call block if given.' do
+      mock = MiniTest::Mock.new
+      mock.expect :ok
+
+      IProcess.new do
+        mock.ok
+      end
+    end
+  end
+
+  context 'share' do
+    it 'must share a variable.' do
+      IProcess.new do
+        share :a
+        variables.must_equal [:a]
+      end
+    end
+
+    it "must not store duplicate variables" do
+      IProcess.new do
+        share :a, :a
+        variables.must_equal [:a]
+      end
+    end
+  end
+
+  context 'unshare' do
+    it "must unshare a variable." do
+      IProcess.new do
+        share :a
+        unshare :a
+        variables.must_be_empty
+      end
+    end
+  end
+
+  context 'fork' do
+    it 'must return the PID on success.' do
+      pid = IProcess.new.fork { }
+      assert_equal Fixnum, pid.class
+    end
+
+    it 'must raise a ArgumentError if a block is not given.' do
+      assert_raises ArgumentError do
+        IProcess.new.fork
+      end
+    end
+
+    it 'must synchronize a shared variable.' do
+      variable = :o_O
+
+      IProcess.new do
+        share :variable
+        fork { variable = :ok }
+      end
+
+      variable.must_equal(:ok)
+    end
+
+    it 'must synchronize two shared variables.' do
+      variable1 = :o_O
+      variable2 = :UnF
+
+      IProcess.new do
+        share :variable1, :variable2
+        fork do
+          variable1 = 123
+          variable2 = 456
+        end
+      end
+
+      variable1.must_equal(123)
+      variable2.must_equal(456)
+    end
+
+    it 'must synchronize a instance variable.' do
+      @ivar = :o_O
+
+      IProcess.new do
+        share :@ivar
+
+        fork do
+          @ivar = :ok
+        end
+      end
+
+      @ivar.must_equal(:ok)
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: iprocess
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Rob Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70132214923240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70132214923240
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70132214921700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: *70132214921700
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70132214920640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70132214920640
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70132214919640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70132214919640
+description: A Domain Specific Language(DSL) for sharing Ruby objectsbetween processes
+  on UNIX-like operating systems.
+email: rob@flowof.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- iprocess.gemspec
+- lib/iprocess.rb
+- lib/iprocess/channel.rb
+- lib/iprocess/delegate.rb
+- lib/iprocess/job.rb
+- lib/iprocess/version.rb
+- test/setup.rb
+- test/test_IProcess_Job_class.rb
+- test/test_IProcess_class.rb
+homepage: https://github.com/robgleeson/iprocess
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ! '[none]'
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Domain Specific Language(DSL) for sharing Ruby objectsbetween processes
+  on UNIX-like operating systems.
+test_files:
+- test/setup.rb
+- test/test_IProcess_class.rb
+- test/test_IProcess_Job_class.rb
+has_rdoc: