tty-command 0.7.0 → 0.10.0

data/lib/tty-command.rb

@@ -1,3 +1 @@
-# encoding: utf-8
-
-require 'tty/command'
+require_relative "tty/command"

data/lib/tty/command.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'rbconfig'
-
-require_relative 'command/cmd'
-require_relative 'command/exit_error'
-require_relative 'command/dry_runner'
-require_relative 'command/process_runner'
-require_relative 'command/printers/null'
-require_relative 'command/printers/pretty'
-require_relative 'command/printers/progress'
-require_relative 'command/printers/quiet'
-require_relative 'command/version'
+require "rbconfig"
+
+require_relative "command/cmd"
+require_relative "command/exit_error"
+require_relative "command/dry_runner"
+require_relative "command/process_runner"
+require_relative "command/printers/null"
+require_relative "command/printers/pretty"
+require_relative "command/printers/progress"
+require_relative "command/printers/quiet"
+require_relative "command/version"
 
 module TTY
   class Command
@@ -19,9 +19,9 @@ module TTY
     TimeoutExceeded = Class.new(StandardError)
 
     # Path to the current Ruby
-    RUBY = ENV['RUBY'] || ::File.join(
-      RbConfig::CONFIG['bindir'],
-      RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT']
+    RUBY = ENV["RUBY"] || ::File.join(
+      RbConfig::CONFIG["bindir"],
+      RbConfig::CONFIG["ruby_install_name"] + RbConfig::CONFIG["EXEEXT"]
     )
 
     WIN_PLATFORMS = /cygwin|mswin|mingw|bccwin|wince|emx/.freeze
@@ -35,7 +35,7 @@ module TTY
     end
 
     def self.windows?
-      !!(RbConfig::CONFIG['host_os'] =~ WIN_PLATFORMS)
+      !!(RbConfig::CONFIG["host_os"] =~ WIN_PLATFORMS)
     end
 
     attr_reader :printer
@@ -59,6 +59,7 @@ module TTY
       @dry_run = options.fetch(:dry_run) { false }
       @printer = use_printer(@printer_name, color: @color, uuid: @uuid)
       @cmd_options = {}
+      @cmd_options[:verbose] = options.fetch(:verbose, true)
       @cmd_options[:pty] = true if options[:pty]
       @cmd_options[:binmode] = true if options[:binmode]
       @cmd_options[:timeout] = options[:timeout] if options[:timeout]
@@ -127,7 +128,7 @@ module TTY
     def wait(*args)
       pattern = args.pop
       unless pattern
-        raise ArgumentError, 'Please provide condition to wait for'
+        raise ArgumentError, "Please provide condition to wait for"
       end
 
       run(*args) do |out, _|
@@ -173,7 +174,7 @@ module TTY
     # @api private
     def command(*args)
       cmd = Cmd.new(*args)
-      cmd.update(@cmd_options)
+      cmd.update(**@cmd_options)
       cmd
     end
 
@@ -203,7 +204,7 @@ module TTY
     #
     # @api private
     def find_printer_class(name)
-      const_name = name.to_s.capitalize.to_sym
+      const_name = name.to_s.split("_").map(&:capitalize).join.to_sym
       if const_name.empty? || !TTY::Command::Printers.const_defined?(const_name)
         raise ArgumentError, %(Unknown printer type "#{name}")
       end

data/lib/tty/command/child_process.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'tempfile'
-require 'securerandom'
-require 'io/console'
+require "tempfile"
+require "securerandom"
+require "io/console"
 
 module TTY
   class Command
@@ -25,14 +24,15 @@ module TTY
         process_opts = normalize_redirect_options(cmd.options)
         binmode = cmd.options[:binmode] || false
         pty     = cmd.options[:pty] || false
+        verbose = cmd.options[:verbose]
 
-        pty = try_loading_pty if pty
-        require('pty') if pty # load within this scope
+        pty = try_loading_pty(verbose) if pty
+        require("pty") if pty # load within this scope
 
         # Create pipes
-        in_rd,  in_wr  = pty ? PTY.open : IO.pipe('utf-8') # reading
-        out_rd, out_wr = pty ? PTY.open : IO.pipe('utf-8') # writing
-        err_rd, err_wr = pty ? PTY.open : IO.pipe('utf-8') # error
+        in_rd,  in_wr  = pty ? PTY.open : IO.pipe("utf-8") # reading
+        out_rd, out_wr = pty ? PTY.open : IO.pipe("utf-8") # writing
+        err_rd, err_wr = pty ? PTY.open : IO.pipe("utf-8") # error
         in_wr.sync = true
 
         if binmode
@@ -65,8 +65,8 @@ module TTY
 
         pid = Process.spawn(cmd.to_command, opts)
 
-        # close in parent process
-        [in_rd, out_wr, err_wr].each { |fd| fd.close if fd }
+        # close streams in parent process talking to the child
+        close_fds(in_rd, out_wr, err_wr)
 
         tuple = [pid, in_wr, out_rd, err_rd]
 
@@ -75,7 +75,7 @@ module TTY
             return yield(*tuple)
           ensure
             # ensure parent pipes are closed
-            [in_wr, out_rd, err_rd].each { |fd| fd.close if fd && !fd.closed? }
+            close_fds(in_wr, out_rd, err_rd)
           end
         else
           tuple
@@ -83,16 +83,23 @@ module TTY
       end
       module_function :spawn
 
+      # Close all streams
+      # @api private
+      def close_fds(*fds)
+        fds.each { |fd| fd && !fd.closed? && fd.close }
+      end
+      module_function :close_fds
+
       # Try loading pty module
       #
       # @return [Boolean]
       #
       # @api private
-      def try_loading_pty
+      def try_loading_pty(verbose = false)
         require 'pty'
         true
       rescue LoadError
-        warn("Requested PTY device but the system doesn't support it.")
+        warn("Requested PTY device but the system doesn't support it.") if verbose
         false
       end
       module_function :try_loading_pty
@@ -125,7 +132,7 @@ module TTY
         key   = fd_to_process_key(spawn_key)
         value = spawn_value
 
-        if key.to_s == 'in'
+        if key.to_s == "in"
           value = convert_to_fd(spawn_value)
         end
 
@@ -188,7 +195,7 @@ module TTY
           return object
         end
 
-        tmp = ::Tempfile.new(::SecureRandom.uuid.split('-')[0])
+        tmp = ::Tempfile.new(::SecureRandom.uuid.split("-")[0])
         content = try_reading(object)
         tmp.write(content)
         tmp.rewind

data/lib/tty/command/cmd.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'securerandom'
-require 'shellwords'
+require "securerandom"
+require "shellwords"
 
 module TTY
   class Command
@@ -22,6 +22,9 @@ module TTY
       # @api public
       attr_reader :uuid
 
+      # Flag that controls whether to print the output only on error or not
+      attr_reader :only_output_on_error
+
       # Initialize a new Cmd object
       #
       # @api private
@@ -30,14 +33,14 @@ module TTY
         if env_or_cmd.respond_to?(:to_hash)
           @env = env_or_cmd
           unless command = args.shift
-            raise ArgumentError, 'Cmd requires command argument'
+            raise ArgumentError, "Cmd requires command argument"
           end
         else
           command = env_or_cmd
         end
 
         if args.empty? && cmd = command.to_s
-          raise ArgumentError, 'No command provided' if cmd.empty?
+          raise ArgumentError, "No command provided" if cmd.empty?
           @command = sanitize(cmd)
           @argv = []
         else
@@ -52,14 +55,15 @@ module TTY
         @env ||= {}
         @options = opts
 
-        @uuid = SecureRandom.uuid.split('-')[0]
+        @uuid = SecureRandom.uuid.split("-")[0]
+        @only_output_on_error = opts.fetch(:only_output_on_error) { false }
         freeze
       end
 
       # Extend command options if keys don't already exist
       #
       # @api public
-      def update(**options)
+      def update(options)
         @options.update(options.update(@options))
       end
 
@@ -75,12 +79,12 @@ module TTY
           converted_key = key.is_a?(Symbol) ? key.to_s.upcase : key.to_s
           escaped_val = val.to_s.gsub(/"/, '\"')
           %(#{converted_key}="#{escaped_val}")
-        end.join(' ')
+        end.join(" ")
       end
 
       def evars(value, &block)
         return (value || block) unless environment.any?
-        %(( export #{environment_string} ; %s )) % [value || block.call]
+        "( export #{environment_string} ; #{value || block.call} )"
       end
 
       def umask(value)
@@ -90,12 +94,12 @@ module TTY
 
       def chdir(value)
         return value unless options[:chdir]
-        %(cd #{options[:chdir]} && %s) % [value]
+        %(cd #{Shellwords.escape(options[:chdir])} && #{value})
       end
 
       def user(value)
         return value unless options[:user]
-        vars = environment.any? ? "#{environment_string} " : ''
+        vars = environment.any? ? "#{environment_string} " : ""
         %(sudo -u #{options[:user]} #{vars}-- sh -c '%s') % [value]
       end
 
@@ -119,7 +123,7 @@ module TTY
 
       # @api public
       def to_s
-        [command.to_s, *Array(argv)].join(' ')
+        [command.to_s, *Array(argv)].join(" ")
       end
 
       # @api public

data/lib/tty/command/dry_runner.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require_relative 'result'
+require_relative "result"
 
 module TTY
   class Command
@@ -18,10 +17,10 @@ module TTY
       # @api public
       def run!(*)
         cmd.to_command
-        message = "#{@printer.decorate('(dry run)', :blue)} " +
+        message = "#{@printer.decorate("(dry run)", :blue)} " +
                   @printer.decorate(cmd.to_command, :yellow, :bold)
-        @printer.write(message, cmd.uuid)
-        Result.new(0, '', '')
+        @printer.write(cmd, message, cmd.uuid)
+        Result.new(0, "", "")
       end
     end # DryRunner
   end # Command

data/lib/tty/command/exit_error.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module TTY
@@ -25,7 +24,7 @@ module TTY
       end
 
       def extract_output(value)
-        (value || '').strip.empty? ? 'Nothing written' : value.strip
+        (value || "").strip.empty? ? "Nothing written" : value.strip
       end
     end # ExitError
   end # Command

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

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'pastel'
+require "pastel"
 
 module TTY
   class Command
@@ -11,6 +9,7 @@ module TTY
         def_delegators :@color, :decorate
 
         attr_reader :output, :options
+        attr_accessor :out_data, :err_data
 
         # Initialize a Printer object
         #
@@ -21,8 +20,11 @@ module TTY
         def initialize(output, options = {})
           @output  = output
           @options = options
-          @enabled  = options.fetch(:color) { true }
-          @color   = ::Pastel.new(output: output, enabled: @enabled)
+          @enabled = options.fetch(:color, true)
+          @color   = ::Pastel.new(enabled: @enabled)
+
+          @out_data = ""
+          @err_data = ""
         end
 
         def print_command_start(cmd, *args)
@@ -30,18 +32,18 @@ module TTY
         end
 
         def print_command_out_data(cmd, *args)
-          write(args.join(' '))
+          write(args.join(" "))
         end
 
         def print_command_err_data(cmd, *args)
-          write(args.join(' '))
+          write(args.join(" "))
         end
 
         def print_command_exit(cmd, *args)
-          write(args.join(' '))
+          write(args.join(" "))
         end
 
-        def write(message)
+        def write(cmd, message)
           raise NotImplemented, "Abstract printer cannot be used"
         end
       end # Abstract

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

@@ -1,7 +1,4 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require_relative 'abstract'
+require_relative "abstract"
 
 module TTY
   class Command

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

@@ -1,51 +1,58 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'pastel'
-
-require_relative 'abstract'
+require_relative "abstract"
 
 module TTY
   class Command
     module Printers
       class Pretty < Abstract
-        TIME_FORMAT = "%5.3f %s".freeze
+        TIME_FORMAT = "%5.3f %s"
+
+        def initialize(*)
+          super
+          @uuid = options.fetch(:uuid, true)
+        end
 
         def print_command_start(cmd, *args)
           message = ["Running #{decorate(cmd.to_command, :yellow, :bold)}"]
-          message << args.map(&:chomp).join(' ') unless args.empty?
-          write(message.join, cmd.uuid)
+          message << args.map(&:chomp).join(" ") unless args.empty?
+          write(cmd, message.join)
         end
 
         def print_command_out_data(cmd, *args)
-          message = args.map(&:chomp).join(' ')
-          write("\t#{message}", cmd.uuid)
+          message = args.map(&:chomp).join(" ")
+          write(cmd, "\t#{message}", out_data)
         end
 
         def print_command_err_data(cmd, *args)
-          message = args.map(&:chomp).join(' ')
-          write("\t" + decorate(message, :red), cmd.uuid)
+          message = args.map(&:chomp).join(" ")
+          write(cmd, "\t" + decorate(message, :red), err_data)
         end
 
         def print_command_exit(cmd, status, runtime, *args)
-          runtime = TIME_FORMAT % [runtime, pluralize(runtime, 'second')]
+          if cmd.only_output_on_error && !status.zero?
+            output << out_data
+            output << err_data
+          end
+
+          runtime = TIME_FORMAT % [runtime, pluralize(runtime, "second")]
           message = ["Finished in #{runtime}"]
           message << " with exit status #{status}" if status
           message << " (#{success_or_failure(status)})"
-          write(message.join, cmd.uuid)
+          write(cmd, message.join)
         end
 
         # Write message out to output
         #
         # @api private
-        def write(message, uuid = nil)
-          uuid_needed = options.fetch(:uuid) { true }
+        def write(cmd, message, data = nil)
+          cmd_set_uuid = cmd.options.fetch(:uuid, true)
+          uuid_needed = cmd.options[:uuid].nil? ? @uuid : cmd_set_uuid
           out = []
           if uuid_needed
-            out << "[#{decorate(uuid, :green)}] " unless uuid.nil?
+            out << "[#{decorate(cmd.uuid, :green)}] " unless cmd.uuid.nil?
           end
           out << "#{message}\n"
-          output << out.join
+          target = (cmd.only_output_on_error && !data.nil?) ? data : output
+          target << out.join
         end
 
         private
@@ -54,15 +61,15 @@ module TTY
         #
         # @api private
         def pluralize(count, word)
-          "#{word}#{'s' unless count.to_f == 1}"
+          "#{word}#{'s' unless count.to_i == 1}"
         end
 
         # @api private
         def success_or_failure(status)
           if status == 0
-            decorate('successful', :green, :bold)
+            decorate("successful", :green, :bold)
           else
-            decorate('failed', :red, :bold)
+            decorate("failed", :red, :bold)
           end
         end
       end # Pretty