ichannel 7.0.0 → 7.1.0

data/.travis.yml

@@ -2,9 +2,9 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ruby-head
+#  - ruby-head
   - rbx-19mode
-  - jruby-19mode
+#  - jruby-19mode
 
 env:
   - SERIALIZER=YAML

data/ChangeLog.txt

@@ -1,3 +1,10 @@
+== v7.1.0
+   - Redis#last_msg, UNIXSocket#last_msg return last read value 
+     after a channel has been closed.
+   The old behavior was to return nil. I'm not sure why I decided to 
+   do that but it's not useful.
+
+
 == v7.0.0
    - IChannel::UNIXSocket#get! raises Timeout::Error
    When a read does not complete in time a Timeout::Error will be 

data/README.md

@@ -16,8 +16,8 @@ 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.
 A [unix socket](http://www.ruby-doc.org/stdlib-2.0/libdoc/socket/rdoc/UNIXSocket.html)
-(local to a single machine)  or [redis](https://redis.io) can be used for
-transport.
+(local to a single machine) or [redis](https://redis.io) can be used for
+storage.
 
 A channel depends on a serializer when reading and writing from the underlying
 socket(e.g: redis or a unix socket) but you can use any serializer that
@@ -32,7 +32,7 @@ __1.__
 
 A demo of how to pass ruby objects through a channel and also between processes.
 [Marshal](http://rubydoc.info/stdlib/core/Marshal) is the serializer of choice,
-and a streamed UNIXSocket is used for transport:
+and a streamed UNIXSocket is used for storage:
 
 ```ruby
 channel = IChannel.unix Marshal
@@ -47,7 +47,7 @@ channel.get # => 'Hello!'
 __2.__
 
 A demo of a channel sending messages between machines by using
-[redis](https://redis.io) for transport:
+[redis](https://redis.io) for storage:
 
 ```ruby
 channel = IChannel.redis Marshal, host: "10.0.0.1", key: "readme-example"
@@ -99,12 +99,12 @@ __PLATFORM SUPPORT__
 
 _supported_
 
-  * CRuby (1.9+)
-  * Rubinius (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.  
-    The other tests pass on jruby, & those tests cover both unix sockets & redis.  
+    JRuby is supported and passes the test suite but it skips any  
+    tests(three/four) that invoke Kernel#fork. The other tests pass   
+    on jruby, and those tests cover unix sockets/redis.
 
 _unsupported_
 
@@ -114,7 +114,7 @@ _unsupported_
 __INSTALL__
 
 If you plan on using redis you'll need to install the 'redis' gem. It's
-optional:
+optional and only loaded when `IChannel.redis` is invoked:
 
     $ gem install redis
 

data/lib/ichannel/redis.rb

@@ -34,7 +34,6 @@ class IChannel::Redis
   def close
     unless closed?
       @redis.quit
-      @last_msg = nil
       @closed = true
     end
   end

data/lib/ichannel/unix_socket.rb

@@ -36,7 +36,6 @@ module IChannel
       unless closed?
         @reader.close
         @writer.close
-        @last_msg = nil
         true
       end
     end

data/lib/ichannel/version.rb

@@ -1,3 +1,3 @@
 module IChannel
-  VERSION = "7.0.0"
+  VERSION = "7.1.0"
 end

data/test/ichannel_redis_test.rb

@@ -1,6 +1,9 @@
 require_relative 'setup'
-require_relative 'ichannel_unix_test'
-class IChannelRedisTest < IChannelUNIXTest
+class IChannelRedisTest < Test::Unit::TestCase
+  # This includes the tests all channels should pass(redis or unix
+  # socket). Any tests specific to redis can go in this class.
+  include UniformIChannelTest
+
   def setup
     serializer = Object.const_get ENV["SERIALIZER"] || "Marshal"
     @channel = IChannel.redis serializer

data/test/ichannel_unix_test.rb

@@ -1,5 +1,9 @@
-require_relative 'setup'
-class IChannelUNIXTest < Test::Unit::TestCase
+require_relative "setup"
+class IChannelTest < Test::Unit::TestCase
+  # This includes the tests all channels should pass(redis or unix
+  # socket). Any tests specific to a unit socket can go in this class.
+  include UniformIChannelTest
+
   def setup
     serializer = Object.const_get ENV["SERIALIZER"] || "Marshal"
     @channel = IChannel.unix serializer
@@ -8,108 +12,4 @@ class IChannelUNIXTest < Test::Unit::TestCase
   def teardown
     @channel.close
   end
-
-  def test_interface
-    %w(write
-    write!
-    get
-    get!
-    close
-    closed?
-    readable?
-    last_msg
-    put
-    put!
-    recv
-    recv!).each do |method|
-      assert @channel.respond_to? method
-    end
-  end
-
-  def test_blocking_get
-    assert_raises Timeout::Error do
-      Timeout.timeout(1) { @channel.get }
-    end
-  end
-
-  def test_timeout_on_get
-    assert_raises Timeout::Error do
-      @channel.get! 0.1
-    end
-  end
-
-  def test_last_msg_after_read
-    @channel.put [42]
-    @channel.get
-    assert_equal [42], @channel.last_msg
-  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)
-    assert_equal %w(b), @channel.last_msg
-  end
-
-  def test_last_msg_cache
-    @channel.put %w(a)
-    2.times { assert_equal %w(a), @channel.last_msg }
-    @channel.close
-    assert_equal nil, @channel.last_msg
-  end
-
-  def test_bust_last_msg_cache
-    @channel.put %w(a)
-    assert_equal %w(a), @channel.last_msg
-    @channel.put %w(b)
-    2.times { assert_equal %w(b), @channel.last_msg }
-  end
-
-  def test_put_on_closed_channel
-    @channel.close
-    assert_raises IOError do
-      @channel.put %w(a)
-    end
-  end
-
-  def test_get_on_closed_channel
-    @channel.close
-    assert_raises IOError do
-      @channel.get
-    end
-  end
-
-  def test_queued_messages
-    @channel.put %w(a)
-    @channel.put %w(b)
-    assert_equal %w(a), @channel.get
-    assert_equal %w(b), @channel.get
-  end
-
-  def test_readable_on_populated_channel
-    @channel.put %w(a)
-    @channel.put %w(b)
-    assert @channel.readable?
-  end
-
-  def test_readable_on_empty_channel
-    @channel.put %w(42)
-    @channel.get # discard
-    refute @channel.readable?
-  end
-
-  def test_readable_on_closed_channel
-    @channel.close
-    refute @channel.readable?
-  end
 end

data/test/setup.rb

@@ -4,3 +4,4 @@ require_relative '../lib/ichannel'
 require 'yaml'
 require 'json'
 require 'test/unit'
+require_relative "uniform_ichannel_test"

data/test/uniform_ichannel_test.rb

@@ -0,0 +1,111 @@
+#
+# These are the tests any ichannel-like interface should pass.
+# The redis and unix socket channel are tested against all these
+# tests.
+#
+require_relative 'setup'
+module UniformIChannelTest
+  def test_interface
+    %w(write
+    write!
+    get
+    get!
+    close
+    closed?
+    readable?
+    last_msg
+    put
+    put!
+    recv
+    recv!).each do |method|
+      assert @channel.respond_to? method
+    end
+  end
+
+  def test_blocking_get
+    assert_raises Timeout::Error do
+      Timeout.timeout(1) { @channel.get }
+    end
+  end
+
+  def test_timeout_on_get
+    assert_raises Timeout::Error do
+      @channel.get! 0.1
+    end
+  end
+
+  def test_last_msg_after_read
+    @channel.put [42]
+    @channel.get
+    assert_equal [42], @channel.last_msg
+  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)
+    assert_equal %w(b), @channel.last_msg
+  end
+
+  def test_last_msg_cache
+    @channel.put %w(a)
+    2.times { assert_equal %w(a), @channel.last_msg }
+    @channel.close
+    assert_equal %w(a), @channel.last_msg
+  end
+
+  def test_bust_last_msg_cache
+    @channel.put %w(a)
+    assert_equal %w(a), @channel.last_msg
+    @channel.put %w(b)
+    2.times { assert_equal %w(b), @channel.last_msg }
+  end
+
+  def test_put_on_closed_channel
+    @channel.close
+    assert_raises IOError do
+      @channel.put %w(a)
+    end
+  end
+
+  def test_get_on_closed_channel
+    @channel.close
+    assert_raises IOError do
+      @channel.get
+    end
+  end
+
+  def test_queued_messages
+    @channel.put %w(a)
+    @channel.put %w(b)
+    assert_equal %w(a), @channel.get
+    assert_equal %w(b), @channel.get
+  end
+
+  def test_readable_on_populated_channel
+    @channel.put %w(a)
+    @channel.put %w(b)
+    assert @channel.readable?
+  end
+
+  def test_readable_on_empty_channel
+    @channel.put %w(42)
+    @channel.get # discard
+    refute @channel.readable?
+  end
+
+  def test_readable_on_closed_channel
+    @channel.close
+    refute @channel.readable?
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies: []
 description: interprocess communication channel
 email:
@@ -37,6 +37,7 @@ files:
 - test/ichannel_redis_test.rb
 - test/ichannel_unix_test.rb
 - test/setup.rb
+- test/uniform_ichannel_test.rb
 homepage: https://github.com/robgleeson/ichannel
 licenses: []
 post_install_message: 
@@ -51,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3143838182628750731
+      hash: 3208859644147126315
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -60,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3143838182628750731
+      hash: 3208859644147126315
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -71,4 +72,5 @@ test_files:
 - test/ichannel_redis_test.rb
 - test/ichannel_unix_test.rb
 - test/setup.rb
+- test/uniform_ichannel_test.rb
 has_rdoc: