cocaine 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54155863b7f03aa7f26da5dd746c959d9911d4a3
-  data.tar.gz: f65332c0a145b19251e71e32e020e507d10151ea
+  metadata.gz: 750b34929d7740b3106549975bb0700c807130f1
+  data.tar.gz: a063b0294e34258351f5b1bfe792cec481004e5e
 SHA512:
-  metadata.gz: 5787857e52b0a42f9ef27be222ca10a0c6ef6a21915dc6f9f75d56bc9bc6886dcfba7c110dc934a58c1d95252723a3199ceaad8422d63ff0bdc7a629f12eb717
-  data.tar.gz: 5d380053dfc1b8774df7966fa2819498619b1e53898145c087d860e647d71be1e2c7cfd974a77cb1148c012fa5b77d5b72d51040ccd094124284cee9cc05e00b
+  metadata.gz: c83f8e5119643be599f791f60051a208cd07549a63088f3b6700949b834a79d8cc82285281f4a94aa71a232fd642f22c4a328b19cc7ac7444558247f54091fce
+  data.tar.gz: 1912dd9fe81df0f2ceb52378b0f95df326747ba1f6f831af9ae5a7c4f74aa83237e5ceddf40885b23de3eb9c2d61dc831cc8289cf2b8af0d562060502aef9dc3

data/.travis.yml

@@ -2,8 +2,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.1.1
+  - 2.1.2
   - jruby-19mode
-
-matrix:
-  allow_failures:
-    - rvm: rbx-19mode

data/NEWS.md

@@ -1,3 +1,11 @@
+New for 0.5.5:
+
+* Bug Fix: Posix- and ProcessRunner respect paths *and* are thread safe!
+* Bug Fix: `exitstatus` should always be set, even if command doesn't run.
+* Test Fix: Do not try to test Runners if they don't run on this system.
+* Improvement: Pass the Errno::ENOENT message through to the exception.
+* Improvement: Improve documentation
+
 New for 0.5.4:
 
 * Bug Fix: PosixRunner and ProcessRunner respect supplemental paths now.

data/README.md

@@ -1,4 +1,4 @@
-# Cocaine [![Build Status](https://secure.travis-ci.org/thoughtbot/cocaine.png)](http://travis-ci.org/thoughtbot/cocaine)
+# Cocaine [![Build Status](https://secure.travis-ci.org/thoughtbot/cocaine.png?branch=master)](http://travis-ci.org/thoughtbot/cocaine)
 
 A small library for doing (command) lines.
 
@@ -10,8 +10,8 @@ The basic, normal stuff:
 
 ```ruby
 line = Cocaine::CommandLine.new("echo", "hello 'world'")
-line.command # => "echo hello 'world'" 
-line.run # => "hello world\n" 
+line.command # => "echo hello 'world'"
+line.run # => "hello world\n"
 ```
 
 Interpolated arguments:
@@ -180,19 +180,13 @@ try to use `PopenRunner`:
 Cocaine::CommandLine.runner = Cocaine::CommandLine::PopenRunner.new
 ```
 
+## Thread Safety
 
-## 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.
+Cocaine should be thread safe. As discussed [here, in this climate_control
+thread](https://github.com/thoughtbot/climate_control/pull/11), climate_control,
+which modifies the environment under which commands are run for the
+BackticksRunner and PopenRunner, is thread-safe but not reentrant. Please let us
+know if you find this is ever not the case.
 
 ## Feedback
 

data/lib/cocaine.rb

@@ -1,6 +1,7 @@
 # coding: UTF-8
 
 require 'rbconfig'
+require 'cocaine/os_detector'
 require 'cocaine/command_line'
 require 'cocaine/command_line/runners'
 require 'cocaine/exceptions'

data/lib/cocaine/command_line.rb

@@ -10,9 +10,9 @@ module Cocaine
       end
 
       def path=(supplemental_path)
-        @supplemental_path = supplemental_path
-        @supplemental_environment ||= {}
-        @supplemental_environment['PATH'] = (Array(supplemental_path) + [ENV['PATH']]).join(File::PATH_SEPARATOR)
+        @supplemental_path = Array(supplemental_path).
+          flatten.
+          join(OS.path_separator)
       end
 
       def environment
@@ -35,10 +35,6 @@ module Cocaine
         @runner = nil
       end
 
-      def java?
-        RUBY_PLATFORM =~ /java/
-      end
-
       private
 
       def best_runner
@@ -65,7 +61,7 @@ module Cocaine
     end
 
     def command(interpolations = {})
-      cmd = [@binary, interpolate(@params, interpolations)]
+      cmd = [path_prefix, @binary, interpolate(@params, interpolations)]
       cmd << bit_bucket if @swallow_stderr
       cmd.join(" ").strip
     end
@@ -80,7 +76,7 @@ module Cocaine
       rescue Errno::ENOENT => e
         raise Cocaine::CommandNotFoundError, e.message
       ensure
-        @exit_status = $?.exitstatus if $?.respond_to?(:exitstatus)
+        @exit_status = $?.respond_to?(:exitstatus) ? $?.exitstatus : 0
       end
 
       if @exit_status == 127
@@ -98,10 +94,6 @@ module Cocaine
       output
     end
 
-    def unix?
-      RbConfig::CONFIG['host_os'] !~ /mswin|mingw/
-    end
-
     private
 
     def colored(text, ansi_color = "\e[32m")
@@ -118,6 +110,28 @@ module Cocaine
       end
     end
 
+    def path_prefix
+      if !self.class.path.nil? && !self.class.path.empty?
+        os_path_prefix
+      end
+    end
+
+    def os_path_prefix
+      if OS.unix?
+        unix_path_prefix
+      else
+        windows_path_prefix
+      end
+    end
+
+    def unix_path_prefix
+      "PATH=#{self.class.path}#{OS.path_separator}$PATH"
+    end
+
+    def windows_path_prefix
+      "SET PATH=#{self.class.path}#{OS.path_separator}%PATH% &"
+    end
+
     def execute(command)
       runner.call(command, environment, runner_options)
     end
@@ -152,7 +166,7 @@ module Cocaine
 
     def shell_quote(string)
       return "" if string.nil?
-      if unix?
+      if OS.unix?
         if string.empty?
           "''"
         else
@@ -164,7 +178,7 @@ module Cocaine
     end
 
     def bit_bucket
-      unix? ? "2>/dev/null" : "2>NUL"
+      OS.unix? ? "2>/dev/null" : "2>NUL"
     end
   end
 end

data/lib/cocaine/command_line/runners/popen_runner.rb

@@ -13,7 +13,7 @@ module Cocaine
 
       def call(command, env = {}, options = {})
         with_modified_environment(env) do
-          IO.popen(command, "r", options) do |pipe|
+          IO.popen(env_command(command), "r", options) do |pipe|
             pipe.read
           end
         end
@@ -21,6 +21,26 @@ module Cocaine
 
       private
 
+      def env_command(command)
+        windows_command(command) || java_command(command) || default_command(command)
+      end
+
+      def windows_command(command)
+        if OS.windows?
+          command
+        end
+      end
+
+      def java_command(command)
+        if OS.java?
+          "env #{command}"
+        end
+      end
+
+      def default_command(command)
+        command
+      end
+
       def with_modified_environment(env, &block)
         ClimateControl.modify(env, &block)
       end

data/lib/cocaine/command_line/runners/posix_runner.rb

@@ -11,7 +11,7 @@ module Cocaine
       end
 
       def self.supported?
-        available? && !Cocaine::CommandLine.java?
+        available? && !OS.java?
       end
 
       def supported?
@@ -21,17 +21,15 @@ module Cocaine
       def call(command, env = {}, options = {})
         input, output = IO.pipe
         options[:out] = output
-        with_modified_environment(env) do
-          pid = spawn(env, command, options)
-          output.close
-          result = ""
-          while partial_result = input.read(8192)
-            result << partial_result
-          end
-          waitpid(pid)
-          input.close
-          result
+        pid = spawn(env, command, options)
+        output.close
+        result = ""
+        while partial_result = input.read(8192)
+          result << partial_result
         end
+        waitpid(pid)
+        input.close
+        result
       end
 
       private
@@ -44,10 +42,6 @@ module Cocaine
         Process.waitpid(pid)
       end
 
-      def with_modified_environment(env, &block)
-        ClimateControl.modify(env, &block)
-      end
-
     end
   end
 end

data/lib/cocaine/command_line/runners/process_runner.rb

@@ -8,7 +8,7 @@ module Cocaine
       end
 
       def self.supported?
-        available? && !Cocaine::CommandLine.java?
+        available? && !OS.java?
       end
 
       def supported?
@@ -18,14 +18,12 @@ module Cocaine
       def call(command, env = {}, options = {})
         input, output = IO.pipe
         options[:out] = output
-        with_modified_environment(env) do
-          pid = spawn(env, command, options)
-          output.close
-          result = input.read
-          waitpid(pid)
-          input.close
-          result
-        end
+        pid = spawn(env, command, options)
+        output.close
+        result = input.read
+        waitpid(pid)
+        input.close
+        result
       end
 
       private
@@ -40,10 +38,6 @@ module Cocaine
         # In JRuby, waiting on a finished pid raises.
       end
 
-      def with_modified_environment(env, &block)
-        ClimateControl.modify(env, &block)
-      end
-
     end
   end
 end

data/lib/cocaine/os_detector.rb

@@ -0,0 +1,27 @@
+# coding: UTF-8
+
+module Cocaine
+  class OSDetector
+    def java?
+      arch =~ /java/
+    end
+
+    def unix?
+      RbConfig::CONFIG['host_os'] !~ /mswin|mingw/
+    end
+
+    def windows?
+      !unix?
+    end
+
+    def path_separator
+      File::PATH_SEPARATOR
+    end
+
+    def arch
+      RUBY_PLATFORM
+    end
+  end
+
+  OS = OSDetector.new
+end

data/lib/cocaine/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module Cocaine
-  VERSION = "0.5.4".freeze
+  VERSION = "0.5.5".freeze
 end

data/spec/cocaine/command_line/runners/fake_runner_spec.rb

@@ -10,13 +10,13 @@ describe Cocaine::CommandLine::FakeRunner do
   it 'can tell if a command was run' do
     subject.call("some command", :environment)
     subject.call("other command", :other_environment)
-    subject.ran?("some command").should be_true
-    subject.ran?("no command").should be_false
+    subject.ran?("some command").should eq true
+    subject.ran?("no command").should eq false
   end
 
   it 'can tell if a command was run even if shell options were set' do
     subject.call("something 2>/dev/null", :environment)
-    subject.ran?("something").should be_true
+    subject.ran?("something").should eq true
   end
 
 end

data/spec/cocaine/command_line_spec.rb

@@ -11,18 +11,17 @@ describe Cocaine::CommandLine do
     cmd.command.should == "convert a.jpg b.png"
   end
 
-  it "specifies the $PATH where the command can be found" do
-    saved_path = ENV['PATH']
-    begin
-      ENV['PATH'] = "/the/environment/path:/other/bin"
-      Cocaine::CommandLine.path = "/path/to/command/dir"
-      cmd = Cocaine::CommandLine.new("echo", "$PATH")
-      cmd.command.should == "echo $PATH"
-      output = cmd.run
-      output.should match(%r{/path/to/command/dir:/the/environment/path:/other/bin})
-    ensure
-      ENV['PATH'] = saved_path
-    end
+  it "specifies the $PATH where the command can be found on unix" do
+    Cocaine::CommandLine.path = ["/path/to/command/dir", "/"]
+    cmd = Cocaine::CommandLine.new("ls")
+    cmd.command.should == "PATH=/path/to/command/dir:/:$PATH ls"
+  end
+
+  it "specifies the %PATH% where the command can be found on windows" do
+    on_windows!
+    Cocaine::CommandLine.path = ['C:\system32', 'D:\\']
+    cmd = Cocaine::CommandLine.new("dir")
+    cmd.command.should == 'SET PATH=C:\system32;D:\;%PATH% & dir'
   end
 
   it "specifies more than one path where the command can be found" do
@@ -152,20 +151,6 @@ describe Cocaine::CommandLine do
     end
   end
 
-  it "detects that the system is unix" do
-    Cocaine::CommandLine.new("convert").should be_unix
-  end
-
-  it "detects that the system is windows" do
-    on_windows!
-    Cocaine::CommandLine.new("convert").should_not be_unix
-  end
-
-  it "detects that the system is windows (mingw)" do
-    on_mingw!
-    Cocaine::CommandLine.new("convert").should_not be_unix
-  end
-
   it "colorizes the output to a tty" do
     logger = FakeLogger.new(:tty => true)
     Cocaine::CommandLine.new("echo", "'Logging!' :foo", :logger => logger).run(:foo => "bar")

data/spec/cocaine/errors_spec.rb

@@ -64,6 +64,6 @@ describe "When an error happens" do
     command.stubs(:command).raises("An Error")
 
     lambda{ command.run }.should raise_error("An Error")
-    command.exit_status.should be_nil
+    command.exit_status.should eq 0
   end
 end

data/spec/cocaine/os_detector_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Cocaine::OSDetector do
+  it "detects that the system is unix" do
+    on_unix!
+    Cocaine::OS.should be_unix
+  end
+
+  it "detects that the system is windows" do
+    on_windows!
+    Cocaine::OS.should be_windows
+  end
+
+  it "detects that the system is windows (mingw)" do
+    on_mingw!
+    Cocaine::OS.should be_windows
+  end
+
+  it "detects that the current Ruby is on Java" do
+    on_java!
+    Cocaine::OS.should be_java
+  end
+end

data/spec/cocaine/runners_spec.rb

@@ -72,7 +72,7 @@ describe 'When running an executable in the supplemental path' do
   end
 
   after do
-    FileUtils.rm_f(Cocaine::CommandLine.path + 'ls')
+    FileUtils.rm_f("#{Cocaine::CommandLine.path}/ls")
   end
 
   [
@@ -81,12 +81,14 @@ describe 'When running an executable in the supplemental path' do
     Cocaine::CommandLine::PosixRunner,
     Cocaine::CommandLine::ProcessRunner
   ].each do |runner_class|
-    describe runner_class do
-      describe '#run' do
-        it 'finds the correct executable' do
-          Cocaine::CommandLine.runner = runner_class.new
-          result = Cocaine::CommandLine.new('ls').run
-          expect(result.strip).to eq('overridden-ls')
+    if runner_class.supported?
+      describe runner_class do
+        describe '#run' do
+          it 'finds the correct executable' do
+            Cocaine::CommandLine.runner = runner_class.new
+            result = Cocaine::CommandLine.new('ls').run
+            expect(result.strip).to eq('overridden-ls')
+          end
         end
       end
     end

data/spec/spec_helper.rb

@@ -5,9 +5,11 @@ require 'cocaine'
 require 'timeout'
 require 'tempfile'
 require 'pry'
-require 'active_support/buffered_logger'
 require 'thread'
 
+begin; require 'active_support/logger'; rescue LoadError; end
+begin; require 'active_support/buffered_logger'; rescue LoadError; end
+
 Dir[File.dirname(__FILE__) + "/support/**.rb"].each{|support_file| require support_file }
 
 RSpec.configure do |config|

data/spec/support/stub_os.rb

@@ -1,14 +1,21 @@
 module StubOS
   def on_windows!
     stub_os('mswin')
+    Cocaine::OS.stubs(:path_separator).returns(";")
   end
 
   def on_unix!
     stub_os('darwin11.0.0')
+    Cocaine::OS.stubs(:path_separator).returns(":")
   end
 
   def on_mingw!
     stub_os('mingw')
+    Cocaine::OS.stubs(:path_separator).returns(";")
+  end
+
+  def on_java!
+    Cocaine::OS.stubs(:arch).returns("universal-java1.7")
   end
 
   def stub_os(host_string)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocaine
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Jon Yurek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -144,6 +144,7 @@ files:
 - lib/cocaine/command_line/runners/posix_runner.rb
 - lib/cocaine/command_line/runners/process_runner.rb
 - lib/cocaine/exceptions.rb
+- lib/cocaine/os_detector.rb
 - lib/cocaine/version.rb
 - spec/cocaine/command_line/runners/backticks_runner_spec.rb
 - spec/cocaine/command_line/runners/fake_runner_spec.rb
@@ -152,6 +153,7 @@ files:
 - spec/cocaine/command_line/runners/process_runner_spec.rb
 - spec/cocaine/command_line_spec.rb
 - spec/cocaine/errors_spec.rb
+- spec/cocaine/os_detector_spec.rb
 - spec/cocaine/runners_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_logger.rb
@@ -191,6 +193,7 @@ test_files:
 - spec/cocaine/command_line/runners/process_runner_spec.rb
 - spec/cocaine/command_line_spec.rb
 - spec/cocaine/errors_spec.rb
+- spec/cocaine/os_detector_spec.rb
 - spec/cocaine/runners_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_logger.rb