ichannel 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  # UNIXSocket#recvmsg iz not implemented on Rubinius yet.
+  # - rbx-19mode
+
+notifications:
+  email: true 

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gem 'rake'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Robert Gleeson
+
+MIT License
+
+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,70 @@
+__OVERVIEW__
+
+
+| Project         | IChannel    
+|:----------------|:--------------------------------------------------
+| Homepage        | https://github.com/robgleeson/ichannel
+| Documentation   | http://rubydoc.info/gems/ichannel/frames 
+| CI              | [![Build Status](https://travis-ci.org/robgleeson/ichannel.png)](https://travis-ci.org/robgleeson/ichannel)
+| Author          | Robert Gleeson             
+
+
+__DESCRIPTION__
+
+Provides a modern and easy to use interprocess communication(IPC) primitive.
+It can be used to transport Ruby objects between Ruby processes running on the 
+same machine. The serialization options are flexible: any serializer that 
+implements `#dump` & `#load` can be used -- this covers Marshal, YAML, & JSON 
+out of the box but not MsgPack -- although you could easily write a wrapper 
+around msgpack.
+
+__EXAMPLES__
+
+__1.__
+
+The first example shows off how you'd pass Ruby objects through a channel.
+The serializer of choice is `Marshal` but it could just as easily be `JSON` or
+`YAML`.
+
+    channel = IChannel.new Marshal
+    channel.put 'hello'
+    channel.put 'goodbye'
+    pid = fork do 
+      channel.get # => 'hello'
+      channel.get # => 'goodbye'
+    end
+    Process.wait pid
+
+__REAL WORLD EXAMPLES__
+ 
+ I am using IChannel in a couple of my own personal projects:
+
+ - [IProcess](https://github.com/robgleeson/iprocess)  
+    Provides a number of abstractions on top of spawning subprocesses and 
+    interprocess communication. IChannel was born inside IProcess but later 
+    extracted into its own project when I realised it could be useful on its
+    own.
+
+ - [XPool](https://github.com/robgleeson/xpool)  
+    A UNIX(X) Process Pool.
+
+__PLATFORM SUPPORT__
+
+_supported_
+
+  * CRuby (1.9+)
+
+_unsupported_
+  
+  * CRuby 1.8
+  * MacRuby
+  * JRuby
+  * Rubinius (support for Rubinius will come sometime in the future).
+
+__INSTALL__
+
+    $ gem install ichannel
+
+__LICENSE__
+
+MIT. See LICENSE.txt.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+desc 'Run the test suite.'
+task :test do
+  $LOAD_PATH.unshift 'lib'
+  Dir["test/*_test.rb"].each do |file|
+    require_relative file
+  end
+end
+task :default => :test

data/ichannel.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require './lib/ichannel/version'
+Gem::Specification.new do |gem|
+  gem.name          = "ichannel"
+  gem.version       = IChannel::VERSION
+  gem.authors       = ["Robert Gleeson"]
+  gem.email         = ["rob@flowof.info"]
+  gem.description   = %q{A simple and modern interprocess communication 
+    primitive.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/robgleeson/ichannel"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/ichannel/version.rb

@@ -0,0 +1,3 @@
+class IChannel
+  VERSION = "1.0.0"
+end

data/lib/ichannel.rb

@@ -0,0 +1,65 @@
+require 'socket'
+class IChannel
+  #
+  # @param [#dump,#load}] serializer
+  #   Any object that implements dump, & load.
+  #   
+  def initialize(serializer) 
+    @reader, @writer = UNIXSocket.pair Socket::SOCK_DGRAM
+    @serializer = serializer 
+  end
+
+  #
+  # Close the channel.
+  #
+  # @return [void]
+  #
+  def close
+    [@reader.close,@writer.close]
+  end
+
+  #
+  # @return [Boolean]
+  #   Returns true if the channel is closed.
+  #
+  def closed?
+    @reader.closed? && @writer.closed?
+  end
+
+  #
+  # @return [Boolean]
+  #   Returns true if the channel is open.
+  #
+  def open?
+    !closed?
+  end
+
+  #
+  # Add an object to the channel.
+  #
+  # @param [Object] object
+  #   An object to add to the channel.
+  #
+  def write(object)
+    _, 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.
+  #
+  # @return [Object]
+  #   The object added to the channel.
+  #
+  def recv
+    readable, _ = IO.select [@reader], [], [], 0.1
+    if readable
+      msg, _ = @reader.recvmsg
+      @serializer.load msg
+    end
+  end
+  alias_method :get, :recv
+end

data/test/ichannel_class_test.rb

@@ -0,0 +1,28 @@
+require_relative 'setup'
+class IChannelTest < Test::Unit::TestCase
+  def setup
+    @channel = IChannel.new Marshal
+  end
+
+  def teardown
+    @channel.close
+  end
+
+  def test_put_and_get 
+    pid = fork do
+      @channel.put %w(a b c)
+    end
+    Process.wait pid
+    assert_equal %w(a b c), @channel.get
+  end
+
+  def test_queued_messages
+    pid = fork do 
+      @channel.put %w(a)
+      @channel.put %w(b)
+    end
+    Process.wait pid
+    assert_equal %w(a), @channel.get
+    assert_equal %w(b), @channel.get
+  end
+end

data/test/setup.rb

@@ -0,0 +1,2 @@
+require 'ichannel'
+require 'test/unit'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ichannel
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-15 00:00:00.000000000 Z
+dependencies: []
+description: ! "A simple and modern interprocess communication \n    primitive."
+email:
+- rob@flowof.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ichannel.gemspec
+- lib/ichannel.rb
+- lib/ichannel/version.rb
+- test/ichannel_class_test.rb
+- test/setup.rb
+homepage: https://github.com/robgleeson/ichannel
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3802321299613243923
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3802321299613243923
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple and modern interprocess communication  primitive.
+test_files:
+- test/ichannel_class_test.rb
+- test/setup.rb