cocaine 0.0.2 → 0.1.0

data/README.md

@@ -2,75 +2,99 @@
 
 A small library for doing (command) lines.
 
+## Feedback
+
+Question? Idea? Problem? Bug? Something else? Comment? Concern? Like use question marks?
+
+[GitHub Issues For All!](https://github.com/thoughtbot/cocaine/issues)
+
 ## 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!
+```ruby
+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'"
+```ruby
+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'"
+```ruby
+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!'"
+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"
+```ruby
+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"
+# ... 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
+```ruby
+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
+```ruby
+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"
+```ruby
+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"
+```ruby
+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
+```ruby
+line = Cocaine::CommandLine.new("/usr/bin/false", "", :expected_outcodes => [0, 1])
+begin
+  line.run
+rescue Cocaine::ExitStatusError => e
+  # => You never get here!
+end
+```
 
 ## License
 

data/lib/cocaine/command_line.rb

@@ -15,15 +15,18 @@ module Cocaine
 
     def command
       cmd = []
-      cmd << full_path(@binary)
+      cmd << @binary
       cmd << interpolate(@params, @options)
       cmd << bit_bucket if @swallow_stderr
-      cmd.join(" ")
+      cmd.join(" ").strip
     end
 
     def run
+      output = ''
       begin
-        output = self.class.send(:'`', command)
+        with_modified_path do
+          output = self.class.send(:'`', command)
+        end
       rescue Errno::ENOENT
         raise Cocaine::CommandNotFoundError
       end
@@ -38,8 +41,15 @@ module Cocaine
 
     private
 
-    def full_path(binary)
-      [self.class.path, binary].compact.join("/")
+    def with_modified_path
+      begin
+        saved_path = ENV['PATH']
+        extra_path = [self.class.path].flatten
+        ENV['PATH'] = [ENV['PATH'], *extra_path].join(File::PATH_SEPARATOR)
+        yield
+      ensure
+        ENV['PATH'] = saved_path
+      end
     end
 
     def interpolate(pattern, vars)

data/lib/cocaine/version.rb

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

data/spec/cocaine/command_line_spec.rb

@@ -11,10 +11,20 @@ describe Cocaine::CommandLine do
     cmd.command.should == "convert a.jpg b.png"
   end
 
-  it "can set a default path and produce commands with that path" do
-    Cocaine::CommandLine.path = "/opt/bin"
-    cmd = Cocaine::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
-    cmd.command.should == "/opt/bin/convert a.jpg b.png"
+  it "specifies the path where the command should be run" do
+    Cocaine::CommandLine.path = "/path/to/command/dir"
+    cmd = Cocaine::CommandLine.new("ruby", "-e 'puts ENV[%{PATH}]'")
+    cmd.command.should == "ruby -e 'puts ENV[%{PATH}]'"
+    output = cmd.run
+    output.should match(%r{/path/to/command/dir})
+  end
+
+  it "specifies more than one path where the command should be run" do
+    Cocaine::CommandLine.path = ["/path/to/command/dir", "/some/other/path"]
+    cmd = Cocaine::CommandLine.new("ruby", "-e 'puts ENV[%{PATH}]'")
+    output = cmd.run
+    output.should match(%r{/path/to/command/dir})
+    output.should match(%r{/some/other/path})
   end
 
   it "can interpolate quoted variables into the parameters" do

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rspec'
-require 'spec/support/with_exitstatus'
+require './spec/support/with_exitstatus'
 require 'mocha'
 require 'bourne'
 require 'cocaine'

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jon Yurek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 -04:00
+date: 2011-06-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency