Command Runner

Build Status Code Climate

Runs commands.

require 'command/runner'

line = Command::Runner.new("echo", "hello")
message = line.pass # => #<Command::Runner::Message:...>
message.exit_code   # => 0
message.stdout      # => "hello\n"
message.time        # => 0.00091773
message.process_id  # => 9622
message.line        # => "echo hello"

with interpolations...

line = Command::Runner.new("echo", "{interpolation}")
message = line.pass(:interpolation => "watermelons")
message.stdout # => "watermelons\n"
message.line   # => "echo watermelons"

that escapes bad stuff...

message = line.pass(:interpolation => "`uname -a`")
message.stdout # => "`uname -a`\n"
message.line   # => "echo \\`uname\\ -a\\`"

unless you don't want it to.

line = Command::Runner.new("echo", "{{interpolation}}")
line.force_unsafe!
message = line.pass(:interpolation => "`uname -a`")
message.stdout # => "Linux Hyperion 3.8.0-25-generic #37-Ubuntu SMP Thu Jun 6 20:47:07 UTC 2013 x86_64 x86_64 x86_64 GNU/Linux\n"
message.line   # => "echo `uname -a`"

It can also use different methods to run commands...

line = Command::Runner.new("echo", "something")
line.backend = Command::Runner::Backends::Spawn.new
line.pass

but defaults to the best one.

If you run a command that doesn't exist on the machine...

line = Command::Runner.new("some-non-existant-command", "")

line.pass.no_command? # => true

it'll tell you.

It calls the given block...

line = Command::Runner.new("echo", "{something}")

line.pass(something: "hello") do |message|
  message.stdout
end # => "hello\n"

and return the value.

Compatibility

It works on

  • 2.1.0
  • 2.0.0
  • 1.9.3
  • JRuby (2.0 Mode)
  • JRuby (1.9 Mode)

unless the travis build fails.

Bitdeli Badge