subshell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80b83c12bd49b50e633b26b8e5996b030f6ec672
+  data.tar.gz: 8ead2b773a035d3ed8b01fc2fd4d22b8330e2f3d
+SHA512:
+  metadata.gz: 9842a6309a81802ad1e0d42c03841b4c8fdce3321122be69c4166b7783c968a5c6ecacae7f66b5bda1384738724fd561ef10d184f5485dd9ae893deec3cc2e78
+  data.tar.gz: 06b501a60b04d4742c2e04caff9582762a06dd52a7e7b702cf14ef5289893d0944361d479ab4ab4f3fa8258aee34b20ab7dbfe54530f5a2ba93faf8d2c82c7ed

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.13.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dafalcon@akamai.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in subshell.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dan Falcone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Subshell
+
+This gem makes it easy to run shell commands from within ruby.  It will 
+raise an exception if the command fails with an unexpected exit status.  By 
+default it automatically redirects STDERR to STDOUT when executing the 
+command.  The return value is the output of the command with whitespace
+automatically stripped.
+   
+Example usage:
+```ruby
+Subshell.exec 'echo hello world'                          # => "hello world"
+Subshell.exec 'echo hello world', strip_whitespace: false # => "hello world\n"
+Subshell.exec 'exit 1'                                    # => raises RuntimeError
+```
+
+## Options
+
+|Option|Default|Description|
+|------|-------|-----------|
+| redirect_stderr_to_stdout | true | append 2>&1 to the command |
+| expected_status | 0 | raise if the exit status of the command does not equal this value |
+| strip_whitespace | true | strip whitespace from the command's output |
+| logger | Rails logger (if available) or nil | log debug info, if set |
+| debug | false | print debug info to STDOUT.  does not affect logger output |
+| quiet | false | disable logger and STDOUT logging.  useful to suppress sensitive or verbose data from being logged |
+
+These options can be set per call.  For convenience, the defaults can be changed with a call to Subshell.set_defaults:
+ 
+```
+Subshell.set_defaults(strip_whitespace: false)
+Subshell.exec 'echo hello world'                 # => 'hello world\n'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'subshell'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install subshell
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/falconed/subshell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "subshell"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/subshell.rb

@@ -0,0 +1,66 @@
+require 'subshell/version'
+require 'logger'
+
+module Rails
+end
+
+module Subshell
+
+  @default_options = {
+      redirect_stderr_to_stdout: true,  # append 2>&1 to the command.
+      expected_status: 0,               # raise if the exit status of the command does not equal this value.
+      strip_whitespace: true,           # strip whitespace from the command's output.
+      logger: defined?(Rails.logger) ? Rails.logger : nil,  # logger to use.  defaults to Rails logger (if available) or nil.
+      debug: false,                     # print debug output to STDOUT.  does not affect logger output.
+      quiet: false                      # disable logger and STDOUT logging.  useful to suppress sensitive data from being logged.
+  }
+
+  class << self
+
+    def exec(command, options = {})
+      options = @default_options.merge(options)
+      output, exit_status = run_command(command, options)
+
+      if exit_status == options[:expected_status]
+        log_debug options, "Subshell.exec \"#{command}\" succeeded with output:\n#{output}"
+        output
+      else
+        error = "Subshell.exec #{command} failed with status #{exit_status} (expected #{options[:expected_status]}):\n#{output}"
+        log_error options, error
+        fail error
+      end
+    end
+
+    def set_defaults(options)
+      @default_options.merge!(options)
+    end
+
+    private
+
+    def run_command(command, options = {})
+      log_debug options,"Subshell.exec: #{command}"
+      command = "#{command} 2>&1" if options[:redirect_stderr_to_stdout]
+      process = IO.popen(command, 'r')
+      _pid, status = Process.wait2(process.pid)
+      output = process.read
+      output.strip! if options[:strip_whitespace]
+      [output, status.exitstatus]
+    end
+
+    def log_message(options, level, message)
+      unless options[:quiet]
+        options[:logger].send(level, message) if options[:logger]
+        puts message if options[:debug]
+      end
+    end
+
+    def log_debug(options, message)
+      log_message options, :debug, message
+    end
+
+    def log_error(options, message)
+      log_message options, :error, message
+    end
+
+  end
+end

data/lib/subshell/version.rb

@@ -0,0 +1,3 @@
+module Subshell
+  VERSION = "0.1.0"
+end

data/subshell.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subshell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'subshell'
+  spec.version       = Subshell::VERSION
+  spec.authors       = ['Dan Falcone']
+  spec.email         = ['danfalcone@gmail.com']
+
+  spec.summary       = %q{Easily run subshell commands.}
+  spec.description   = %q{Flexible library for running subshell commands with reasonable defaults.}
+  spec.homepage      = 'https://github.com/falconed/subshell'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: subshell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Falcone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Flexible library for running subshell commands with reasonable defaults.
+email:
+- danfalcone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/subshell.rb
+- lib/subshell/version.rb
+- subshell.gemspec
+homepage: https://github.com/falconed/subshell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Easily run subshell commands.
+test_files: []