tty-command 0.9.0 → 0.10.0

data/lib/tty/command/cmd.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-require 'shellwords'
+require "securerandom"
+require "shellwords"
 
 module TTY
   class Command
@@ -33,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
@@ -55,7 +55,7 @@ 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
@@ -63,7 +63,7 @@ module TTY
       # Extend command options if keys don't already exist
       #
       # @api public
-      def update(**options)
+      def update(options)
         @options.update(options.update(@options))
       end
 
@@ -79,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)
@@ -94,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
 
@@ -123,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,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'result'
+require_relative "result"
 
 module TTY
   class Command
@@ -17,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(cmd, message, cmd.uuid)
-        Result.new(0, '', '')
+        Result.new(0, "", "")
       end
     end # DryRunner
   end # Command

data/lib/tty/command/exit_error.rb

@@ -24,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
@@ -22,11 +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 = ''
+          @out_data = ""
+          @err_data = ""
         end
 
         def print_command_start(cmd, *args)
@@ -34,15 +32,15 @@ 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(cmd, message)

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,34 +1,29 @@
-# 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 }
+          @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?
+          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(' ')
+          message = args.map(&:chomp).join(" ")
           write(cmd, "\t#{message}", out_data)
         end
 
         def print_command_err_data(cmd, *args)
-          message = args.map(&:chomp).join(' ')
+          message = args.map(&:chomp).join(" ")
           write(cmd, "\t" + decorate(message, :red), err_data)
         end
 
@@ -38,7 +33,7 @@ module TTY
             output << err_data
           end
 
-          runtime = TIME_FORMAT % [runtime, pluralize(runtime, 'second')]
+          runtime = TIME_FORMAT % [runtime, pluralize(runtime, "second")]
           message = ["Finished in #{runtime}"]
           message << " with exit status #{status}" if status
           message << " (#{success_or_failure(status)})"
@@ -66,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

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,19 @@
-# 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_out_data(cmd, *args)
-          write(cmd, args.join(' '), out_data)
+          write(cmd, args.join(" "), out_data)
         end
 
         def print_command_err_data(cmd, *args)
-          write(cmd, args.join(' '), err_data)
+          write(cmd, args.join(" "), err_data)
         end
 
         def print_command_exit(cmd, status, *args)

data/lib/tty/command/process_runner.rb

@@ -1,10 +1,10 @@
 # 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
@@ -128,20 +128,20 @@ 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
@@ -154,7 +154,15 @@ module TTY
         ]
       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
@@ -168,8 +176,8 @@ module TTY
 
             ready[0].each do |reader|
               begin
-                line = reader.readpartial(BUFSIZE)
-                buffer.(line)
+                chunk = reader.readpartial(BUFSIZE)
+                handler.(chunk)
 
                 # control total time spent reading
                 runtime = Time.now - Thread.current[:cmd_start]

data/lib/tty/command/truncator.rb

@@ -17,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
 
@@ -92,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

@@ -2,6 +2,6 @@
 
 module TTY
   class Command
-    VERSION = '0.9.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.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-28 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,28 +16,14 @@ 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
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,46 +42,31 @@ dependencies:
   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:
-- me@piotrmurach.com
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- examples/bash.rb
-- examples/basic.rb
-- examples/buffer.rb
-- 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/timeout_input.rb
-- examples/wait.rb
 - lib/tty-command.rb
 - lib/tty/command.rb
 - lib/tty/command/child_process.rb
@@ -111,35 +82,16 @@ files:
 - lib/tty/command/result.rb
 - lib/tty/command/truncator.rb
 - lib/tty/command/version.rb
-- spec/spec_helper.rb
-- spec/unit/binmode_spec.rb
-- spec/unit/cmd_spec.rb
-- spec/unit/dry_run_spec.rb
-- spec/unit/exit_error_spec.rb
-- spec/unit/input_spec.rb
-- spec/unit/output_spec.rb
-- spec/unit/printer_spec.rb
-- spec/unit/printers/custom_spec.rb
-- spec/unit/printers/null_spec.rb
-- spec/unit/printers/pretty_spec.rb
-- spec/unit/printers/progress_spec.rb
-- spec/unit/printers/quiet_spec.rb
-- spec/unit/pty_spec.rb
-- spec/unit/redirect_spec.rb
-- spec/unit/result_spec.rb
-- spec/unit/ruby_spec.rb
-- spec/unit/run_spec.rb
-- spec/unit/test_spec.rb
-- spec/unit/timeout_spec.rb
-- spec/unit/truncator_spec.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:
@@ -155,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Execute shell commands with pretty output logging and capture their stdout,