easy_shell 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Harlan T Wood
+
+MIT License
+
+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,77 @@
+easy_shell
+==========
+
+Easily execute shell commands from ruby, with options like verbose output,
+confirm first, and continue (or abort) on failure.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_shell'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_shell
+
+Sample Usage
+------------
+
+    require 'easy_shell'
+
+Vanilla usage
+
+    > run "date +%M"
+    => Running "date +%M"
+    11
+     => "11\n"
+
+Quiet
+
+    > run "date +%M", :quiet => true
+     => "12\n"
+
+Require interactive confirmation before executing command
+
+    > run "date +%M", :confirm_first  => true
+    => Running "date +%M"
+    Execute [Yn]?  [Yn]
+    13
+     => "13\n"
+
+    > run "date +%M", :confirm_first  => true
+    => Running "date +%M"
+    Execute [Yn]?  [Yn] n
+     => nil
+
+Raise exception when the command fails (not found or non-zero exit code)...
+
+    > run "nosuchcommand"
+    => Running "nosuchcommand"
+    RuntimeError: ERROR running "nosuchcommand"
+    Output:
+    sh: nosuchcommand: command not found
+        [stacktrace removed]
+
+...unless we ask to continue on failure
+
+    > run "nosuchcommand", :continue_on_failure => true
+    => Running "nosuchcommand"
+    Continuing, ignoring error while running "nosuchcommand"
+    Output:
+    sh: nosuchcommand: command not found
+     => "sh: nosuchcommand: command not found\n"
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/easy_shell.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_shell/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "easy_shell"
+  gem.version       = EasyShell::VERSION
+  gem.authors       = ["Harlan T Wood"]
+  gem.email         = ["code@harlantwood.net"]
+  gem.description   = %q{Execute shell commands, with options like verbose output, confirm first, and continue or stop on failure}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/harlantwood/easy_shell"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/easy_shell.rb

@@ -0,0 +1,44 @@
+require "easy_shell/version"
+require "easy_shell/core_ext/kernel"
+
+module EasyShell
+  def self.run(cmd, options = {})
+    defaults = {
+      :quiet => false,
+      :confirm_first => false,
+      :continue_on_failure => false,
+    }
+    unknown_options = options.keys - defaults.keys
+    raise "Unknown options #{unknown_options.inspect}" unless unknown_options.empty?
+    options = defaults.merge(options)
+    cmd.gsub!(/\s+/, ' ')
+    cmd.strip!
+    cmd_sanitized = cmd.gsub(%r{(https://[-\w]+:)[-\w]+@}, '\1[password sanitized]@')
+    puts "=> Running #{cmd_sanitized.inspect}\n" unless options[:quiet]
+
+    return unless confirm("Execute [Yn]? ") if options[:confirm_first]
+
+    output = `#{cmd} 2>&1`
+    success = $?.success?
+    puts output if success && !options[:quiet]
+
+    unless success
+      if options[:continue_on_failure]
+        msg = "Continuing, ignoring error while running #{cmd_sanitized.inspect}"
+        msg += "\nOutput:\n#{output}" if output
+        puts msg
+      else
+        msg = "ERROR running #{cmd_sanitized.inspect}"
+        msg += "\nOutput:\n#{output}" if output
+        raise msg
+      end
+    end
+    output
+  end
+
+  def self.confirm(msg)
+    STDOUT << "#{msg} [Yn] "
+    response = STDIN.gets.chomp
+    response.empty? || !!response.match(/^(y|yes)$/i)
+  end
+end

data/lib/easy_shell/core_ext/kernel.rb

@@ -0,0 +1,5 @@
+module Kernel
+  def run(cmd, options = {})
+    EasyShell.run cmd, options
+  end
+end

data/lib/easy_shell/version.rb

@@ -0,0 +1,3 @@
+module EasyShell
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: easy_shell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Harlan T Wood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-27 00:00:00.000000000 Z
+dependencies: []
+description: Execute shell commands, with options like verbose output, confirm first,
+  and continue or stop on failure
+email:
+- code@harlantwood.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_shell.gemspec
+- lib/easy_shell.rb
+- lib/easy_shell/core_ext/kernel.rb
+- lib/easy_shell/version.rb
+homepage: https://github.com/harlantwood/easy_shell
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Execute shell commands, with options like verbose output, confirm first,
+  and continue or stop on failure
+test_files: []