process_helper 0.1.1 → 0.1.2.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f6c294b3af6eeb01a68ab036eaae0f720f910c4
-  data.tar.gz: 987e9e32db4886c989ab50ced59e9ec7c09cc17c
+  metadata.gz: 0fe565a56a28dd005bbd6772a14e1ca917d521d4
+  data.tar.gz: a97b43fc84e8c3cbe778d626c4a5f2f09aaa81af
 SHA512:
-  metadata.gz: 1f2dfb45e79b770329316dfa5453c3297157429311e79847aa6361e72e7fbd29fa2f19b85e88194d25171d4eb36fc6bdd0986ab4ed9ce0a6f44a26ea44d402bc
-  data.tar.gz: 143164249879466bd5a18b8abad0b1f16b1994bd43ea750dbe73a4e03537f80fa43706ec8fcac8b81ded29a47fc83361ac96d4c22ed1e023c0da1bc7e3610aad
+  metadata.gz: 47bbcfde26d525ed4b592eb006135cf0296916e488761efa0cee05a03763ae4c6ff3720a230a570d233e0b5e0a3bc2c3616e023b75511a0f85d3e3848dfb6cbc
+  data.tar.gz: 06cd7b2e798b29824ce23bdfa6b7e9fbb41800db1c0ab7fe4e7c4ecbe5bd3b4a64dcf297a5adcf43534d3f642e559aea64cd94de28a3d805bc29ffab788585ca

data/README.md

@@ -51,6 +51,7 @@ However, `process_helper` was created because none of them made it *easy* to run
   * [`:timeout` (short form `:kill`)](#timeout-short-form-kill)
   * [`: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)  
+* [Example Helper Script](#example-helper-script)
 * [Version](#version)
 * [Contributing](#contributing)
 * [(Un)License](#unlicense)
@@ -248,6 +249,31 @@ WARNING: Check your ProcessHelper options - :puts_output is :never, and :include
  => "ls: /does_not_exist: No such file or directory\n"
  ```
 
+## Example Helper Script
+
+You can DRY up your usage of common process helper options by making a helper script like this that you can require:
+
+`setup_process_helper.rb`
+```
+require 'process_helper'
+include ProcessHelper
+
+def process_without_output(cmd, options = {})
+  process(cmd, {out: :error, include_output_in_exception: false}.merge(default_options_for_process_helper).merge(options))
+end
+
+def process_with_output(cmd, options = {})
+  process(cmd, default_options_for_process_helper.merge(options))
+end
+
+def default_options_for_process_helper
+  # IMPORTANT NOTE: Running under a pseudo-terminal (pty) gives coloring and other
+  # benefits, but will result in end-of-line being "\r\n" instead of just "\n".
+  # Be aware of this if attempting to split return value into lines.
+  {log: true, pty: true}
+end
+```
+
 ## Version
 
 You can see the version of ProcessHelper in the `ProcessHelper::VERSION` constant:

data/lib/process_helper.rb

@@ -10,7 +10,7 @@ require 'stringio'
 # Full documentation at https://github.com/thewoolleyman/process_helper
 module ProcessHelper
   # Don't forget to keep version in sync with gemspec
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2.pre.beta.1'.freeze
 
   # rubocop:disable Style/ModuleFunction
   extend self
@@ -98,7 +98,7 @@ module ProcessHelper
             ch = stdout_and_stderr.read_nonblock(1)
           end
           break unless ch
-          printf ch if always_puts_output
+          printf format_char(ch) if always_puts_output
           output += ch
           stdout_and_stderr.flush
         end
@@ -128,6 +128,10 @@ module ProcessHelper
     output
   end
 
+  def format_char(ch)
+    ch == '%' ? '%%' : ch
+  end
+
   def handle_timeout_error(output, options, seconds = nil, additional_msg = nil)
     msg = "Timed out after #{options.fetch(:timeout, seconds)} seconds."
     msg += " #{additional_msg}" if additional_msg

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.1.1'
+  spec.version = '0.1.2.pre.beta.1'
   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/output_handling_spec.rb

@@ -34,6 +34,15 @@ RSpec.describe 'output handling' do
         .and(not_output.to_stderr)
   end
 
+  it 'escapes non-format % characters' do
+    expect do
+      clazz.process(
+        'echo %',
+        puts_output: :always)
+    end.to output("%\n").to_stdout
+      .and(not_output.to_stderr)
+  end
+
   describe 'when :puts_output == :never' do
     describe 'when include_output_in_exception is false' do
       it 'show warning' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2.pre.beta.1
 platform: ruby
 authors:
 - Chad Woolley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -185,12 +185,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Makes it easier to spawn ruby sub-processes with proper capturing / of stdout