shell_command 0.1.0

data/.gitignore

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

data/.pryrc

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift './lib'
+require 'shell_command'

data/.travis.yml

@@ -0,0 +1,12 @@
+
+rvm: 
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  #- jruby-19mode (Appears to have popen3(…) from 1.8.7) 
+  #- rbx-19mode   (Appears to not implement Open3.spawn(…))
+
+notifications:
+  irc: "irc.freenode.org#flowof.info"
+  recipients:
+    - rob@flowof.info

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Robert Gleeson
+
+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,55 @@
+__OVERVIEW__
+
+
+| Project         | shell\_command 
+|:----------------|:--------------------------------------------------
+| Homepage        | https://github.com/robgleeson/shell\_command
+| Wiki            | https://github.com/robgleeson/shell\_command/wiki
+| Documentation   | http://rubydoc.info/gems/shell\_command/frames 
+| Author          | Rob Gleeson   
+
+__DESCRIPTION__
+
+shell\_command tries to provide a better interface for communicating with   
+commands you spawn on the shell. The examples will give you a much better idea   
+of what I mean.  
+
+__USE CASES__
+
+* Run a command, and find out if it was successful (e.g: exited with 0).
+* Run a command, and access stdout or stderr.
+
+__EXAMPLES__
+
+The first example lets you handle a failure yourself, but the second example   
+assumes you want a exception raised on failure.  
+
+__1.__
+
+    ShellCommand.run "ls" do |command|
+      if command.success?
+        puts command.stdout
+      else
+        raise RuntimeError, "The command 'ls' failed." 
+      end
+    end
+
+__2.__
+
+    begin
+      ShellCommand.run! "ls"
+    rescue ShellCommand::Exception => e 
+      p e.message
+    end
+
+__SUPPORTED PLATFORMS__
+
+JRuby, and Rubinius do not implement `Open3.popen3(…)` properly yet. :(  
+As soon as they do they will be supported in 1.9 mode.
+
+  * CRuby 1.9+
+
+__LICENSE__
+
+See LICENSE.txt
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.name       = :test
+  t.test_files = FileList["test/*.rb"]
+end
+
+task :default => :test

data/lib/shell_command.rb

@@ -0,0 +1,86 @@
+require "shell_command/version"
+require 'open3'
+
+module ShellCommand
+
+  class Exception < StandardError
+  end
+
+  #
+  # @attr [Process::Status] status
+  #   The status of the command.
+  #
+  # @attr [String] stderr
+  #   The output written by the command to standard error.
+  #
+  # @attr [String] stdout
+  #   The output written by the command to standard output.
+  #
+  class Command < Struct.new(:status, :stderr, :stdout)
+
+    def method_missing method, *args, &block
+      if status.respond_to?(method)
+        status.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing? method, include_private = false
+      status.respond_to?(method, include_private)
+    end
+
+  end
+
+  #
+  # @param [String] *args
+  #   A command and its arguments to execute (if any).
+  #
+  # @yieldparam [ShellCommand::Command] command
+  #   Yields {ShellCommand::Command} if a block is given.
+  #
+  # @return [ShellCommand::Command]
+  #   Returns a {ShellCommand::Command}
+  #
+  def run *args
+    if args.empty?
+      raise ArgumentError, 'Wrong number of arguments (0 for 1)'
+    end
+
+    Open3.popen3(*args) do |_, stdout, stderr, thr|
+      status  = thr.value
+      command = Command.new(status, stderr.read, stdout.read)
+
+      if block_given?
+        yield(command)
+      else
+        command
+      end
+    end
+  end
+  module_function :run
+
+  #
+  # @param 
+  #   (see #run)
+  #
+  # @raise [ShellCommand::Exception]
+  #   If the command is unsuccessful (e.g: > 0 exit status code) 
+  #
+  # @return 
+  #   (see #run)
+  #
+  def run! *args
+    command = run(*args)
+
+    if command.success?
+      command
+    else
+      raise ShellCommand::Exception,
+            "The command '#{args.join(' ')}' has failed."
+    end
+  end
+  module_function :run!
+
+end
+

data/lib/shell_command/version.rb

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

data/shell_command.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shell_command/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shell_command"
+  s.version     = ShellCommand::VERSION
+  s.authors     = ["Rob Gleeson"]
+  s.email       = ["rob@flowof.info"]
+  s.homepage    = "https://github.com/robgleeson/shell_command"
+  
+  s.summary     = %q{shell_command tries to provide a better interface for 
+                     communicating with commands you spawn on the shell}
+
+  s.description = s.summary
+
+  s.rubyforge_project = "shell_command"
+
+  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.required_ruby_version = '~> 1.9.1'
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+
+end

data/test/setup.rb

@@ -0,0 +1,6 @@
+require 'shell_command'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+alias context describe
+

data/test/test_shell_command.rb

@@ -0,0 +1,56 @@
+context ShellCommand do
+
+  context 'run' do
+    it 'must successfully execute "echo".' do
+      command = ShellCommand.run "echo -n Hi!"
+      command.success?.must_equal(true)
+    end
+
+    it 'must give access to the standard output of "echo"' do
+      command = ShellCommand.run "echo -n Hi!"
+      command.stdout.must_equal("Hi!")
+    end
+
+    it 'must give access to the standard error output of "echo"' do
+      command = ShellCommand.run "ls /i_do_not_exist"
+      command.stderr.empty?.must_equal(false)
+    end
+
+    it 'must call a block, if given.' do
+      mock = MiniTest::Mock.new
+      mock.expect(:ok, nil)
+
+      ShellCommand.run "ls" do |command|
+        mock.ok
+      end
+
+      mock.verify
+    end
+
+    it "must yield a parameter, if asked." do
+      ShellCommand.run "ls" do |command|
+        command.must_be_instance_of(ShellCommand::Command)
+      end
+    end
+
+    it 'must raise a ArgumentError if given no arguments.' do
+      proc {
+        ShellCommand.run
+      }.must_raise(ArgumentError)
+    end
+  end
+
+  context 'run!' do
+    it 'must raise a exception when a command fails.' do
+      proc {
+        ShellCommand.run! "ls /opskddiofjfsiodjf"
+      }.must_raise(ShellCommand::Exception)
+    end
+
+    it 'must give a Command when a command is successful.' do
+      command = ShellCommand.run! "ls"
+      command.must_be_instance_of(ShellCommand::Command)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: shell_command
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rob Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70283541504560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70283541504560
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70283541504100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70283541504100
+description: shell_command tries to provide a better interface for  communicating
+  with commands you spawn on the shell
+email:
+- rob@flowof.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shell_command.rb
+- lib/shell_command/version.rb
+- shell_command.gemspec
+- test/setup.rb
+- test/test_shell_command.rb
+homepage: https://github.com/robgleeson/shell_command
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -941004093862676109
+requirements: []
+rubyforge_project: shell_command
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: shell_command tries to provide a better interface for  communicating with
+  commands you spawn on the shell
+test_files:
+- test/setup.rb
+- test/test_shell_command.rb