process_helper 0.0.1

data/spec/options/validation_spec.rb

@@ -0,0 +1,69 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'options validation raises InvalidOptionError' do
+  attr_reader :clazz
+
+  before do
+    @clazz = Clazz.new
+  end
+
+  it 'on single invalid option' do
+    expect do
+      clazz.process('echo', invalid_option: false)
+    end.to raise_error(
+        ProcessHelper::InvalidOptionsError,
+        /Invalid option\(s\) 'invalid_option' given.*Valid options are.*puts_output/)
+  end
+
+  it 'on multiple invalid options' do
+    expect do
+      clazz.process('echo', invalid_option: false, invalid_option2: true)
+    end.to raise_error(
+        ProcessHelper::InvalidOptionsError,
+        /Invalid option\(s\) 'invalid_option, invalid_option2' given/)
+  end
+
+  it 'when both long and short form of option is given' do
+    expect do
+      clazz.process('echo', puts_output: :always, out: :always)
+    end.to raise_error(
+        ProcessHelper::InvalidOptionsError,
+        "Cannot specify both 'puts_output' and 'out'")
+  end
+
+  it 'when expected_exit_status param is passed non-integer or array without all integers' do
+    expect do
+      clazz.process('echo', expected_exit_status: '0')
+    end.to raise_error(
+        ProcessHelper::InvalidOptionsError,
+        "'expected_exit_status','exp_st' options must be an Integer or an array of Integers")
+  end
+
+  it 'when boolean param is passed non-boolean' do
+    expect do
+      clazz.process('echo', include_output_in_exception: '0')
+    end.to raise_error(
+        ProcessHelper::InvalidOptionsError,
+        "'include_output_in_exception','out_ex' options must be a boolean")
+  end
+
+  it 'when puts_output param is passed invalid value' do
+    expect do
+      clazz.process('echo', puts_output: :invalid)
+    end.to raise_error(
+        ProcessHelper::InvalidOptionsError,
+        "'puts_output','out' options must be one of the following: :always, :error, :never")
+  end
+
+  it 'when input_lines is passed invalid value'
+
+  it 'when timeout is passed non-float'
+
+  it 'when passed a short option' do
+    expect do
+      clazz.process('echo', exp_st: '0')
+    end.to raise_error(
+        ProcessHelper::InvalidOptionsError,
+        "'expected_exit_status','exp_st' options must be an Integer or an array of Integers")
+  end
+end

data/spec/output_handling_spec.rb

@@ -0,0 +1,61 @@
+require_relative 'spec_helper'
+
+RSpec.describe 'output handling' do
+  attr_reader :clazz
+
+  before do
+    @clazz = Clazz.new
+  end
+
+  it 'captures stdout only' do
+    expect do
+      clazz.process(
+        'echo stdout > /dev/stdout && echo stderr > /dev/null',
+        puts_output: :always)
+    end.to output("stdout\n").to_stdout
+        .and(not_output.to_stderr)
+  end
+
+  it 'captures stderr only' do
+    expect do
+      clazz.process(
+        'echo stdout > /dev/null && echo stderr > /dev/stderr',
+        puts_output: :always)
+    end.to output("stderr\n").to_stdout
+        .and(not_output.to_stderr)
+  end
+
+  it 'captures stdout and stderr' do
+    expect do
+      clazz.process(
+        'echo stdout > /dev/stdout && echo stderr > /dev/stderr',
+        puts_output: :always)
+    end.to output("stdout\nstderr\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
+        expect do
+          clazz.process(
+            'echo stdout > /dev/stdout',
+            puts_output: :never,
+            include_output_in_exception: false)
+        end.to output(/all error output will be suppressed if process fails/).to_stderr
+            .and(not_output.to_stdout)
+      end
+    end
+
+    describe 'when include_output_in_exception == true' do
+      it 'do not show warning' do
+        expect do
+          clazz.process(
+            'echo stdout > /dev/stdout',
+            puts_output: :never)
+        end.to output(/unless process fails with an exit code other than \[0\]/).to_stderr
+            .and(not_output.to_stdout)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'rspec'
+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 helper methods
+# module SpecHelper
+# end
+# include SpecHelper
+
+# Dummy fixture class
+class Clazz
+  include ProcessHelper
+end

data/spec/static_analysis_spec.rb

@@ -0,0 +1,18 @@
+require_relative 'spec_helper'
+
+describe 'static analysis checks' do
+  include ProcessHelper
+
+  it 'ruby-lint' do
+    process(
+      "ruby-lint #{File.expand_path('../../spec', __FILE__)}",
+      puts_output: :error
+    )
+  end
+
+  it 'rubocop' do
+    process(
+      "rubocop -c #{File.expand_path('../../.rubocop.yml', __FILE__)}",
+      puts_output: :error)
+  end
+end

data/spec/version_spec.rb

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

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: process_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Glenn Oppegard
+- Chad Woolley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+- !ruby/object:Gem::Dependency
+  name: ruby-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: Wrapper around Open3#popen2e with other useful options.
+email:
+- oppegard@gmail.com
+- thewoolleyman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- 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
+- spec/input_handling_spec.rb
+- spec/options/expected_exit_status_spec.rb
+- spec/options/include_output_in_exception_spec.rb
+- spec/options/puts_output_spec.rb
+- spec/options/validation_spec.rb
+- spec/output_handling_spec.rb
+- spec/spec_helper.rb
+- spec/static_analysis_spec.rb
+- spec/version_spec.rb
+homepage: https://github.com/thewoolleyman/process_helper
+licenses:
+- Unlicense
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Makes it easier to spawn ruby sub-processes with proper capturing / of stdout
+  and stderr streams.
+test_files:
+- spec/error_handling_spec.rb
+- spec/input_handling_spec.rb
+- spec/options/expected_exit_status_spec.rb
+- spec/options/include_output_in_exception_spec.rb
+- spec/options/puts_output_spec.rb
+- spec/options/validation_spec.rb
+- spec/output_handling_spec.rb
+- spec/spec_helper.rb
+- spec/static_analysis_spec.rb
+- spec/version_spec.rb