process_helper 0.0.4.pre.beta.3 → 0.0.4.pre.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 966719c9586242b7332ade84478e11e320e4ae98
-  data.tar.gz: b64c492f89dd399c2197c2edb8f4725911dc9fc4
+  metadata.gz: dac1e6b00a41e6783110d9a9fc96da71fd5ab61c
+  data.tar.gz: 8831f8d4596d34ea1142074170147baf080bfaeb
 SHA512:
-  metadata.gz: c9939dbe6aa70fd5c9ff9192574115991ad8721182e6472c112eb8f2229cf59575ecc0a5f0d43c2084dfc2bb97e10dd7324f3d242427fada36b75443d12d750c
-  data.tar.gz: 5279d553623bd90792f97e0dda4245d9095daa8b8022f038ec42014b25bf94632075907832386c02f3bce80e75966bf8c72286b0534156869c774cc4f1d84a49
+  metadata.gz: 540109394d1a586ba812d347769e39b65481ce4ac616cc78100a383db5c318ff214599c0cdf107d5edff6bb183b657154285793468f7d3a0ce4055383106bd1c
+  data.tar.gz: ab5b802c207e303928e984ef64de2cef779b4f46f68fb52de72d6946dad814b8bd6e06ae54c30c84c55f447a877a32ed7d6e0b4993470db5c1760bd65e427030

data/.travis.yml

@@ -3,5 +3,8 @@ sudo: false
 addons:
     code_climate:
         repo_token: e7445c267f016d1a041c9cd16889fa806714e9a7c9bc1fc7936465442b9a167b
+before_install:
+  - gem update --remote bundler
+  - gem update --system
 after_success:
   - bundle exec codeclimate-test-reporter

data/README.md

@@ -49,6 +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)
 * [Warnings if failure output will be suppressed based on options](#warnings-if-failure-output-will-be-suppressed-based-on-options)  
 * [Version](#version)
 * [Contributing](#contributing)
@@ -213,6 +214,14 @@ 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`)
+
+Valid value is a boolean.  Default value is false.
+
+* Prints command to STDOUT before it is executed.
+* This is useful to have a "log" to know what commands are executing,
+  especially when using `puts_output: :error` or `puts_output: :never`,
+  and when the command might not finish immediately.
 
 
 ## Warnings if failure output will be suppressed based on options

data/lib/process_helper.rb

@@ -6,7 +6,7 @@ require 'stringio'
 # Makes it easier to spawn ruby sub-processes with proper capturing of stdout and stderr streams.
 module ProcessHelper
   # Don't forget to keep version in sync with gemspec
-  VERSION = '0.0.4.pre.beta.3'.freeze
+  VERSION = '0.0.4.pre.beta.4'.freeze
 
   # rubocop:disable Style/ModuleFunction
   extend self
@@ -16,6 +16,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]
     output, process_status =
       if options[:pseudo_terminal]
         process_with_pseudo_terminal(cmd, options)
@@ -175,6 +176,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?
   end
 
   def valid_option_pairs
@@ -185,6 +187,7 @@ module ProcessHelper
       %w(pseudo_terminal pty),
       %w(puts_output out),
       %w(timeout kill),
+      %w(trace t),
     ]
     pairs.each do |pair|
       pair.each_with_index do |opt, index|
@@ -230,6 +233,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'
       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.3'
+  spec.version = '0.0.4.pre.beta.4'
   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

@@ -0,0 +1,23 @@
+require_relative 'spec_helper'
+
+RSpec.describe 'trace handling' do
+  attr_reader :clazz
+
+  before do
+    @clazz = Clazz.new
+  end
+
+  it 'prints command if trace is true' do
+    expect do
+      clazz.process('echo stdout > /dev/stdout', puts_output: :always, trace: 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
+    expect do
+      clazz.process('echo stdout > /dev/stdout', puts_output: :always, trace: false)
+    end.to output("stdout\n").to_stdout
+        .and(not_output.to_stderr)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.4.pre.beta.3
+  version: 0.0.4.pre.beta.4
 platform: ruby
 authors:
 - Chad Woolley
@@ -155,6 +155,7 @@ 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
@@ -193,3 +194,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/static_analysis_spec.rb
 - spec/timeout_handling_spec.rb
+- spec/trace_handling_spec.rb