tty-command 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01a539add505698f2073117f6df6c957e09dbeb349b6eae684eccf121d3a8a2b
-  data.tar.gz: eae4769195fd22d266c9c76093b9f85e3b8faeb61152197d5af65e3e435dfa83
+  metadata.gz: bb68a910c5ff66e9272e4a13e3f2d0efd90752bcb9c4da5d6e95c338806f6041
+  data.tar.gz: 4d93dcafc447d2f1fb16678901b503b0a6fe73a786eb0d671743c128f687e2b4
 SHA512:
-  metadata.gz: f3a44386dd5eb460ca3d8c7740f7c7e0660f6aeda18f0e0c7c4d67bfb30e962f4e96f34509584c5e7120d69fd415c2321b0b61d997f2f12cad101f63dfed5a93
-  data.tar.gz: 022477365445a4da55e3ee87c4d3c23305003e6da7d7c94b6de7857e409396e4105596584ea66a7c904d7f5f5725716527e6a353391e1a97ea78928fcb1052d0
+  metadata.gz: '019fa8d2991d8fc81ab35b563e9538e1d992da8acbe33948d0ca45116b844f1001893f31a7613d1815bfcedb5899fbb0e4e0ae9a8030955fca67ff200056bd8f'
+  data.tar.gz: 3ddc25cfab6b31e2d1f18367eb92b2751068e3b1d3187c86a4169cd7e7429d7ef75d0aeaa2ff98d98eb2a95f16651bcd6417196452a2303268c254950bb898bd

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## [v0.9.0] - 2019-09-28
+
+### Changed
+* Change gemspec to require Ruby >= 2.0.0
+
 ## [v0.8.2] - 2018-08-07
 
 ### Changed
@@ -123,6 +128,7 @@
 
 * Initial implementation and release
 
+[v0.9.0]: https://github.com/piotrmurach/tty-command/compare/v0.8.2...v0.9.0
 [v0.8.2]: https://github.com/piotrmurach/tty-command/compare/v0.8.1...v0.8.2
 [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

data/README.md

@@ -1,3 +1,7 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # TTY::Command [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![Gem Version](https://badge.fury.io/rb/tty-command.svg)][gem]
@@ -190,6 +194,8 @@ You can force the printer to always in print in color by passing the `:color` op
 cmd = TTY::Command.new(color: true)
 ```
 
+If the default printers don't meet your needs you can always create [a custom printer](#34-custom-printer)
+
 #### 2.3.1 Color
 
 When using printers you can switch off coloring by using `:color` option set to `false`.
@@ -328,7 +334,7 @@ cmd.run(:echo, 'hello', env: {foo: 'bar', baz: nil})
 
 ### 3.2 Options
 
-When a hash is given in the last argument (options), it allows to specify a current directory, umask, user, group and and zero or more fd redirects for the child process.
+When a hash is given in the last argument (options), it allows to specify a current directory, umask, user, group and zero or more fd redirects for the child process.
 
 #### 3.2.1 Redirection
 
@@ -415,7 +421,7 @@ cmd.run("my_cli_program", "login", in: in_stream).out
 
 #### 3.2.3 Timeout
 
-You can timeout command execuation by providing the `:timeout` option in seconds:
+You can timeout command execution by providing the `:timeout` option in seconds:
 
 ```ruby
 cmd.run("while test 1; sleep 1; done", timeout: 5)
@@ -445,7 +451,7 @@ cmd = TTY::Command.new(binmode: true)
 
 #### 3.2.5 Signal
 
-You can specify process termination signal other than the defaut `SIGTERM`:
+You can specify process termination signal other than the default `SIGTERM`:
 
 ```ruby
 cmd.run("whilte test1; sleep1; done", timeout: 5, signal: :KILL)
@@ -483,7 +489,7 @@ However, in `interactive` mode with `pty` flag on:
 cmd.run("git log", pty: true) # => uses pager and waits for user input (never returns)
 ```
 
-In addition, when pty device is used, any input to command may be echoed to the standard output, as well as some redirets may not work.
+In addition, when pty device is used, any input to command may be echoed to the standard output, as well as some redirects may not work.
 
 #### 3.2.7 Current directory
 
@@ -595,22 +601,24 @@ 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. The `write` accepts two arguments, first the currently run command instance and second the message to be printed:
+If the built-in printers do not meet your requirements you can create your own. A printer is a regular Ruby class that can be registered through `:printer` option to receive notifications about received command data.
+
+As the command runs the custom printer will be notified when the command starts, when data is printed to stdout, when data is printed to stderr and when the command exits.
+
+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.
+
+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(cmd, message)
-    puts message
+    puts cmd.to_command + message
   end
 end
 
-printer = CustomPrinter
-
-cmd = TTY::Command.new(printer: printer)
+cmd = TTY::Command.new(printer: CustomPrinter)
 ```
 
-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
 
 Here's a slightly more elaborate example to illustrate how tty-command can improve on plain old shell scripts. This example installs a new version of Ruby on an Ubuntu machine.
@@ -650,4 +658,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright (c) 2016-2018 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2016 Piotr Murach. See LICENSE for further details.

data/examples/buffer.rb

@@ -0,0 +1,4 @@
+require_relative "../lib/tty-command"
+
+cmd = TTY::Command.new(pty: true)
+cmd.run("rubocop")

data/lib/tty-command.rb

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

data/lib/tty/command/child_process.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'tempfile'

data/lib/tty/command/cmd.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'securerandom'
 require 'shellwords'

data/lib/tty/command/dry_runner.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require_relative 'result'

data/lib/tty/command/exit_error.rb

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

data/lib/tty/command/process_runner.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'thread'

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

data/lib/tty/command/version.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Command
-    VERSION = '0.8.2'.freeze
+    VERSION = '0.9.0'
   end # Command
 end # TTY

data/spec/unit/binmode_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe TTY::Command, '#run' do
   it "encodes output as unicode by default" do
     output = StringIO.new

data/spec/unit/cmd_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command::Cmd, '::new' do
   it "requires at least command argument" do

data/spec/unit/dry_run_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command, 'dry run' do
   let(:output) { StringIO.new }

data/spec/unit/exit_error_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command::ExitError, 'info' do
   it "displays stdin & stdout" do

data/spec/unit/input_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe TTY::Command, 'input' do
   it "reads user input data" do
     cli = fixtures_path('cli')

data/spec/unit/output_spec.rb

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

data/spec/unit/printer_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command, ':printer' do
   it "fails to find printer for nil" do

data/spec/unit/pty_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe TTY::Command, ':pty' do
   it "executes command in pseudo terminal mode as global option",
      unless: RSpec::Support::OS.windows? do

data/spec/unit/redirect_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 RSpec.describe TTY::Command, 'redirect' do

data/spec/unit/result_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command::Result do
   it "exits successfully" do

data/spec/unit/ruby_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command, '#ruby' do
   it "runs ruby with a single string argument" do

data/spec/unit/run_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 RSpec.describe TTY::Command, '#run' do
   it 'runs command and prints to stdout' do
     output = StringIO.new

data/spec/unit/test_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command, '#test' do
   it "implements classic bash command" do

data/spec/unit/timeout_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command, '#run' do
   it "times out infinite process without input or output" do

data/spec/unit/truncator_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 RSpec.describe TTY::Command::Truncator do
   it "writes nil content" do

data/tty-command.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tty/command/version'
@@ -7,21 +6,25 @@ Gem::Specification.new do |spec|
   spec.name          = "tty-command"
   spec.version       = TTY::Command::VERSION
   spec.authors       = ["Piotr Murach"]
-  spec.email         = [""]
+  spec.email         = ["me@piotrmurach.com"]
 
   spec.summary       = %q{Execute shell commands with pretty output logging and capture their stdout, stderr and exit status.}
   spec.description   = %q{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.}
   spec.homepage      = "https://piotrmurach.github.io/tty"
   spec.license       = "MIT"
 
-  spec.files         = Dir['README.md', 'LICENSE.txt', 'CHANGELOG.md', 'Rakefile', "{lib,spec}/**/*.rb", "{bin,examples,tasks}/*", 'tty-command.gemspec']
+  spec.files         = Dir['{lib,spec,examples}/**/*.rb']
+  spec.files        += Dir['{bin,tasks}/*', 'tty-command.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_dependency 'pastel', '~> 0.7.0'
 
-  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 1.5.0'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-command
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2019-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -31,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,23 +38,20 @@ dependencies:
     - - ">="
       - !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'
+        version: '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
@@ -76,7 +70,7 @@ description: Execute shell commands with pretty output logging and capture their
   stderr and exit status. Redirect stdin, stdout and stderr of each command to a file
   or a string.
 email:
-- ''
+- me@piotrmurach.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -89,7 +83,7 @@ files:
 - bin/setup
 - examples/bash.rb
 - examples/basic.rb
-- examples/cli
+- examples/buffer.rb
 - examples/env.rb
 - examples/logger.rb
 - examples/output.rb
@@ -154,15 +148,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.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Execute shell commands with pretty output logging and capture their stdout,

data/examples/cli

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-
-name = $stdin.gets
-puts "Your name: #{name}"