rubysh 0.0.10 → 0.0.11

data/README.md

@@ -92,7 +92,7 @@ the `AliasRubysh` helper:
 Rubysh takes a splatted array argument as a command specification. In
 particular, it doesn't convert it back and forth a command-line
 string, meaning you don't have to worry about spaces in
-variables. (You should still always think twice before putting
+arguments. (You should still always think twice before putting
 untrusted arguments into a shell argument.)
 
 ## Installation
@@ -112,6 +112,5 @@ Patches welcome! I'm happy to merge pull requests.
 
 ## Future features
 
-- Support for environment variables
-- Finer-grained IO control
+- Better support for streaming output
 - Subshell syntax (`cat <(ls)`, `echo $(ls)`)

data/lib/rubysh/command.rb

@@ -3,6 +3,10 @@ module Rubysh
     attr_accessor :raw_args, :directives, :args
 
     def initialize(args)
+      if args.length == 1 && args[0].kind_of?(Array)
+        raise "It looks like you created a Rubysh::Command with a singleton nested array: #{args.inspect}. That'll never be runnable, and probably indicates you forgot a splat somewhere."
+      end
+
       @raw_args = args
       @directives = []
       @args = nil

data/lib/rubysh/runner.rb

@@ -56,9 +56,15 @@ module Rubysh
       case how = opts[:how]
       when :partial
         # Read until we get some bytes
-        @parallel_io.run_once until state[:buffer].length != state[:read_pos]
+        while state[:buffer].length == state[:read_pos]
+          # If everything's exited, just return nil
+          return nil if @parallel_io.finalized
+          @parallel_io.run_once
+        end
       when :nonblock
         @parallel_io.read_available(state[:target])
+        # Return nil unless we have something new
+        return nil if state[:buffer].length == state[:read_pos]
       when nil
         communicate if @runner_state == :started
       else
@@ -203,13 +209,22 @@ module Rubysh
       target_state
     end
 
-    private
+    def kill(signal='TERM')
+      my_pid = pid
+      unless my_pid
+        raise Rubysh::Error::BaseError.new("You haven't started this runner yet.")
+      end
+      Rubysh.log.debug("Sending #{signal} to #{my_pid}")
+      Process.kill(signal, my_pid)
+    end
 
     def wait
       run_io
       do_wait
     end
 
+    private
+
     def targets_by_fd_numbers
       @targets.inject({}) do |hash, (_, target_state)|
         fd_num = target_state[:subprocess_fd_number]

data/lib/rubysh/subprocess/pid_aware_parallel_io.rb

@@ -58,10 +58,13 @@ class Rubysh::Subprocess
       Signal.trap('CHLD', @old_sigchld_handler)
     end
 
+    attr_reader :finalized
+
     # readers/writers should be hashes mapping {fd => name}
     def initialize(readers, writers, subprocesses)
       @breaker_reader, @breaker_writer = IO.pipe
       @subprocesses = subprocesses
+      @finalized = false
 
       readers = readers.dup
       readers[@breaker_reader] = nil
@@ -75,6 +78,8 @@ class Rubysh::Subprocess
     end
 
     def run_once(timeout=nil)
+      return if @finalized
+
       @subprocesses.each do |subprocess|
         subprocess.wait(true)
       end
@@ -98,6 +103,8 @@ class Rubysh::Subprocess
       available_readers.each {|reader| reader.close}
       available_writers.each {|writer| writer.close}
       self.class.deregister_parallel_io(self)
+
+      @finalized = true
     end
   end
 end

data/lib/rubysh/version.rb

@@ -1,3 +1,3 @@
 module Rubysh
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/test/functional/_lib.rb

@@ -3,5 +3,3 @@ require File.expand_path('../_lib', File.dirname(__FILE__))
 module RubyshTest::Functional
   class FunctionalTest < RubyshTest::Test; end
 end
-
-MiniTest::Unit.runner = MiniTest::Unit.new

data/test/functional/lib/env.rb

@@ -1,7 +1,7 @@
 require File.expand_path('../_lib', File.dirname(__FILE__))
 
 module RubyshTest::Functional
-  class TripleLessThanTest < FunctionalTest
+  class EnvTest < FunctionalTest
     describe 'when using <<< string' do
       it 'the string is delivered on stdin' do
         ENV['TEST1'] = '1'

data/test/functional/lib/kill.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../_lib', File.dirname(__FILE__))
+
+module RubyshTest::Functional
+  class KillTest < FunctionalTest
+    describe 'when killing' do
+      it 'delivers a sigterm by default' do
+        result = Rubysh.run_async('ruby', '-e', 'sleep 10', Rubysh.>)
+        result.kill
+        result.wait
+
+        assert_equal(nil, result.exitstatus)
+        assert_equal(Signal.list['TERM'], result.full_status.termsig)
+      end
+
+      it 'delivers the specified signal otherwise' do
+        result = Rubysh.run_async('ruby', '-e', 'sleep 10', Rubysh.>)
+        result.kill('KILL')
+        result.wait
+
+        assert_equal(nil, result.exitstatus)
+        assert_equal(Signal.list['KILL'], result.full_status.termsig)
+      end
+    end
+  end
+end

data/test/functional/lib/read.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../_lib', File.dirname(__FILE__))
+
+module RubyshTest::Functional
+  class ReadTest < FunctionalTest
+    describe 'when reading with :how => :partial' do
+      it 'returns nil once the process is dead' do
+        runner = Rubysh('ruby', '-e', 'puts "hi"', Rubysh.>).run_async
+
+        # Pump stdout
+        while runner.read(:how => :partial)
+        end
+
+        runner.wait
+        assert_equal(nil, runner.read(:how => :partial))
+      end
+    end
+  end
+end

data/test/integration/_lib.rb

@@ -3,5 +3,3 @@ require File.expand_path('../_lib', File.dirname(__FILE__))
 module RubyshTest::Integration
   class IntegrationTest < RubyshTest::Test; end
 end
-
-MiniTest::Unit.runner = MiniTest::Unit.new

data/test/unit/_lib.rb

@@ -3,5 +3,3 @@ require File.expand_path('../_lib', File.dirname(__FILE__))
 module RubyshTest::Unit
   class UnitTest < RubyshTest::Test; end
 end
-
-MiniTest::Unit.runner = MiniTest::Unit.new

data/test/unit/lib/rubysh/command.rb

@@ -15,6 +15,10 @@ module RubyshTest::Unit
         command = Rubysh::Command.new(['ls', '/tmp', directive, '/foo'])
         assert_equal('Command: ls /tmp 2>&1 /foo', command.to_s)
       end
+
+      it 'raises an error when given an unsplatted array' do
+        assert_raises(RuntimeError) {Rubysh::Command.new([['ls', 'stuff']])}
+      end
     end
 
     describe 'when calling #run_async' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysh
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -110,7 +110,9 @@ files:
 - test/functional/_lib.rb
 - test/functional/lib/env.rb
 - test/functional/lib/fd-lister
+- test/functional/lib/kill.rb
 - test/functional/lib/leaked_fds.rb
+- test/functional/lib/read.rb
 - test/functional/lib/redirect_ordering.rb
 - test/functional/lib/triple_less_than.rb
 - test/integration/_lib.rb
@@ -138,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1275881591566036262
+      hash: 3386670358533092265
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1275881591566036262
+      hash: 3386670358533092265
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -162,7 +164,9 @@ test_files:
 - test/functional/_lib.rb
 - test/functional/lib/env.rb
 - test/functional/lib/fd-lister
+- test/functional/lib/kill.rb
 - test/functional/lib/leaked_fds.rb
+- test/functional/lib/read.rb
 - test/functional/lib/redirect_ordering.rb
 - test/functional/lib/triple_less_than.rb
 - test/integration/_lib.rb