Scallop
Ergonomic shell wrapper.
Features:
- Easy access to command's output (stdout & stderr)
- Failure handling
- Parameterization
- Measuring execution time
- Built-in string escaping
- No dependencies
Installation
Add this line to your application's Gemfile:
gem 'scallop'And then execute:
$ bundle
Or install it yourself as:
$ gem install scallop
Usage
To run sudo -u chuck grep -R /home/chuck
result = Scallop.sudo(:chuck).cmd(:grep, '-R', '/home/chuck').runYou can then check whether command succeeded
result.success?See its output
result.stdout
result.stderr
result.output # STDOUT and STDERR combinedYou can also access information about command execution time
result.timing.real # Elapsed real time
result.timing.stime # System CPU time
result.timing.utime # User CPU time
result.timing.total # Total time, that is utime + stime + cutime + cstimeHandling failures with exceptions
If you replace run with run!, exception will be raised in case command fails
begin
Scallop.cmd(some_command).run!
rescue Scallop::Errors::CommandFailed => error
# you can access result right on the error itself
error.result.stderr
endPiping
To run cat /some/file | grep something
command = Scallop.cmd(:cat, '/some/file') | Scallop.cmd(:grep, 'something')
command.runParameterization
stored_command = Scallop.cmd(:rm, '-rf', Scallop::Param[:path])
stored_command.set(path: '/foo').run # rm -rf /foo
stored_command.set(path: '/bar').run # rm -rf /barYou can also check specs for examples.