ichannel 8.0.0 → 8.1.0

data/ChangeLog.txt

@@ -1,3 +1,7 @@
+== v8.1.0
+   - add Redis#{unix_socket,redis?}, UNIXSocket#{unix_socket?, redis?}
+   Predicates indicating if you have a redis or unix socket channel.
+
 == v8.0.0
    - Redis#write! does not time out.
    A write to redis is not wrapped in Timeout.timeout() anymore
@@ -7,8 +11,8 @@
    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.
+   - Remove use of timeout.rb from lib/
+   retire 'timeout.rb' from stdlib
 
 == v7.1.0
    - Redis#last_msg, UNIXSocket#last_msg return last read value 

data/README.md

@@ -115,8 +115,10 @@ And to finish:
 
 __SEE ALSO__
 
-  - [ifuture](https://github.com/Havenwood/ifuture)
-    futures built on process forks and ichannel.
+  - [ifuture](https://github.com/havenwood/ifuture)  
+    An implementation of the future pattern that leverages
+    `Kernel#fork` and ichannel.  
+    credit [@havenwood](https://github.com/havenwood).
 
 __LICENSE__
 

data/lib/ichannel/redis.rb

@@ -144,4 +144,24 @@ class IChannel::Redis
   def readable?
     !closed? && !empty?
   end
+
+  #
+  # @return [Boolean]
+  #   Returns false.
+  #
+  # @see UNIXSocket#unix_socket?
+  #
+  def unix_socket?
+    false
+  end
+
+  #
+  # @return [Boolean]
+  #   Returns true.
+  #
+  # @see UNIXSocket#redis?
+  #
+  def redis?
+    true
+  end
 end

data/lib/ichannel/unix_socket.rb

@@ -1,160 +1,178 @@
 require 'socket'
-module IChannel
-  class UNIXSocket
-    SEP = '_$_'
-    if respond_to? :private_constant
-      private_constant :SEP
-    end
+class IChannel::UNIXSocket
+  SEP = '_$_'
+  if respond_to? :private_constant
+    private_constant :SEP
+  end
 
-    #
-    # @param [#dump,#load] serializer
-    #   Any object that implements dump, & load.
-    #
-    # @return [IChannel::UNIXSocket]
-    #
-    def initialize(serializer = Marshal, adapter_options)
-      @serializer = serializer
-      @last_msg = nil
-      @reader, @writer = ::UNIXSocket.pair :STREAM
-    end
+  #
+  # @param [#dump,#load] serializer
+  #   Any object that implements dump, & load.
+  #
+  # @return [IChannel::UNIXSocket]
+  #
+  def initialize(serializer = Marshal, adapter_options)
+    @serializer = serializer
+    @last_msg = nil
+    @reader, @writer = ::UNIXSocket.pair :STREAM
+  end
 
-    #
-    # @return [Boolean]
-    #   Returns true when the channel is closed.
-    #
-    def closed?
-      @reader.closed? && @writer.closed?
-    end
+  #
+  # @return [Boolean]
+  #   Returns true when the channel is closed.
+  #
+  def closed?
+    @reader.closed? && @writer.closed?
+  end
 
-    #
-    # Close the channel.
-    #
-    # @return [Boolean]
-    #   Returns true when the channel has been closed.
-    #
-    def close
-      unless closed?
-        @reader.close
-        @writer.close
-        true
-      end
+  #
+  # Close the channel.
+  #
+  # @return [Boolean]
+  #   Returns true when the channel has been closed.
+  #
+  def close
+    unless closed?
+      @reader.close
+      @writer.close
+      true
     end
+  end
 
-    #
-    # Add an object to the channel.
-    #
-    # @raise [IOError]
-    #   When the channel is closed.
-    #
-    # @param [Object] object
-    #   An object to add.
-    #
-    def write(object)
-      write!(object, nil)
-    end
-    alias_method :put, :write
+  #
+  # Add an object to the channel.
+  #
+  # @raise [IOError]
+  #   When the channel is closed.
+  #
+  # @param [Object] object
+  #   An object to add.
+  #
+  def write(object)
+    write!(object, nil)
+  end
+  alias_method :put, :write
 
-    #
-    # Add an object to the channel.
-    #
-    # @param
-    #   (see IChannel#write)
-    #
-    # @param [Numeric] timeout
-    #   The number of seconds to wait for the channel to become writable.
-    #
-    # @raise 
-    #   (see IChannel#write)
-    #
-    # @raise [IOError]
-    #   When _timeout_ seconds elapse and the channel cannot be written to.
-    #
-    def write!(object, timeout = 0.1)
-      if @writer.closed?
-        raise IOError, 'The channel cannot be written to (closed).'
-      end
-      _, writable, _ = IO.select nil, [@writer], nil, timeout
-      if writable
-        msg = @serializer.dump(object)
-        writable[0].syswrite "#{msg}#{SEP}"
-      else
-        raise IOError, 'The channel cannot be written to.'
-      end
+  #
+  # Add an object to the channel.
+  #
+  # @param
+  #   (see IChannel#write)
+  #
+  # @param [Numeric] timeout
+  #   The number of seconds to wait for the channel to become writable.
+  #
+  # @raise 
+  #   (see IChannel#write)
+  #
+  # @raise [IOError]
+  #   When _timeout_ seconds elapse and the channel cannot be written to.
+  #
+  def write!(object, timeout = 0.1)
+    if @writer.closed?
+      raise IOError, 'The channel cannot be written to (closed).'
     end
-    alias_method :put!, :write!
-
-    #
-    # Reads the last message written to the channel by reading until the channel
-    # is empty. The last message is cached and reset to nil on call to {#close}.
-    #
-    # @return [Object]
-    #   Returns the last message to be written to the channel.
-    #
-    def last_msg
-      while readable?
-        @last_msg = get
-      end
-      @last_msg
+    _, writable, _ = IO.select nil, [@writer], nil, timeout
+    if writable
+      msg = @serializer.dump(object)
+      writable[0].syswrite "#{msg}#{SEP}"
+    else
+      raise IOError, 'The channel cannot be written to.'
     end
+  end
+  alias_method :put!, :write!
 
-    #
-    # Receive an object from the channel.
-    #
-    # @raise [IOError]
-    #   When the channel is closed.
-    #
-    # @return [Object]
-    #   The object read from the channel.
-    #
-    def recv
-      recv!(nil)
+  #
+  # Reads the last message written to the channel by reading until the channel
+  # is empty. The last message is cached and reset to nil on call to {#close}.
+  #
+  # @return [Object]
+  #   Returns the last message to be written to the channel.
+  #
+  def last_msg
+    while readable?
+      @last_msg = get
     end
-    alias_method :get, :recv
+    @last_msg
+  end
 
-    #
-    # Receive an object from the channel.
-    #
-    # Unlike {#recv}, which waits indefinitely until the channel becomes readable,
-    # this method will raise an IOError when _timeout_ seconds elapse and the
-    # channel remains unreadable.
-    #
-    # @param [Numeric] timeout
-    #   The number of seconds to wait for the channel to become readable.
-    #
-    # @raise [IOError]
-    #   (see IChannel#recv)
-    #
-    # @raise [IChannel::TimeoutError]
-    #   When _timeout_ seconds elapse & the channel remains unreadable.
-    #
-    # @return [Object]
-    #   The object read from the channel.
-    #
-    def recv!(timeout = 0.1)
-      if @reader.closed?
-        raise IOError, 'The channel cannot be read from (closed).'
-      end
-      readable, _ = IO.select [@reader], nil, nil, timeout
-      if readable
-        msg = readable[0].readline(SEP).chomp SEP
-        @last_msg = @serializer.load msg
-      else
-        raise IChannel::TimeoutError, 'Time out on read (waited for %s second(s))' % [timeout]
-      end
+  #
+  # Receive an object from the channel.
+  #
+  # @raise [IOError]
+  #   When the channel is closed.
+  #
+  # @return [Object]
+  #   The object read from the channel.
+  #
+  def recv
+    recv!(nil)
+  end
+  alias_method :get, :recv
+
+  #
+  # Receive an object from the channel.
+  #
+  # Unlike {#recv}, which waits indefinitely until the channel becomes readable,
+  # this method will raise an IOError when _timeout_ seconds elapse and the
+  # channel remains unreadable.
+  #
+  # @param [Numeric] timeout
+  #   The number of seconds to wait for the channel to become readable.
+  #
+  # @raise [IOError]
+  #   (see IChannel#recv)
+  #
+  # @raise [IChannel::TimeoutError]
+  #   When _timeout_ seconds elapse & the channel remains unreadable.
+  #
+  # @return [Object]
+  #   The object read from the channel.
+  #
+  def recv!(timeout = 0.1)
+    if @reader.closed?
+      raise IOError, 'The channel cannot be read from (closed).'
+    end
+    readable, _ = IO.select [@reader], nil, nil, timeout
+    if readable
+      msg = readable[0].readline(SEP).chomp SEP
+      @last_msg = @serializer.load msg
+    else
+      raise IChannel::TimeoutError, 'Time out on read (waited for %s second(s))' % [timeout]
     end
-    alias_method :get!, :recv!
+  end
+  alias_method :get!, :recv!
 
-    #
-    # @return [Boolean]
-    #   Returns true when the channel is readable.
-    #
-    def readable?
-      if closed?
-        false
-      else
-        readable, _ = IO.select [@reader], nil, nil, 0
-        !! readable
-      end
+  #
+  # @return [Boolean]
+  #   Returns true when the channel is readable.
+  #
+  def readable?
+    if closed?
+      false
+    else
+      readable, _ = IO.select [@reader], nil, nil, 0
+      !! readable
     end
   end
+
+  # 
+  # @return [Boolean]
+  #   Returns true.
+  #
+  # @see Redis#unix_socket?
+  #
+  def unix_socket?
+    true
+  end
+
+  #
+  # @return [Boolean]
+  #   Returns false.
+  #
+  # @see Redis#redis?
+  #
+  def redis?
+    false
+  end
 end

data/lib/ichannel/version.rb

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

data/release-notes.txt

@@ -0,0 +1,3 @@
+bump in lib/ichannel/version.rb
+bump in ChangeLog.txt
+bundle exec rake release

data/test/ichannel_redis_test.rb

@@ -22,4 +22,12 @@ class IChannelRedisTest < testcase
     @channel.instance_variable_get(:@redis).del(key)
     @channel.close
   end
+
+  def test_redis?
+    assert_equal true, @channel.redis?
+  end
+
+  def test_unix_socket?
+    assert_equal false, @channel.unix_socket?
+  end
 end

data/test/ichannel_unix_test.rb

@@ -12,4 +12,12 @@ class IChannelTest < Test::Unit::TestCase
   def teardown
     @channel.close
   end
+
+  def test_redis?
+    assert_equal false, @channel.redis?
+  end
+
+  def test_unix_socket?
+    assert_equal true, @channel.unix_socket?
+  end
 end

data/test/uniform_ichannel_test.rb

@@ -17,7 +17,9 @@ module UniformIChannelTest
     put
     put!
     recv
-    recv!).each do |method|
+    recv!
+    unix_socket?
+    redis?).each do |method|
       assert @channel.respond_to? method
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichannel
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies: []
 description: interprocess communication channel
 email:
@@ -34,6 +34,7 @@ files:
 - lib/ichannel/redis.rb
 - lib/ichannel/unix_socket.rb
 - lib/ichannel/version.rb
+- release-notes.txt
 - test/ichannel_redis_test.rb
 - test/ichannel_unix_test.rb
 - test/setup.rb
@@ -52,7 +53,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3456216786864862770
+      hash: -1427294118300470678
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3456216786864862770
+      hash: -1427294118300470678
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23