scmd 3.0.1 → 3.0.5

data/scmd.gemspec

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "scmd/version"
 
@@ -8,16 +10,21 @@ Gem::Specification.new do |gem|
   gem.version     = Scmd::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
   gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
-  gem.description = %q{Build and run system commands.}
-  gem.summary     = %q{Build and run system commands.}
+  gem.summary     = "Build and run system commands."
+  gem.description = "Build and run system commands."
   gem.homepage    = "http://github.com/redding/scmd"
-  gem.license     = 'MIT'
+  gem.license     = "MIT"
+
+  gem.files = `git ls-files | grep "^[^.]"`.split($INPUT_RECORD_SEPARATOR)
 
-  gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert", ["~> 2.15"])
+  gem.required_ruby_version = ">= 2.5"
+
+  gem.add_development_dependency("much-style-guide", ["~> 0.6.0"])
+  gem.add_development_dependency("assert",           ["~> 2.19.2"])
+
   gem.add_dependency("posix-spawn", ["~> 0.3.11"])
 end

data/script/bench.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 # $ bundle exec ruby script/bench.rb
 
-require 'bench/runner'
+require_relative "../bench/runner"
 
 class ScmdBenchLogger
-
   def initialize(file_path)
-    @file = File.open(file_path, 'w')
+    @file = File.open(file_path, "w")
     @ios = [@file, $stdout]
     yield self
     @file.close
@@ -17,10 +18,9 @@ class ScmdBenchLogger
     end
   end
 
-  def respond_to?(*args)
+  def respond_to_missing?(*args)
     @ios.first.respond_to?(args.first.to_s) ? true : super
   end
-
 end
 
 def run_cmd(logger, *args)
@@ -33,7 +33,7 @@ def run_cmd(logger, *args)
   GC.start
 end
 
-ScmdBenchLogger.new('bench/results.txt') do |logger|
+ScmdBenchLogger.new("bench/results.txt") do |logger|
   run_cmd(logger, Scmd.new("echo hi"), 1)
   run_cmd(logger, Scmd.new("echo hi"), 10)
   run_cmd(logger, Scmd.new("echo hi"), 100)
@@ -44,4 +44,3 @@ ScmdBenchLogger.new('bench/results.txt') do |logger|
   run_cmd(logger, Scmd.new("cat test/support/bigger-than-64k.txt"), 100)
   run_cmd(logger, Scmd.new("cat test/support/bigger-than-64k.txt"), 1000)
 end
-

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # this file is automatically required when you run `assert`
 # put any test helpers here
 
@@ -6,6 +8,15 @@ ROOT_PATH = File.expand_path("../..", __FILE__)
 $LOAD_PATH.unshift(ROOT_PATH)
 
 # require pry for debugging (`binding.pry`)
-require 'pry'
+require "pry"
+
+require "test/support/factory"
+
+# 1.8.7 backfills
 
-require 'test/support/factory'
+# Array#sample
+if !(a = []).respond_to?(:sample) && a.respond_to?(:choice)
+  class Array
+    alias_method :sample, :choice
+  end
+end

data/test/support/factory.rb

@@ -1,6 +1,7 @@
-require 'assert/factory'
+# frozen_string_literal: true
+
+require "assert/factory"
 
 module Factory
   extend Assert::Factory
-
 end

data/test/system/command_tests.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require "assert"
-require 'scmd/command'
+require "scmd/command"
 
 class Scmd::Command
-
   class SystemTests < Assert::Context
     desc "Scmd::Command"
     setup do
@@ -17,27 +18,28 @@ class Scmd::Command
       assert_equal 0, @success_cmd.exitstatus
       assert @success_cmd.success?
       assert_equal "hi\n", @success_cmd.stdout
-      assert_equal '', @success_cmd.stderr
+      assert_equal "", @success_cmd.stderr
 
       @failure_cmd.run
 
       assert_not_nil @failure_cmd.pid
       assert_not_equal 0, @failure_cmd.exitstatus
       assert_not @failure_cmd.success?
-      assert_equal '', @failure_cmd.stdout
-      assert_not_equal '', @failure_cmd.stderr
+      assert_equal "", @failure_cmd.stdout
+      assert_not_equal "", @failure_cmd.stderr
     end
 
     should "raise an exception with proper backtrace on `run!`" do
-      err = begin;
-        @failure_cmd.run!
-      rescue Exception => err
-        err
-      end
+      err =
+        begin
+          @failure_cmd.run!
+        rescue => ex
+          ex
+        end
 
       assert_kind_of Scmd::RunError, err
-      assert_includes 'No such file or directory', err.message
-      assert_includes 'test/system/command_tests.rb:', err.backtrace.first
+      assert_includes "No such file or directory", err.message
+      assert_includes "test/system/command_tests.rb:", err.backtrace.first
     end
 
     should "return itself on `run`, `run!`" do
@@ -57,7 +59,6 @@ class Scmd::Command
       cmd.wait
       assert_not cmd.running?
     end
-
   end
 
   class InputTests < SystemTests
@@ -65,7 +66,7 @@ class Scmd::Command
     setup do
       @cmd = Scmd::Command.new("sh")
     end
-    subject { @cmd }
+    subject{ @cmd }
 
     should "run the command given a single line of input" do
       subject.run "echo hi"
@@ -81,7 +82,6 @@ class Scmd::Command
       assert_equal "hi\n",  @cmd.stdout
       assert_equal "err\n", @cmd.stderr
     end
-
   end
 
   class LongRunningTests < SystemTests
@@ -124,21 +124,20 @@ class Scmd::Command
 
     should "be killable with a non-default signal" do
       @long_cmd.start
-      @long_cmd.kill('INT')
+      @long_cmd.kill("INT")
 
       assert_not @long_cmd.running?
     end
-
   end
 
   class BufferDeadlockTests < SystemTests
     desc "when capturing data from an output buffer"
     setup do
-      @small_path = File.join(ROOT_PATH, 'test/support/smaller-than-64k.txt')
+      @small_path = File.join(ROOT_PATH, "test/support/smaller-than-64k.txt")
       @small_data = File.read(@small_path)
       @small_cmd  = Scmd::Command.new("cat #{@small_path}")
 
-      @big_path = File.join(ROOT_PATH, 'test/support/bigger-than-64k.txt')
+      @big_path = File.join(ROOT_PATH, "test/support/bigger-than-64k.txt")
       @big_data = File.read(@big_path)
       @big_cmd  = Scmd::Command.new("cat #{@big_path}")
     end
@@ -152,15 +151,14 @@ class Scmd::Command
       assert_nothing_raised{ @big_cmd.wait(1) }
       assert_equal @big_data, @big_cmd.stdout
     end
-
   end
 
   class WithEnvVarTests < SystemTests
     desc "with environment variables"
     setup do
       @cmd = Scmd::Command.new("echo $SCMD_TEST_VAR", {
-        :env => { 'SCMD_TEST_VAR' => 'test' }
-      })
+        env: { "SCMD_TEST_VAR" => "test" },
+      },)
     end
 
     should "use them when running the command" do
@@ -168,7 +166,6 @@ class Scmd::Command
       assert @cmd.success?
       assert_equal "test\n", @cmd.stdout
     end
-
   end
 
   class WithOptionsTests < SystemTests
@@ -177,8 +174,8 @@ class Scmd::Command
       @path = "/"
       # `chdir` is the only one that reliably worked
       @cmd = Scmd::Command.new("pwd", {
-        :options => { :chdir => @path }
-      })
+        options: { chdir: @path },
+      },)
     end
 
     should "use them when running the command" do
@@ -188,7 +185,5 @@ class Scmd::Command
       assert_not_equal "#{Dir.pwd}\n", @cmd.stdout
       assert_equal "#{@path}\n", @cmd.stdout
     end
-
   end
-
 end

data/test/unit/command_spy_tests.rb

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
+
 require "assert"
-require 'scmd/command_spy'
+require "scmd/command_spy"
 
 class Scmd::CommandSpy
-
   class UnitTests < Assert::Context
     desc "Scmd::CommandSpy"
     setup do
       @spy_class = Scmd::CommandSpy
     end
-
   end
 
   class InitTests < UnitTests
     setup do
-      @orig_scmd_test_mode = ENV['SCMD_TEST_MODE']
-      ENV['SCMD_TEST_MODE'] = '1'
+      @orig_scmd_test_mode = ENV["SCMD_TEST_MODE"]
+      ENV["SCMD_TEST_MODE"] = "1"
       Scmd.reset
 
       @cmd_str = Factory.string
@@ -22,7 +22,7 @@ class Scmd::CommandSpy
     end
     teardown do
       Scmd.reset
-      ENV['SCMD_TEST_MODE'] = @orig_scmd_test_mode
+      ENV["SCMD_TEST_MODE"] = @orig_scmd_test_mode
     end
     subject{ @spy }
 
@@ -54,17 +54,17 @@ class Scmd::CommandSpy
 
       assert_equal 1,  subject.pid
       assert_equal 0,  subject.exitstatus
-      assert_equal '', subject.stdout
-      assert_equal '', subject.stderr
+      assert_equal "", subject.stdout
+      assert_equal "", subject.stderr
     end
 
     should "allow specifying env and options" do
       opts = { Factory.string => Factory.string }
       cmd = Scmd::Command.new(Factory.string, {
-        :env     => { :SCMD_TEST_VAR => 1 },
-        :options => opts
-      })
-      exp = { 'SCMD_TEST_VAR' => '1' }
+        env: { SCMD_TEST_VAR: 1 },
+        options: opts,
+      },)
+      exp = { "SCMD_TEST_VAR" => "1" }
       assert_equal exp,  cmd.env
       assert_equal opts, cmd.options
     end
@@ -161,6 +161,22 @@ class Scmd::CommandSpy
       assert_equal 2, Scmd.calls.size
     end
 
+    should "not track global run, run! or start calls if not in test mode" do
+      ENV.delete("SCMD_TEST_MODE")
+
+      input = Factory.string
+      # if `Scmd.calls` is called when not in test mode it will raise an error,
+      # so if no error is raised then it didn't try to add the call
+      assert_raises(NoMethodError){ Scmd.calls }
+      assert_nothing_raised do
+        subject.run(input)
+        subject.run!(input)
+        subject.start(input)
+      end
+
+      ENV["SCMD_TEST_MODE"] = "1"
+    end
+
     should "track its wait calls" do
       timeout = Factory.string
       subject.wait(timeout)
@@ -216,13 +232,11 @@ class Scmd::CommandSpy
         :pid,
         :exitstatus,
         :stdout,
-        :stderr
-      ].choice
+        :stderr,
+      ].sample
       Assert.stub(spy2, a){ Factory.string }
 
       assert_not_equal spy1, spy2
     end
-
   end
-
 end

data/test/unit/command_tests.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require "assert"
-require 'scmd/command'
+require "scmd/command"
 
 class Scmd::Command
-
   class UnitTests < Assert::Context
     desc "Scmd::Command"
     setup do
@@ -27,9 +28,9 @@ class Scmd::Command
 
     should "stringify its env hash" do
       cmd = Scmd::Command.new("echo $SCMD_TEST_VAR", {
-        :env => { :SCMD_TEST_VAR => 1 }
-      })
-      exp = { 'SCMD_TEST_VAR' => '1' }
+        env: { SCMD_TEST_VAR: 1 },
+      },)
+      exp = { "SCMD_TEST_VAR" => "1" }
       assert_equal exp, cmd.env
     end
 
@@ -40,8 +41,8 @@ class Scmd::Command
     should "default its result values" do
       assert_nil subject.pid
       assert_nil subject.exitstatus
-      assert_equal '', subject.stdout
-      assert_equal '', subject.stderr
+      assert_equal "", subject.stdout
+      assert_equal "", subject.stderr
     end
 
     should "default its state" do
@@ -72,7 +73,5 @@ class Scmd::Command
       subject.kill
       assert_nil subject.pid
     end
-
   end
-
 end

data/test/unit/scmd_tests.rb

@@ -1,25 +1,25 @@
+# frozen_string_literal: true
+
 require "assert"
-require 'scmd'
+require "scmd"
 
-require 'scmd/command'
-require 'scmd/command_spy'
-require 'scmd/stored_commands'
+require "scmd/command"
+require "scmd/command_spy"
+require "scmd/stored_commands"
 
 module Scmd
-
   class UnitTests < Assert::Context
     desc "Scmd"
     subject{ Scmd }
 
     should have_imeths :new, :commands, :calls, :reset, :add_command
-
   end
 
   class NonTestModeTests < UnitTests
     desc "when NOT in test mode"
 
     should "build a `Command` with the `new` method" do
-      assert_instance_of Scmd::Command, subject.new('echo hi')
+      assert_instance_of Scmd::Command, subject.new("echo hi")
     end
 
     should "raise no method error on the test mode API methods" do
@@ -32,23 +32,23 @@ module Scmd
         subject.add_command(Factory.string)
       end
     end
-
   end
 
   class TestModeTests < UnitTests
     desc "when in test mode"
     setup do
-      @orig_scmd_test_mode = ENV['SCMD_TEST_MODE']
-      ENV['SCMD_TEST_MODE'] = '1'
+      @orig_scmd_test_mode = ENV["SCMD_TEST_MODE"]
+      ENV["SCMD_TEST_MODE"] = "1"
       Scmd.reset
     end
     teardown do
       Scmd.reset
-      ENV['SCMD_TEST_MODE'] = @orig_scmd_test_mode
+      ENV["SCMD_TEST_MODE"] = @orig_scmd_test_mode
     end
 
-    should "get a command spy from the commands collection with the new` method" do
-      assert_equal Scmd::CommandSpy.new('echo hi'), subject.new('echo hi')
+    should "get a command spy from the commands collection with the `new` "\
+           "method" do
+      assert_equal Scmd::CommandSpy.new("echo hi"), subject.new("echo hi")
     end
 
     should "know its test mode API attrs" do
@@ -76,7 +76,6 @@ module Scmd
       subject.add_command(cmd_str){ |cmd| cmd.stdout = output }
       assert_equal output, subject.new(cmd_str).stdout
     end
-
   end
 
   class CallTests < UnitTests
@@ -97,26 +96,24 @@ module Scmd
       assert_equal @input,   subject.input
       assert_equal @cmd,     subject.cmd
     end
-
   end
 
   class TimeoutErrorTests < UnitTests
     desc "TimeoutError"
     setup do
-      @error = Scmd::TimeoutError.new('test')
+      @error = Scmd::TimeoutError.new("test")
     end
     subject{ @error }
 
     should "be a RuntimeError" do
       assert_kind_of ::RuntimeError, subject
     end
-
   end
 
   class RunErrorTests < UnitTests
     desc "RunError"
     setup do
-      @error = Scmd::RunError.new('test')
+      @error = Scmd::RunError.new("test")
     end
     subject{ @error }
 
@@ -125,16 +122,14 @@ module Scmd
     end
 
     should "set its backtrace to the caller by default" do
-      assert_match /scmd_tests.rb:.*$/, subject.backtrace.first
+      assert_match(/scmd_tests.rb:.*$/, subject.backtrace.first)
     end
 
     should "allow passing a custom backtrace" do
       called_from = caller
-      error = Scmd::RunError.new('test', called_from)
+      error = Scmd::RunError.new("test", called_from)
 
       assert_equal called_from, error.backtrace
     end
-
   end
-
 end

data/test/unit/stored_commands_tests.rb

@@ -1,10 +1,11 @@
-require 'assert'
-require 'scmd/stored_commands'
+# frozen_string_literal: true
 
-require 'scmd/command_spy'
+require "assert"
+require "scmd/stored_commands"
 
-class Scmd::StoredCommands
+require "scmd/command_spy"
 
+class Scmd::StoredCommands
   class UnitTests < Assert::Context
     desc "Scmd::StoredCommands"
     setup do
@@ -98,7 +99,6 @@ class Scmd::StoredCommands
       cmds1.add(@cmd_str)
       assert_not_equal cmds1, cmds2
     end
-
   end
 
   class StubTests < UnitTests
@@ -125,7 +125,7 @@ class Scmd::StoredCommands
 
     should "allow setting commands for specific opts" do
       cmd = subject.call(@opts)
-      assert_equal '', cmd.stdout
+      assert_equal "", cmd.stdout
 
       subject.with({}){ |cmd| cmd.stdout = @output }
       cmd = subject.call({})
@@ -137,10 +137,8 @@ class Scmd::StoredCommands
       stub2 = Stub.new(@cmd_str)
       assert_equal stub1, stub2
 
-      Assert.stub(stub1, [:cmd_str, :hash].choice){ Factory.string }
+      Assert.stub(stub1, [:cmd_str, :hash].sample){ Factory.string }
       assert_not_equal stub1, stub2
     end
-
   end
-
 end