ichannel 5.1.1 → 5.1.1.1

data/.travis.yml

@@ -1,9 +1,13 @@
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - ruby-head
-  # UNIXSocket#recvmsg iz not implemented on Rubinius yet.
-  # - rbx-19mode
+
+env:
+  - SERIALIZER=YAML
+  - SERIALIZER=Marshal
+  - SERIALIZER=JSON
 
 notifications:
   email: true 

data/ChangeLog.txt

@@ -1,3 +1,7 @@
+== v5.1.1.1
+	* doc improvements
+	a set of doc improvements
+
 == v5.1.1
 	* Change socket type to use TCP.
 	The use of UDP could result in bugs because of its unordered nature.

data/README.md

@@ -1,31 +1,33 @@
 __OVERVIEW__
 
 
-| Project         | IChannel    
+| Project         | ichannel   
 |:----------------|:--------------------------------------------------
 | Homepage        | https://github.com/robgleeson/ichannel
-| Documentation   | http://rubydoc.info/gems/ichannel/frames 
+| Documentation   | http://rubydoc.info/github/robgleeson/ichannel/frames  
 | CI              | [![Build Status](https://travis-ci.org/robgleeson/ichannel.png)](https://travis-ci.org/robgleeson/ichannel)
 | Author          | Robert Gleeson             
 
 
 __DESCRIPTION__
 
-A modern, flexible & easy to use interprocess communication(IPC) primitive. The 
-basic premise is that you can "put" and "get" Ruby objects to/from a channel. 
-This works across any Ruby process & its subprocesses, though, which is why it 
-can be useful. You could describe putting and getting objects to/from the channel
-as message passing but the message could potentially be any Ruby object, 
-although I think sending small messages(as a Hash) works very well for most 
-scenarios.
+ichannel simplifies interprocess communication by providing a bi-directional
+channel that can transport ruby objects between processes on the same machine. 
+All communication on a channel occurs on a streamed UNIXSocket that a channel
+uses to queues its messages (ruby objects), and also to ensure that messages 
+are received in the order they are sent.
+
+In order to transport ruby objects through a channel the objects are serialized 
+before a write and deserialized after a read. The choice of serializer is left 
+up to you. A serializer can be any object that implements `dump` and
+`load` -- two methods that are usually implemented by serializers written in
+ruby.
 
 __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`.
+A demo of how to pass ruby objects through a channel and also between processes:
 
 ```ruby
 channel = IChannel.new Marshal
@@ -38,52 +40,24 @@ channel.get # => Fixnum
 channel.get # => 'Hello!'
 ```
 
-__SERIALIZERS__
-
-To send Ruby objects between processes they have to be serialized, but on the
-bright side the number of serializers to choose from is vast. Marshal, JSON, & 
-YAML are supported out of the box to name a few but adding support for other 
-serializers is a trivial amount of work.
+__2.__
 
-For example, here is a MessagePack serializer you could use:
+MessagePack doesn't implement `dump` or `load` but a wrapper can be easily
+written:
 
 ```ruby
-require 'ichannel'
-require 'msgpack'
-serializer = Class.new do
+module MyMessagePack
   def self.dump(msg)
-    MessagePack.pack msg
+    MessagePack.pack(msg)
   end
 
   def self.load(msg)
-    MessagePack.unpack msg
+    MessagePack.unpack(msg)
   end
 end
-channel = IChannel.new serializer
+channel = IChannel.new MyMessagePack
 ```
 
-As you can see above as long as the serializer responds to `.dump` & `.load` it 
-can be passed as a serializer to IChannel.
-
-__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 lightweight UNIX(X) process pool implementation.
-
-
-Other people have started to write code on top of ichannel, too:
-  
-  - [ifuture](https://github.com/Havenwood/ifuture)  
-    An implementation of Futures for Ruby using process forks and ichannel.
-
 __PLATFORM SUPPORT__
 
 _supported_
@@ -101,6 +75,11 @@ __INSTALL__
 
     $ gem install ichannel
 
+__SEE ALSO__
+  
+  - [ifuture](https://github.com/Havenwood/ifuture)  
+    futures built on process forks and ichannel.
+
 __LICENSE__
 
 MIT. See LICENSE.txt.

data/lib/ichannel/version.rb

@@ -1,3 +1,3 @@
 class IChannel
-  VERSION = "5.1.1"
+  VERSION = "5.1.1.1"
 end

data/lib/ichannel.rb

@@ -26,7 +26,6 @@ class IChannel
   #
   # @return [Boolean]
   #   Returns true when the channel has been closed.
-  #   Returns nil when the channel is already closed.
   #
   def close
     unless closed?

data/test/ichannel_class_test.rb

@@ -1,14 +1,15 @@
 require_relative 'setup'
 class IChannelTest < Test::Unit::TestCase
   def setup
-    @channel = IChannel.new [YAML, Marshal, JSON].sample
+    serializer = Object.const_get ENV["SERIALIZER"] || "Marshal"
+    @channel = IChannel.new serializer
   end
 
   def teardown
     @channel.close
   end
 
-  def test_put_and_get 
+  def test_put_and_get
     pid = fork do
       @channel.put %w(a b c)
     end
@@ -26,12 +27,12 @@ class IChannelTest < Test::Unit::TestCase
   def test_get_on_closed_channel
     @channel.close
     assert_raises IOError do
-      @channel.put %w(b)
+      @channel.get
     end
   end
 
   def test_queued_messages
-    pid = fork do 
+    pid = fork do
       @channel.put %w(a)
       @channel.put %w(b)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-12 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies: []
 description: ! "A modern and easy-to-use interprocess communication \n    primitive."
 email:
@@ -46,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4510016947679308105
+      hash: -2186920518720444736
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4510016947679308105
+      hash: -2186920518720444736
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23