rubysh 0.2.1 → 0.2.2

data/lib/rubysh/base_command.rb

@@ -5,6 +5,10 @@ module Rubysh
   #
   # - freeze after initialize?
   class BaseCommand
+    def opts
+      @opts || {}
+    end
+
     def stringify_arg(arg)
       case arg
       when BaseCommand, BaseDirective

data/lib/rubysh/error.rb

@@ -4,10 +4,11 @@ module Rubysh
 
     class ExecError < BaseError
       # Exception klass and caller from the child process
-      attr_accessor :klass, :caller
+      attr_accessor :raw_message, :klass, :caller
 
-      def initialize(message, klass, caller)
+      def initialize(message, raw_message, klass, caller)
         super(message)
+        @raw_message = raw_message
         @klass = klass
         @caller = caller
       end

data/lib/rubysh/redirect.rb

@@ -126,7 +126,9 @@ module Rubysh
         :target_name => target_name,
         :read_pos => 0,
         :subprocess_fd_number => Util.to_fileno(source),
-        :tee => @opts[:tee]
+        :tee => @opts[:tee],
+        :on_read => @opts[:on_read],
+        :on_write => @opts[:on_write],
       }
     end
 

data/lib/rubysh/runner.rb

@@ -36,6 +36,7 @@ module Rubysh
     # read(:how => :nonblock): Return whatever is immediately available
     def read(target=nil, opts=nil)
       raise Rubysh::Error::AlreadyRunError.new("Can only read from a runner in runner_state :started or :waited, not #{@runner_state.inspect}") unless @runner_state == :started || @runner_state == :waited
+      raise Rubysh::Error::BaseError.new("Can't read from a runner where :on_read has been provided") if command.opts[:on_read]
 
       if target.kind_of?(Hash)
         opts = target
@@ -263,28 +264,36 @@ module Rubysh
     # there.
     def prepare_io
       @parallel_io = Subprocess::PidAwareParallelIO.new(readers, writers, subprocesses)
-      @parallel_io.on_read do |target_name, data|
-        state = @targets[target_name]
-        buffer = state[:buffer]
-        if data == Subprocess::ParallelIO::EOF
-          Rubysh.log.debug("EOF reached on #{target_name.inspect}")
-          buffer.close_write
-        else
-          Rubysh.log.debug("Just read #{data.inspect} on #{target_name.inspect}")
-          tee = state[:tee]
-          tee.write(data) if tee
-
-          # Seek to end
-          buffer.pos = buffer.length
-          buffer.write(data)
+      if on_read = command.opts[:on_read]
+        @parallel_io.on_read(on_read)
+      else
+        @parallel_io.on_read do |target_name, data|
+          state = @targets[target_name]
+          buffer = state[:buffer]
+          if data == Subprocess::ParallelIO::EOF
+            Rubysh.log.debug("EOF reached on #{target_name.inspect}")
+            buffer.close_write
+          else
+            Rubysh.log.debug("Just read #{data.inspect} on #{target_name.inspect}")
+            tee = state[:tee]
+            tee.write(data) if tee
+
+            # Seek to end
+            buffer.pos = buffer.length
+            buffer.write(data)
+          end
         end
       end
 
-      @parallel_io.on_write do |target_name, written, remaining|
-        if data == Subprocess::ParallelIO::EOF
-          Rubysh.log.debug("EOF reached on #{target_name.inspect}")
-        else
-          Rubysh.log.debug("Just wrote #{written.inspect} on #{target_name.inspect}")
+      if on_write = command.opts[:on_write]
+        @parallel_io.on_write(on_write)
+      else
+        @parallel_io.on_write do |target_name, written, remaining|
+          if data == Subprocess::ParallelIO::EOF
+            Rubysh.log.debug("EOF reached on #{target_name.inspect}")
+          else
+            Rubysh.log.debug("Just wrote #{written.inspect} on #{target_name.inspect}")
+          end
         end
       end
     end

data/lib/rubysh/subprocess.rb

@@ -123,7 +123,6 @@ module Rubysh
     def exec_program
       begin
         Kernel.exec([command, command], *args)
-        raise Rubysh::Error::UnreachableError.new("This code should be unreachable. If you are seeing this exception, it means someone overrode Kernel.exec. That's not very nice of them.")
       rescue Exception => e
         msg = {
           'message' => e.message,
@@ -135,6 +134,8 @@ module Rubysh
         # Note: atexit handlers will fire in this case. May want to do
         # something about that.
         exit(1)
+      else
+        raise Rubysh::Error::UnreachableError.new("This code should be unreachable. If you are seeing this exception, it means someone overrode Kernel.exec. That's not very nice of them.")
       end
     end
 
@@ -145,7 +146,7 @@ module Rubysh
       when false
         # success!
       when Hash
-        @exec_error = Rubysh::Error::ExecError.new("Failed to exec in subprocess: #{msg['message']}", msg['klass'], msg['caller'])
+        @exec_error = Rubysh::Error::ExecError.new("Failed to exec in subprocess: #{msg['message']}", msg['message'], msg['klass'], msg['caller'])
       else
         @exec_error = Rubysh::Error::BaseError.new("Invalid message received over the exec_status pipe: #{msg.inspect}")
       end

data/lib/rubysh/subprocess/parallel_io.rb

@@ -15,12 +15,14 @@ class Rubysh::Subprocess
       @writer_buffers = {}
     end
 
-    def on_read(&blk)
-      @on_read = blk
+    def on_read(method=nil, &blk)
+      raise "Can't provide both method and block" if method && blk
+      @on_read = method || blk
     end
 
-    def on_write(&blk)
-      @on_write = blk
+    def on_write(method=nil, &blk)
+      raise "Can't provide both method and block" if method && blk
+      @on_write = method || blk
     end
 
     def write(writer_name, data, close_on_complete=true)

data/lib/rubysh/subprocess/pid_aware_parallel_io.rb

@@ -43,7 +43,7 @@ class Rubysh::Subprocess
     def self.trigger_breaker(writer)
       begin
         writer.write_nonblock('a') unless writer.closed?
-      rescue Errno::EAGAIN, Errno::EPIPE
+      rescue Errno::EAGAIN, Errno::EPIPE, IOError
       end
     end
 

data/lib/rubysh/version.rb

@@ -1,3 +1,3 @@
 module Rubysh
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/test/_lib.rb

@@ -3,7 +3,7 @@ require 'bundler/setup'
 
 require 'minitest/autorun'
 require 'minitest/spec'
-require 'mocha'
+require 'mocha/setup'
 
 $:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
 

data/test/functional/lib/on_output.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../_lib', File.dirname(__FILE__))
+
+module RubyshTest::Functional
+  class ReadTest < FunctionalTest
+    describe 'when using :on_read' do
+      it 'calls back as output is streamed' do
+        stdout = ''
+        stderr = ''
+
+        runner = Rubysh('ruby', '-e', 'puts "hi"; $stderr.puts "hullo there"; puts "hello"',
+          Rubysh.>, Rubysh.stderr > :stderr,
+          :on_read => Proc.new do |target_name, data|
+            case target_name
+            when :stdout then stdout << data unless data == Rubysh::Subprocess::ParallelIO::EOF
+            when :stderr then stderr << data unless data == Rubysh::Subprocess::ParallelIO::EOF
+            else
+              raise "Invalid name: #{target_name.inspect}"
+            end
+          end
+          ).run
+        assert_equal("hi\nhello\n", stdout)
+        assert_equal("hullo there\n", stderr)
+      end
+
+      it 'does not allow reading' do
+        runner = Rubysh('echo', 'hi',
+          Rubysh.>, Rubysh.stderr > :stderr,
+          :on_read => Proc.new {}
+          ).run
+        assert_raises(Rubysh::Error::BaseError) {runner.read}
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysh
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -114,6 +114,7 @@ files:
 - test/functional/lib/fd-lister
 - test/functional/lib/kill.rb
 - test/functional/lib/leaked_fds.rb
+- test/functional/lib/on_output.rb
 - test/functional/lib/read.rb
 - test/functional/lib/redirect_ordering.rb
 - test/functional/lib/triple_less_than.rb
@@ -142,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 737846493172444945
+      hash: -1131101407467327753
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -151,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 737846493172444945
+      hash: -1131101407467327753
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -168,6 +169,7 @@ test_files:
 - test/functional/lib/fd-lister
 - test/functional/lib/kill.rb
 - test/functional/lib/leaked_fds.rb
+- test/functional/lib/on_output.rb
 - test/functional/lib/read.rb
 - test/functional/lib/redirect_ordering.rb
 - test/functional/lib/triple_less_than.rb