process_helper 0.0.4.pre.beta.4 → 0.0.4.pre.beta.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dac1e6b00a41e6783110d9a9fc96da71fd5ab61c
-  data.tar.gz: 8831f8d4596d34ea1142074170147baf080bfaeb
+  metadata.gz: d2f03bf56af641f1950bc970aa466dbe9e02b651
+  data.tar.gz: 48875777e0c764098effc5e4441c55b794caf6d0
 SHA512:
-  metadata.gz: 540109394d1a586ba812d347769e39b65481ce4ac616cc78100a383db5c318ff214599c0cdf107d5edff6bb183b657154285793468f7d3a0ce4055383106bd1c
-  data.tar.gz: ab5b802c207e303928e984ef64de2cef779b4f46f68fb52de72d6946dad814b8bd6e06ae54c30c84c55f447a877a32ed7d6e0b4993470db5c1760bd65e427030
+  metadata.gz: 76c9dba3252d1b036d19c70ca73ab51ace44edaf1d05a58b71176dcad4f52af937413703aa88333ea8b03fc95aae6ceb83dffa1120dc143672c95f51f524c611
+  data.tar.gz: 4d39a694b203397a324fadc02cdce6267235f827efcef00bae5e3c6105aee4747f0fba65a39e33035b7bca99e9abaed9dc96469c9984e95bca48c17e1cc89d89

data/README.md

@@ -49,7 +49,7 @@ However, `process_helper` was created because none of them made it *easy* to run
   * [`:pseudo_terminal` (short form `:pty`)](#pseudo_terminal-short-form-pty)
   * [`:puts_output` (short form `:out`)](#puts_output-short-form-out)
   * [`:timeout` (short form `:kill`)](#timeout-short-form-kill)
-  * [`:trace` (short form `:t`)](#trace-short-form-t)
+  * [`:log_cmd` (short form `:log`)](#log_cmd-short-form-log)
 * [Warnings if failure output will be suppressed based on options](#warnings-if-failure-output-will-be-suppressed-based-on-options)  
 * [Version](#version)
 * [Contributing](#contributing)
@@ -214,7 +214,7 @@ Valid value is a float, e.g. `1.5`.  Default value is nil/undefined.
 
 See [https://www.pivotaltracker.com/story/show/93303096](https://www.pivotaltracker.com/story/show/93303096) for more details.
 
-### `:trace` (short form `:t`)
+### `:log_cmd` (short form `:log`)
 
 Valid value is a boolean.  Default value is false.
 

data/lib/process_helper.rb

@@ -3,10 +3,14 @@ require 'pty'
 require 'timeout'
 require 'stringio'
 
-# Makes it easier to spawn ruby sub-processes with proper capturing of stdout and stderr streams.
+# Makes it easy to spawn Ruby sub-processes with guaranteed exit status handling,
+# capturing and/or suppressing combined STDOUT and STDERR streams,
+# providing STDIN input, timeouts, and running via a pseudo terminal.
+#
+# Full documentation at https://github.com/thewoolleyman/process_helper
 module ProcessHelper
   # Don't forget to keep version in sync with gemspec
-  VERSION = '0.0.4.pre.beta.4'.freeze
+  VERSION = '0.0.4.pre.beta.5'.freeze
 
   # rubocop:disable Style/ModuleFunction
   extend self
@@ -16,7 +20,7 @@ module ProcessHelper
     fail ProcessHelper::EmptyCommandError, 'command must not be empty' if cmd.empty?
     options = options.dup
     options_processing(options)
-    puts cmd if options[:trace]
+    puts cmd if options[:log_cmd]
     output, process_status =
       if options[:pseudo_terminal]
         process_with_pseudo_terminal(cmd, options)
@@ -176,7 +180,7 @@ module ProcessHelper
     options[:pseudo_terminal] = false if options[:pseudo_terminal].nil?
     options[:expected_exit_status] = [0] if options[:expected_exit_status].nil?
     options[:input] = StringIO.new(options[:input].to_s) unless options[:input].is_a?(StringIO)
-    options[:trace] = false if options[:trace].nil?
+    options[:log_cmd] = false if options[:log_cmd].nil?
   end
 
   def valid_option_pairs
@@ -187,7 +191,7 @@ module ProcessHelper
       %w(pseudo_terminal pty),
       %w(puts_output out),
       %w(timeout kill),
-      %w(trace t),
+      %w(log_cmd log),
     ]
     pairs.each do |pair|
       pair.each_with_index do |opt, index|
@@ -233,7 +237,7 @@ module ProcessHelper
         validate_boolean(pair, value) if option.to_s == 'include_output_in_exception'
         validate_boolean(pair, value) if option.to_s == 'pseudo_terminal'
         validate_puts_output(pair, value) if option.to_s == 'puts_output'
-        validate_boolean(pair, value) if option.to_s == 'trace'
+        validate_boolean(pair, value) if option.to_s == 'log_cmd'
       end
     end
   end

data/process_helper.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |spec|
   spec.name = 'process_helper'
   # Don't forget to keep version in sync with ProcessHelper::Version
-  spec.version = '0.0.4.pre.beta.4'
+  spec.version = '0.0.4.pre.beta.5'
   spec.authors = ['Chad Woolley', 'Glenn Oppegard']
   spec.email = ['oppegard@gmail.com', 'thewoolleyman@gmail.com']
   spec.summary = "Makes it easier to spawn ruby sub-processes with proper capturing /

data/spec/{trace_handling_spec.rb → log_cmd_handling_spec.rb}

@@ -1,22 +1,22 @@
 require_relative 'spec_helper'
 
-RSpec.describe 'trace handling' do
+RSpec.describe 'log command handling' do
   attr_reader :clazz
 
   before do
     @clazz = Clazz.new
   end
 
-  it 'prints command if trace is true' do
+  it 'prints command if log_cmd is true' do
     expect do
-      clazz.process('echo stdout > /dev/stdout', puts_output: :always, trace: true)
+      clazz.process('echo stdout > /dev/stdout', puts_output: :always, log_cmd: true)
     end.to output("echo stdout > /dev/stdout\nstdout\n").to_stdout
         .and(not_output.to_stderr)
   end
 
-  it 'does not print command if trace is false' do
+  it 'does not print command if log_cmd is false' do
     expect do
-      clazz.process('echo stdout > /dev/stdout', puts_output: :always, trace: false)
+      clazz.process('echo stdout > /dev/stdout', puts_output: :always, log_cmd: false)
     end.to output("stdout\n").to_stdout
         .and(not_output.to_stderr)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.4.pre.beta.4
+  version: 0.0.4.pre.beta.5
 platform: ruby
 authors:
 - Chad Woolley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,7 @@ files:
 - ruby-lint.yml
 - spec/error_handling_spec.rb
 - spec/input_handling_spec.rb
+- spec/log_cmd_handling_spec.rb
 - spec/module_visibility_spec.rb
 - spec/options/expected_exit_status_spec.rb
 - spec/options/include_output_in_exception_spec.rb
@@ -155,7 +156,6 @@ files:
 - spec/spec_helper.rb
 - spec/static_analysis_spec.rb
 - spec/timeout_handling_spec.rb
-- spec/trace_handling_spec.rb
 homepage: https://github.com/thewoolleyman/process_helper
 licenses:
 - Unlicense
@@ -184,6 +184,7 @@ summary: Makes it easier to spawn ruby sub-processes with proper capturing / of
 test_files:
 - spec/error_handling_spec.rb
 - spec/input_handling_spec.rb
+- spec/log_cmd_handling_spec.rb
 - spec/module_visibility_spec.rb
 - spec/options/expected_exit_status_spec.rb
 - spec/options/include_output_in_exception_spec.rb
@@ -194,4 +195,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/static_analysis_spec.rb
 - spec/timeout_handling_spec.rb
-- spec/trace_handling_spec.rb