class Cocaine::CommandLine

Attributes

logger[RW]
runner[RW]
exit_status[R]
runner[R]

Public Class Methods

environment() click to toggle source
# File lib/cocaine/command_line.rb, line 24
def environment
  @supplemental_environment ||= {}
end
fake!() click to toggle source
# File lib/cocaine/command_line.rb, line 32
def fake!
  @runner = FakeRunner.new
end
new(binary, params = "", options = {}) click to toggle source
# File lib/cocaine/command_line.rb, line 52
def initialize(binary, params = "", options = {})
  @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) || [0]
  @environment       = @options.delete(:environment) || {}
end
path() click to toggle source
# File lib/cocaine/command_line.rb, line 6
def path
  @supplemental_path
end
path=(supplemental_path) click to toggle source
# File lib/cocaine/command_line.rb, line 9
def path=(supplemental_path)
  @supplemental_path = supplemental_path
  @supplemental_environment ||= {}
  @supplemental_environment['PATH'] = [ENV['PATH'], *supplemental_path].join(File::PATH_SEPARATOR)
end
posix_spawn_available?() click to toggle source
# File lib/cocaine/command_line.rb, line 15
def posix_spawn_available?
  @posix_spawn_available ||= begin
    require 'posix/spawn'
    true
  rescue LoadError => e
    false
  end
end
unfake!() click to toggle source
# File lib/cocaine/command_line.rb, line 36
def unfake!
  @runner = nil
end

Private Class Methods

best_runner() click to toggle source
# File lib/cocaine/command_line.rb, line 42
def best_runner
  return PosixRunner.new   if posix_spawn_available?
  return ProcessRunner.new if Process.respond_to?(:spawn)
  BackticksRunner.new
end

Public Instance Methods

command(interpolations = {}) click to toggle source
# File lib/cocaine/command_line.rb, line 63
def command(interpolations = {})
  cmd = []
  cmd << @binary
  cmd << interpolate(@params, interpolations)
  cmd << bit_bucket if @swallow_stderr
  cmd.join(" ").strip
end
run(interpolations = {}) click to toggle source
# File lib/cocaine/command_line.rb, line 71
def run(interpolations = {})
  output = ''
  begin
    full_command = command(interpolations)
    log("#{colored("Command")} :: #{full_command}")
    output = execute(full_command)
  rescue Errno::ENOENT
    raise Cocaine::CommandNotFoundError
  ensure
    @exit_status = $?.exitstatus
  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
unix?() click to toggle source
# File lib/cocaine/command_line.rb, line 91
def unix?
  RbConfig::CONFIG['host_os'] !~ /mswin|mingw/
end

Private Instance Methods

bit_bucket() click to toggle source
# File lib/cocaine/command_line.rb, line 138
def bit_bucket
  unix? ? "2>/dev/null" : "2>NUL"
end
colored(text, ansi_color = "\e[32m") click to toggle source
# File lib/cocaine/command_line.rb, line 97
def colored(text, ansi_color = "\e[32m")
  if @logger && @logger.respond_to?(:tty?) && @logger.tty?
    "#{ansi_color}#{text}\e[0m"
  else
    text
  end
end
environment() click to toggle source
# File lib/cocaine/command_line.rb, line 115
def environment
  self.class.environment.merge(@environment)
end
execute(command) click to toggle source
# File lib/cocaine/command_line.rb, line 111
def execute(command)
  runner.call(command, environment)
end
interpolate(pattern, interpolations) click to toggle source
# File lib/cocaine/command_line.rb, line 119
def interpolate(pattern, interpolations)
  interpolations.inject(pattern) do |command_string, (key, value)|
    command_string.gsub(/:\{?#{key}\}?/) { shell_quote(value) }
  end
end
log(text) click to toggle source
# File lib/cocaine/command_line.rb, line 105
def log(text)
  if @logger
    @logger.info(text)
  end
end
shell_quote(string) click to toggle source
# File lib/cocaine/command_line.rb, line 125
def shell_quote(string)
  return "" if string.nil?
  if unix?
    if string.empty?
      "''"
    else
      string.split("'").map{|m| "'#{m}'" }.join("\\'")
    end
  else
    %Q{"#{string}"}
  end
end