safe_shell 1.0.1 → 1.0.2

data/.gitignore

@@ -22,3 +22,6 @@ pkg/*
 
 ## PROJECT::SPECIFIC
 tmp/*
+
+## RVM
+.rvmrc

data/README.rdoc

@@ -17,6 +17,9 @@ SafeShell sets the $? operator to the process status, in the same manner as the
     # Return true if the command exits with a zero status:
     SafeShell.execute?("echo", "Hello, world!")
 
+    # Raise an exception if the command exits with a non-zero status:
+    SafeShell.execute!("echo", "Hello, world!")
+
 == Why?
 
 If you use backticks to process a file supplied by a user, a carefully crafted filename could allow execution of an arbitrary command:
@@ -36,7 +39,7 @@ SafeShell solves this.
 Tested with Ruby 1.8.7, but it should be happy on pretty much any Ruby version. Maybe not so much on Windows.
 
 == Developing
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/lib/safe_shell.rb

@@ -1,4 +1,6 @@
 module SafeShell
+  class CommandFailedException < RuntimeError; end
+
   def self.execute(command, *args)
     opts = args.last.kind_of?(Hash) ? args.pop : {}
     read_end, write_end = IO.pipe
@@ -21,4 +23,17 @@ module SafeShell
     execute(*args)
     $?.success?
   end
+
+  def self.execute!(*args)
+    execute(*args).tap do
+      raise_command_failed_exception(*args) unless $?.success?
+    end
+  end
+
+private
+
+  def self.raise_command_failed_exception(*args)
+    raise CommandFailedException.new("Shell command #{args.inspect} failed with status #{$?}")
+  end
+
 end

data/lib/safe_shell/version.rb

@@ -1,3 +1,3 @@
 module SafeShell
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/safe_shell_spec.rb

@@ -40,4 +40,16 @@ describe "SafeShell" do
     end
   end
 
+  context ".execute!" do
+    it "returns the output of the command" do
+      SafeShell.execute!("echo", "Hello, world!").should == "Hello, world!\n"
+    end
+
+    it "raises an exception of the command fails" do
+      expect {
+        SafeShell.execute!("test", "a", "=", "b")
+      }.should raise_error(SafeShell::CommandFailedException)
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: safe_shell
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Envato
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +11:00
+date: 2012-01-03 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: safe_shell
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Safely execute shell commands and get their output.