rubbish

DESCRIPTION:

A ruby-ish way to go to the shell.

Bash and Fish aware.

SYNOPSIS:

Although it's easy enough to access the system's default shell from ruby, you may want to run a specific shell like fish for it's unique features:

require 'rubbish'

# Fish features the double splat...
# reads output and returns it:
Rubbish.fish('ls lib/**.rb').split #=> ["lib/rubbish.rb"]
# The '?' method return weather or not the command succeeded.
# Fish's true and false commands:
Rubbish.fish?('true') #=> true
Rubbish.fish?('false') #=> false

# Run a bash script, have it output to STDOUT...
Rubbish.bash? "  echo \"Date/Time now: \"\n  date\n"
#=> true

# Rubbish will accept :fish and :bash calls, but
# you can add other shells... say... ruby?
# sure, why not:
Rubbish::SHELL_VERSION[:ruby] = '3.0' # Ensures it's ruby ~>3.0.
answer = Rubbish.ruby "  a = 5\n  b = 6\n  puts a+b\n"
#=> "11\n"

FEATURES:

Rubbish.shell('echo "OK"')              #=> "OK\n"
Rubbish.shell(shell:'fish'){|p| p.puts 'echo "OK"'}  #=> "OK\n"
Rubbish.bash('echo "OK"')                      #=> "OK\n"
Rubbish.fish('true')                           #=> ""

Exit status instead:

Rubbish.shell('true', shell:'fish', read:false) #=> true
Rubbish.shell('false', shell:'fish', read:false) #=> false
Rubbish.fish?('true')  #=> true
Rubbish.fish?('false') #=> false

An edge case:

b = nil
a = Rubbish.bash do |p|
  p.puts "echo Good"
  p.puts "echo Day!"
  b = p.gets
end
b #=> "Good\n"
a #=> "Day!\n"

Passing options to the "shell":

Rubbish::SHELL_VERSION[:date] = nil
Rubbish.date date:'2021-09-21' #=> "Tue Sep 21 12:00:00 AM PDT 2021\n"

INSTALL:

$ gem install rubbish

== LICENSE:

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.