cocaine 0.3.2 → 0.4.0

data/.travis.yml

@@ -2,5 +2,4 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ree
   - jruby

data/README.md

@@ -17,21 +17,21 @@ line.run # => "hello world\n"
 Interpolated arguments:
 
 ```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'"
+line = Cocaine::CommandLine.new("convert", ":in -scale :resolution :out")
+line.command(:in => "omg.jpg",
+             :resolution => "32x32",
+             :out => "omg_thumb.jpg")
+# => "convert 'omg.jpg' -scale '32x32' 'omg_thumb.jpg'"
 ```
 
 It prevents attempts at being bad:
 
 ```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")
+line.command(:file => "haha`rm -rf /`.txt") # => "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")
+line.command(:file => "ohyeah?'`rm -rf /`.ha!") # => "cat 'ohyeah?'\\''`rm -rf /`.ha!'"
 ```
 
 You can ignore the result:
@@ -105,8 +105,8 @@ line.command # => "/opt/bin/lolwut"
 You can see what's getting run. The 'Command' part it logs is in green for visibility!
 
 ```ruby
-line = Cocaine::CommandLine.new("echo", ":var", :var => "LOL!", :logger => Logger.new(STDOUT))
-line.run # => Logs this with #info -> Command :: echo 'LOL!'
+line = Cocaine::CommandLine.new("echo", ":var", :logger => Logger.new(STDOUT))
+line.run(:var => "LOL!") # => Logs this with #info -> Command :: echo 'LOL!'
 ```
 
 Or log every command:
@@ -149,6 +149,19 @@ in https://github.com/thoughtbot/cocaine/issues/24 and probably fixed in
 http://jira.codehaus.org/browse/JRUBY-6162. You *will* want to use the
 `BackticksRunner` if you are unable to update JRuby.
 
+## REE
+
+So, here's the thing about REE: The specs that involve timeouts don't work
+there. Not because the logic is unsound, but because the command runs really
+slowly. The test passes -- eventually. This was verified using an external
+debugger: the process that REE kicks off in the tests reads and writes
+surprisingly slowly. For this reason, we cannot recommend using Cocaine with
+REE anymore.
+
+It's not something we like, so if anyone has any insight into this problem,
+we'd love to hear about it. But, for the time being, we'll consider it more
+appropriate to just not use it anymore. Upgrade to 1.9.3, people.
+
 ## Feedback
 
 *Security* concerns must be privately emailed to

data/lib/cocaine/command_line.rb

@@ -52,19 +52,19 @@ module Cocaine
       @environment       = @options.delete(:environment) || {}
     end
 
-    def command
+    def command(interpolations = {})
       cmd = []
       cmd << @binary
-      cmd << interpolate(@params, @options)
+      cmd << interpolate(@params, interpolations)
       cmd << bit_bucket if @swallow_stderr
       cmd.join(" ").strip
     end
 
-    def run
+    def run(interpolations = {})
       output = ''
       begin
         @logger.info("\e[32mCommand\e[0m :: #{command}") if @logger
-        output = execute(command)
+        output = execute(command(interpolations))
       rescue Errno::ENOENT
         raise Cocaine::CommandNotFoundError
       ensure
@@ -93,26 +93,9 @@ module Cocaine
       self.class.environment.merge(@environment)
     end
 
-    def interpolate(pattern, vars)
-      # interpolates :variables and :{variables}
-      pattern.gsub(%r#:(?:\w+|\{\w+\})#) do |match|
-        key = match[1..-1]
-        key = key[1..-2] if key[0,1] == '{'
-        if invalid_variables.include?(key)
-          raise InterpolationError,
-            "Interpolation of #{key} isn't allowed."
-        end
-        interpolation(vars, key) || match
-      end
-    end
-
-    def invalid_variables
-      %w(expected_outcodes swallow_stderr logger environment)
-    end
-
-    def interpolation(vars, key)
-      if vars.key?(key.to_sym)
-        shell_quote(vars[key.to_sym])
+    def interpolate(pattern, interpolations)
+      interpolations.inject(pattern) do |command_string, (key, value)|
+        command_string.gsub(/:\{?#{key}\}?/) { shell_quote(value) }
       end
     end
 

data/lib/cocaine/version.rb

@@ -1,3 +1,3 @@
 module Cocaine
-  VERSION = "0.3.2".freeze
+  VERSION = "0.4.0".freeze
 end

data/spec/cocaine/command_line_spec.rb

@@ -52,48 +52,49 @@ describe Cocaine::CommandLine do
   it "can interpolate quoted variables into the command line's parameters" do
     cmd = Cocaine::CommandLine.new("convert",
                                    ":one :{two}",
-                                   :one => "a.jpg",
-                                   :two => "b.png",
                                    :swallow_stderr => false)
-    cmd.command.should == "convert 'a.jpg' 'b.png'"
+
+    command_string = cmd.command(:one => "a.jpg", :two => "b.png")
+    command_string.should == "convert 'a.jpg' 'b.png'"
+  end
+
+  it "interpolates when running a command" do
+    command = Cocaine::CommandLine.new("echo", ":hello_world")
+    command.run(:hello_world => "Hello, world").should match(/Hello, world/)
   end
 
   it "quotes command line options differently if we're on windows" do
     on_windows!
     cmd = Cocaine::CommandLine.new("convert",
                                    ":one :{two}",
-                                   :one => "a.jpg",
-                                   :two => "b.png",
                                    :swallow_stderr => false)
-    cmd.command.should == 'convert "a.jpg" "b.png"'
+    command_string = cmd.command(:one => "a.jpg", :two => "b.png")
+    command_string.should == 'convert "a.jpg" "b.png"'
   end
 
   it "can quote and interpolate dangerous variables" do
     cmd = Cocaine::CommandLine.new("convert",
                                    ":one :two",
-                                   :one => "`rm -rf`.jpg",
-                                   :two => "ha'ha.png",
                                    :swallow_stderr => false)
-    cmd.command.should == "convert '`rm -rf`.jpg' 'ha'\\''ha.png'"
+    command_string = cmd.command(:one => "`rm -rf`.jpg", :two => "ha'ha.png")
+    command_string.should == "convert '`rm -rf`.jpg' 'ha'\\''ha.png'"
   end
 
   it "can quote and interpolate dangerous variables even on windows" do
     on_windows!
     cmd = Cocaine::CommandLine.new("convert",
                                    ":one :two",
-                                   :one => "`rm -rf`.jpg",
-                                   :two => "ha'ha.png",
                                    :swallow_stderr => false)
-    cmd.command.should == %{convert "`rm -rf`.jpg" "ha'ha.png"}
+    command_string = cmd.command(:one => "`rm -rf`.jpg", :two => "ha'ha.png")
+    command_string.should == %{convert "`rm -rf`.jpg" "ha'ha.png"}
   end
 
   it "quotes blank values into the command line's parameters" do
     cmd = Cocaine::CommandLine.new("curl",
                                    "-X POST -d :data :url",
-                                   :data => "",
-                                   :url => "http://localhost:9000",
                                    :swallow_stderr => false)
-    cmd.command.should == "curl -X POST -d '' 'http://localhost:9000'"
+    command_string = cmd.command(:data => "", :url => "http://localhost:9000")
+    command_string.should == "curl -X POST -d '' 'http://localhost:9000'"
   end
 
   it "allows colons in parameters" do
@@ -118,21 +119,6 @@ describe Cocaine::CommandLine do
     cmd.command.should == "convert a.jpg b.png 2>NUL"
   end
 
-  it "raises if trying to interpolate :swallow_stderr" do
-    cmd = Cocaine::CommandLine.new("convert", ":swallow_stderr", :swallow_stderr => false)
-    lambda { cmd.command }.should raise_error(Cocaine::CommandLineError)
-  end
-
-  it "raises if trying to interpolate :expected_outcodes" do
-    cmd = Cocaine::CommandLine.new("convert", ":expected_outcodes", :expected_outcodes => [0])
-    lambda { cmd.command }.should raise_error(Cocaine::CommandLineError)
-  end
-
-  it "raises if trying to interpolate :logger" do
-    cmd = Cocaine::CommandLine.new("convert", ":logger", :logger => stub)
-    lambda { cmd.command }.should raise_error(Cocaine::CommandLineError)
-  end
-
   it "runs the command it's given and return the output" do
     cmd = Cocaine::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
     cmd.stubs(:execute).with("convert a.jpg b.png").returns(:correct_value)
@@ -174,17 +160,17 @@ describe Cocaine::CommandLine do
   end
 
   it "detects that the system is unix" do
-    Cocaine::CommandLine.new("convert").unix?.should be_true
+    Cocaine::CommandLine.new("convert").should be_unix
   end
 
   it "detects that the system is windows" do
     on_windows!
-    Cocaine::CommandLine.new("convert").unix?.should be_false
+    Cocaine::CommandLine.new("convert").should_not be_unix
   end
 
   it "detects that the system is windows (mingw)" do
     on_mingw!
-    Cocaine::CommandLine.new("convert").unix?.should be_false
+    Cocaine::CommandLine.new("convert").should_not be_unix
   end
 
   it "logs the command to a supplied logger" do

data/spec/support/nonblocking_examples.rb

@@ -3,7 +3,7 @@ shared_examples_for "a command that does not block" do
     garbage_file = Tempfile.new("garbage")
     10.times{ garbage_file.write("A" * 1024 * 1024) }
 
-    Timeout::timeout(5) do
+    Timeout.timeout(5) do
       output = subject.call("cat '#{garbage_file.path}'")
       $?.exitstatus.should == 0
       output.length.should == 10 * 1024 * 1024

metadata

@@ -1,101 +1,102 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cocaine
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 2
-  version: 0.3.2
 platform: ruby
-authors: 
+authors:
 - Jon Yurek
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bourne
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: posix-spawn
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: posix-spawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A small library for doing (command) lines
 email: jyurek@thoughtbot.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - GOALS
@@ -123,38 +124,29 @@ files:
 - spec/support/with_exitstatus.rb
 homepage: http://github.com/thoughtbot/cocaine
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A small library for doing (command) lines
-test_files: 
+test_files:
 - spec/cocaine/command_line/runners/backticks_runner_spec.rb
 - spec/cocaine/command_line/runners/posix_runner_spec.rb
 - spec/cocaine/command_line/runners/process_runner_spec.rb
@@ -163,3 +155,4 @@ test_files:
 - spec/support/nonblocking_examples.rb
 - spec/support/stub_os.rb
 - spec/support/with_exitstatus.rb
+has_rdoc: