scmd 3.0.1 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  data.tar.gz: 41ab93becdd3b11aa43cf2b7465bb06740176732
-  metadata.gz: d8df11392ad93610a721cdfb7c85aa4a2bc3b0a2
-SHA512: 
-  data.tar.gz: c069015a2af2701ac855f12384c2941b39ede49b7e89b9157a83be6214b83034106405a1ad0c52fc016007b65a4d3ced67cb118008a6d7c0fa5cbf56fa3eb0ed
-  metadata.gz: cce48d3004f825e93f42b5e1a397ed5c7dbaff2a4fddcfce0e8acba3586b56286ba9a3dd7952136b73aacdb2eb51cd9ebf3435d35719dfc2cc0384a87193fec6
+---
+SHA256:
+  metadata.gz: f93aa47368dbe362f4e21f275f29e463e1be3ac7a4eec07b5ce2d18b77155543
+  data.tar.gz: 3d9daf1670226711e0852c079276823f211088eb306e7b147b8bba140d5aee74
+SHA512:
+  metadata.gz: 6aab5d881aa873b1f95309ecd760a2e04e349df5821b3ac8814e5a4aba0fbe95e38aa6638cd3f9b5b70e0fea410b93a1aba65c78bf82ac8223b33514f9740616
+  data.tar.gz: 4a167c35519b264b3c33c93c72315af1f73f50c8b0b3373fb59946dcd95dbd5d93046d4978560ee1568a9cedd241487df27d986607ae6cc31373136fc179fd88

data/Gemfile

@@ -1,11 +1,19 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
+ruby ">= 2.5"
+
 gemspec
 
-gem 'rake'
-gem 'pry', "~> 0.9.0"
-gem 'whysoslow'
+gem "pry"
+gem "whysoslow"
+
+# to release, uncomment this and run `bundle exec ggem r -f`
+gem 'ggem'
 
-platform :rbx do
-  gem 'rubysl'
-end
+gem "assert", path: "/Users/kellyredding/projects/tmp/assert"
+gem "much-style-guide", path: "/Users/kellyredding/projects/tmp/much-style-guide"
+gem "much-factory", path: "/Users/kellyredding/projects/tmp/much-factory"
+gem "much-not-given", path: "/Users/kellyredding/projects/tmp/much-not-given"
+gem "much-stub", path: "/Users/kellyredding/projects/tmp/much-stub"

data/README.md

@@ -42,7 +42,7 @@ cmd.start
 
 begin
   cmd.wait(10)
-rescue Scmd::Timeout => err
+rescue Scmd::TimeoutError => err
   cmd.stop # attempt to stop the cmd nicely, kill if doesn't stop in time
   cmd.kill # just kill the cmd now
 end

data/bench/results.txt

@@ -2,79 +2,79 @@ echo hi: 1 times
 ----------------
 whysoslow? ..
 
-mem @ start             29 MB                   ??
-mem @ finish            29 MB                   +   0 MB,   0%
+mem @ start             17 MB                   ??
+mem @ finish            17 MB                   +   0 MB,   0%
 
-         user     system   total    real
-time     0.0 ms   0.0 ms   0.0 ms   1.928 ms
+                      user                  system                total                 real
+time                  0.5820000000000001 ms 0.5519999999999999 ms 3.786 ms              3.7030000000000003 ms
 
 echo hi: 10 times
 -----------------
 whysoslow? ..
 
-mem @ start             38 MB                   ??
-mem @ finish            38 MB                   -   0 MB,   0%
+mem @ start             17 MB                   ??
+mem @ finish            17 MB                   +   0 MB,   0%
 
-          user      system    total     real
-time      0.0 ms    0.0 ms    10.0 ms   16.874 ms
+                      user                  system                total                 real
+time                  2.475 ms              3.822 ms              32.675999999999995 ms 34.702 ms
 
 echo hi: 100 times
 ------------------
 whysoslow? ..
 
-mem @ start             38 MB                   ??
-mem @ finish            38 MB                   -   0 MB,   0%
+mem @ start             17 MB                   ??
+mem @ finish            18 MB                   +   0 MB,   2%
 
-           user       system     total      real
-time       20.0 ms    20.0 ms    130.0 ms   147.925 ms
+                      user                  system                total                 real
+time                  19.75 ms              31.77 ms              281.766 ms            306.74899999999997 ms
 
 echo hi: 1000 times
 -------------------
 whysoslow? ..
 
-mem @ start             38 MB                   ??
-mem @ finish            41 MB                   +   3 MB,   7%
+mem @ start             18 MB                   ??
+mem @ finish            29 MB                   +  11 MB,  61%
 
-            user        system      total       real
-time        170.0 ms    180.0 ms    1320.0 ms   1390.406 ms
+                      user                  system                total                 real
+time                  161.98399999999998 ms 271.296 ms            2432.76 ms            2662.98 ms
 
 cat test/support/bigger-than-64k.txt: 1 times
 ---------------------------------------------
 whysoslow? ..
 
-mem @ start             41 MB                   ??
-mem @ finish            41 MB                   -   0 MB,   0%
+mem @ start             31 MB                   ??
+mem @ finish            31 MB                   +   0 MB,   1%
 
-         user     system   total    real
-time     0.0 ms   0.0 ms   0.0 ms   3.487 ms
+                     user                 system               total                real
+time                 0.412 ms             0.504 ms             4.343999999999999 ms 4.654 ms
 
 cat test/support/bigger-than-64k.txt: 10 times
 ----------------------------------------------
 whysoslow? ..
 
-mem @ start             41 MB                   ??
-mem @ finish            43 MB                   +   2 MB,   4%
+mem @ start             31 MB                   ??
+mem @ finish            34 MB                   +   2 MB,   7%
 
-          user      system    total     real
-time      0.0 ms    0.0 ms    20.0 ms   30.533 ms
+                      user                  system                total                 real
+time                  3.2880000000000003 ms 4.386 ms              43.447 ms             46.552 ms
 
 cat test/support/bigger-than-64k.txt: 100 times
 -----------------------------------------------
 whysoslow? ..
 
-mem @ start             43 MB                   ??
-mem @ finish            85 MB                   +  42 MB,  98%
+mem @ start             33 MB                   ??
+mem @ finish            56 MB                   +  23 MB,  68%
 
-          user      system    total     real
-time      40.0 ms   40.0 ms   250.0 ms  274.06 ms
+                      user                  system                total                 real
+time                  28.892999999999997 ms 40.599000000000004 ms 407.804 ms            440.11 ms
 
 cat test/support/bigger-than-64k.txt: 1000 times
 ------------------------------------------------
 whysoslow? ..
 
-mem @ start             85 MB                   ??
-mem @ finish            506 MB                  + 421 MB, 497%
+mem @ start             44 MB                   ??
+mem @ finish            297 MB                  + 254 MB, 582%
 
-            user        system      total       real
-time        360.0 ms    400.0 ms    2540.0 ms   2649.686 ms
+                     user                 system               total                real
+time                 285.236 ms           408.677 ms           4097.647 ms          4428.276999999999 ms
 

data/bench/runner.rb

@@ -1,29 +1,32 @@
-require 'whysoslow'
-require 'scmd'
+# frozen_string_literal: true
 
-class ScmdBenchRunner
+require "whysoslow"
+require "scmd"
 
+class ScmdBenchRunner
   attr_reader :result
 
   def self.run(*args)
-    self.new(*args).run
+    new(*args).run
   end
 
   def initialize(printer_io, cmd, num_times = 10)
     @cmd = cmd
-    @proc = proc do
-      num_times.times{ cmd.run! }
-    end
+    @proc =
+      proc do
+        num_times.times{ cmd.run! }
+      end
 
-    @printer = Whysoslow::DefaultPrinter.new(printer_io, {
-      :title => "#{@cmd.cmd_str}: #{num_times} times",
-      :verbose => true
-    })
+    @printer =
+      Whysoslow::DefaultPrinter.new(
+        printer_io,
+        title: "#{@cmd.cmd_str}: #{num_times} times",
+        verbose: true,
+      )
     @runner = Whysoslow::Runner.new(@printer)
   end
 
   def run
-    @runner.run &@proc
+    @runner.run(&@proc)
   end
-
 end

data/lib/scmd/command.rb

@@ -1,6 +1,8 @@
-require 'thread'
-require 'posix-spawn'
-require 'scmd'
+# frozen_string_literal: true
+
+require "thread"
+require "posix-spawn"
+require "scmd"
 
 # Scmd::Command is a base wrapper for handling system commands. Initialize it
 # with with a string specifying the command to execute.  You can then run the
@@ -8,7 +10,6 @@ require 'scmd'
 # create a more custom command wrapper.
 
 module Scmd
-
   class Command
     READ_SIZE            = 10240 # bytes
     READ_CHECK_TIMEOUT   = 0.001 # seconds
@@ -26,7 +27,11 @@ module Scmd
     end
 
     def run(input = nil)
-      run!(input) rescue RunError
+      begin
+        run!(input)
+      rescue
+        RunError
+      end
       self
     end
 
@@ -34,11 +39,13 @@ module Scmd
       start_err_msg, start_err_bt = nil, nil
       begin
         start(input)
-      rescue StandardError => err
-        start_err_msg, start_err_bt = err.message, err.backtrace
+      rescue => ex
+        start_err_msg, start_err_bt = ex.message, ex.backtrace
       ensure
         wait # indefinitely until cmd is done running
-        raise RunError.new(start_err_msg || @stderr, start_err_bt || caller) if !success?
+        unless success?
+          raise RunError.new(start_err_msg || @stderr, start_err_bt || caller)
+        end
       end
 
       self
@@ -49,19 +56,20 @@ module Scmd
 
       @pid = @child_process.pid.to_i
       @child_process.write(input)
-      @read_output_thread = Thread.new do
-        while @child_process.check_for_exit
-          begin
-            read_output
-          rescue EOFError => err
+      @read_output_thread =
+        Thread.new do
+          while @child_process.check_for_exit
+            begin
+              read_output
+            rescue EOFError # rubocop:disable Lint/SuppressedException
+            end
           end
+          @stop_w.write_nonblock(".")
         end
-        @stop_w.write_nonblock('.')
-      end
     end
 
     def wait(timeout = nil)
-      return if !running?
+      return unless running?
 
       wait_for_exit(timeout)
       if @child_process.running?
@@ -78,18 +86,18 @@ module Scmd
     end
 
     def stop(timeout = nil)
-      return if !running?
+      return unless running?
 
       send_term
       begin
         wait(timeout || DEFAULT_STOP_TIMEOUT)
-      rescue TimeoutError => err
+      rescue TimeoutError
         kill
       end
     end
 
     def kill(signal = nil)
-      return if !running?
+      return unless running?
 
       send_kill(signal)
       wait # indefinitely until cmd is killed
@@ -108,25 +116,28 @@ module Scmd
     end
 
     def inspect
-      reference = '0x0%x' % (self.object_id << 1)
+      reference = "0x0%x" % (object_id << 1)
       "#<#{self.class}:#{reference}"\
-      " @cmd_str=#{self.cmd_str.inspect}"\
+      " @cmd_str=#{cmd_str.inspect}"\
       " @exitstatus=#{@exitstatus.inspect}>"
     end
 
     private
 
     def read_output
-      @child_process.read(READ_SIZE){ |out, err| @stdout += out; @stderr += err }
+      @child_process.read(READ_SIZE) do |out, err|
+        @stdout += out
+        @stderr += err
+      end
     end
 
     def wait_for_exit(timeout)
-      ios, _, _ = IO.select([ @stop_r ], nil, nil, timeout)
-      @stop_r.read_nonblock(1) if ios && ios.include?(@stop_r)
+      ios, _, _ = IO.select([@stop_r], nil, nil, timeout)
+      @stop_r.read_nonblock(1) if ios&.include?(@stop_r)
     end
 
     def reset_attrs
-      @stdout, @stderr, @pid, @exitstatus = '', '', nil, nil
+      @stdout, @stderr, @pid, @exitstatus = +"", +"", nil, nil
     end
 
     def setup_run
@@ -145,33 +156,32 @@ module Scmd
     end
 
     def send_term
-      send_signal 'TERM'
+      send_signal "TERM"
     end
 
     def send_kill(signal = nil)
-      send_signal(signal || 'KILL')
+      send_signal(signal || "KILL")
     end
 
     def send_signal(sig)
-      return if !running?
+      return unless running?
       @child_process.send_signal(sig)
     end
 
     def stringify_hash(hash)
-      hash.inject({}) do |h, (k, v)|
+      hash.reduce({}) do |h, (k, v)|
         h.merge(k.to_s => v.to_s)
       end
     end
 
     class ChildProcess
-
       attr_reader :pid, :stdin, :stdout, :stderr
 
       def initialize(cmd_str, env, options)
-        @pid, @stdin, @stdout, @stderr = *::POSIX::Spawn::popen4(
+        @pid, @stdin, @stdout, @stderr = *::POSIX::Spawn.popen4(
           env,
           cmd_str,
-          options
+          options,
         )
         @wait_pid, @wait_status = nil, nil
       end
@@ -194,25 +204,34 @@ module Scmd
       end
 
       def write(input)
-        if !input.nil?
+        unless input.nil?
           [*input].each{ |line| @stdin.puts line.to_s }
           @stdin.close
         end
       end
 
       def read(size)
-        ios, _, _ = IO.select([ @stdout, @stderr ], nil, nil, READ_CHECK_TIMEOUT)
+        ios, _, _ =
+          IO.select([@stdout, @stderr], nil, nil, READ_CHECK_TIMEOUT)
         if ios && block_given?
-          yield read_if_ready(ios, @stdout, size), read_if_ready(ios, @stderr, size)
+          yield(
+            read_if_ready(ios, @stdout, size),
+            read_if_ready(ios, @stderr, size)
+          )
         end
       end
 
       def send_signal(sig)
-        process_kill(sig, self.pid)
+        process_kill(sig, pid)
+      end
+
+      def flush_stdout
+        @stdout.read
       end
 
-      def flush_stdout; @stdout.read; end
-      def flush_stderr; @stderr.read; end
+      def flush_stderr
+        @stderr.read
+      end
 
       def teardown
         [@stdin, @stdout, @stderr].each{ |fd| fd.close if fd && !fd.closed? }
@@ -221,7 +240,7 @@ module Scmd
       private
 
       def read_if_ready(ready_ios, io, size)
-        ready_ios.include?(io) ? read_by_size(io, size) : ''
+        ready_ios.include?(io) ? read_by_size(io, size) : ""
       end
 
       def read_by_size(io, size)
@@ -238,11 +257,8 @@ module Scmd
       end
 
       def pgrep
-        @pgrep ||= Command.new('which pgrep').run.stdout.strip
+        @pgrep ||= Command.new("which pgrep").run.stdout.strip
       end
-
     end
-
   end
-
 end

data/lib/scmd/command_spy.rb

@@ -1,9 +1,9 @@
-require 'scmd'
+# frozen_string_literal: true
 
-module Scmd
+require "scmd"
 
+module Scmd
   class CommandSpy
-
     attr_reader :cmd_str, :env, :options
     attr_reader :run_calls, :run_bang_calls, :start_calls
     attr_reader :wait_calls, :stop_calls, :kill_calls
@@ -20,12 +20,12 @@ module Scmd
 
       @running = false
 
-      @stdout, @stderr, @pid, @exitstatus = '', '', 1, 0
+      @stdout, @stderr, @pid, @exitstatus = "", "", 1, 0
     end
 
     def run(input = nil)
       @run_calls.push(InputCall.new(input))
-      Scmd.calls.push(Scmd::Call.new(self, input))
+      Scmd.calls.push(Scmd::Call.new(self, input)) if ENV["SCMD_TEST_MODE"]
       self
     end
 
@@ -35,7 +35,7 @@ module Scmd
 
     def run!(input = nil)
       @run_bang_calls.push(InputCall.new(input))
-      Scmd.calls.push(Scmd::Call.new(self, input))
+      Scmd.calls.push(Scmd::Call.new(self, input)) if ENV["SCMD_TEST_MODE"]
       self
     end
 
@@ -45,7 +45,7 @@ module Scmd
 
     def start(input = nil)
       @start_calls.push(InputCall.new(input))
-      Scmd.calls.push(Scmd::Call.new(self, input))
+      Scmd.calls.push(Scmd::Call.new(self, input)) if ENV["SCMD_TEST_MODE"]
       @running = true
     end
 
@@ -92,21 +92,21 @@ module Scmd
       @cmd_str.to_s
     end
 
-    def ==(other_spy)
-      if other_spy.kind_of?(CommandSpy)
-        self.cmd_str         == other_spy.cmd_str        &&
-        self.env             == other_spy.env            &&
-        self.options         == other_spy.options        &&
-        self.run_calls       == other_spy.run_calls      &&
-        self.run_bang_calls  == other_spy.run_bang_calls &&
-        self.start_calls     == other_spy.start_calls    &&
-        self.wait_calls      == other_spy.wait_calls     &&
-        self.stop_calls      == other_spy.stop_calls     &&
-        self.kill_calls      == other_spy.kill_calls     &&
-        self.pid             == other_spy.pid            &&
-        self.exitstatus      == other_spy.exitstatus     &&
-        self.stdout          == other_spy.stdout         &&
-        self.stderr          == other_spy.stderr
+    def ==(other)
+      if other.is_a?(CommandSpy)
+        cmd_str         == other.cmd_str        &&
+        env             == other.env            &&
+        options         == other.options        &&
+        run_calls       == other.run_calls      &&
+        run_bang_calls  == other.run_bang_calls &&
+        start_calls     == other.start_calls    &&
+        wait_calls      == other.wait_calls     &&
+        stop_calls      == other.stop_calls     &&
+        kill_calls      == other.kill_calls     &&
+        pid             == other.pid            &&
+        exitstatus      == other.exitstatus     &&
+        stdout          == other.stdout         &&
+        stderr          == other.stderr
       else
         super
       end
@@ -115,7 +115,5 @@ module Scmd
     InputCall   = Struct.new(:input)
     TimeoutCall = Struct.new(:timeout)
     SignalCall  = Struct.new(:signal)
-
   end
-
 end

data/lib/scmd/stored_commands.rb

@@ -1,9 +1,9 @@
-require 'scmd/command_spy'
+# frozen_string_literal: true
 
-module Scmd
+require "scmd/command_spy"
 
+module Scmd
   class StoredCommands
-
     attr_reader :hash
 
     def initialize
@@ -30,16 +30,15 @@ module Scmd
       @hash.empty?
     end
 
-    def ==(other_stored_commands)
-      if other_stored_commands.kind_of?(StoredCommands)
-        self.hash == other_stored_commands.hash
+    def ==(other)
+      if other.is_a?(StoredCommands)
+        hash == other.hash
       else
         super
       end
     end
 
     class Stub
-
       attr_reader :cmd_str, :hash
 
       def initialize(cmd_str)
@@ -62,17 +61,14 @@ module Scmd
         CommandSpy.new(@cmd_str, opts).tap(&block)
       end
 
-      def ==(other_stub)
-        if other_stub.kind_of?(Stub)
-          self.cmd_str == other_stub.cmd_str &&
-          self.hash    == other_stub.hash
+      def ==(other)
+        if other.is_a?(Stub)
+          cmd_str == other.cmd_str &&
+          hash    == other.hash
         else
           super
         end
       end
-
     end
-
   end
-
 end

data/lib/scmd/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Scmd
-  VERSION = "3.0.1"
+  VERSION = "3.0.5"
 end

data/lib/scmd.rb

@@ -1,42 +1,44 @@
-require 'scmd/version'
-require 'scmd/command'
+# frozen_string_literal: true
 
-module Scmd
+require "scmd/version"
+require "scmd/command"
 
+module Scmd
   # Scmd can be run in "test mode".  This means that command spies will be used
   # in place of "live" commands, each time a command is run or started will be
   # logged in a collection and option-specific spies can be added and used to
   # "stub" spies with specific attributes in specific contexts.
 
   def self.new(*args)
-    if !ENV['SCMD_TEST_MODE']
+    if !ENV["SCMD_TEST_MODE"]
       Command.new(*args)
     else
-      self.commands.get(*args)
+      commands.get(*args)
     end
   end
 
   def self.commands
-    raise NoMethodError if !ENV['SCMD_TEST_MODE']
-    @commands ||= begin
-      require 'scmd/stored_commands'
-      StoredCommands.new
-    end
+    raise NoMethodError unless ENV["SCMD_TEST_MODE"]
+    @commands ||=
+      begin
+        require "scmd/stored_commands"
+        StoredCommands.new
+      end
   end
 
   def self.calls
-    raise NoMethodError if !ENV['SCMD_TEST_MODE']
+    raise NoMethodError unless ENV["SCMD_TEST_MODE"]
     @calls ||= []
   end
 
   def self.reset
-    raise NoMethodError if !ENV['SCMD_TEST_MODE']
-    self.calls.clear
-    self.commands.remove_all
+    raise NoMethodError unless ENV["SCMD_TEST_MODE"]
+    calls.clear
+    commands.remove_all
   end
 
   def self.add_command(cmd_str, &block)
-    self.commands.add(cmd_str, &block)
+    commands.add(cmd_str, &block)
   end
 
   class Call < Struct.new(:cmd_str, :input, :cmd)
@@ -53,5 +55,4 @@ module Scmd
       set_backtrace(called_from || caller)
     end
   end
-
 end