process_helper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43c97ff5250f9529fb45ba6f84107cfbd5d380a7
-  data.tar.gz: 6fa5e4e3fdc84e70e2a6cba5dbc039e7ba5e83d2
+  metadata.gz: d29ad0fa584a226473f5a65df1b814c0283958cb
+  data.tar.gz: 3732855e1fe9cb030c64d959555be9a342f3ae84
 SHA512:
-  metadata.gz: 3475a513be15da0c3ba577b7a7d1cb131fa1061670e66f8b867387af3162a319960a1f12687102d01b1096feb904f61abe6cd1cfcd333763c13c33c51c2d27c9
-  data.tar.gz: cd497e35282b042c5462ee1f76f4427a9ce8238a09f04facc8dc05cca7a357f2391b7f85f5c6aa1e437be4c879cb84873092860ec0cc5bd399c5d00d166f03c9
+  metadata.gz: 2960aaf0bc89d84df0a1c580569fb715434e393a8a6e2b352b901fb1f84daf3d9b78fb8b1c9d87955332f32de00bc5ac8c3448dccbb4bcf3b35b9188bf7e3c0a
+  data.tar.gz: 194c492795fa05862416a84eb7a3d5b346f35fa469287b379c488781f68a6bca1557325cf9ac595690a407a463422484ac472623427813d1424acb99f0636f92

data/README.md

@@ -45,6 +45,18 @@ And then execute:
 Or install it yourself as:
 
     $ gem install process_helper
+    
+Or, if you want to avoid a Gem/RubyGems dependency, you can copy the `process_helper.rb` file from the `lib` folder directly into your project and require it:
+
+    # from a ruby file:
+    require_relative 'process_helper'
+    
+    # from IRB:
+    require './process_helper'
+
+    # or put the directory containing it on the load path:
+    $LOAD_PATH.unshift('.')
+    require 'process_helper'
 
 ## Usage
 
@@ -128,6 +140,27 @@ Valid values are `:always`, `:error`, and `:never`.  Default value is `:always`.
   error - i.e. non-zero or unexpected exit status
 * `:never` will never print output to STDOUT
 
+### `:timeout` (short form `:kill`)
+
+***WARNING! This option is beta and will be changed in a future release!***
+
+Valid value is a float, e.g. `1.5`.  Default value is nil/undefined.
+
+* Currently controls how long `process_helper` will wait to read from
+  a blocked IO stream before timing out (via [IO.select](http://ruby-doc.org/core-2.2.0/IO.html#method-c-select)).  For example, invoking `cat` with no arguments, which by default will continue accepting input until killed.
+* If undefined (default), there will be no timeout, and `process_helper` will hang if a process hangs while waiting to read from IO.
+
+***The following changes are planned for this option:***
+
+* Add validation of value (enforced to be a float).
+* Add ability for the timeout value to also kill long running processes which are ***not*** in blocked waiting on an IO stream read (i.e. kill process regardless of any IO state, not just via [IO.selects](http://ruby-doc.org/core-2.2.0/IO.html#method-c-select) timeout support).
+* Have both types of timeouts raise different and unique exception classes.
+* Possibly have different option names to allow different timeout values for the two types of timeouts.
+
+See [https://www.pivotaltracker.com/story/show/93303096](https://www.pivotaltracker.com/story/show/93303096) for more details.
+
+
+
 ## Warnings if failure output will be suppressed based on options
 
 ProcessHelper will give you a warning if you pass a combination of options that would
@@ -163,6 +196,10 @@ ProcessHelper::VERSION
    you have a single atomic commit on your branch.
 6. Create a new Pull Request
 
+## (Un)License
+
+`process_helper` is (un)licensed under the [unlicense](http://unlicense.org/).  So, feel free to copy it into your project (it's usable as a single required file and module), use it, abuse it, do what you will, no attribution required. :)
+
 ## Resources
 
 Other Ruby Process tools/libraries

data/lib/process_helper.rb

@@ -1,12 +1,9 @@
-require_relative 'process_helper/version'
-require_relative 'process_helper/empty_command_error'
-require_relative 'process_helper/invalid_options_error'
-require_relative 'process_helper/unexpected_exit_status_error'
-require_relative 'process_helper/unprocessed_input_error'
 require 'open3'
 
 # Makes it easier to spawn ruby sub-processes with proper capturing of stdout and stderr streams.
 module ProcessHelper
+  PROCESS_HELPER_VERSION = '0.0.3'
+
   def process(cmd, options = {})
     cmd = cmd.to_s
     fail ProcessHelper::EmptyCommandError, 'command must not be empty' if cmd.empty?
@@ -62,7 +59,7 @@ module ProcessHelper
         output_line = nil
       end
     rescue EOFError
-      input_lines_processed -= 1  if !original_input_lines.empty? && !current_input_line_processed
+      input_lines_processed -= 1 if !original_input_lines.empty? && !current_input_line_processed
       fail_unless_all_input_lines_processed(original_input_lines, input_lines_processed)
     rescue IO::WaitReadable
       if input_lines.empty?
@@ -255,4 +252,22 @@ module ProcessHelper
     options[:expected_exit_status] =
       [options[:expected_exit_status]]
   end
+
+  # Custom Exception Classes:
+
+  # Error which is raised when a command is empty
+  class EmptyCommandError < RuntimeError
+  end
+
+  # Error which is raised when options are invalid
+  class InvalidOptionsError < RuntimeError
+  end
+
+  # Error which is raised when a command returns an unexpected exit status (return code)
+  class UnexpectedExitStatusError < RuntimeError
+  end
+
+  # Error which is raised when command exists while input lines remain unprocessed
+  class UnprocessedInputError < RuntimeError
+  end
 end

data/process_helper.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'process_helper/version'
+require 'process_helper'
 
 Gem::Specification.new do |spec|
   spec.name = 'process_helper'
-  spec.version = ProcessHelper::VERSION
+  spec.version = ProcessHelper::PROCESS_HELPER_VERSION
   spec.authors = ['Glenn Oppegard', 'Chad Woolley']
   spec.email = ['oppegard@gmail.com', 'thewoolleyman@gmail.com']
   spec.summary = "Makes it easier to spawn ruby sub-processes with proper capturing /
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec-retry', '~> 0.4'
   spec.add_development_dependency 'rubocop', '= 0.29.1' # exact version for static analyis libs
   spec.add_development_dependency 'ruby-lint', '= 2.0.2' # exact version for static analyis libs
 end

data/spec/spec_helper.rb

@@ -4,14 +4,18 @@ if ENV['CODECLIMATE_REPO_TOKEN']
 end
 
 require 'rspec'
+require 'rspec/retry'
 require_relative '../lib/process_helper'
 
 RSpec::Matchers.define_negated_matcher :not_output, :output
 RSpec::Matchers.define_negated_matcher :not_raise_error, :raise_error
 
 # RSpec config
-# RSpec.configure do |c|
-# end
+RSpec.configure do |config|
+  config.verbose_retry = true
+  config.default_retry_count = 5
+  config.default_sleep_interval = 1
+end
 
 # RSpec helper methods
 # module SpecHelper

data/spec/version_spec.rb

@@ -2,6 +2,6 @@ require_relative 'spec_helper'
 
 RSpec.describe 'version' do
   it 'is semantic' do
-    expect(::ProcessHelper::VERSION).to match(/^\d\.\d\.\d\.*\w*$/)
+    expect(::ProcessHelper::PROCESS_HELPER_VERSION).to match(/^\d\.\d\.\d\.*\w*$/)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Glenn Oppegard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -108,15 +122,10 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- LICENSE
 - README.md
 - Rakefile
+- UNLICENSE
 - lib/process_helper.rb
-- lib/process_helper/empty_command_error.rb
-- lib/process_helper/invalid_options_error.rb
-- lib/process_helper/unexpected_exit_status_error.rb
-- lib/process_helper/unprocessed_input_error.rb
-- lib/process_helper/version.rb
 - process_helper.gemspec
 - ruby-lint.yml
 - spec/error_handling_spec.rb

data/lib/process_helper/empty_command_error.rb

@@ -1,5 +0,0 @@
-# Error which is raised when a command is empty
-module ProcessHelper
-  class EmptyCommandError < RuntimeError
-  end
-end

data/lib/process_helper/invalid_options_error.rb

@@ -1,5 +0,0 @@
-# Error which is raised when options are invalid
-module ProcessHelper
-  class InvalidOptionsError < RuntimeError
-  end
-end

data/lib/process_helper/unexpected_exit_status_error.rb

@@ -1,5 +0,0 @@
-# Error which is raised when a command returns an unexpected exit status (return code)
-module ProcessHelper
-  class UnexpectedExitStatusError < RuntimeError
-  end
-end

data/lib/process_helper/unprocessed_input_error.rb

@@ -1,5 +0,0 @@
-# Error which is raised when command exists while input lines remain unprocessed
-module ProcessHelper
-  class UnprocessedInputError < RuntimeError
-  end
-end

data/lib/process_helper/version.rb

@@ -1,4 +0,0 @@
-# Library version
-module ProcessHelper
-  VERSION = '0.0.2'
-end