command_utils 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3845dc2af885cf859dbc3f1afc1c2a0dd7ef31e4
-  data.tar.gz: 3359ba253daa038a08d4d3247ccd40c2a48d16ac
+  metadata.gz: 43313ab411781575b5f54cd723d95189d6ef8cfd
+  data.tar.gz: 9f7aeb3db8f866314c1d0c59efcf9a7a29e6d681
 SHA512:
-  metadata.gz: c79aa92e07443ddcaf7b986347d5facfccceb2bc1a7d5f70cc7bf3cbdb79ee0234e8eee773697d303364dc605ad533f8d6313f84fde299ac9e3ef2936f075942
-  data.tar.gz: a18f88fc4fcfb06266e7102e958040472a413ca50e6baf68e6a67abd58c513e695e9a767376fb8627620a3d0433526c7404acd24c69bd8c842df18327ebd5ee5
+  metadata.gz: 0f1175dd3ab6259546955779aefca5375a5e7da16c65d00f1af6265ac8874e5a1ee2b9d8ab2d0993dc0550779856ff702e663f578b810ab2a55ffb388dd2f040
+  data.tar.gz: 31be009f839f09db332d9012a71a3e9ef6cd82cf701a1474938bb4c5e75794b4691f2cc424f1cf05ecc6214e8465eea4c58d19448ce609aef7fe558bcac9e92b

data/lib/command_utils.rb

@@ -1,10 +1,11 @@
-require_relative 'command_utils/non_zero_status'
 require_relative 'command_utils/line_buffer'
 
 # Class to assist calling external commands, while processing its output and return code.
-# All methods which execute given command, raise NonZeroStatus if its return is not 0.
 class CommandUtils
 
+  # PID of currently running process.
+  attr_reader :pid
+
   #  call-seq:
   #    new([env,] command...)
   #
@@ -24,29 +25,30 @@ class CommandUtils
     yield self if block_given?
   end
 
-  # Execute command, yielding to given block, each time there is output available.
+  # Execute command, yielding to given block, each time there is output available (not line buffered):
   # stream:: either +:stdout+ or +:stderr+.
   # data:: data read from respective stream.
-  def each_output # :yields: stream, data
-    run do
-      loop do
-        io_list = [@stdout_read, @stderr_read].keep_if{|io| not io.closed?}
-        break if io_list.empty?
-        IO.select(io_list).first.each do |io|
-          if io.eof?
-            io.close
-            next
-          end
-          label = case io
-          when @stdout_read
-            :stdout
-          when @stderr_read
-            :stderr
-          end
-          yield label, io.read
+  # Raises CommandUtils::StatusError class exception if command execution is not successfull.
+  def each_output &block # :yields: stream, data
+    spawn
+    loop do
+      io_list = [@stdout_read, @stderr_read].keep_if{|io| not io.closed?}
+      break if io_list.empty?
+      IO.select(io_list).first.each do |io|
+        if io.eof?
+          io.close
+          next
         end
+        label = case io
+        when @stdout_read
+          :stdout
+        when @stderr_read
+          :stderr
+        end
+        yield label, io.read
       end
     end
+    process_status
   end
 
   #  call-seq:
@@ -57,9 +59,10 @@ class CommandUtils
     self.new(*args).each_output(&block)
   end
 
-  # Execute command, yielding to given block, each time there is a new line available.
+  # Execute command, yielding to given block, each time there is a new line available (does line buffering):
   # stream:: either +:stdout+ or +:stderr+.
   # data:: data read from respective stream.
+  # Raises CommandUtils::StatusError class exception if command execution is not successfull.
   def each_line &block # :yields: stream, data
     stdout_lb = LineBuffer.new(
       proc do |data|
@@ -99,6 +102,7 @@ class CommandUtils
   # and optionally:
   # +:stdout_prefix+:: Prefix to use for all stdout messages.
   # +:stderr_prefix+:: Prefix to use for all stderr messages.
+  # Raises CommandUtils::StatusError class exception if command execution is not successfull.
   def logger_exec options
     each_line do |stream, data|
       level = options["#{stream}_level".to_sym]
@@ -117,12 +121,9 @@ class CommandUtils
 
   private
 
-  def run
-    spawn
-    yield
-    process_status
-  end
-
+  # Process.spawn a new process with @env and @command.
+  #
+  # Sets @pid, @stdout_write and @stderr_write.
   def spawn
     @stdout_read, @stdout_write = IO.pipe
     @stderr_read, @stderr_write = IO.pipe
@@ -142,14 +143,47 @@ class CommandUtils
     @stderr_write.close
   end
 
+  # Parent class for all status errors.
+  class StatusError < StandardError
+    # Process::Status
+    attr_accessor :status
+    # Command as passed to Process#spawn
+    attr_accessor :command
+    def initialize message, status, command
+      super message
+      @status, @command = status, command
+    end
+  end
+
+  # Raised when process exited with non zero status.
+  class NonZeroExit < StatusError ; end
+  # Raised when process was signaled.
+  class Signaled < StatusError ; end
+  # Raised when process was stopped.
+  class Stopped < StatusError ; end
+  # Raised when process exited with unknown status.
+  class Unknown < StatusError ; end
+
+  # Wait for process termination, then process its status.
   def process_status
-    Process.wait @pid
-    unless (status = $?.exitstatus) == 0
-      raise NonZeroStatus.new(
-        "Command exited with #{status}.",
-        status,
-        @command
-        )
+    flags = Process::WNOHANG|Process::WUNTRACED
+    pid, status = Process.wait2(@pid, flags)
+    if status.exited?
+      unless status.exitstatus == 0
+        message = "Command exited with #{status.exitstatus}."
+        raise NonZeroExit.new(message, status, @command)
+      end
+    elsif status.signaled?
+      message = "Command was signaled with #{status.termsig}."
+      message += " Core dump generated." if status.coredump?
+      raise Signaled.new(message, status, @command)
+    elsif status.stopped?
+      message = "Command was stopped with signal #{status.stopsig}, PID=#{pid}."
+      raise Stopped.new(message, status, @command)
+    else
+      message = "Unknown return status."
+      raise Unknown.new(message, status, @command)
     end
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_utils
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Fabio Pugliese Ornellas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,48 +16,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: guard-rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
-  name: guard-rdoc
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: '4.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: '4.6'
 description: This Gem will help you call external commands, process its stdout and
   stderr, to your own fit, and at the end, validate its return code.
 email: fabio.ornellas@gmail.com
@@ -67,7 +67,6 @@ extra_rdoc_files: []
 files:
 - lib/command_utils.rb
 - lib/command_utils/line_buffer.rb
-- lib/command_utils/non_zero_status.rb
 homepage: https://github.com/fornellas/command_utils
 licenses:
 - GPL

data/lib/command_utils/non_zero_status.rb

@@ -1,18 +0,0 @@
-class CommandUtils
-
-  # Raised when executed command does not return 0
-  class NonZeroStatus < RuntimeError
-
-    # Command exit status
-    attr_accessor :status
-    # Command as passed to Process#spawn
-    attr_accessor :command
-
-    def initialize message, status, command
-      super message
-      @status, @command = status, command
-    end
-
-  end
-
-end