cocaine 0.0.1

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Default: Run specs.'
+task :default => 'spec:unit'
+
+namespace :spec do
+  desc "Run unit specs"
+  RSpec::Core::RakeTask.new('unit') do |t|
+    t.pattern = 'spec/cocaine/**/*_spec.rb'
+  end
+end
+

data/lib/cocaine.rb

@@ -0,0 +1,5 @@
+require 'cocaine/command_line'
+require 'cocaine/exceptions'
+
+module Cocaine
+end

data/lib/cocaine/command_line.rb

@@ -0,0 +1,85 @@
+module Cocaine
+  class CommandLine
+    class << self
+      attr_accessor :path
+    end
+
+    def initialize(binary, params = "", options = {})
+      @binary            = binary.dup
+      @params            = params.dup
+      @options           = options.dup
+      @swallow_stderr    = @options.has_key?(:swallow_stderr) ? @options.delete(:swallow_stderr) : Cocaine.options[:swallow_stderr]
+      @expected_outcodes = @options.delete(:expected_outcodes)
+      @expected_outcodes ||= [0]
+    end
+
+    def command
+      cmd = []
+      cmd << full_path(@binary)
+      cmd << interpolate(@params, @options)
+      cmd << bit_bucket if @swallow_stderr
+      cmd.join(" ")
+    end
+
+    def run
+      begin
+        output = self.class.send(:'`', command)
+      rescue Errno::ENOENT
+        raise Cocaine::CommandNotFoundError
+      end
+      if $?.exitstatus == 127
+        raise Cocaine::CommandNotFoundError
+      end
+      unless @expected_outcodes.include?($?.exitstatus)
+        raise Cocaine::ExitStatusError, "Command '#{command}' returned #{$?.exitstatus}. Expected #{@expected_outcodes.join(", ")}"
+      end
+      output
+    end
+
+    private
+
+    def full_path(binary)
+      [self.class.path, binary].compact.join("/")
+    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)
+    end
+
+    def interpolation(vars, key)
+      if vars.key?(key.to_sym)
+        shell_quote(vars[key.to_sym])
+      end
+    end
+
+    def shell_quote(string)
+      return "" if string.nil? or string.empty?
+      if self.class.unix?
+        string.split("'").map{|m| "'#{m}'" }.join("\\'")
+      else
+        %{"#{string}"}
+      end
+    end
+
+    def bit_bucket
+      self.class.unix? ? "2>/dev/null" : "2>NUL"
+    end
+
+    def self.unix?
+      File.exist?("/dev/null")
+    end
+  end
+end

data/lib/cocaine/exceptions.rb

@@ -0,0 +1,6 @@
+module Cocaine
+  class CommandLineError     < StandardError; end
+  class CommandNotFoundError < CommandLineError; end
+  class ExitStatusError      < CommandLineError; end
+  class InterpolationError   < CommandLineError; end
+end

data/lib/cocaine/version.rb

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

data/spec/cocaine/command_line_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Cocaine::CommandLine do
+  before do
+    Cocaine::CommandLine.path = nil
+    File.stubs(:exist?).with("/dev/null").returns(true)
+  end
+
+  it "takes a command and parameters and produce a shell command for bash" do
+    cmd = Cocaine::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
+    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"
+  end
+
+  it "can interpolate quoted variables into the 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'"
+  end
+
+  it "quotes command line options differently if we're on windows" do
+    File.stubs(:exist?).with("/dev/null").returns(false)
+    cmd = Cocaine::CommandLine.new("convert",
+                                     ":one :{two}",
+                                     :one => "a.jpg",
+                                     :two => "b.png",
+                                     :swallow_stderr => false)
+    cmd.command.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'"
+  end
+
+  it "can quote and interpolate dangerous variables even on windows" do
+    File.stubs(:exist?).with("/dev/null").returns(false)
+    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"}
+  end
+
+  it "allows colons in parameters" do
+    cmd = Cocaine::CommandLine.new("convert", "'a.jpg' xc:black 'b.jpg'", :swallow_stderr => false)
+    cmd.command.should == "convert 'a.jpg' xc:black 'b.jpg'"
+  end
+
+  it "adds redirection to get rid of stderr in bash" do
+    File.stubs(:exist?).with("/dev/null").returns(true)
+    cmd = Cocaine::CommandLine.new("convert",
+                                     "a.jpg b.png",
+                                     :swallow_stderr => true)
+
+    cmd.command.should == "convert a.jpg b.png 2>/dev/null"
+  end
+
+  it "adds redirection to get rid of stderr in cmd.exe" do
+    File.stubs(:exist?).with("/dev/null").returns(false)
+    cmd = Cocaine::CommandLine.new("convert",
+                                     "a.jpg b.png",
+                                     :swallow_stderr => true)
+
+    cmd.command.should == "convert a.jpg b.png 2>NUL"
+  end
+
+  it "raises if trying to interpolate :swallow_stderr or :expected_outcodes" do
+    cmd = Cocaine::CommandLine.new("convert",
+                                     ":swallow_stderr :expected_outcodes",
+                                     :swallow_stderr => false,
+                                     :expected_outcodes => [0, 1])
+
+    lambda do
+      cmd.command
+    end.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.class.stubs(:"`").with("convert a.jpg b.png").returns(:correct_value)
+    with_exitstatus_returning(0) do
+      cmd.run.should == :correct_value
+    end
+  end
+
+  it "raises a CommandLineError if the result code isn't expected" do
+    cmd = Cocaine::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
+    cmd.class.stubs(:"`").with("convert a.jpg b.png").returns(:correct_value)
+    with_exitstatus_returning(1) do
+      lambda do
+        cmd.run
+      end.should raise_error(Cocaine::CommandLineError)
+    end
+  end
+
+  it "does not raise a CommandLineError if the result code is expected" do
+    cmd = Cocaine::CommandLine.new("convert",
+                                     "a.jpg b.png",
+                                     :expected_outcodes => [0, 1],
+                                     :swallow_stderr => false)
+    cmd.class.stubs(:"`").with("convert a.jpg b.png").returns(:correct_value)
+    with_exitstatus_returning(1) do
+      lambda do
+        cmd.run
+      end.should_not raise_error
+    end
+  end
+
+  it "detects that the system is unix or windows based on presence of /dev/null" do
+    File.stubs(:exist?).returns(true)
+    Cocaine::CommandLine.unix?.should == true
+  end
+
+  it "detects that the system is not unix or windows based on absence of /dev/null" do
+    File.stubs(:exist?).returns(false)
+    Cocaine::CommandLine.unix?.should_not == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'spec/support/with_exitstatus'
+require 'mocha'
+require 'bourne'
+require 'cocaine'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.include WithExitstatus
+end

data/spec/support/with_exitstatus.rb

@@ -0,0 +1,12 @@
+module WithExitstatus
+  def with_exitstatus_returning(code)
+    saved_exitstatus = $?.nil? ? 0 : $?.exitstatus
+    begin
+      `ruby -e 'exit #{code.to_i}'`
+      yield
+    ensure
+      `ruby -e 'exit #{saved_exitstatus.to_i}'`
+    end
+  end
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: cocaine
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jon Yurek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bourne
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A small library for doing (command) lines
+email: jyurek@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/cocaine.rb
+- lib/cocaine/command_line.rb
+- lib/cocaine/exceptions.rb
+- lib/cocaine/version.rb
+- spec/spec_helper.rb
+- spec/cocaine/command_line_spec.rb
+- spec/support/with_exitstatus.rb
+has_rdoc: true
+homepage: http://www.thoughtbot.com/projects/cocaine
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A small library for doing (command) lines
+test_files: 
+- spec/cocaine/command_line_spec.rb