half_shell 0.0.3

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'minitest'
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Chris Gibson
+
+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,43 @@
+Half Shell
+=========
+
+`half_shell` is a simple ruby gem for executing shell commands
+
+Installation:
+
+    gem install half_shell
+
+Examples:
+
+    require 'half_shell'
+    
+    # execute a command and capture the result
+    result = HalfShell.execute 'ls'
+     => #<HalfShell::Result:0x101270f18 @stdout="Gemfile\nGemfile.lock\nREADME.md\nRakefile\nbenchmark.rb\ncoverage\nhalf_shell.gemspec\nlib\ntest\n", @status=0, @command="ls", @stderr="">
+    
+    # status
+    result.status
+     => 0
+    
+    # stdout
+    result.stdout
+     => "Gemfile\nGemfile.lock\nREADME.md\nRakefile\nbenchmark.rb\ncoverage\nhalf_shell.gemspec\nlib\ntest\n"
+     
+    # stderr
+    result.stderr
+     => ""
+    
+    # raise an exception if the command exits with a non-zero status code
+    HalfShell.execute '(exit 123)'
+     => HalfShell::ExecuteError: command <(exit 123)> failed with status <123>
+    
+    # don't raise an exception if the command exits with a non-zero status code
+    HalfShell.execute '(exit 123)', :raise => false
+     => #<HalfShell::Result:0x1012380a0 @stdout="", @status=123, @command="(exit 123)", @stderr="">
+     
+    # execute a command, but only care about the status
+    HalfShell.execute! 'ls'
+     => true
+    
+    HalfShell.execute! '(exit 123)'
+     => false

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_{test,spec}.rb']
+  # t.warning = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = FileList['test/**/*_{test,spec}.rb']
+    t.verbose = true
+    t.rcov_opts << %w{ --exclude .rvm }
+  end
+rescue LoadError
+  desc 'Analyze code coverage with tests'
+  task :rcov do
+    puts "Install rcov"
+  end
+end

data/benchmark.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'benchmark'
+require 'systemu'
+require File.expand_path '../lib/half_shell', __FILE__
+
+commands = [
+  'ls',
+  'pwd',
+  'echo 123'
+] * 100
+
+Benchmark.bm 15 do |bm|
+  bm.report('backticks') { commands.each { |command| `#{command}` } }
+  bm.report('systemu') { commands.each { |command| systemu command } }
+  bm.report('halfshell') { commands.each { |command| HalfShell.execute(command) } }
+end

data/half_shell.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "half_shell/version"
+
+Gem::Specification.new do |s|
+  s.name        = "half_shell"
+  s.version     = HalfShell::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Gibson"]
+  s.email       = ["chrislgibson@gmail.com"]
+  s.homepage    = "http://github.com/chrisgibson/half_shell"
+  s.summary     = %q{a simple ruby gem for executing shell commands}
+  s.description = %q{a bit cleaner than built-in methods of executing commands and less complicated under the hood than systemu}
+
+  s.rubyforge_project = "half_shell"
+
+  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"]
+  
+  s.add_dependency 'open4'
+  s.add_development_dependency 'minitest'
+end

data/lib/half_shell.rb

@@ -0,0 +1,48 @@
+require 'shellwords'
+require 'open4'
+
+module HalfShell
+  
+  class ExecuteError < StandardError
+    
+    attr_reader :command, :status
+    
+    def initialize(command, status)
+      @command, @status = command, status
+      super "command <#{@command}> failed with status <#{@status}>"
+    end
+    
+  end
+
+  class << self
+    
+    def execute(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      opts[:raise] = true unless opts.has_key? :raise
+      
+      command = args.join(' ')
+      
+      stdout, stderr = nil
+      status = Open4.popen4(command) do |pid, _stdin, _stdout, _stderr|
+        stdout = _stdout.read
+        stderr = _stderr.read
+      end
+      
+      if opts[:raise] && status.exitstatus != 0
+        raise ExecuteError.new command, status.exitstatus
+      end
+      
+      Result.new command, status.exitstatus, stdout, stderr
+    end
+    
+    def execute!(*args)
+      command = args.join(' ')
+      `#{command}`
+      $?.success?
+    end
+    
+  end
+
+end
+
+require File.expand_path '../half_shell/result', __FILE__

data/lib/half_shell/result.rb

@@ -0,0 +1,21 @@
+class HalfShell::Result
+  
+  attr_reader :command, :status, :stderr, :stdout
+  
+  def initialize(command, status, stdout, stderr)
+    @command = command
+    @status, @stdout, @stderr = status, stdout, stderr
+  end
+  
+  def to_s
+    %Q{#<HalfShell::Result command="#{shorten(command)}" status=#{status} stdout="#{shorten(stdout)}" stderr="#{shorten(stderr)}">}
+  end
+  
+  private
+  
+  def shorten(str)
+    chars = 10
+    str.gsub(/\n/, '\n')[0..(str.size > chars ? chars - 3 : -1)] + (str.size > chars ? '...' : '')
+  end
+  
+end

data/lib/half_shell/version.rb

@@ -0,0 +1,3 @@
+module HalfShell
+  VERSION = "0.0.3"
+end

data/test/half_shell_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe HalfShell do
+  
+  describe '#execute' do
+    
+    describe 'when raising exception on non-zero status' do
+      
+      it 'should raise an exception on non-zero status' do
+        lambda { HalfShell.execute('(exit 123)') }.must_raise HalfShell::ExecuteError
+      end
+      
+      it 'should read stdout' do
+        HalfShell.execute('echo "foo bar"').stdout.chomp.must_equal "foo bar"
+      end
+      
+      it 'should read stderr' do
+        HalfShell.execute('echo "foo bar" 1>&2').stderr.chomp.must_equal "foo bar"
+      end
+      
+    end
+    
+    describe 'when NOT raising exception on non-zero status' do
+      
+      it 'should return the correct status code' do
+        HalfShell.execute('(exit 123)', :raise => false).status.must_equal 123
+      end
+      
+      it 'should read stdout' do
+        HalfShell.execute('echo "foo bar"').stdout.chomp.must_equal "foo bar"
+      end
+      
+      it 'should read stderr' do
+        HalfShell.execute('echo "foo bar" 1>&2').stderr.chomp.must_equal "foo bar"
+      end
+      
+    end
+    
+  end
+  
+  describe '#execute!' do
+    
+    it 'should return true when command exited with a zero status' do
+      HalfShell.execute!('(exit 0)').must_equal true
+    end
+    
+    it 'should return false when command exited with a non-zero status' do
+      HalfShell.execute!('(exit 123)').must_equal false
+    end
+    
+  end
+  
+end

data/test/result_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe HalfShell::Result do
+  
+  describe '.to_s' do
+    
+    it 'should include command, status, stdout, and stderr' do
+      HalfShell::Result.new('ls', 0, 'stdout', 'stderr').to_s.must_equal \
+        '#<HalfShell::Result command="ls" status=0 stdout="stdout" stderr="stderr">'
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require File.expand_path('../../lib/half_shell', __FILE__)

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: half_shell
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Chris Gibson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-24 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: a bit cleaner than built-in methods of executing commands and less complicated under the hood than systemu
+email: 
+- chrislgibson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- benchmark.rb
+- half_shell.gemspec
+- lib/half_shell.rb
+- lib/half_shell/result.rb
+- lib/half_shell/version.rb
+- test/half_shell_spec.rb
+- test/result_spec.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/chrisgibson/half_shell
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: half_shell
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: a simple ruby gem for executing shell commands
+test_files: 
+- test/half_shell_spec.rb
+- test/result_spec.rb
+- test/test_helper.rb