io_unblock 0.1.1 → 0.1.2

data/lib/io_unblock.rb

@@ -1,10 +1,10 @@
 require 'thread'
-require "io_unblock/version"
-
-module IoUnblock
-  class IoUnblockError < StandardError; end
-end
-
+require 'socket'
+require 'forwardable'
+require 'io_unblock/version'
+require 'io_unblock/errors'
 require 'io_unblock/delegation'
 require 'io_unblock/buffer'
 require 'io_unblock/stream'
+require 'io_unblock/tcp_socket'
+

data/lib/io_unblock/buffer.rb

@@ -9,16 +9,16 @@ module IoUnblock
       @mutex = Mutex.new
     end
     
-    def push bytes, cb
-      synched { @buffer.push [bytes, cb] }
+    def push bytes, cb, cb_args
+      synched { @buffer.push [bytes, cb, cb_args] }
     end
     
     def pop
       synched { @buffer.pop }
     end
         
-    def unshift bytes, cb
-      synched { @buffer.unshift [bytes, cb] }
+    def unshift bytes, cb, cb_args
+      synched { @buffer.unshift [bytes, cb, cb_args] }
     end
     
     def shift

data/lib/io_unblock/errors.rb

@@ -0,0 +1,4 @@
+module IoUnblock
+  class IoUnblockError < StandardError; end
+end
+

data/lib/io_unblock/stream.rb

@@ -54,35 +54,55 @@ module IoUnblock
     end
     
     def stop
-      @s_mutex.synchronize do
-        if @running
-          @running = false
-          @processor.join
-        end
+      if @processor == Thread.current
+        stop_inside
+      else
+        stop_outside
       end
       self
     end
     
     # The callback triggered here will be invoked only when all bytes
     # have been written.
-    def write bytes, &cb
-      @w_buff.push bytes, cb
+    def write bytes, *cb_args, &cb
+      @w_buff.push bytes, cb, cb_args
       self
     end
+
+    def alive?
+      @processor && @processor.alive?
+    end
     
 private
-    def trigger_callbacks named, *args, &other
-      other && other.call(*args)
-      @callbacks.key?(named) && @callbacks[named].call(*args)
+    def stop_inside
+      @running = false
+    end
+
+    def stop_outside
+      @s_mutex.synchronize do
+        if @running
+          @running = false
+          @processor.join
+        end
+      end
+    end
+
+    def guard_callback named, cb, *args
+      cb && cb.call(*args)
     rescue Exception => ex
       if named == :callback_failed
         warn "Exception raised in callback_failed handler: #{ex}"
-        ex.backtrace.each { |b| warn b }
+        warn "From: #{ex.backtrace.first}"
       else
         trigger_callbacks :callback_failed, ex, named
       end
     end
 
+    def trigger_callbacks named, *args, &other
+      guard_callback named, other, *args
+      guard_callback named, @callbacks[named], *args
+    end
+
     def flush_and_close
       _write while connected? && @w_buff.buffered?
       io_close
@@ -109,25 +129,26 @@ private
     def _write
       written = 0
       while written < MAX_BYTES_PER_WRITE
-        bytes, cb = @w_buff.shift
+        bytes, cb, cb_args = @w_buff.shift
         break unless bytes
         begin
           w = io_write bytes
         rescue Errno::EINTR, Errno::EAGAIN, Errno::EWOULDBLOCK
           # writing will either block, or cannot otherwise be completed,
           # put data back and try again some other day
-          @w_buff.unshift bytes, cb
+          @w_buff.unshift bytes, cb, cb_args
           break
         rescue Exception
           force_close $!
           break
         end
         written += w
+        trigger_callbacks :wrote, bytes, w
         if w < bytes.size
-          @w_buff.unshift bytes[w..-1], cb
-          trigger_callbacks :wrote, bytes, w
+          @w_buff.unshift bytes[w..-1], cb, cb_args
         else
-          trigger_callbacks :wrote, bytes, w, &cb
+          # A separate callback invocation so we can pass custom args
+          guard_callback :wrote, cb, bytes, w, *cb_args
         end
       end
     end

data/lib/io_unblock/tcp_socket.rb

@@ -0,0 +1,16 @@
+module IoUnblock
+  class TcpSocket
+    extend Forwardable
+
+    def_delegators :@stream, :start, :stop, :callbacks, :write,
+      :running?, :connected?, :alive?, :select_delay, :select_delay=
+    attr_reader :host, :port
+
+    def initialize host, port, callbacks=nil
+      @host = host
+      @port = port
+      @socket = ::TCPSocket.new host, port
+      @stream = Stream.new @socket, callbacks
+    end
+  end
+end

data/lib/io_unblock/version.rb

@@ -1,3 +1,3 @@
 module IoUnblock
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/io_unblock/buffer_spec.rb

@@ -6,41 +6,41 @@ describe IoUnblock::Buffer do
   end
   
   it "should be empty when nothing is buffered" do
-    @buffer.push :a, 1
+    @buffer.push :a, 1, 'hello'
     @buffer.pop
     @buffer.empty?.must_equal true
     @buffer.buffered?.must_equal false
   end
   
   it "should not be empty when stuff is buffered" do
-    @buffer.push :a, 1
+    @buffer.push :a, 1, 'hello'
     @buffer.empty?.must_equal false
     @buffer.buffered?.must_equal true
   end
   
   it "should push to the end of the buffer" do
-    @buffer.push :a, 1
-    @buffer.push :b, 2
-    @buffer.first.must_equal [:a, 1]
-    @buffer.last.must_equal [:b, 2]
+    @buffer.push :a, 1, 'hello'
+    @buffer.push :b, 2, 'world'
+    @buffer.first.must_equal [:a, 1, 'hello']
+    @buffer.last.must_equal [:b, 2, 'world']
   end
   
   it "should unshift to the beginning of the buffer" do
-    @buffer.unshift :a, 1
-    @buffer.unshift :b, 2
-    @buffer.last.must_equal [:a, 1]
-    @buffer.first.must_equal [:b, 2]
+    @buffer.unshift :a, 1, 'hello'
+    @buffer.unshift :b, 2, 'world'
+    @buffer.first.must_equal [:b, 2, 'world']
+    @buffer.last.must_equal [:a, 1, 'hello']
   end
   
   it "should shift from the beginning" do
-    @buffer.push :a, 1
-    @buffer.push :b, 2
-    @buffer.shift.must_equal [:a, 1]
+    @buffer.push :a, 1, 'hello'
+    @buffer.push :b, 2, 'world'
+    @buffer.shift.must_equal [:a, 1, 'hello']
   end
   
   it "should pop from the end" do
-    @buffer.push :a, 1
-    @buffer.push :b, 2
-    @buffer.pop.must_equal [:b, 2]
+    @buffer.push :a, 1, 'hello'
+    @buffer.push :b, 2, 'world'
+    @buffer.pop.must_equal [:b, 2, 'world']
   end
 end

data/spec/io_unblock/stream_spec.rb

@@ -1,8 +1,19 @@
 require File.expand_path("../../spec_helper.rb", __FILE__)
 
 describe IoUnblock::Stream do
+  include Stubz
   def dummy_io; @dummy_io ||= DummyIO.new; end
   def stream; @stream ||= IoUnblock::Stream.new dummy_io; end
+
+  # Watch for Thread exceptions
+  before do
+    @th_abort = Thread.abort_on_exception
+    Thread.abort_on_exception = true
+  end
+
+  after do
+    Thread.abort_on_exception = @th_abort
+  end
   
   it "raises an exception if started twice" do
     stream.start
@@ -179,6 +190,14 @@ describe IoUnblock::Stream do
       called_with.must_equal [ ['lo', 2] ]
     end
     
+    it "triggers the given callback after writing the full string with params" do
+      dummy_io.max_write = 3
+      stream.start
+      stream.write('hello', 'turbo', 'is', 'me', &callback)
+      stream.stop
+      called_with.must_equal [ ['lo', 2, 'turbo', 'is', 'me'] ]
+    end
+
     it "is not connected when failed is triggered" do
       is_connected = true
       cb_stream = callback_stream(
@@ -202,13 +221,29 @@ describe IoUnblock::Stream do
     end
 
     it "warns when triggering callback_failed raises an exception" do
+      warn_lines = []
       cb_err = RuntimeError.new 'failback!'
       cb_stream = callback_stream(
         :callback_failed => lambda { |*_| raise cb_err }
       )
+      stub(cb_stream, :warn) { |w| warn_lines << w }
       cb_stream.start
       cb_stream.write('another test') { raise cb_err }
       cb_stream.stop
+      warn_lines.first.must_equal 'Exception raised in callback_failed handler: failback!'
+      /\AFrom: /.must_match warn_lines.last
+    end
+
+    it "stops properly when called within the processor thread" do
+      stopped_called = false
+      cb_stream = callback_stream(
+        :looped => lambda { |s| sleep 0.25; s.stop },
+        :stopped => lambda { |s| stopped_called = true }
+      )
+      cb_stream.start
+      Thread.pass until cb_stream.running?
+      Thread.pass while cb_stream.alive?
+      stopped_called.must_equal true
     end
   end
 end

data/spec/io_unblock/tcp_socket_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+describe IoUnblock::TcpSocket do
+  include Stubz
+
+  def tcp_socket
+    @tcp_socket ||= IoUnblock::TcpSocket.new('host.name', 33, {:call => :back})
+  end
+
+  before do
+    @socket = MiniTest::Mock.new
+    @stream = MiniTest::Mock.new
+    stub(::TCPSocket, :new, @socket)
+    stub(::IoUnblock::Stream, :new, @stream)
+  end
+
+  describe "attribs" do
+    it "has a host" do
+      tcp_socket.host.must_equal 'host.name'
+    end
+
+    it "has a port" do
+      tcp_socket.port.must_equal 33
+    end
+  end
+
+  describe "delegation to the stream" do
+    it "delegates start" do
+      @stream.expect(:start, nil, [:some, :args])
+      tcp_socket.start :some, :args
+      @stream.verify
+    end
+
+    it "delegates stop" do
+      @stream.expect(:stop, nil, ['moar cowbell'])
+      tcp_socket.stop 'moar cowbell'
+      @stream.verify
+    end
+
+    it "delegates callbacks" do
+      @stream.expect(:callbacks, {:a => :hash})
+      tcp_socket.callbacks.must_equal({:a => :hash})
+      @stream.verify
+    end
+
+    it "delegates running?" do
+      @stream.expect(:running?, :generally_a_bool)
+      tcp_socket.running?.must_equal :generally_a_bool
+      @stream.verify
+    end
+
+    it "delegates connected?" do
+      @stream.expect(:connected?, :again_a_bool)
+      tcp_socket.connected?.must_equal :again_a_bool
+      @stream.verify
+    end
+
+    it "delegates select_delay" do
+      @stream.expect(:select_delay, 48)
+      tcp_socket.select_delay.must_equal 48
+      @stream.verify
+    end
+
+    it "delegates select_delay=" do
+      @stream.expect(:select_delay=, 19, [19])
+      tcp_socket.select_delay = 19
+      @stream.verify
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -11,74 +11,10 @@ begin
   require 'minitest/emoji'
 rescue LoadError
 end
-require 'io_unblock'
-require 'stringio'
 
-# Used to test IO stuff, using stringio objects for the write and
-# read stream.
-class DummyIO
-  attr_reader :closed, :w_stream, :r_stream, :raised_write, :raised_read
-  alias :closed? :closed
-  alias :raised_write? :raised_write
-  alias :raised_read? :raised_read
-  attr_accessor :readable, :writeable
-  attr_accessor :write_delay, :read_delay
-  attr_accessor :max_write, :max_read
-  attr_accessor :raise_read, :raise_write
-  alias :readable? :readable
-  alias :writeable? :writeable
-  
-  def initialize *args, &block
-    @r_stream = StringIO.new
-    @w_stream = StringIO.new
-    @readable = @writeable = true
-    @read_delay = @write_delay = 0
-    @max_write = 0
-    @max_read = 0
-    @closed = false
-    @raise_read = nil
-    @raise_write = nil
-    @raised_write = false
-    @raised_read = false
-  end
-  
-  def close
-    @closed = true
-    @w_stream.close
-    @r_stream.close
-  end
-  
-  def write_nonblock bytes
-    sleep(@write_delay) if @write_delay > 0
-    do_raise_write
-    if @max_write > 0 && bytes.size > @max_write
-      @w_stream.write bytes[0...@max_write]
-    else
-      @w_stream.write bytes
-    end
-  end
-  
-  def read_nonblock len
-    sleep(@read_delay) if @read_delay > 0
-    do_raise_read
-    if @max_read > 0 && len > @max_read
-      @r_stream.read @max_read
-    else
-      @r_stream.read len
-    end
-  end
+Dir[File.expand_path('../support/*.rb', __FILE__)].each do |r|
+  require r
+end
 
-  def do_raise_write
-    if @raise_write
-      @raised_write = true
-      raise @raise_write
-    end
-  end
+require 'io_unblock'
 
-  def do_raise_read
-    if @raise_read
-      @raised_read = true
-      raise @raise_read
-    end
-  end
-end

data/spec/support/dummy_io.rb

@@ -0,0 +1,70 @@
+require 'stringio'
+
+# Used to test IO stuff, using stringio objects for the write and
+# read stream.
+class DummyIO
+  attr_reader :closed, :w_stream, :r_stream, :raised_write, :raised_read
+  alias :closed? :closed
+  alias :raised_write? :raised_write
+  alias :raised_read? :raised_read
+  attr_accessor :readable, :writeable
+  attr_accessor :write_delay, :read_delay
+  attr_accessor :max_write, :max_read
+  attr_accessor :raise_read, :raise_write
+  alias :readable? :readable
+  alias :writeable? :writeable
+  
+  def initialize *args, &block
+    @r_stream = StringIO.new
+    @w_stream = StringIO.new
+    @readable = @writeable = true
+    @read_delay = @write_delay = 0
+    @max_write = 0
+    @max_read = 0
+    @closed = false
+    @raise_read = nil
+    @raise_write = nil
+    @raised_write = false
+    @raised_read = false
+  end
+  
+  def close
+    @closed = true
+    @w_stream.close
+    @r_stream.close
+  end
+  
+  def write_nonblock bytes
+    sleep(@write_delay) if @write_delay > 0
+    do_raise_write
+    if @max_write > 0 && bytes.size > @max_write
+      @w_stream.write bytes[0...@max_write]
+    else
+      @w_stream.write bytes
+    end
+  end
+  
+  def read_nonblock len
+    sleep(@read_delay) if @read_delay > 0
+    do_raise_read
+    if @max_read > 0 && len > @max_read
+      @r_stream.read @max_read
+    else
+      @r_stream.read len
+    end
+  end
+
+  def do_raise_write
+    if @raise_write
+      @raised_write = true
+      raise @raise_write
+    end
+  end
+
+  def do_raise_read
+    if @raise_read
+      @raised_read = true
+      raise @raise_read
+    end
+  end
+end

data/spec/support/stubz.rb

@@ -0,0 +1,49 @@
+module Stubz
+  def self.included base
+    base.__send__(:before) { _ensure_stubs_ }
+    base.__send__(:after) { _reset_stubs_ }
+  end
+
+  def stub_instance(klass, meth, *val, &block)
+    _do_stub_ klass, meth, *val, &block
+  end
+
+  def stub(obj, meth, *val, &block)
+    _do_stub_ get_meta_class(obj), meth, *val, &block
+  end
+
+  def get_meta_class klass
+    class << klass; self; end
+  end
+
+  def _do_stub_ klass, meth, *val, &block
+    if klass.method_defined? meth
+      aliased = "_stub_#{meth}_#{Time.now.to_i}_"
+      klass.send(:alias_method, aliased, meth)
+    else
+      aliased = nil
+    end
+    if block
+      klass.send(:define_method, meth, &block)
+    else
+      klass.send(:define_method, meth) do |*_|
+        val.first
+      end
+    end
+    @stubbies << [klass, meth, aliased]
+  end
+
+  def _ensure_stubs_
+    @stubbies = []
+  end
+
+  def _reset_stubs_
+    @stubbies.each do |(klass, meth, aliased)|
+      klass.send(:remove_method, meth)
+    if aliased
+      klass.send(:alias_method, meth, aliased)
+      klass.send(:remove_method, aliased)
+    end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io_unblock
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000Z
+date: 2012-03-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2161186640 !ruby/object:Gem::Requirement
+  requirement: &2160167540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161186640
+  version_requirements: *2160167540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2161185800 !ruby/object:Gem::Requirement
+  requirement: &2160165920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161185800
+  version_requirements: *2160165920
 description: Non-blocking IO reads/writes wrapped in a thread
 email:
 - ian.eccles@gmail.com
@@ -50,12 +50,17 @@ files:
 - lib/io_unblock.rb
 - lib/io_unblock/buffer.rb
 - lib/io_unblock/delegation.rb
+- lib/io_unblock/errors.rb
 - lib/io_unblock/stream.rb
+- lib/io_unblock/tcp_socket.rb
 - lib/io_unblock/version.rb
 - spec/io_unblock/buffer_spec.rb
 - spec/io_unblock/delegation_spec.rb
 - spec/io_unblock/stream_spec.rb
+- spec/io_unblock/tcp_socket_spec.rb
 - spec/spec_helper.rb
+- spec/support/dummy_io.rb
+- spec/support/stubz.rb
 homepage: https://github.com/iande/io_unblock
 licenses: []
 post_install_message: 
@@ -84,5 +89,8 @@ test_files:
 - spec/io_unblock/buffer_spec.rb
 - spec/io_unblock/delegation_spec.rb
 - spec/io_unblock/stream_spec.rb
+- spec/io_unblock/tcp_socket_spec.rb
 - spec/spec_helper.rb
+- spec/support/dummy_io.rb
+- spec/support/stubz.rb
 has_rdoc: