cocaine 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,26 @@
+
+LICENSE
+
+The MIT License
+
+Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
+
+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 @@
+# Cocaine
+
+A small library for doing (command) lines.
+
+## Usage
+
+The basic, normal stuff.
+
+    line = Cocaine::CommandLine.run("command", "some 'crazy' options")
+    line.command      # => "command some 'crazy' options"
+    output = line.run # => Get you some output!
+
+Allowing arguments to be dynamic.
+
+    line = Cocaine::CommandLine.new("convert", ":in -scale :resolution :out",
+                                    :in => "omg.jpg",
+                                    :resolution => "32x32",
+                                    :out => omg_thumb.jpg")
+    line.command # => "convert 'omg.jpg' -scale '32x32' 'omg_thumb.jpg'"
+
+It prevents attempts at being bad.
+
+    line = Cocaine::CommandLine.new("cat", ":file", :file => "haha`rm -rf /`.txt")
+    line.command # => "cat 'haha`rm -rf /`.txt'"
+
+    line = Cocaine::CommandLine.new("cat", ":file", :file => "ohyeah?'`rm -rf /`.ha!")
+    line.command # => "cat 'ohyeah?'\\''`rm -rf /`.ha!'"
+
+You can ignore the result.
+
+    line = Cocaine::CommandLine.new("noisy", "--extra-verbose", :swallow_stderr => true)
+    line.command # => "noisy --extra-verbose 2>/dev/null"
+
+    # ... and on Windows...
+    line.command # => "noisy --extra-verbose 2>NUL"
+
+If your command errors, you get an exception.
+
+    line = Cocaine::CommandLine.new("git", "commit")
+    begin
+      line.run
+    rescue Cocaine::ExitStatusError => e
+      e.message # => "Command 'git commit' returned 1. Expected 0"
+    end
+
+You don't have the command? You get an exception.
+
+    line = Cocaine::CommandLine.new("lolwut")
+    begin
+      line.run
+    rescue Cocaine::CommandNotFoundError => e
+      e # => the command isn't in the $PATH for this process.
+    end
+
+But don't fear, you can specify where to look for the command.
+
+    Cocaine::CommandLine.path = "/opt/bin"
+    line = Cocaine::CommandLine.new("lolwut")
+    line.command # => "/opt/bin/lolwut"
+
+Or, just, you know, put it in the command.
+
+    line = Cocaine::CommandLine.new("/opt/bin/lolwut")
+    line.command # => "/opt/bin/lolwut"
+
+If your command might return something non-zero, and you expect that, it's cool.
+
+    line = Cocaine::CommandLine.new("/usr/bin/false", "", :expected_outcodes => [0, 1])
+    begin
+      line.run
+    rescue Cocaine::ExitStatusError => e
+      # => You never get here!
+    end
+
+## License
+
+Copyright 2011 Jon Yurek and thoughtbot, inc. This is free software, and may be redistributed under the terms specified in the LICENSE file.

data/lib/cocaine/command_line.rb

@@ -8,7 +8,7 @@ module Cocaine
       @binary            = binary.dup
       @params            = params.dup
       @options           = options.dup
-      @swallow_stderr    = @options.has_key?(:swallow_stderr) ? @options.delete(:swallow_stderr) : Cocaine.options[:swallow_stderr]
+      @swallow_stderr    = @options.delete(:swallow_stderr)
       @expected_outcodes = @options.delete(:expected_outcodes)
       @expected_outcodes ||= [0]
     end

data/lib/cocaine/version.rb

@@ -1,3 +1,3 @@
 module Cocaine
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cocaine
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jon Yurek
@@ -69,6 +69,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
+- LICENSE
 - Rakefile
 - lib/cocaine.rb
 - lib/cocaine/command_line.rb