tty-command 0.7.0 → 0.10.0

data/lib/tty/command/printers/progress.rb

@@ -1,14 +1,9 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'pastel'
-require_relative 'abstract'
+require_relative "abstract"
 
 module TTY
   class Command
     module Printers
       class Progress < Abstract
-
         def print_command_exit(cmd, status, runtime, *args)
           output.print(success_or_failure(status))
         end
@@ -21,9 +16,9 @@ module TTY
         # @api private
         def success_or_failure(status)
           if status == 0
-            decorate('.', :green)
+            decorate(".", :green)
           else
-            decorate('F', :red)
+            decorate("F", :red)
           end
         end
       end # Progress

data/lib/tty/command/printers/quiet.rb

@@ -1,23 +1,33 @@
-# encoding: utf-8
-
-require_relative 'abstract'
+require_relative "abstract"
 
 module TTY
   class Command
     module Printers
       class Quiet < Abstract
-        attr_reader :output, :options
-
         def print_command_start(cmd)
           # quiet
         end
 
-        def print_command_exit(cmd, *args)
+        def print_command_out_data(cmd, *args)
+          write(cmd, args.join(" "), out_data)
+        end
+
+        def print_command_err_data(cmd, *args)
+          write(cmd, args.join(" "), err_data)
+        end
+
+        def print_command_exit(cmd, status, *args)
+          unless !cmd.only_output_on_error || status.zero?
+            output << out_data
+            output << err_data
+          end
+
           # quiet
         end
 
-        def write(message)
-          output << message
+        def write(cmd, message, data = nil)
+          target = (cmd.only_output_on_error && !data.nil?) ? data : output
+          target << message
         end
       end # Progress
     end # Printers

data/lib/tty/command/process_runner.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'thread'
+require "thread"
 
-require_relative 'child_process'
-require_relative 'result'
-require_relative 'truncator'
+require_relative "child_process"
+require_relative "result"
+require_relative "truncator"
 
 module TTY
   class Command
@@ -23,7 +22,8 @@ module TTY
         @cmd     = cmd
         @timeout = cmd.options[:timeout]
         @input   = cmd.options[:input]
-        @signal  = cmd.options[:signal] || :TERM
+        @signal  = cmd.options[:signal] || "SIGKILL"
+        @binmode = cmd.options[:binmode]
         @printer = printer
         @block   = block
       end
@@ -40,22 +40,10 @@ module TTY
       def run!
         @printer.print_command_start(cmd)
         start = Time.now
-        runtime = 0.0
 
         pid, stdin, stdout, stderr = ChildProcess.spawn(cmd)
 
-        # no input to write, close child's stdin pipe
-        stdin.close if (@input.nil? || @input.empty?) && !stdin.nil?
-
-        readers = [stdout, stderr]
-        writers = [@input && stdin].compact
-
-        while writers.any?
-          ready_readers, ready_writers = IO.select(readers, writers, [], @timeout)
-          raise TimeoutExceeded if ready_readers.nil? || ready_writers.nil?
-
-          write_stream(ready_writers, writers)
-        end
+        write_stream(stdin, @input)
 
         stdout_data, stderr_data = read_streams(stdout, stderr)
 
@@ -67,6 +55,10 @@ module TTY
         Result.new(status, stdout_data, stderr_data, runtime)
       ensure
         [stdin, stdout, stderr].each { |fd| fd.close if fd && !fd.closed? }
+        if pid # Ensure no zombie processes
+          ::Process.detach(pid)
+          terminate(pid)
+        end
       end
 
       # Stop a process marked by pid
@@ -80,6 +72,9 @@ module TTY
 
       private
 
+      # The buffer size for reading stdout and stderr
+      BUFSIZE = 16 * 1024
+
       # @api private
       def handle_timeout(runtime)
         return unless @timeout
@@ -91,28 +86,35 @@ module TTY
       # Write the input to the process stdin
       #
       # @api private
-      def write_stream(ready_writers, writers)
+      def write_stream(stream, input)
         start = Time.now
-        ready_writers.each do |fd|
-          begin
-            err   = nil
-            size  = fd.write(@input)
-            @input = @input.byteslice(size..-1)
-          rescue IO::WaitWritable
-          rescue Errno::EPIPE => err
-            # The pipe closed before all input written
-            # Probably process exited prematurely
-            fd.close
-            writers.delete(fd)
-          end
-          if err || @input.bytesize == 0
-            fd.close
-            writers.delete(fd)
-          end
+        writers = [input && stream].compact
+
+        while writers.any?
+          ready = IO.select(nil, writers, writers, @timeout)
+          raise TimeoutExceeded if ready.nil?
+
+          ready[1].each do |writer|
+            begin
+              err   = nil
+              size  = writer.write(@input)
+              input = input.byteslice(size..-1)
+            rescue IO::WaitWritable
+            rescue Errno::EPIPE => err
+              # The pipe closed before all input written
+              # Probably process exited prematurely
+              writer.close
+              writers.delete(writer)
+            end
+            if err || input.bytesize == 0
+              writer.close
+              writers.delete(writer)
+            end
 
-          # control total time spent writing
-          runtime = Time.now - start
-          handle_timeout(runtime)
+            # control total time spent writing
+            runtime = Time.now - start
+            handle_timeout(runtime)
+          end
         end
       end
 
@@ -126,53 +128,74 @@ module TTY
         stdout_data = []
         stderr_data = Truncator.new
 
-        out_buffer = -> (line) {
-          stdout_data << line
-          @printer.print_command_out_data(cmd, line)
-          @block.(line, nil) if @block
+        out_handler = ->(data) {
+          stdout_data << data
+          @printer.print_command_out_data(cmd, data)
+          @block.(data, nil) if @block
         }
 
-        err_buffer = -> (line) {
-          stderr_data << line
-          @printer.print_command_err_data(cmd, line)
-          @block.(nil, line) if @block
+        err_handler = ->(data) {
+          stderr_data << data
+          @printer.print_command_err_data(cmd, data)
+          @block.(nil, data) if @block
         }
 
-        stdout_thread = read_stream(stdout, out_buffer)
-        stderr_thread = read_stream(stderr, err_buffer)
+        stdout_thread = read_stream(stdout, out_handler)
+        stderr_thread = read_stream(stderr, err_handler)
 
         stdout_thread.join
         stderr_thread.join
 
-        [stdout_data.join, stderr_data.read]
+        encoding = @binmode ? Encoding::BINARY : Encoding::UTF_8
+
+        [
+          stdout_data.join.force_encoding(encoding),
+          stderr_data.read.dup.force_encoding(encoding)
+        ]
       end
 
-      def read_stream(stream, buffer)
+      # Read stream and invoke handler when data becomes available
+      #
+      # @param [IO] stream
+      #   the stream to read data from
+      # @param [Proc] handler
+      #   the handler to call when data becomes available
+      #
+      # @api private
+      def read_stream(stream, handler)
         Thread.new do
+          if Thread.current.respond_to?(:report_on_exception)
+            Thread.current.report_on_exception = false
+          end
           Thread.current[:cmd_start] = Time.now
-          begin
-            while (line = stream.gets)
-              buffer.(line)
-
-              # control total time spent reading
-              runtime = Time.now - Thread.current[:cmd_start]
-              handle_timeout(runtime)
+          readers = [stream]
+
+          while readers.any?
+            ready = IO.select(readers, nil, readers, @timeout)
+            raise TimeoutExceeded if ready.nil?
+
+            ready[0].each do |reader|
+              begin
+                chunk = reader.readpartial(BUFSIZE)
+                handler.(chunk)
+
+                # control total time spent reading
+                runtime = Time.now - Thread.current[:cmd_start]
+                handle_timeout(runtime)
+              rescue Errno::EAGAIN, Errno::EINTR
+              rescue EOFError, Errno::EPIPE, Errno::EIO # thrown by PTY
+                readers.delete(reader)
+                reader.close
+              end
             end
-          rescue Errno::EIO
-            # GNU/Linux `gets` raises when PTY slave is closed
-            nil
-          rescue => err
-            raise err
-          ensure
-            stream.close
           end
         end
       end
 
       # @api private
       def waitpid(pid)
-        ::Process.waitpid(pid, Process::WUNTRACED)
-        $?.exitstatus
+        _pid, status = ::Process.waitpid2(pid, ::Process::WUNTRACED)
+        status.exitstatus || status.termsig if _pid
       rescue Errno::ECHILD
         # In JRuby, waiting on a finished pid raises.
       end

data/lib/tty/command/result.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module TTY

data/lib/tty/command/truncator.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module TTY
@@ -18,8 +17,8 @@ module TTY
       # @api public
       def initialize(options = {})
         @max_size = options.fetch(:max_size) { DEFAULT_SIZE }
-        @prefix   = ''
-        @suffix   = ''
+        @prefix   = ""
+        @suffix   = ""
         @skipped  = 0
       end
 
@@ -93,7 +92,7 @@ module TTY
       # @api private
       def append(value, dst)
         remain    = @max_size - dst.bytesize
-        remaining = ''
+        remaining = ""
         if remain > 0
           value_bytes = value.to_s.bytesize
           offset = value_bytes < remain ? value_bytes : remain

data/lib/tty/command/version.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Command
-    VERSION = '0.7.0'
+    VERSION = "0.10.0"
   end # Command
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-command
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-19 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,98 +16,57 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Execute shell commands with pretty output logging and capture their stdout,
   stderr and exit status. Redirect stdin, stdout and stderr of each command to a file
   or a string.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- benchmarks/memory.rb
-- bin/console
-- bin/setup
-- examples/bash.rb
-- examples/basic.rb
-- examples/cli
-- examples/env.rb
-- examples/logger.rb
-- examples/output.rb
-- examples/pty.rb
-- examples/redirect_stderr.rb
-- examples/redirect_stdin.rb
-- examples/redirect_stdout.rb
-- examples/stdin_input.rb
-- examples/threaded.rb
-- examples/timeout.rb
-- examples/wait.rb
 - lib/tty-command.rb
 - lib/tty/command.rb
 - lib/tty/command/child_process.rb
@@ -123,14 +82,16 @@ files:
 - lib/tty/command/result.rb
 - lib/tty/command/truncator.rb
 - lib/tty/command/version.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-command.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-command/issues
+  changelog_uri: https://github.com/piotrmurach/tty-command/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-command
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-command
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -139,15 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Execute shell commands with pretty output logging and capture their stdout,