Skip to content
This repository has been archived by the owner on Feb 7, 2018. It is now read-only.

Commit

Permalink
Let's use colons in the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabe Berke-Williams committed Nov 12, 2011
1 parent c74077c commit f96add7
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Expand Up @@ -18,7 +18,7 @@ line.command # => "command some 'crazy' options"
output = line.run # => Get you some output! output = line.run # => Get you some output!
``` ```


Allowing arguments to be dynamic. Allowing arguments to be dynamic:


```ruby ```ruby
line = Cocaine::CommandLine.new("convert", ":in -scale :resolution :out", line = Cocaine::CommandLine.new("convert", ":in -scale :resolution :out",
Expand All @@ -28,7 +28,7 @@ line = Cocaine::CommandLine.new("convert", ":in -scale :resolution :out",
line.command # => "convert 'omg.jpg' -scale '32x32' 'omg_thumb.jpg'" line.command # => "convert 'omg.jpg' -scale '32x32' 'omg_thumb.jpg'"
``` ```


It prevents attempts at being bad. It prevents attempts at being bad:


```ruby ```ruby
line = Cocaine::CommandLine.new("cat", ":file", :file => "haha`rm -rf /`.txt") line = Cocaine::CommandLine.new("cat", ":file", :file => "haha`rm -rf /`.txt")
Expand All @@ -38,7 +38,7 @@ line = Cocaine::CommandLine.new("cat", ":file", :file => "ohyeah?'`rm -rf /`.ha!
line.command # => "cat 'ohyeah?'\\''`rm -rf /`.ha!'" line.command # => "cat 'ohyeah?'\\''`rm -rf /`.ha!'"
``` ```


You can ignore the result. You can ignore the result:


```ruby ```ruby
line = Cocaine::CommandLine.new("noisy", "--extra-verbose", :swallow_stderr => true) line = Cocaine::CommandLine.new("noisy", "--extra-verbose", :swallow_stderr => true)
Expand All @@ -48,7 +48,7 @@ line.command # => "noisy --extra-verbose 2>/dev/null"
line.command # => "noisy --extra-verbose 2>NUL" line.command # => "noisy --extra-verbose 2>NUL"
``` ```


If your command errors, you get an exception. If your command errors, you get an exception:


```ruby ```ruby
line = Cocaine::CommandLine.new("git", "commit") line = Cocaine::CommandLine.new("git", "commit")
Expand All @@ -59,7 +59,7 @@ rescue Cocaine::ExitStatusError => e
end end
``` ```


You don't have the command? You get an exception. You don't have the command? You get an exception:


```ruby ```ruby
line = Cocaine::CommandLine.new("lolwut") line = Cocaine::CommandLine.new("lolwut")
Expand All @@ -70,32 +70,32 @@ rescue Cocaine::CommandNotFoundError => e
end end
``` ```


But don't fear, you can specify where to look for the command. But don't fear, you can specify where to look for the command:


```ruby ```ruby
Cocaine::CommandLine.path = "/opt/bin" Cocaine::CommandLine.path = "/opt/bin"
line = Cocaine::CommandLine.new("lolwut") line = Cocaine::CommandLine.new("lolwut")
line.command # => "lolwut", but it looks in /opt/bin for it. line.command # => "lolwut", but it looks in /opt/bin for it.
``` ```


You can even give it a bunch of places to look. You can even give it a bunch of places to look:


```ruby ```ruby
FileUtils.rm("/opt/bin/lolwut") FileUtils.rm("/opt/bin/lolwut")
`echo 'echo Hello' > /usr/local/bin/lolwut` `echo 'echo Hello' > /usr/local/bin/lolwut`
Cocaine::CommandLine.path = ["/opt/bin", "/usr/local/bin"] Cocaine::CommandLine.path = ["/opt/bin", "/usr/local/bin"]
line = Cocaine::CommandLine.new("lolwut") line = Cocaine::CommandLine.new("lolwut")
line.run # => prints 'Hello', because it searches the path line.run # => prints 'Hello', because it searches the path
``` ```


Or, just, you know, put it in the command. Or just put it in the command:


```ruby ```ruby
line = Cocaine::CommandLine.new("/opt/bin/lolwut") line = Cocaine::CommandLine.new("/opt/bin/lolwut")
line.command # => "/opt/bin/lolwut" line.command # => "/opt/bin/lolwut"
``` ```


If your command might return something non-zero, and you expect that, it's cool. If your command might return something non-zero, and you expect that, it's cool:


```ruby ```ruby
line = Cocaine::CommandLine.new("/usr/bin/false", "", :expected_outcodes => [0, 1]) line = Cocaine::CommandLine.new("/usr/bin/false", "", :expected_outcodes => [0, 1])
Expand Down

0 comments on commit f96add7

Please sign in to comment.