tty-command 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9086c13127af2f7d61b0577426a34ea6e71929c
-  data.tar.gz: fbb089e7cc7d6937571ab84c3700856bb6f7eac7
+  metadata.gz: c3d696d9fa5255f95622561988eddfcb26650824
+  data.tar.gz: cf0fe3027e2e2958b55a1c99ce1f9769ccbd717a
 SHA512:
-  metadata.gz: 3eeb7cc3fc245a9bc126ee2948c9d02ebae2e88df4f83a4c3ead72e4ee8b1597ac087b039448f843ab4f305575957dbde65f86ff7813101678a801aabc3f37a3
-  data.tar.gz: 028e2be35a74088e0015bb60577a4cbdf462b31e727221aa7e3d72a7c2530c68f47bdff8ed1593e55d1af249f1e006d6078d15d55dbbc59d839fc35a5fac4a6b
+  metadata.gz: 06bdcfbea782615ef663e866bc11862f7cc9046a98ce6748418d83c4d539597e93f6d31bd928477b91a08370c9db9cef33094252110e08439a06cc02bac7b60d
+  data.tar.gz: 94da004a191721e5d45e26f62587d5bfadb767fc083af00fa3eeac4d7e5520b7ec354578597b6c563bfb423adcb6d018e41d9215e8cf592099f79475dedf1e2c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [v0.6.0] - 2017-07-22
+
+### Added
+* Add runtime property to command result
+* Add ability to merge multiple redirects
+
+### Changed
+* Change to make all strings immutable
+* Change waiting for pid to recover when already dead
+
+### Fix
+* Fix redirection to instead of redirecting to parent process, redirect to child process. And hence allow for :out => :err redirection to work with output logging.
+
 ## [v0.5.0] - 2017-07-16
 
 ### Added

data/README.md

@@ -278,33 +278,54 @@ cmd.run(:echo, 'hello', chdir: '/var/tmp')
 
 There are few ways you can redirect commands output.
 
-You can directly use shell redirection facility like so:
+You can directly use shell redirection like so:
 
 ```ruby
-cmd.run("ls 1&>2")
+out, err = cmd.run("ls 1&>2")
+puts err
+# =>
+# CHANGELOG.md
+# CODE_OF_CONDUCT.md
+# Gemfile
+# ...
 ```
 
-You can provide the streams as additional hash options where the key is one of `:in`, `:out`, `:err`, an integer (a file descriptor for the child process), an IO or array. The pair value can be a filename for redirection.
+You can provide redirection as additional hash options where the key is one of `:in`, `:out`, `:err`, an integer (a file descriptor for the child process), an IO or array. For example, `stderr` can be merged into stdout as follows:
 
 ```ruby
-cmd.run(:ls, :in => "/dev/null")   # read mode
-cmd.run(:ls, :out => "/dev/null")  # write mode
-cmd.run(:ls, :err => "log")        # write mode
-cmd.run(:ls, [:out, :err] => "/dev/null") # write mode
-cmd.run(:ls, 3 => "/dev/null")     # read mode
+cmd.run(:ls, :err => :out)
+cmd.run(:ls, :stderr => :stdout)
+cmd.run(:ls, 2 => 1)
+cmd.run(:ls, STDERR => :out)
+cmd.run(:ls, STDERR => STDOUT)
 ```
 
-You can also provide actual file descriptor for redirection:
+The hash key and value specify a file descriptor in the child process (stderr & stdout in the examples).
+
+You can also redirect to a file:
 
 ```ruby
+cmd.run(:cat, :in => 'file')
 cmd.run(:cat, :in => open('/etc/passwd'))
+cmd.run(:ls, :out => 'log')
+cmd.run(:ls, :out => "/dev/null")
+cmd.run(:ls, :out => 'out.log', :err => "err.log")
+cmd.run(:ls, [:out, :err] => "log")
+cmd.run("ls 1>&2", :err => 'log')
+```
+
+It is possible to specify flags and permissions of file creation explicitly by passing an array value:
+
+```ruby
+cmd.run(:ls, :out => ['log', 'w']) # 0664 assumed
+cmd.run(:ls, :out => ['log', 'w', 0600])
+cmd.run(:ls, :out => ['log', File::WRONLY|File::EXCL|File::CREAT, 0600])
 ```
 
-For example, to merge stderr into stdout you would do:
+You can, for example, read data from one source and output to another:
 
 ```ruby
-cmd.run(:ls, '-la', :stderr => :stdout)
-cmd.run(:ls, '-la', 2 => 1)
+cmd.run("cat", :in => "Gemfile", :out => 'gemfile.log')
 ```
 
 #### 3.2.3 Handling Input

data/examples/redirect_stderr.rb

@@ -4,7 +4,7 @@ require 'tty-command'
 
 cmd = TTY::Command.new
 
-out, err = cmd.run("echo 'hello' 1>& 2")
+out, err = cmd.run("echo 'hello'", :out => :err)
 
 puts "out: #{out}"
 puts "err: #{err}"

data/examples/redirect_stdout.rb

@@ -4,4 +4,7 @@ require 'tty-command'
 
 cmd = TTY::Command.new
 
-cmd.run(:ls, :out => 'ls_sample')
+out, err = cmd.run(:ls, :out => 'ls.log')
+
+puts "OUT>> #{out}"
+puts "ERR>> #{err}"

data/lib/tty/command.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'rbconfig'
 

data/lib/tty/command/dry_runner.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'result'
 
@@ -15,10 +16,10 @@ module TTY
       # Show command without running
       #
       # @api public
-      def run!(&block)
+      def run!(*)
         cmd.to_command
-        message = "#{@printer.decorate('(dry run)', :blue)} "
-        message << @printer.decorate(cmd.to_command, :yellow, :bold)
+        message = "#{@printer.decorate('(dry run)', :blue)} " +
+                  @printer.decorate(cmd.to_command, :yellow, :bold)
         @printer.write(message, cmd.uuid)
         Result.new(0, '', '')
       end

data/lib/tty/command/execute.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'tempfile'
 require 'securerandom'
@@ -29,11 +30,11 @@ module TTY
         in_wr.sync = true
 
         # redirect fds
-        opts = ({
+        opts = {
           :in  => in_rd,  in_wr  => :close,
           :out => out_wr, out_rd => :close,
           :err => err_wr, err_rd => :close
-        }).merge(process_opts)
+        }.merge(process_opts)
 
         pid = Process.spawn(cmd.to_command, opts)
 
@@ -55,47 +56,86 @@ module TTY
 
       private
 
+      # Normalize spawn fd into :in, :out, :err keys.
+      #
+      # @return [Hash]
+      #
+      # @api private
       def normalize_redirect_options(options)
         options.reduce({}) do |opts, (key, value)|
           if fd?(key)
-            process_key = fd_to_process_key(key)
-            if process_key.to_s == 'in'
-              value = convert_to_fd(value)
+            spawn_key, spawn_value = convert(key, value)
+            opts[spawn_key] = spawn_value
+          elsif key.is_a?(Array) && key.all?(&method(:fd?))
+            key.each do |k|
+              spawn_key, spawn_value = convert(k, value)
+              opts[spawn_key] = spawn_value
             end
-            opts[process_key] = value
           end
           opts
         end
       end
 
+      # Convert option pari to recognized spawn option pair
+      #
+      # @api private
+      def convert(spawn_key, spawn_value)
+        key   = fd_to_process_key(spawn_key)
+        value = spawn_value
+
+        if key.to_s == 'in'
+          value = convert_to_fd(spawn_value)
+        end
+
+        if fd?(spawn_value)
+          value = fd_to_process_key(spawn_value)
+          value = [:child, value] # redirect in child process
+        end
+        [key, value]
+      end
+
+      # Determine if object is a fd
+      #
+      # @return [Boolean]
+      #
       # @api private
       def fd?(object)
         case object
-        when :stdin, :stdout, :stderr, :in, :out, :err
-          true
-        when STDIN, STDOUT, STDERR, $stdin, $stdout, $stderr, ::IO
-          true
-        when ::IO
+        when :stdin, :stdout, :stderr, :in, :out, :err,
+             STDIN, STDOUT, STDERR, $stdin, $stdout, $stderr, ::IO
           true
         when ::Integer
           object >= 0
-        when respond_to?(:to_i) && !object.to_io.nil?
-          true
         else
-          false
+          respond_to?(:to_i) && !object.to_io.nil?
         end
       end
 
-      def try_reading(object)
-        if object.respond_to?(:read)
-          object.read
-        elsif object.respond_to?(:to_s)
-          object.to_s
-        else
+      # Convert fd to name :in, :out, :err
+      #
+      # @api private
+      def fd_to_process_key(object)
+        case object
+        when STDIN, $stdin, :in, :stdin, 0
+          :in
+        when STDOUT, $stdout, :out, :stdout, 1
+          :out
+        when STDERR, $stderr, :err, :stderr, 2
+          :err
+        when Integer
+          object >= 0 ? IO.for_fd(object) : nil
+        when IO
           object
+        when respond_to?(:to_io)
+          object.to_io
+        else
+          raise ExecuteError, "Wrong execute redirect: #{object.inspect}"
         end
       end
 
+      # Convert file name to file handle
+      #
+      # @api private
       def convert_to_fd(object)
         return object if fd?(object)
 
@@ -104,29 +144,22 @@ module TTY
         end
 
         tmp = ::Tempfile.new(::SecureRandom.uuid.split('-')[0])
-
         content = try_reading(object)
         tmp.write(content)
         tmp.rewind
         tmp
       end
 
-      def fd_to_process_key(object)
-        case object
-        when STDIN, $stdin, :in, :stdin, 0
-          :in
-        when STDOUT, $stdout, :out, :stdout, 1
-          :out
-        when STDERR, $stderr, :err, :stderr, 2
-          :err
-        when Integer
-          object >= 0 ? IO.for_fd(object) : nil
-        when IO
-          object
-        when respond_to?(:to_io)
-          object.to_io
+      # Attempts to read object content
+      #
+      # @api private
+      def try_reading(object)
+        if object.respond_to?(:read)
+          object.read
+        elsif object.respond_to?(:to_s)
+          object.to_s
         else
-          raise ExecuteError, "Wrong execute redirect: #{object.inspect}"
+          object
         end
       end
     end # Execute

data/lib/tty/command/exit_error.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Command
@@ -17,11 +18,14 @@ module TTY
       end
 
       def info(cmd_name, result)
-        message = ''
-        message << "Running `#{cmd_name}` failed with\n"
-        message << "  exit status: #{result.exit_status}\n"
-        message << "  stdout: #{(result.out || '').strip.empty? ? 'Nothing written' : result.out.strip}\n"
-        message << "  stderr: #{(result.err || '').strip.empty? ? 'Nothing written' : result.err.strip}\n"
+        "Running `#{cmd_name}` failed with\n" \
+        "  exit status: #{result.exit_status}\n" \
+        "  stdout: #{extract_output(result.out)}\n" \
+        "  stderr: #{extract_output(result.err)}\n"
+      end
+
+      def extract_output(value)
+        (value || '').strip.empty? ? 'Nothing written' : value.strip
       end
     end # ExitError
   end # Command

data/lib/tty/command/process_runner.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'thread'
 
@@ -37,7 +38,7 @@ module TTY
         start = Time.now
         runtime = 0.0
 
-        pid, stdin, stdout, stderr = spawn(cmd) # do |pid, stdin, stdout, stderr|
+        pid, stdin, stdout, stderr = spawn(cmd)
 
         # write and read streams
         write_stream(stdin)
@@ -48,7 +49,7 @@ module TTY
 
         @printer.print_command_exit(cmd, status, runtime)
 
-        Result.new(status, stdout_data, stderr_data)
+        Result.new(status, stdout_data, stderr_data, runtime)
       rescue
         terminate(pid)
         Result.new(-1, stdout_data, stderr_data)
@@ -62,7 +63,7 @@ module TTY
       #
       # @api public
       def terminate(pid)
-        ::Process.kill(@signal, pid)
+        ::Process.kill(@signal, pid) rescue nil
       end
 
       private
@@ -111,7 +112,7 @@ module TTY
       #
       # @api private
       def read_streams(stdout, stderr, &block)
-        stdout_data = ''
+        stdout_data = []
         stderr_data = Truncator.new
 
         print_out = -> (cmd, line) { @printer.print_command_out_data(cmd, line) }
@@ -131,7 +132,7 @@ module TTY
           end
         end
 
-        [stdout_data, stderr_data.read]
+        [stdout_data.join, stderr_data.read]
       end
 
       def read_stream(stream, data, print_callback, callback)

data/lib/tty/command/result.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Command
@@ -16,10 +17,17 @@ module TTY
       attr_reader :err
       alias stderr err
 
-      def initialize(status, out, err)
+      # Total command execution time
+      attr_reader :runtime
+
+      # Create a result
+      #
+      # @api public
+      def initialize(status, out, err, runtime = 0.0)
         @status = status
         @out    = out
         @err    = err
+        @runtime = runtime
       end
 
       # Enumerate over output lines

data/lib/tty/command/truncator.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Command
@@ -33,14 +34,14 @@ module TTY
       def write(content)
         content = content.to_s.dup
 
-        content = append(content, @prefix)
+        content, @prefix = append(content, @prefix)
 
         if (over = (content.bytesize - @max_size)) > 0
           content = content.byteslice(over..-1)
           @skipped += over
         end
 
-        content = append(content, @suffix)
+        content, @suffix = append(content, @suffix)
 
         # suffix is full but we still have content to write
         while content.bytesize > 0
@@ -61,11 +62,7 @@ module TTY
           return @prefix << @suffix
         end
 
-        res = ''
-        res << @prefix
-        res << "\n... omitting #{@skipped} bytes ...\n"
-        res << @suffix
-        res
+         @prefix + "\n... omitting #{@skipped} bytes ...\n" + @suffix
       end
       alias to_s read
 
@@ -95,14 +92,15 @@ module TTY
       #
       # @api private
       def append(value, dst)
-        remain = @max_size - dst.bytesize
+        remain    = @max_size - dst.bytesize
+        remaining = ''
         if remain > 0
           value_bytes = value.to_s.bytesize
           offset = value_bytes < remain ? value_bytes : remain
-          dst << value.byteslice(0...offset)
+          remaining = value.byteslice(0...offset)
           value = value.byteslice(offset..-1)
         end
-        value
+        [value, dst + remaining]
       end
     end # Truncator
   end # Command

data/lib/tty/command/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Command
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end # Command
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-command
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2017-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel