tty-command 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0da26e779e4608d8ea38cf75801e0afa682dfd14
-  data.tar.gz: 1a8f798ca2de05727cd9217a20314a9730763cd9
+  metadata.gz: 9c645ef5e1ef832ee5503018bc7aab93cdd71c17
+  data.tar.gz: 99b9fffd1e85616b3e36d4d0002684611a3a4dc0
 SHA512:
-  metadata.gz: 6c966cec07e3ded53c89a294291e4ae9b74cdc7c0c81fb9a5843cd26bb0d7846fe14d57ae4b44756f8b5567fe40163bc27d7e33f2fedecb9826e97892002b9ba
-  data.tar.gz: d098129b2cda2da46cab16cc33f1086f7f1aa163b6c6d6a4e4d2a62103ba9e626704bfc2f275e7e6583cbeab3ee5a9352de48135d214b491caaeae8f550e000d
+  metadata.gz: 16830dc6e8c5ac16616e4d14981924f18128800e1ddcae4cca6c1432c1649424a2dd758221a678267b1a76963c8c1aeebf49ff6da7a0e736d5dcb8abbc68dca5
+  data.tar.gz: 6ac45eeef2482b4f59ff9a5ec2486d2953b01bb1d7c9b6a99a373ecae7d89a3cf26f4aae464dbc984e893f898c34f6e4af88bc12de3a947b3f586459cb5ed918

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## [v0.8.1] - 2018-05-20
+
+### Changed
+* Change ProcessRunner#write_stream to handle all writing logic
+
 ## [v0.8.0] - 2018-04-22
 
 ### Added
@@ -110,6 +115,7 @@
 
 * Initial implementation and release
 
+[v0.8.1]: https://github.com/piotrmurach/tty-command/compare/v0.8.0...v0.8.1
 [v0.8.0]: https://github.com/piotrmurach/tty-command/compare/v0.7.0...v0.8.0
 [v0.7.0]: https://github.com/piotrmurach/tty-command/compare/v0.6.0...v0.7.0
 [v0.6.0]: https://github.com/piotrmurach/tty-command/compare/v0.5.0...v0.6.0

data/README.md

@@ -194,14 +194,28 @@ cmd = TTY::Command.new(color: true)
 
 When using printers you can switch off coloring by using `:color` option set to `false`.
 
-#### 2.3.2 Uuid
+#### 2.3.2 UUID
 
-By default, when logging is enabled, each log entry is prefixed by specific command run uuid number. This number can be switched off using the `:uuid` option:
+By default, when logging is enabled and `pretty` printer is used, each log entry is prefixed by specific command run uuid number. This number can be switched off using the `:uuid` option at initialization:
 
 ```ruby
 cmd = TTY::Command.new(uuid: false)
 cmd.run('rm -R all_my_files')
-# => rm -r all_my_files
+# =>
+#  Running rm -r all_my_files
+#  ...
+#  Finished in 6 seconds with exit status 0 (successful)
+```
+
+or individually per command run:
+
+```rub
+cmd = TTY::Command.new
+cmd.run("echo hello", uuid: false)
+# =>
+#  Running echo hello
+#      hello
+#  Finished in 0.003 seconds with exit status 0 (successful)
 ```
 
 #### 2.3.3 Only output on error
@@ -581,11 +595,11 @@ cmd.run(:ls, '-1').each("\t") { ... }
 
 ### 3.4 Custom printer
 
-If the built-in printers do not meet your requirements you can create your own. At the very minimum you need to specify the `write` method that will be called during the lifecycle of command execution:
+If the built-in printers do not meet your requirements you can create your own. At the very minimum you need to specify the `write` method that will be called during the lifecycle of command execution. The `write` accepts two arguments, first the currently run command instance and second the message to be printed:
 
 ```ruby
 CustomPrinter < TTY::Command::Printers::Abstract
-  def write(message)
+  def write(cmd, message)
     puts message
   end
 end
@@ -595,6 +609,7 @@ printer = CustomPrinter
 cmd = TTY::Command.new(printer: printer)
 ```
 
+Please see [lib/tty/command/printers/abstract.rb](https://github.com/piotrmurach/tty-command/blob/master/lib/tty/command/printers/abstract.rb) for a full set of methods that you can override.
 
 ## 4. Example
 

data/examples/timeout_input.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'tty-command'
+
+cmd = TTY::Command.new
+
+path = File.expand_path("../spec/fixtures/infinite_input", __dir__)
+
+range = 1..Float::INFINITY
+infinite_input = range.lazy.map { |x| x }.first(10_000).join("\n")
+
+cmd.run(path, input: infinite_input, timeout: 2)

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

@@ -11,24 +11,29 @@ module TTY
       class Pretty < Abstract
         TIME_FORMAT = "%5.3f %s".freeze
 
+        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(cmd, message.join, cmd.uuid)
+          write(cmd, message.join)
         end
 
         def print_command_out_data(cmd, *args)
           message = args.map(&:chomp).join(' ')
-          write(cmd, "\t#{message}", cmd.uuid, out_data)
+          write(cmd, "\t#{message}", out_data)
         end
 
         def print_command_err_data(cmd, *args)
           message = args.map(&:chomp).join(' ')
-          write(cmd, "\t" + decorate(message, :red), cmd.uuid, err_data)
+          write(cmd, "\t" + decorate(message, :red), err_data)
         end
 
         def print_command_exit(cmd, status, runtime, *args)
-          unless !cmd.only_output_on_error || status.zero?
+          if cmd.only_output_on_error && !status.zero?
             output << out_data
             output << err_data
           end
@@ -37,17 +42,18 @@ module TTY
           message = ["Finished in #{runtime}"]
           message << " with exit status #{status}" if status
           message << " (#{success_or_failure(status)})"
-          write(cmd, message.join, cmd.uuid)
+          write(cmd, message.join)
         end
 
         # Write message out to output
         #
         # @api private
-        def write(cmd, message, uuid = nil, data = 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"
           target = (cmd.only_output_on_error && !data.nil?) ? data : output

data/lib/tty/command/process_runner.rb

@@ -44,17 +44,7 @@ module TTY
 
         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?
-
-        writers = [@input && stdin].compact
-
-        while writers.any?
-          ready = IO.select(nil, writers, writers, @timeout)
-          raise TimeoutExceeded if ready.nil?
-
-          write_stream(ready[1], writers)
-        end
+        write_stream(stdin, @input)
 
         stdout_data, stderr_data = read_streams(stdout, stderr)
 
@@ -84,7 +74,7 @@ module TTY
       private
 
       # The buffer size for reading stdout and stderr
-      BUFSIZE = 3 * 1024
+      BUFSIZE = 16 * 1024
 
       # @api private
       def handle_timeout(runtime)
@@ -97,28 +87,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
 
-          # control total time spent writing
-          runtime = Time.now - start
-          handle_timeout(runtime)
+        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)
+          end
         end
       end
 

data/lib/tty/command/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Command
-    VERSION = '0.8.0'
+    VERSION = '0.8.1'
   end # Command
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-command
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -107,6 +107,7 @@ files:
 - 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