cocaine 0.3.0 → 0.3.1

data/.travis.yml

@@ -2,7 +2,5 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx-18mode
-  - rbx-19mode
   - ree
   - jruby

data/LICENSE

@@ -3,7 +3,7 @@ LICENSE
 
 The MIT License
 
-Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
+Copyright (c) 2011-2012 Jon Yurek and thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS.md

@@ -1,3 +1,9 @@
+New for 0.3.1:
+
+* Made the `Runner` manually swappable, in case `ProcessRunner` doesn't work
+  for some reason.
+* Fixed copyright years.
+
 New for 0.3.0:
 
 * Support blank arguments.
@@ -5,6 +11,5 @@ New for 0.3.0:
 * Add `CommandLine#exit_status`.
 * Automatically use `POSIX::Spawn` if available.
 * Add `CommandLine#environment` as a hash of extra `ENV` data..
-* Add `CommandLine#environment=` to set that hash.
 * Add `CommandLine#runner` which produces an object that responds to `#call`.
 * Fix a race condition but only on Ruby 1.9.

data/README.md

@@ -125,6 +125,30 @@ processes. For applications with large heaps the gain can be
 significant. To include `posix-spawn`, simply add it to your `Gemfile` or,
 if you don't use bundler, install the gem.
 
+## Runners
+
+Cocaine will attempt to choose from among 3 different ways of running commands.
+The simplest is using backticks, and is the default in 1.8. In Ruby 1.9, it
+will attempt to use `Process.spawn`. And, as mentioned above, if the
+`posix-spawn` gem is installed, it will attempt to use that. If for some reason
+one of the `.spawn` runners don't work for you, you can override them manually
+by setting a new runner, like so:
+
+```ruby
+Cocaine::CommandLine.runner = Cocaine::BackticksRunner.new
+```
+
+And if you really want to, you can define your own Runner, though I can't
+imagine why you would.
+
+### JRuby Caveat
+
+If you get `Error::ECHILD` errors and are using JRuby, there is a very good
+chance that the error is actually in JRuby. This was brought to our attention
+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.
+
 ## Feedback
 
 *Security* concerns must be privately emailed to
@@ -136,7 +160,7 @@ Question? Idea? Problem? Bug? Comment? Concern? Like using question marks?
 
 ## License
 
-Copyright 2011 Jon Yurek and thoughtbot, inc. This is free software, and
+Copyright 2011-2012 Jon Yurek and thoughtbot, inc. This is free software, and
 may be redistributed under the terms specified in the
 [LICENSE](https://github.com/thoughtbot/cocaine/blob/master/LICENSE)
 file.

data/cocaine.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform          = Gem::Platform::RUBY
   s.author            = "Jon Yurek"
   s.email             = "jyurek@thoughtbot.com"
-  s.homepage          = "http://www.thoughtbot.com/projects/cocaine"
+  s.homepage          = "http://github.com/thoughtbot/cocaine"
   s.summary           = "A small library for doing (command) lines"
   s.description       = "A small library for doing (command) lines"
 

data/lib/cocaine/command_line.rb

@@ -1,7 +1,7 @@
 module Cocaine
   class CommandLine
     class << self
-      attr_accessor :logger
+      attr_accessor :logger, :runner
 
       def path
         @supplemental_path
@@ -24,6 +24,18 @@ module Cocaine
       def environment
         @supplemental_environment ||= {}
       end
+
+      def runner
+        @runner || best_runner
+      end
+
+      private
+
+      def best_runner
+        return PosixRunner.new   if posix_spawn_available?
+        return ProcessRunner.new if Process.respond_to?(:spawn)
+        BackticksRunner.new
+      end
     end
     @environment = {}
 
@@ -33,11 +45,11 @@ module Cocaine
       @binary            = binary.dup
       @params            = params.dup
       @options           = options.dup
+      @runner            = @options.delete(:runner) || self.class.runner
       @logger            = @options.delete(:logger) || self.class.logger
       @swallow_stderr    = @options.delete(:swallow_stderr)
-      @expected_outcodes = @options.delete(:expected_outcodes)
-      @expected_outcodes ||= [0]
-      @runner            = best_runner
+      @expected_outcodes = @options.delete(:expected_outcodes) || [0]
+      @environment       = @options.delete(:environment) || {}
     end
 
     def command
@@ -68,19 +80,17 @@ module Cocaine
     end
 
     def unix?
-      (RbConfig::CONFIG['host_os'] =~ /mswin|mingw/).nil?
+      RbConfig::CONFIG['host_os'] !~ /mswin|mingw/
     end
 
     private
 
     def execute(command)
-      runner.call(command, self.class.environment)
+      runner.call(command, environment)
     end
 
-    def best_runner
-      return PosixRunner.new   if self.class.posix_spawn_available?
-      return ProcessRunner.new if Process.respond_to?(:spawn)
-      BackticksRunner.new
+    def environment
+      self.class.environment.merge(@environment)
     end
 
     def interpolate(pattern, vars)
@@ -97,7 +107,7 @@ module Cocaine
     end
 
     def invalid_variables
-      %w(expected_outcodes swallow_stderr logger)
+      %w(expected_outcodes swallow_stderr logger environment)
     end
 
     def interpolation(vars, key)

data/lib/cocaine/version.rb

@@ -1,3 +1,3 @@
 module Cocaine
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

data/spec/cocaine/command_line_spec.rb

@@ -26,7 +26,7 @@ describe Cocaine::CommandLine do
     output.should match(%r{/path/to/command/dir})
     output.should match(%r{/some/other/path})
   end
-  
+
   it "temporarily changes specified environment variables" do
     Cocaine::CommandLine.environment['TEST'] = 'Hello, world!'
     cmd = Cocaine::CommandLine.new("ruby", "-e 'puts ENV[%{TEST}]'")
@@ -34,6 +34,21 @@ describe Cocaine::CommandLine do
     output.should match(%r{Hello, world!})
   end
 
+  it 'changes environment variables for the command line' do
+    Cocaine::CommandLine.environment['TEST'] = 'Hello, world!'
+    cmd = Cocaine::CommandLine.new("ruby",
+                                   "-e 'puts ENV[%{TEST}]'",
+                                   :environment => {'TEST' => 'Hej hej'})
+    output = cmd.run
+    output.should match(%r{Hej hej})
+  end
+
+  it 'passes the existing environment variables through to the runner' do
+    command = Cocaine::CommandLine.new('echo', '$HOME')
+    output = command.run
+    output.chomp.should_not == ''
+  end
+
   it "can interpolate quoted variables into the command line's parameters" do
     cmd = Cocaine::CommandLine.new("convert",
                                    ":one :{two}",
@@ -215,5 +230,21 @@ describe Cocaine::CommandLine do
       cmd = Cocaine::CommandLine.new("echo", "hello")
       cmd.runner.class.should == Cocaine::CommandLine::PosixRunner
     end
+
+    it "uses the BackticksRunner if the posix-spawn gem is available, but we told it to use Backticks all the time" do
+      Cocaine::CommandLine.stubs(:posix_spawn_available?).returns(true)
+      Cocaine::CommandLine.runner = Cocaine::CommandLine::BackticksRunner.new
+
+      cmd = Cocaine::CommandLine.new("echo", "hello")
+      cmd.runner.class.should == Cocaine::CommandLine::BackticksRunner
+    end
+
+    it "uses the BackticksRunner if the posix-spawn gem is available, but we told it to use Backticks" do
+      Cocaine::CommandLine.stubs(:posix_spawn_available?).returns(true)
+
+      cmd = Cocaine::CommandLine.new("echo", "hello", :runner => Cocaine::CommandLine::BackticksRunner.new)
+      cmd.runner.class.should == Cocaine::CommandLine::BackticksRunner
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocaine
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -121,7 +121,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/stub_os.rb
 - spec/support/with_exitstatus.rb
-homepage: http://www.thoughtbot.com/projects/cocaine
+homepage: http://github.com/thoughtbot/cocaine
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -133,22 +133,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2124621343266974199
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2124621343266974199
 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
+- spec/cocaine/command_line_spec.rb
+- spec/spec_helper.rb
+- spec/support/stub_os.rb
+- spec/support/with_exitstatus.rb
+has_rdoc: