tty-command 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb68a910c5ff66e9272e4a13e3f2d0efd90752bcb9c4da5d6e95c338806f6041
-  data.tar.gz: 4d93dcafc447d2f1fb16678901b503b0a6fe73a786eb0d671743c128f687e2b4
+  metadata.gz: efe5adcd3fe993ed0b35a1d640b77e50d42611e4c87efd296656c82680bbe19e
+  data.tar.gz: 91276213aee2b1a56b3b983e3779d47da9c2de4b2f16fd9fa1603173d12ec522
 SHA512:
-  metadata.gz: '019fa8d2991d8fc81ab35b563e9538e1d992da8acbe33948d0ca45116b844f1001893f31a7613d1815bfcedb5899fbb0e4e0ae9a8030955fca67ff200056bd8f'
-  data.tar.gz: 3ddc25cfab6b31e2d1f18367eb92b2751068e3b1d3187c86a4169cd7e7429d7ef75d0aeaa2ff98d98eb2a95f16651bcd6417196452a2303268c254950bb898bd
+  metadata.gz: 3d3159b1a53f1649a220c6cd41f00fe8c9621c26460715d2352c1ff010c84de2f8ced1a06ce4de998da16f43a9d254429b37f825a370059dad1828b820c28060
+  data.tar.gz: '094d9b3afbc63cb7b94888873e602badf0dc2dd6dee3c2a13c79d2865ee7c1270f52136df5472c9c080f1f157778808033ffe3a4989b72cba6dbcf5d83d57c3c'

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## [v0.10.0] - 2020-10-22
+
+### Changed
+* Change :chdir option to escape directory location path
+* Change gemspec to add metadata and remove test artefacts
+* Change to update pastel dependency and restrict version to minor only
+* Remove bundler as a dev dependency and relax rspec's upper boundary
+
+### Fixed
+* Fix Ruby 2.7 keyword conversion errors
+* Fix error when environment variable contains % character
+
 ## [v0.9.0] - 2019-09-28
 
 ### Changed
@@ -128,6 +140,7 @@
 
 * Initial implementation and release
 
+[v0.10.0]: https://github.com/piotrmurach/tty-command/compare/v0.9.0...v0.10.0
 [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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Piotr Murach
+Copyright (c) 2016 Piotr Murach (https://piotrmurach.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,5 @@
 <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>
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/blob/master/images/tty.png" alt="TTY Toolkit logo"/></a>
 </div>
 
 # TTY::Command [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
@@ -36,7 +36,7 @@ Why should we be handcuffed to `sh` or `bash` for these scripts when we could be
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty-command'
+gem "tty-command"
 ```
 
 And then execute:
@@ -88,11 +88,11 @@ Or install it yourself as:
 Create a command instance and then run some commands:
 
 ```ruby
-require 'tty-command'
+require "tty-command"
 
 cmd = TTY::Command.new
-cmd.run('ls -la')
-cmd.run('echo Hello!')
+cmd.run("ls -la")
+cmd.run("echo Hello!")
 ```
 
 Note that `run` will throw an exception if the command fails. This is already an improvement over ordinary shell scripts, which just keep on going when things go bad. That usually makes things worse.
@@ -100,7 +100,7 @@ Note that `run` will throw an exception if the command fails. This is already an
 You can use the return value to capture stdout and stderr:
 
 ```ruby
-out, err = cmd.run('cat ~/.bashrc | grep alias')
+out, err = cmd.run("cat ~/.bashrc | grep alias")
 ```
 
 Instead of using a plain old string, you can break up the arguments and they'll get escaped if necessary:
@@ -127,13 +127,13 @@ The `env`, `command` and `options` arguments are described in the following sect
 For example, to display file contents:
 
 ```ruby
-cmd.run('cat file.txt')
+cmd.run("cat file.txt")
 ```
 
 If the command succeeds, a `TTY::Command::Result` is returned that records stdout and stderr:
 
 ```ruby
-out, err = cmd.run('date')
+out, err = cmd.run("date")
 puts "The date is #{out}"
 # => "The date is Tue 10 May 2016 22:30:15 BST\n"
 ```
@@ -141,7 +141,7 @@ puts "The date is #{out}"
 You can also pass a block that gets invoked anytime stdout and/or stderr receive output:
 
 ```ruby
-cmd.run('long running script') do |out, err|
+cmd.run("long running script") do |out, err|
   output << out if out
   errors << err if err
 end
@@ -161,8 +161,8 @@ If the error output is very long, the stderr may contain only a prefix, number o
 If you expect a command to fail occasionally, use `run!` instead. Then you can detect failures and respond appropriately. For example:
 
 ```ruby
-if cmd.run!('which xyzzy').failure?
-  cmd.run('brew install xyzzy')
+if cmd.run!("which xyzzy").failure?
+  cmd.run("brew install xyzzy")
 end
 ```
 
@@ -184,7 +184,7 @@ cmd = TTY::Command.new(printer: :progress)
 By default the printers log to `stdout` but this can be changed by passing an object that responds to `<<` message:
 
 ```ruby
-logger = Logger.new('dev.log')
+logger = Logger.new("dev.log")
 cmd = TTY::Command.new(output: logger)
 ```
 
@@ -206,7 +206,7 @@ By default, when logging is enabled and `pretty` printer is used, each log entry
 
 ```ruby
 cmd = TTY::Command.new(uuid: false)
-cmd.run('rm -R all_my_files')
+cmd.run("rm -R all_my_files")
 # =>
 #  Running rm -r all_my_files
 #  ...
@@ -230,13 +230,13 @@ When using a command that can fail, setting `:only_output_on_error` option to `t
 
 ```ruby
 cmd = TTY::Command.new
-cmd.run('non_failing_command', only_output_on_error: true)
+cmd.run("non_failing_command", only_output_on_error: true)
 ```
 
 This will only print the `Running` and `Finished` lines, while:
 
 ```ruby
-cmd.run('non_failing_command')
+cmd.run("non_failing_command")
 ```
 
 will also print any output that the `non_failing_command` might generate.
@@ -244,13 +244,13 @@ will also print any output that the `non_failing_command` might generate.
 Running either:
 
 ```ruby
-cmd.run('failing_command', only_output_on_error: true)
+cmd.run("failing_command", only_output_on_error: true)
 ```
 
 either:
 
 ```ruby
-cmd.run('failing_command')
+cmd.run("failing_command")
 ```
 
 will also print the output.
@@ -271,7 +271,7 @@ Sometimes it can be useful to put your script into a "dry run" mode that prints
 
 ```ruby
 cmd = TTY::Command.new(dry_run: true)
-cmd.run(:rm, 'all_my_files')
+cmd.run(:rm, "all_my_files")
 # => [123abc] (dry run) rm all_my_files
 ```
 
@@ -286,7 +286,7 @@ cmd.dry_run? # => true
 If you need to wait for a long running script and stop it when a given pattern has been matched use `wait` like so:
 
 ```ruby
-cmd.wait 'tail -f /var/log/production.log', /something happened/
+cmd.wait "tail -f /var/log/production.log", /something happened/
 ```
 
 ### 2.6 Test
@@ -294,7 +294,7 @@ cmd.wait 'tail -f /var/log/production.log', /something happened/
 To simulate classic bash test command you case use `test` method with expression to check as a first argument:
 
 ```ruby
-if cmd.test '-e /etc/passwd'
+if cmd.test "-e /etc/passwd"
   puts "Sweet..."
 else
   puts "Ohh no! Where is it?"
@@ -317,19 +317,19 @@ cmd.ruby %q{-e "puts 'Hello world'"}
 The environment variables need to be provided as hash entries, that can be set directly as a first argument:
 
 ```ruby
-cmd.run({'RAILS_ENV' => 'PRODUCTION'}, :rails, 'server')
+cmd.run({"RAILS_ENV" => "PRODUCTION"}, :rails, "server")
 ```
 
 or as an option with `:env` key:
 
 ```ruby
-cmd.run(:rails, 'server', env: {rails_env: :production})
+cmd.run(:rails, "server", env: {rails_env: :production})
 ```
 
 When a value in env is nil, the variable is unset in the child process:
 
 ```ruby
-cmd.run(:echo, 'hello', env: {foo: 'bar', baz: nil})
+cmd.run(:echo, "hello", env: {foo: "bar", baz: nil})
 ```
 
 ### 3.2 Options
@@ -367,27 +367,27 @@ The hash key and value specify a file descriptor in the child process (stderr &
 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(: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 => "out.log", :err => "err.log")
 cmd.run(:ls, [:out, :err] => "log")
-cmd.run("ls 1>&2", :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])
+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])
 ```
 
 You can, for example, read data from one source and output to another:
 
 ```ruby
-cmd.run("cat", :in => "Gemfile", :out => 'gemfile.log')
+cmd.run("cat", :in => "Gemfile", :out => "gemfile.log")
 ```
 
 #### 3.2.2 Handling Input
@@ -402,7 +402,7 @@ puts "Your name: #{name}"
 In order to execute `cli` with name input do:
 
 ```ruby
-cmd.run('cli', input: "Piotr\n")
+cmd.run("cli", input: "Piotr\n")
 # => Your name: Piotr
 ```
 
@@ -496,7 +496,7 @@ In addition, when pty device is used, any input to command may be echoed to the
 To change directory in which the command is run pass the `:chdir` option:
 
 ```ruby
-cmd.run(:echo, 'hello', chdir: '/var/tmp')
+cmd.run(:echo, "hello", chdir: "/var/tmp")
 ```
 
 #### 3.2.8 User
@@ -504,7 +504,7 @@ cmd.run(:echo, 'hello', chdir: '/var/tmp')
 To run command as a given user do:
 
 ```ruby
-cmd.run(:echo, 'hello', user: 'piotr')
+cmd.run(:echo, "hello", user: "piotr")
 ```
 
 #### 3.2.9 Group
@@ -512,7 +512,7 @@ cmd.run(:echo, 'hello', user: 'piotr')
 To run command as part of group do:
 
 ```ruby
-cmd.run(:echo, 'hello', group: 'devs')
+cmd.run(:echo, "hello", group: "devs")
 ```
 
 #### 3.2.10 Umask
@@ -520,7 +520,7 @@ cmd.run(:echo, 'hello', group: 'devs')
 To run command with umask do:
 
 ```ruby
-cmd.run(:echo, 'hello', umask: '007')
+cmd.run(:echo, "hello", umask: "007")
 ```
 
 ### 3.3 Result
@@ -528,13 +528,13 @@ cmd.run(:echo, 'hello', umask: '007')
 Each time you run command the stdout and stderr are captured and return as result. The result can be examined directly by casting it to tuple:
 
 ```ruby
-out, err = cmd.run(:echo, 'Hello')
+out, err = cmd.run(:echo, "Hello")
 ```
 
 However, if you want to you can defer reading:
 
 ```ruby
-result = cmd.run(:echo, 'Hello')
+result = cmd.run(:echo, "Hello")
 result.out
 result.err
 ```
@@ -544,7 +544,7 @@ result.err
 To check if command exited successfully use `success?`:
 
 ```ruby
-result = cmd.run(:echo, 'Hello')
+result = cmd.run(:echo, "Hello")
 result.success? # => true
 ```
 
@@ -553,7 +553,7 @@ result.success? # => true
 To check if command exited unsuccessfully use `failure?` or `failed?`:
 
 ```ruby
-result = cmd.run(:echo, 'Hello')
+result = cmd.run(:echo, "Hello")
 result.failure?  # => false
 result.failed?   # => false
 ```
@@ -563,7 +563,7 @@ result.failed?   # => false
 To check if command ran to completion use `exited?` or `complete?`:
 
 ```ruby
-result = cmd.run(:echo, 'Hello')
+result = cmd.run(:echo, "Hello")
 result.exited?    # => true
 result.complete?  # => true
 ```
@@ -573,7 +573,7 @@ result.complete?  # => true
 The result itself is an enumerable and allows you to iterate over the stdout output:
 
 ```ruby
-result = cmd.run(:ls, '-1')
+result = cmd.run(:ls, "-1")
 result.each { |line| puts line }
 # =>
 #  CHANGELOG.md
@@ -596,7 +596,7 @@ TTY::Command.record_separator = "\n\r"
 or configured per `each` call by passing delimiter as an argument:
 
 ```ruby
-cmd.run(:ls, '-1').each("\t") { ... }
+cmd.run(:ls, "-1").each("\t") { ... }
 ```
 
 ### 3.4 Custom printer

data/lib/tty-command.rb

@@ -1 +1 @@
-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
@@ -128,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, _|
@@ -174,7 +174,7 @@ module TTY
     # @api private
     def command(*args)
       cmd = Cmd.new(*args)
-      cmd.update(@cmd_options)
+      cmd.update(**@cmd_options)
       cmd
     end
 
@@ -204,7 +204,7 @@ module TTY
     #
     # @api private
     def find_printer_class(name)
-      const_name = name.to_s.split('_').map(&:capitalize).join.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,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'tempfile'
-require 'securerandom'
-require 'io/console'
+require "tempfile"
+require "securerandom"
+require "io/console"
 
 module TTY
   class Command
@@ -27,12 +27,12 @@ module TTY
         verbose = cmd.options[:verbose]
 
         pty = try_loading_pty(verbose) if pty
-        require('pty') if pty # load within this scope
+        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
@@ -132,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
 
@@ -195,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