ichannel 7.1.0 → 8.0.0

data/.travis.yml

@@ -2,14 +2,13 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-#  - ruby-head
   - rbx-19mode
-#  - jruby-19mode
+# - ruby-head
 
 env:
-  - SERIALIZER=YAML
-  - SERIALIZER=Marshal
-  - SERIALIZER=JSON
+  - REDIS=1 SERIALIZER=YAML
+  - REDIS=1 SERIALIZER=Marshal
+  - REDIS=1 SERIALIZER=JSON
 
 services:
   - redis-server

data/ChangeLog.txt

@@ -1,3 +1,15 @@
+== v8.0.0
+   - Redis#write! does not time out.
+   A write to redis is not wrapped in Timeout.timeout() anymore
+   and cannot be timed out. The timeout argument is a no-op.
+
+   - Add IChannel::TimeoutError
+   Redis#get!, UNIXSocket#get!, UNIXSocket#write! raise
+   IChannel::TimeoutError instead of Timeout::Error.
+   
+   - Remove all use of timeout.rb from lib/
+   'timeout' from the standard library is retired from ichannel.
+
 == v7.1.0
    - Redis#last_msg, UNIXSocket#last_msg return last read value 
      after a channel has been closed.

data/Gemfile

@@ -6,5 +6,8 @@ group :development do
   gem "yard"
   gem "foreman"
 end
+group :test do
+  gem "colorize"
+end
 gem "redis"
 gemspec

data/README.md

@@ -101,15 +101,6 @@ _supported_
 
   * CRuby (1.9+)  
   * Rubinius (1.9+)  
-  * JRuby (1.9+ - some tests skipped)  
-    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_
-
-  * Any 1.8 implementation
-  * MacRuby
 
 __INSTALL__
 

data/lib/ichannel/redis.rb

@@ -59,27 +59,22 @@ class IChannel::Redis
   # Add an object to the channel.
   #
   # @param [Object] object
-  #   The object to add to the channel.
+  #   An object to add.
   #
   # @param [Fixnum] timeout
-  #   The amount of time to wait for the write to complete.
+  #   This argument is a no-op for a write to a redis channel.
   #
   # @raise [IOError]
   #   When the channel is closed.
   #
-  # @raise [Timeout::Error]
-  #   When the write does not complete in time.
-  #
   # @return [void]
   #
   def write!(object, timeout = 0.1)
     if closed?
       raise IOError, 'The channel cannot be written to (closed)'
     end
-    Timeout.timeout(timeout) do
-      dump = @serializer.dump object
-      @redis.lpush @key, dump
-    end
+    dump = @serializer.dump object
+    @redis.lpush @key, dump
   end
   alias_method :put!, :write!
 
@@ -99,12 +94,12 @@ class IChannel::Redis
 
   #
   # @param [Fixnum] timeout
-  #   The number of seconds (as an Integer) to wait before a time out will occur.
+  #   The number of seconds (as an Integer) to wait for a read.
   #
   # @raise [IOError]
   #   When the channel is closed or empty.
   #
-  # @raise [Timeout::Error]
+  # @raise [IChannel::TimeoutError]
   #   When _timeout_ seconds pass and the read has not completed.
   #
   # @return [Object]
@@ -118,7 +113,7 @@ class IChannel::Redis
     if payload
       @last_msg = @serializer.load(payload)
     else
-      raise Timeout::Error, "timeout on read after #{timeout} seconds"
+      raise IChannel::TimeoutError, "timeout on read after #{timeout} seconds"
     end
   end
   alias_method :get!, :recv!

data/lib/ichannel/unix_socket.rb

@@ -47,7 +47,7 @@ module IChannel
     #   When the channel is closed.
     #
     # @param [Object] object
-    #   An object to add to the channel.
+    #   An object to add.
     #
     def write(object)
       write!(object, nil)
@@ -57,20 +57,17 @@ module IChannel
     #
     # Add an object to the channel.
     #
-    # Unlike {#write}, which waits indefinitely until the channel becomes writable,
-    # this method will raise an IOError when _timeout_ seconds elapse and
-    # the channel remains unwritable.
-    #
     # @param
     #   (see IChannel#write)
     #
     # @param [Numeric] timeout
     #   The number of seconds to wait for the channel to become writable.
     #
-    # @raise (see IChannel#write)
+    # @raise 
+    #   (see IChannel#write)
     #
     # @raise [IOError]
-    #   When _timeout_ seconds elapse & the channel remains unwritable.
+    #   When _timeout_ seconds elapse and the channel cannot be written to.
     #
     def write!(object, timeout = 0.1)
       if @writer.closed?
@@ -127,7 +124,7 @@ module IChannel
     # @raise [IOError]
     #   (see IChannel#recv)
     #
-    # @raise [Timeout::Error]
+    # @raise [IChannel::TimeoutError]
     #   When _timeout_ seconds elapse & the channel remains unreadable.
     #
     # @return [Object]
@@ -142,7 +139,7 @@ module IChannel
         msg = readable[0].readline(SEP).chomp SEP
         @last_msg = @serializer.load msg
       else
-        raise Timeout::Error, 'Time out on read (waited for %s second(s))' % [timeout]
+        raise IChannel::TimeoutError, 'Time out on read (waited for %s second(s))' % [timeout]
       end
     end
     alias_method :get!, :recv!

data/lib/ichannel/version.rb

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

data/lib/ichannel.rb

@@ -1,5 +1,5 @@
 module IChannel
-  require "timeout"
+  TimeoutError = Class.new(StandardError)
   require_relative "ichannel/unix_socket"
 
   #

data/test/ichannel_redis_test.rb

@@ -1,6 +1,14 @@
 require_relative 'setup'
-class IChannelRedisTest < Test::Unit::TestCase
-  # This includes the tests all channels should pass(redis or unix
+if ENV["REDIS"] != "1"
+  require "colorize"
+  warn "[WARNING] redis tests ignored. set REDIS=1 to test with redis.".red
+  testcase = Object
+else
+  testcase = Test::Unit::TestCase
+end
+
+class IChannelRedisTest < testcase
+  # This includes the tests all channels should pass(redis and unix
   # socket). Any tests specific to redis can go in this class.
   include UniformIChannelTest
 
@@ -14,10 +22,4 @@ class IChannelRedisTest < Test::Unit::TestCase
     @channel.instance_variable_get(:@redis).del(key)
     @channel.close
   end
-
-  def test_timeout_on_get
-    assert_raises Timeout::Error do
-      @channel.get! 1
-    end
-  end
 end

data/test/ichannel_unix_test.rb

@@ -1,6 +1,6 @@
 require_relative "setup"
 class IChannelTest < Test::Unit::TestCase
-  # This includes the tests all channels should pass(redis or unix
+  # This includes the tests all channels should pass(redis and unix
   # socket). Any tests specific to a unit socket can go in this class.
   include UniformIChannelTest
 

data/test/setup.rb

@@ -1,7 +1,8 @@
 require "bundler"
 Bundler.require :default
-require_relative '../lib/ichannel'
+require 'ichannel'
 require 'yaml'
 require 'json'
+require 'timeout'
 require 'test/unit'
 require_relative "uniform_ichannel_test"

data/test/uniform_ichannel_test.rb

@@ -29,8 +29,8 @@ module UniformIChannelTest
   end
 
   def test_timeout_on_get
-    assert_raises Timeout::Error do
-      @channel.get! 0.1
+    assert_raises IChannel::TimeoutError do
+      @channel.get! 1
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 8.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-15 00:00:00.000000000 Z
 dependencies: []
 description: interprocess communication channel
 email:
@@ -52,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3208859644147126315
+      hash: 3456216786864862770
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3208859644147126315
+      hash: 3456216786864862770
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23