About

mruby-command provides Go-inspired, non-blocking commands that work well with mruby's cooperative scheduler (mruby-task). It is based on code that was originally written for CRuby.

Install

MRuby::Build.new("app") do |conf|
  conf.toolchain
  conf.gembox "default"
  conf.gem github: "0x1eef/mruby-command", branch: "main"
end

Quick start

Spawn

Spawn a command and collect its output and exit status:

cmd = Command.new("echo", "hello")
puts cmd.stdout  # => "hello\n"

Callbacks

Success and failure callbacks provide hooks for when a command exits successfully or unsuccessfully:

Command.new("ruby", "-e", "exit 0")
  .success { |cmd| print "Command [#{cmd.pid}] was successful\n" }
  .failure { |cmd| print "Command [#{cmd.pid}] was unsuccessful\n" }
Command.new("ruby", "-e", "exit 42")
  .success { |cmd| print "unreachable\n" }
  .failure { |cmd| print "Command [#{cmd.pid}] failed\n" }

Exit status

cmd = Command.new("ruby", "-e", "exit 42")
puts cmd.exit_status  # => 42
puts cmd.success?     # => false

Command not found

When the command is not found, failure callbacks still fire and command_not_found? returns true:

cmd = Command.new("nonexistent")
puts cmd.command_not_found?  # => true

Features

Command.new(cmd, *argv)
Creates a new command object with the given command and optional arguments. The command is not spawned until one of the output, status, or callback methods is called.

Command#spawn
Spawns the command, captures stdout and stderr, and waits for the process to finish. Called automatically by methods that need output or exit status.

Command#stdout
Returns the captured stdout output as a string.

Command#stderr
Returns the captured stderr output as a string.

Command#pid
Returns the process ID of the spawned command.

Command#exit_status
Returns the exit status of the command, or nil if the command has not been spawned yet.

Command#success?
Returns true if the command exited with a zero status.

Command#command_not_found?
Returns true if the command could not be found.

Command#success
Accepts a block that is called when the command exits successfully.

Command#failure
Accepts a block that is called when the command exits unsuccessfully.

Command#argv
Appends arguments to the command.

License

BSD Zero Clause
See LICENSE