tty-command 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c645ef5e1ef832ee5503018bc7aab93cdd71c17
-  data.tar.gz: 99b9fffd1e85616b3e36d4d0002684611a3a4dc0
+SHA256:
+  metadata.gz: 01a539add505698f2073117f6df6c957e09dbeb349b6eae684eccf121d3a8a2b
+  data.tar.gz: eae4769195fd22d266c9c76093b9f85e3b8faeb61152197d5af65e3e435dfa83
 SHA512:
-  metadata.gz: 16830dc6e8c5ac16616e4d14981924f18128800e1ddcae4cca6c1432c1649424a2dd758221a678267b1a76963c8c1aeebf49ff6da7a0e736d5dcb8abbc68dca5
-  data.tar.gz: 6ac45eeef2482b4f59ff9a5ec2486d2953b01bb1d7c9b6a99a373ecae7d89a3cf26f4aae464dbc984e893f898c34f6e4af88bc12de3a947b3f586459cb5ed918
+  metadata.gz: f3a44386dd5eb460ca3d8c7740f7c7e0660f6aeda18f0e0c7c4d67bfb30e962f4e96f34509584c5e7120d69fd415c2321b0b61d997f2f12cad101f63dfed5a93
+  data.tar.gz: 022477365445a4da55e3ee87c4d3c23305003e6da7d7c94b6de7857e409396e4105596584ea66a7c904d7f5f5725716527e6a353391e1a97ea78928fcb1052d0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## [v0.8.2] - 2018-08-07
+
+### Changed
+* Change gemspec to load only required files
+
+### Fixed
+* Fix issue with Ruby greater than 2.5.0 displaying thread error traceback by default
+
 ## [v0.8.1] - 2018-05-20
 
 ### Changed
@@ -115,6 +123,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.7.0]: https://github.com/piotrmurach/tty-command/compare/v0.6.0...v0.7.0

data/examples/bash.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 

data/examples/basic.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 

data/examples/env.rb

@@ -1,9 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 
-out, err = cmd.run("env | grep FOO", env: { 'FOO' =>'hello'})
+out, _ = cmd.run("env | grep FOO", env: { 'FOO' =>'hello'})
 
 puts "Result: #{out}"

data/examples/logger.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'logger'
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 logger = Logger.new('dev.log')
 

data/examples/output.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 cmd.run("i=0; while true; do i=$[$i+1]; echo 'hello '$i; sleep 1; done") do |out, err|

data/examples/pty.rb

@@ -1,4 +1,6 @@
-require 'tty-command'
+# frozen_string_literal: true
+
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 

data/examples/redirect_stderr.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 

data/examples/redirect_stdin.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cli = File.expand_path('cli', __dir__)
 cmd = TTY::Command.new

data/examples/redirect_stdout.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 

data/examples/stdin_input.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
 require 'pathname'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 cli = Pathname.new('examples/cli')

data/examples/threaded.rb

@@ -1,4 +1,6 @@
-require 'tty-command'
+# frozen_string_literal: true
+
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 

data/examples/timeout.rb

@@ -1,7 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 
-cmd.run("while test 1; do echo 'hello'; sleep 1; done", timeout: 5, signal: :KILL)
+begin
+  cmd.run("while test 1; do echo 'hello'; sleep 1; done", timeout: 5, signal: :KILL)
+rescue TTY::Command::TimeoutExceeded
+  puts 'BOOM!'
+end

data/examples/timeout_input.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
+require_relative '../lib/tty-command'
 
 cmd = TTY::Command.new
 

data/examples/wait.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty-command'
 require 'logger'
+require_relative '../lib/tty-command'
 
 logger = Logger.new('dev.log')
 cmd = TTY::Command.new

data/lib/tty/command/process_runner.rb

@@ -157,6 +157,9 @@ module TTY
 
       def read_stream(stream, buffer)
         Thread.new do
+          if Thread.current.respond_to?(:report_on_exception)
+            Thread.current.report_on_exception = false
+          end
           Thread.current[:cmd_start] = Time.now
           readers = [stream]
 

data/lib/tty/command/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require 'tty-command'
+
+module TestHelpers
+  module Paths
+    def gem_root
+      File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    end
+
+    def dir_path(*args)
+      path = File.join(gem_root, *args)
+      FileUtils.mkdir_p(path) unless ::File.exist?(path)
+      File.realpath(path)
+    end
+
+    def tmp_path(*args)
+      File.expand_path(File.join(dir_path('tmp'), *args))
+    end
+
+    def fixtures_path(*args)
+      File.expand_path(File.join(dir_path('spec/fixtures'), *args))
+    end
+  end
+
+  module Platform
+    def jruby?
+      RUBY_PLATFORM == "java"
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(TestHelpers::Paths)
+  config.include(TestHelpers::Platform)
+
+  config.after(:each, type: :cli) do
+    FileUtils.rm_rf(tmp_path)
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/binmode_spec.rb

@@ -0,0 +1,27 @@
+RSpec.describe TTY::Command, '#run' do
+  it "encodes output as unicode by default" do
+    output = StringIO.new
+    cmd = TTY::Command.new(output: output)
+    out, _ = cmd.run("echo '昨夜のコンサートは'")
+
+    expect(out.encoding).to eq(Encoding::UTF_8)
+    # expect(out.chomp).to eq("昨夜のコンサートは")
+  end
+
+  it "encodes output as binary" do
+    output = StringIO.new
+    cmd = TTY::Command.new(output: output)
+    out, _ = cmd.run("echo '昨夜のコンサートは'", binmode: true)
+
+    expect(out.encoding).to eq(Encoding::BINARY)
+    #expect(out.chomp).to eq("\xE6\x98\xA8\xE5\xA4\x9C\xE3\x81\xAE\xE3\x82\xB3\xE3\x83\xB3\xE3\x82\xB5\xE3\x83\xBC\xE3\x83\x88\xE3\x81\xAF".force_encoding(Encoding::BINARY))
+  end
+
+  it "encodes all commands output as binary" do
+    output = StringIO.new
+    cmd = TTY::Command.new(output: output, binmode: true)
+    out, _ = cmd.run("echo 'hello'")
+
+    expect(out.encoding).to eq(Encoding::BINARY)
+  end
+end

data/spec/unit/cmd_spec.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Command::Cmd, '::new' do
+  it "requires at least command argument" do
+    expect {
+      TTY::Command::Cmd.new({})
+    }.to raise_error(ArgumentError, /Cmd requires command argument/)
+  end
+
+  it "requires non empty command argument" do
+    expect {
+      TTY::Command::Cmd.new(nil)
+    }.to raise_error(ArgumentError, /No command provided/)
+  end
+
+  it "accepts a command" do
+    cmd = TTY::Command::Cmd.new(:echo)
+    expect(cmd.command).to eq('echo')
+    expect(cmd.argv).to eq([])
+    expect(cmd.options).to eq({})
+    expect(cmd.to_command).to eq('echo')
+  end
+
+  it "accepts a command as heredoc" do
+    cmd = TTY::Command::Cmd.new <<-EOHEREDOC
+      if [[ $? -eq 0]]; then
+        echo "Bash it!"
+      fi
+    EOHEREDOC
+    expect(cmd.argv).to eq([])
+    expect(cmd.options).to eq({})
+    expect(cmd.to_command).to eq([
+      "      if [[ $? -eq 0]]; then",
+      "        echo \"Bash it!\"",
+      "      fi\n"
+    ].join("\n"))
+  end
+
+  it "accepts command as [cmdname, arg1, ...]" do
+    cmd = TTY::Command::Cmd.new(:echo, '-n', 'hello')
+    expect(cmd.command).to eq('echo')
+    expect(cmd.argv).to eq(['-n', 'hello'])
+    expect(cmd.to_command).to eq('echo -n hello')
+  end
+
+  it "accepts command as [[cmdname, argv0], arg1, ...]" do
+    cmd = TTY::Command::Cmd.new([:echo, '-n'], 'hello')
+    expect(cmd.command).to eq('echo')
+    expect(cmd.argv).to eq(['-n', 'hello'])
+    expect(cmd.to_command).to eq('echo -n hello')
+  end
+
+  it "accepts command with environment as [cmdname, arg1, ..., opts]" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', env: {foo: 'bar'})
+    expect(cmd.to_command).to eq(%{( export FOO=\"bar\" ; echo hello )})
+  end
+
+  it "accepts command with multiple environment keys" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', env: {foo: 'a', bar: 'b'})
+    expect(cmd.to_command).to eq(%{( export FOO=\"a\" BAR=\"b\" ; echo hello )})
+  end
+
+  it "accepts command with environemnt string keys" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', env: {'FOO_bar' => 'a', bar: 'b'})
+    expect(cmd.to_command).to eq(%{( export FOO_bar=\"a\" BAR=\"b\" ; echo hello )})
+  end
+
+  it "escapes environment values" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', env: {foo: 'abc"def'})
+    expect(cmd.to_command).to eq(%{( export FOO=\"abc\\\"def\" ; echo hello )})
+  end
+
+  it "accepts environment as first argument" do
+    cmd = TTY::Command::Cmd.new({'FOO' => true, 'BAR' => 1}, :echo, 'hello')
+    expect(cmd.to_command).to eq(%{( export FOO=\"true\" BAR=\"1\" ; echo hello )})
+  end
+
+  it "runs command in specified directory" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', chdir: '/tmp')
+    expect(cmd.to_command).to eq("cd /tmp && echo hello")
+  end
+
+  it "runs command in specified directory with environment" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', chdir: '/tmp', env: {foo: 'bar'})
+    expect(cmd.to_command).to eq(%{cd /tmp && ( export FOO=\"bar\" ; echo hello )})
+  end
+
+  it "runs command as a user" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', user: 'piotrmurach')
+    expect(cmd.to_command).to eq("sudo -u piotrmurach -- sh -c 'echo hello'")
+  end
+
+  it "runs command as a group" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', group: 'devs')
+    expect(cmd.to_command).to eq("sg devs -c \\\"echo hello\\\"")
+  end
+
+  it "runs command as a user in a group" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', user: 'piotrmurach', group: 'devs')
+    expect(cmd.to_command).to eq("sudo -u piotrmurach -- sh -c 'sg devs -c \\\"echo hello\\\"'")
+  end
+
+  it "runs command with umask" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', umask: '077')
+    expect(cmd.to_command).to eq("umask 077 && echo hello")
+  end
+
+  it "runs command with umask, chdir" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', umask: '077', chdir: '/tmp')
+    expect(cmd.to_command).to eq("cd /tmp && umask 077 && echo hello")
+  end
+
+  it "runs command with umask, chdir & user" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', umask: '077', chdir: '/tmp', user: 'piotrmurach')
+    expect(cmd.to_command).to eq("cd /tmp && umask 077 && sudo -u piotrmurach -- sh -c 'echo hello'")
+  end
+
+  it "runs command with umask, user, chdir and env" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello', umask: '077', chdir: '/tmp', user: 'piotrmurach', env: {foo: 'bar'})
+    expect(cmd.to_command).to eq(%{cd /tmp && umask 077 && ( export FOO=\"bar\" ; sudo -u piotrmurach FOO=\"bar\" -- sh -c 'echo hello' )})
+  end
+
+  it "provides unique identifier" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+    expect(cmd.uuid).to match(/^\w{8}$/)
+  end
+
+  it "converts command to hash" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+    expect(cmd.to_hash).to include({
+      command: 'echo',
+      argv: ['hello']
+    })
+  end
+
+  it "escapes arguments that need escaping" do
+    cmd = TTY::Command::Cmd.new(:echo, 'hello world')
+    expect(cmd.to_hash).to include({
+      command: 'echo',
+      argv: ["hello\\ world"]
+    })
+  end
+
+  it "escapes special characters in split arguments" do
+    args = %w(git for-each-ref --format='%(refname)' refs/heads/)
+    cmd = TTY::Command::Cmd.new(*args)
+    expect(cmd.to_hash).to include({
+      command: 'git',
+      argv: ["for-each-ref", "--format\\=\\'\\%\\(refname\\)\\'", "refs/heads/"]
+    })
+  end
+end