shell_tools 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,15 @@
+# ShellTools
+
+Some common shell utilities.
+
+## sh
+
+Execute the command and return the output. The stderr and stdout are merged together into the output. If it exits with a non-zero status, this method will raise an error.
+
+## sh_with_code
+
+Execute the command and return the output and status code. The stderr and stdout are merged together into the output
+
+## escape
+
+Escapes any number of words and joins them into an escaped string.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :test do
+  Rake::TestTask.new do |t|
+    Dir['test/*_test.rb'].each{|f| require File.expand_path(f)}
+  end
+end

data/lib/shell_tools.rb

@@ -0,0 +1,58 @@
+require "shell_tools/version"
+
+module ShellTools
+  extend self
+  
+  def sh(cmd, base = nil)
+    out, code = sh_with_code(cmd)
+    code == 0 ? out : raise(out.empty? ? "Running `#{cmd}' failed. Run this command directly for more detailed output." : out)
+  end
+
+  # Run in shell, return both status and output
+  # @see #sh
+  def sh_with_code(cmd, base = nil)
+    cmd << " 2>&1"
+    outbuf = ''
+    outbuf = `#{base && "cd '#{base}' && "}#{cmd}`
+    [outbuf, $?]
+  end
+
+  def escape(*command)
+    command.flatten.map {|word| escape_word(word) }.join(' ')
+  end
+
+  def escape_word(str)
+    if str.empty?
+      "''"
+    elsif %r{\A[0-9A-Za-z+,./:=@_-]+\z} =~ str
+      str
+    else
+      result = ''
+      str.scan(/('+)|[^']+/) {
+        if $1
+          result << %q{\'} * $1.length
+        else
+          result << "'#{$&}'"
+        end
+      }
+      result
+    end
+  end
+
+  def capture
+    old_out, old_err = STDOUT.dup, STDERR.dup
+    stdout_read, stdout_write = IO.pipe
+    stderr_read, stderr_write = IO.pipe
+    $stdout.reopen(stdout_write)
+    $stderr.reopen(stderr_write)
+    yield
+    stdout_write.close
+    stderr_write.close
+    out = stdout_read.rewind && stdout_read.read rescue nil
+    err = stderr_read.rewind && stderr_read.read rescue nil
+    [out, err]
+  ensure
+    $stdout.reopen(old_out)
+    $stderr.reopen(old_err)
+  end
+end

data/lib/shell_tools/version.rb

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

data/shell_tools.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shell_tools/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shell_tools"
+  s.version     = ShellTools::VERSION
+  s.authors     = ["Josh Hull"]
+  s.email       = ["joshbuddy@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Some common shell utils}
+  s.description = %q{Some common shell utils.}
+
+  s.rubyforge_project = "shell_tools"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+end

data/test/shell_utils_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe "ShellTools" do
+  it "should sh" do
+    assert_equal Time.new.to_i.to_s, ShellTools.sh("date +%s").strip
+  end
+
+  it "should sh and raise" do
+    assert_raises RuntimeError do
+      ShellTools.sh("mymilkshakebringsvariousboystotheYARD")
+    end
+  end
+
+  it "should sh_with_code" do
+    out, status = ShellTools.sh_with_code("date +%s")
+    assert_equal Time.new.to_i.to_s, out.strip
+    assert_equal 0, status.to_i
+  end
+
+  it "should sh_with_code and fail" do
+    out, status = ShellTools.sh_with_code("mymilkshakebringsvariousboystotheYARD")
+    assert_equal "sh: mymilkshakebringsvariousboystotheYARD: command not found", out.strip
+    refute_equal 0, status.to_i
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'minitest/autorun'
+$:.unshift File.expand_path("../../lib")
+require 'shell_tools'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: shell_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70259743014820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70259743014820
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70259743013800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70259743013800
+description: Some common shell utils.
+email:
+- joshbuddy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/shell_tools.rb
+- lib/shell_tools/version.rb
+- shell_tools.gemspec
+- test/shell_utils_test.rb
+- test/test_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -759511355527622154
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -759511355527622154
+requirements: []
+rubyforge_project: shell_tools
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Some common shell utils
+test_files:
+- test/shell_utils_test.rb
+- test/test_helper.rb