tty-command 0.9.0 → 0.10.0

data/Rakefile

@@ -1,10 +0,0 @@
-# encoding: utf-8
-
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-task default: :spec
-
-desc 'Run all specs'
-task ci: %w[ spec ]

data/bin/console

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'tty-command'
-require 'irb'
-IRB.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/examples/bash.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-
-f = 'file'
-if cmd.test("[ -f #{f} ]")
-  puts "#{f} already exists!"
-else
-  cmd.run :touch, f
-end

data/examples/basic.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-
-out, err = cmd.run(:echo, 'hello world!')
-
-puts "Result: #{out}"

data/examples/buffer.rb

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

data/examples/env.rb

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

data/examples/logger.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-require_relative '../lib/tty-command'
-
-logger = Logger.new('dev.log')
-
-cmd = TTY::Command.new(output: logger, color: false)
-
-cmd.run(:ls)

data/examples/output.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-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|
-  if out =~ /.*5.*/
-    raise ArgumentError, 'BOOM'
-  end
-end

data/examples/pty.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-
-path = File.expand_path("../spec/fixtures/color", __dir__)
-
-cmd.run(path, pty: true)

data/examples/redirect_stderr.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-
-out, err = cmd.run("echo 'hello'", :out => :err)
-
-puts "out: #{out}"
-puts "err: #{err}"

data/examples/redirect_stdin.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cli = File.expand_path('cli', __dir__)
-cmd = TTY::Command.new
-
-stdin = StringIO.new
-stdin.puts "hello"
-stdin.puts "world"
-stdin.rewind
-
-out, _ = cmd.run(cli, :in => stdin)
-
-puts "#{out}"

data/examples/redirect_stdout.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-
-out, err = cmd.run(:ls, :out => 'ls.log')
-
-puts "OUT>> #{out}"
-puts "ERR>> #{err}"

data/examples/stdin_input.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-cli = Pathname.new('examples/cli')
-out, _ = cmd.run(cli, input: "Piotr\n")
-
-puts "#{out}"

data/examples/threaded.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-
-threads = []
-3.times do |i|
-  th = Thread.new do
-    10.times { cmd.run("echo th#{i}; sleep 0.1") }
-  end
-  threads << th
-end
-threads.each(&:join)

data/examples/timeout.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/tty-command'
-
-cmd = TTY::Command.new
-
-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,12 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/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/examples/wait.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-require_relative '../lib/tty-command'
-
-logger = Logger.new('dev.log')
-cmd = TTY::Command.new
-
-Thread.new do
-  10.times do |i|
-    sleep 1
-    if i == 5
-      logger << "error\n"
-    else
-      logger << "hello #{i}\n"
-    end
-  end
-end
-
-
-cmd.wait('tail -f dev.log', /error/)

data/spec/spec_helper.rb

@@ -1,78 +0,0 @@
-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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-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

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-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