terrapin 0.6.0.alpha

data/lib/terrapin/command_line/multi_pipe.rb

@@ -0,0 +1,50 @@
+module Terrapin
+  class CommandLine
+    class MultiPipe
+      def initialize
+        @stdout_in, @stdout_out = IO.pipe
+        @stderr_in, @stderr_out = IO.pipe
+      end
+
+      def pipe_options
+        { out: @stdout_out, err: @stderr_out }
+      end
+
+      def output
+        Output.new(@stdout_output, @stderr_output)
+      end
+
+      def read_and_then(&block)
+        close_write
+        read
+        block.call
+        close_read
+      end
+
+      private
+
+      def close_write
+        @stdout_out.close
+        @stderr_out.close
+      end
+
+      def read
+        @stdout_output = read_stream(@stdout_in)
+        @stderr_output = read_stream(@stderr_in)
+      end
+
+      def close_read
+        @stdout_in.close
+        @stderr_in.close
+      end
+
+      def read_stream(io)
+        result = ""
+        while partial_result = io.read(8192)
+          result << partial_result
+        end
+        result
+      end
+    end
+  end
+end

data/lib/terrapin/command_line/output.rb

@@ -0,0 +1,12 @@
+class Terrapin::CommandLine::Output
+  def initialize(output = nil, error_output = nil)
+    @output = output
+    @error_output = error_output
+  end
+
+  attr_reader :output, :error_output
+
+  def to_s
+    output.to_s
+  end
+end

data/lib/terrapin/command_line/runners.rb

@@ -0,0 +1,7 @@
+# coding: UTF-8
+
+require 'terrapin/command_line/runners/backticks_runner'
+require 'terrapin/command_line/runners/process_runner'
+require 'terrapin/command_line/runners/posix_runner'
+require 'terrapin/command_line/runners/popen_runner'
+require 'terrapin/command_line/runners/fake_runner'

data/lib/terrapin/command_line/runners/backticks_runner.rb

@@ -0,0 +1,30 @@
+# coding: UTF-8
+
+require 'climate_control'
+
+module Terrapin
+  class CommandLine
+    class BackticksRunner
+      def self.supported?
+        true
+      end
+
+      def supported?
+        self.class.supported?
+      end
+
+      def call(command, env = {}, options = {})
+        with_modified_environment(env) do
+          Output.new(`#{command}`)
+        end
+      end
+
+      private
+
+      def with_modified_environment(env, &block)
+        ClimateControl.modify(env, &block)
+      end
+
+    end
+  end
+end

data/lib/terrapin/command_line/runners/fake_runner.rb

@@ -0,0 +1,30 @@
+# coding: UTF-8
+
+module Terrapin
+  class CommandLine
+    class FakeRunner
+      def self.supported?
+        false
+      end
+
+      def supported?
+        self.class.supported?
+      end
+
+      attr_reader :commands
+
+      def initialize
+        @commands = []
+      end
+
+      def call(command, env = {}, options = {})
+        commands << [command, env]
+        Output.new("")
+      end
+
+      def ran?(predicate_command)
+        @commands.any?{|(command, _)| command =~ Regexp.new(predicate_command) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# coding: UTF-8
+
+module Terrapin
+  class CommandLine
+    class PopenRunner
+      def self.supported?
+        true
+      end
+
+      def supported?
+        self.class.supported?
+      end
+
+      def call(command, env = {}, options = {})
+        with_modified_environment(env) do
+          IO.popen(command, "r", options) do |pipe|
+            Output.new(pipe.read)
+          end
+        end
+      end
+
+      private
+
+      def with_modified_environment(env, &block)
+        ClimateControl.modify(env, &block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# coding: UTF-8
+
+module Terrapin
+  class CommandLine
+    class PosixRunner
+      def self.available?
+        return @available unless @available.nil?
+
+        @available = posix_spawn_gem_available?
+      end
+
+      def self.supported?
+        available? && !OS.java?
+      end
+
+      def supported?
+        self.class.supported?
+      end
+
+      def call(command, env = {}, options = {})
+        pipe = MultiPipe.new
+        pid = spawn(env, command, options.merge(pipe.pipe_options))
+        pipe.read_and_then do
+          waitpid(pid)
+        end
+        pipe.output
+      end
+
+      private
+
+      def spawn(*args)
+        POSIX::Spawn.spawn(*args)
+      end
+
+      def waitpid(pid)
+        Process.waitpid(pid)
+      end
+
+      def self.posix_spawn_gem_available?
+        require 'posix/spawn'
+        true
+      rescue LoadError
+        false
+      end
+
+      private_class_method :posix_spawn_gem_available?
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# coding: UTF-8
+
+module Terrapin
+  class CommandLine
+    class ProcessRunner
+      def self.available?
+        Process.respond_to?(:spawn)
+      end
+
+      def self.supported?
+        available? && !OS.java?
+      end
+
+      def supported?
+        self.class.supported?
+      end
+
+      def call(command, env = {}, options = {})
+        pipe = MultiPipe.new
+        pid = spawn(env, command, options.merge(pipe.pipe_options))
+        pipe.read_and_then do
+          waitpid(pid)
+        end
+        pipe.output
+      end
+
+      private
+
+      def spawn(*args)
+        Process.spawn(*args)
+      end
+
+      def waitpid(pid)
+        Process.waitpid(pid)
+      rescue Errno::ECHILD
+        # In JRuby, waiting on a finished pid raises.
+      end
+
+    end
+  end
+end

data/lib/terrapin/exceptions.rb

@@ -0,0 +1,8 @@
+# coding: UTF-8
+
+module Terrapin
+  class CommandLineError < StandardError; end
+  class CommandNotFoundError < CommandLineError; end
+  class ExitStatusError < CommandLineError; end
+  class InterpolationError < CommandLineError; end
+end

data/lib/terrapin/os_detector.rb

@@ -0,0 +1,27 @@
+# coding: UTF-8
+
+module Terrapin
+  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/terrapin/version.rb

@@ -0,0 +1,4 @@
+# coding: UTF-8
+module Terrapin
+  VERSION = "0.6.0.alpha".freeze
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rspec'
+require 'mocha/api'
+require 'bourne'
+require 'terrapin'
+require 'timeout'
+require 'tempfile'
+require 'pry'
+require 'thread'
+require 'pathname'
+
+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|
+  config.mock_with :mocha
+  config.include WithExitstatus
+  config.include StubOS
+  config.include UnsettingExitstatus
+end
+
+def best_logger
+  if ActiveSupport.const_defined?("Logger")
+    ActiveSupport::Logger
+  elsif ActiveSupport.const_defined?("BufferedLogger")
+    ActiveSupport::BufferedLogger
+  else
+    Logger
+  end
+end

data/spec/support/fake_logger.rb

@@ -0,0 +1,18 @@
+class FakeLogger
+  def initialize(options = {})
+    @tty = options[:tty]
+    @entries = []
+  end
+
+  def info(text)
+    @entries << text
+  end
+
+  def entries
+    @entries
+  end
+
+  def tty?
+    @tty
+  end
+end

data/spec/support/have_output.rb

@@ -0,0 +1,11 @@
+RSpec::Matchers.define :have_output do |expected|
+  match do |actual|
+    actual.output == expected
+  end
+end
+
+RSpec::Matchers.define :have_error_output do |expected|
+  match do |actual|
+    actual.error_output == expected
+  end
+end

data/spec/support/nonblocking_examples.rb

@@ -0,0 +1,14 @@
+shared_examples_for "a command that does not block" do
+  it 'does not block if the command outputs a lot of data' do
+    garbage_file = Tempfile.new("garbage")
+    10.times{ garbage_file.write("A" * 1024 * 1024) }
+
+    Timeout.timeout(5) do
+      output = subject.call("cat '#{garbage_file.path}'")
+      $?.exitstatus.should == 0
+      output.output.length.should == 10 * 1024 * 1024
+    end
+
+    garbage_file.close
+  end
+end

data/spec/support/stub_os.rb

@@ -0,0 +1,25 @@
+module StubOS
+  def on_windows!
+    stub_os('mswin')
+    Terrapin::OS.stubs(:path_separator).returns(";")
+  end
+
+  def on_unix!
+    stub_os('darwin11.0.0')
+    Terrapin::OS.stubs(:path_separator).returns(":")
+  end
+
+  def on_mingw!
+    stub_os('mingw')
+    Terrapin::OS.stubs(:path_separator).returns(";")
+  end
+
+  def on_java!
+    Terrapin::OS.stubs(:arch).returns("universal-java1.7")
+  end
+
+  def stub_os(host_string)
+    # http://blog.emptyway.com/2009/11/03/proper-way-to-detect-windows-platform-in-ruby/
+    RbConfig::CONFIG.stubs(:[]).with('host_os').returns(host_string)
+  end
+end

data/spec/support/unsetting_exitstatus.rb

@@ -0,0 +1,7 @@
+module UnsettingExitstatus
+  def assuming_no_processes_have_been_run
+    class << $?
+      undef_method :exitstatus
+    end
+  end
+end

data/spec/support/with_exitstatus.rb

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

data/spec/terrapin/command_line/output_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Terrapin::CommandLine::Output do
+  it 'holds an input and error stream' do
+    output = Terrapin::CommandLine::Output.new(:a, :b)
+    expect(output.output).to eq :a
+    expect(output.error_output).to eq :b
+  end
+
+  it 'calls #to_s on the output when you call #to_s on it' do
+    output = Terrapin::CommandLine::Output.new(:a, :b)
+    expect(output.to_s).to eq 'a'
+  end
+end