ichannel 6.1.0 → 6.1.1

data/.travis.yml

@@ -3,6 +3,8 @@ rvm:
   - 1.9.3
   - 2.0.0
   - ruby-head
+  - rbx-19mode
+  - jruby-19mode
 
 env:
   - SERIALIZER=YAML

data/ChangeLog.txt

@@ -1,4 +1,12 @@
-== HEAD
+== v6.1.1
+	- Add support for Rubinius, JRuby (1.9+ mode)
+
+	- Fix the optional dependency on Redis.
+	This was totally broken :/ We explicitly required Redis in lib/ichannel.rb.
+	Now we require "ichannel/redis" when IChannel.redis is invoked, which in turn
+	requires "redis", so the dependency is only exposed when invoking that method.
+
+== v6.1.0
 	- Redis#last_msg, UNIXSocket#last_msg changes.
 	The last_msg method returns the last value read by #get when a channel is
 	not readable.
@@ -9,7 +17,7 @@
 	- Add IChannel::Redis.
 	Add Redis as a backend.
 
-== v0.6.0
+== v6.0.0
 	- IChannel::UNIXSocket can now be serialized by Marshal.
 	IChannel::UNIXSocket can be serialized by Marshal but there's a gotcha: it
 	only really works on the same machine between one or more Ruby processes.

data/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 group :development do
   gem "pry"
   gem "rake"
-  gem "redcarpet"
+  gem "redcarpet" unless RUBY_ENGINE == "jruby"
   gem "yard"
   gem "foreman"
 end

data/README.md

@@ -11,25 +11,10 @@ __OVERVIEW__
 __DESCRIPTION__
 
 ichannel is a channel for interprocess communication between ruby processes on
-the same machine(or network). The basic premise is that you can "put" a ruby 
+the same machine or network. The basic premise is that you can "put" a ruby 
 object onto the channel and on the other end(maybe in a different process, 
 or maybe on a different machine) you can "get" the object from the channel.
-
-The two main modes of transport are a UNIXSocket(streamed) or [redis](https://redis.io).
-A unix socket is fast and operates without any external dependencies but it
-can't go beyond a single machine. A channel that uses redis can operate between
-different machines. And incase you're wondering ichannel uses a 
-redis [list](http://redis.io/commands#list) to queue messages. 
-
-The last topic I feel I should talk about before the examples is serialization. 
-A ruby object is serialized(on write) and deserialized(on read) when passing
-through a channel. A channel can use any serializer that implements the dump and
-load methods but the default is [Marshal](http://ruby-doc.org/core-2.0/Marshal.html).
-There are also a number of objects that cannot be serialized (such as IO, 
-anonymous classes/modules, Proc, …) but I've found most of the time I send
-simple objects like Hash.
-
-
+ 
 __EXAMPLES__
 
 __1.__
@@ -70,14 +55,15 @@ Process.wait pid
 
 __3.__
 
-A demo of how to use ichannel with Redis:
+A demo of a channel sending messages between machines by using
+[redis](https://redis.io) as a backend:
 
 ```ruby
-channel = IChannel.redis
+channel = IChannel.redis Marshal, key: "readme-example"
 channel.put %w(a)
 
-# In another process, far away…
-channel = IChannel.redis
+# In another process, on another machine, far away…
+channel = IChannel.redis Marshal, key: "readme-example"
 channel.get # => ["a"]
 ```
 
@@ -103,14 +89,19 @@ __PLATFORM SUPPORT__
 
 _supported_
 
-  * CRuby (1.9+)
+  * CRuby (1.9+)  
+  * Rubinius (1.9+)
+  * JRuby (1.9+ - some tests skipped)  
+    JRuby is supported and passes the test suite but it has a few skips.
+    Three skips are because jruby does not implement Kernel.fork and one
+    looks like a possible bug in JRuby's Marshal when trying to deserialize 
+    a channel that uses a unix socket. The other 24 tests pass on jruby, &
+    those tests cover both unix sockets & redis.
 
 _unsupported_
-  
-  * CRuby 1.8
+
+  * Any 1.8 implementation  
   * MacRuby
-  * JRuby
-  * Rubinius (support for Rubinius will come sometime in the future).
 
 __INSTALL__
 

data/lib/ichannel/redis.rb

@@ -1,5 +1,5 @@
+require "redis"
 class IChannel::Redis
-
   #
   # @param [#dump,#load] serializer
   #   A serializer.

data/lib/ichannel/version.rb

@@ -1,3 +1,3 @@
 module IChannel
-  VERSION = "6.1.0"
+  VERSION = "6.1.1"
 end

data/lib/ichannel.rb

@@ -1,7 +1,6 @@
 module IChannel
-  require 'redis'
+  require "timeout"
   require_relative "ichannel/unix_socket"
-  require_relative "ichannel/redis"
 
   #
   # @param
@@ -22,9 +21,9 @@ module IChannel
   #   (see Redis#initialize)
   #
   def self.redis(serializer = Marshal, options = {})
-    unless defined?(::Redis)
-      require 'redis'
+    unless defined?(IChannel::Redis)
+      require_relative "ichannel/redis"
     end
-    Redis.new serializer, options
+    IChannel::Redis.new serializer, options
   end
 end

data/test/ichannel_unix_test.rb

@@ -27,26 +27,43 @@ class IChannelUNIXTest < Test::Unit::TestCase
   end
 
   def test_last_msg_after_read
-    @channel.put 42
+    @channel.put [42]
     @channel.get
-    assert_equal 42, @channel.last_msg
+    assert_equal [42], @channel.last_msg
   end
 
   def test_serialization_in_fork
+    if RUBY_ENGINE == "jruby"
+      skip "jruby does not implement Kernel.fork"
+    end
     dump = Marshal.dump(@channel)
     pid = fork do
-      Marshal.load(dump).put 42
+      Marshal.load(dump).put [42]
     end
     Process.wait pid
-    assert_equal 42, @channel.get
+    assert_equal [42], @channel.get
   end
 
   def test_serialization
-    @channel.put 42
+    if RUBY_ENGINE == "jruby"
+      skip "fails on jruby"
+    end
+    @channel.put [42]
     dump = Marshal.dump @channel
-    assert_equal 42, Marshal.load(dump).get
+    assert_equal [42], Marshal.load(dump).get
   end
 
+  def test_fork
+    if RUBY_ENGINE == "jruby"
+      skip "jruby does not implement Kernel.fork"
+    end
+    pid = fork do
+      @channel.put [42]
+    end
+    Process.wait pid
+    assert_equal [42], @channel.get
+  end
+  
   def test_last_msg
     @channel.put %w(a)
     @channel.put %w(b)
@@ -67,14 +84,6 @@ class IChannelUNIXTest < Test::Unit::TestCase
     2.times { assert_equal %w(b), @channel.last_msg }
   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_put_on_closed_channel
     @channel.close
     assert_raises IOError do
@@ -90,11 +99,8 @@ class IChannelUNIXTest < Test::Unit::TestCase
   end
 
   def test_queued_messages
-    pid = fork do
-      @channel.put %w(a)
-      @channel.put %w(b)
-    end
-    Process.wait pid
+    @channel.put %w(a)
+    @channel.put %w(b)
     assert_equal %w(a), @channel.get
     assert_equal %w(b), @channel.get
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-05-05 00:00:00.000000000 Z
 dependencies: []
 description: ! "A modern and easy-to-use interprocess communication \n    primitive."
 email:
@@ -51,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3267569127984942618
+      hash: -277858576396614172
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3267569127984942618
+      hash: -277858576396614172
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23