rubbish 0.2.200128 → 1.0.210921

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4cf8bce4e93ddb99df77ab62e0223ef4dd3c3d7a9397ecfee07a7630a13606d
-  data.tar.gz: 6d5be379098c58eacac6b74ec5eedb5909f30be9bee03aeaf094f6726c04023a
+  metadata.gz: c0f0bcdd58cb0bd08f604b7acaee9cadb5ccabaa022a5a8db7d85f64f7e50580
+  data.tar.gz: b51390309a1af812676a37d1631c6cdddc73a96f7b94875f4a41ee4984414698
 SHA512:
-  metadata.gz: de35ecaa12da6ca6c3888afd9271344eaec0501baa669a58b0c90a4c1aa730868697b68c5b850cefe1ca62ab3780c255a87109868e63ff785228ec7733b33431
-  data.tar.gz: 197de12725801e594fc1a5718f15e41e6998c57bd198c30d9f9d9fb44586c9ad3d00e34d763e5d7786a2fcf80811a1d919f5e4e164851706c84eae44c9066d03
+  metadata.gz: 2ae8609febdeaadf67a15e250124cc3491aa2f4e9c9f6646b0edb179fef9424fbcdfad7e0d91d124ec3903efa181139c6e71ad91d26f2dff71e9d9f71f4c86c6
+  data.tar.gz: 85c409b26548537d4ecebd7b6845bc1c5245b5fca28cb0f0c7ff90ff04f75b8e89161a4e057a825995bf614c41192615c0fde8e4800e0dc622e441bebb881c93

data/README.md

@@ -1,5 +1,9 @@
 # rubbish
 
+* [VERSION 1.0.210921](https://github.com/author/rubbish/releases)
+* [github](https://www.github.com/author/rubbish)
+* [rubygems](https://rubygems.org/gems/rubbish)
+
 ## DESCRIPTION:
 
 A ruby-ish way to go to the shell.
@@ -10,64 +14,75 @@ Bash and Fish aware.
 
 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.
-    ls_lib = Rubbish.fish('ls lib/**.rb').split #=> ["lib/good.rb", "lib/good/bad.rb", "lib/good/ugly.rb"]
-
-    # Run a bash script, have it output to STDOUT(read: false)...
-    Rubbish.bash <<-BASH, read: false
-      echo "Date/Time now: "
-      date
-    BASH
-
-    # Rubbish will accept :fish and :bash calls, but
-    # you can add other shells... say... ruby?
-    # sure, why not:
-    Rubbish::SHELL_VERSION[:ruby] = '2.0' # Ensures it's ruby ~>2.0.
-    answer = Rubbish.ruby <<-RUBY #=> "11"
-      a = 5
-      b = 6
-      puts a+b
-    RUBY
-
+```ruby
+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? <<-BASH
+  echo "Date/Time now: "
+  date
+BASH
+#=> 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 <<-RUBY
+  a = 5
+  b = 6
+  puts a+b
+RUBY
+#=> "11\n"
+```
 ## FEATURES:
 
-Read(read: true) by default:
-
-* Rubbish.shell('bash','echo "OK"') #=> OK
-* Rubbish.shell('fish'){|p| p.puts 'echo "OK"'}  #=> OK
-* Rubbish.bash('echo "OK"') #=> OK
-* Rubbish.fish('true') #=> ''
-
-Exit status instead when not reading(read: false):
-
-* Rubbish.fish('true', read: false) #=> true
-* Rubbish.fish('false', read: false) #=> false
-
+```ruby
+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:
+```ruby
+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:
-
-    require 'rubbish'
-    b = nil
-    a = Rubbish.bash do |p|
-      p.puts "echo Good"
-      p.puts "echo Day!"
-      b = p.gets
-    end
-    puts b # Good
-    puts a # Day!
-
+```ruby
+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":
+```ruby
+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
-
+```console
+$ gem install rubbish
+```
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2020 carlosjhr64
+Copyright (c) 2021 CarlosJHR64
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/rubbish.rb

@@ -1,28 +1,8 @@
 module Rubbish
-  VERSION = '0.2.200128'
+  VERSION = '1.0.210921'
   SHELL_VERSION = {bash: nil, fish: nil}
 
-  # Fine!
-  # Let there be Rubbish.args!!!
-  def self.args(*args)
-    script, read  =  nil, true
-    until args.empty?
-      arg = args.shift
-      case arg
-      when String
-        script = arg
-      when TrueClass, FalseClass
-        read = arg
-      when Hash
-        script = arg[:script]  if arg.has_key? :script
-        read   = arg[:read]    if arg.has_key? :read
-      end
-    end
-    return script, read
-  end
-
-  def self.shell(shell, *args, &block)
-    script, read = Rubbish.args(*args)
+  def self.shell(script=nil, shell:'bash', read:true, &block)
     IO.popen(shell, (read)? 'w+' : 'w') do |pipe|
       # No matter what, we know we're going to write first.
       writing = true
@@ -32,38 +12,43 @@ module Rubbish
         pipe.close_write
         writing = false
       end
-      if block
-        block.call(pipe)
-        # close if we were writing
-        pipe.close_write if writing
-      end
+      block.call(pipe) if block
+      # close if we were writing
+      pipe.close_write if writing
       # Read if reading
       read = pipe.read if read
     end
     read || $?.to_i==0
   end
 
-  def self.method_missing(shell, *args, &block)
-    if args.length.between?(0,2) and SHELL_VERSION.has_key? shell
+  def self.method_missing(shell, *args, **kw, &block)
+    shell=shell[0..-2].to_sym unless read=(shell[-1]!='?')
+    if SHELL_VERSION.has_key?(shell) and args.length.between?(0,1)
       if minimum = SHELL_VERSION[shell]
         minimum = Gem::Version.new minimum
         if version = `#{shell} --version`.scan(/\d+\.\d+\.\d+/).first
           version  = Gem::Version.new version
           bumped = minimum.bump
-          raise "Need #{shell} version ~> #{minimum}" unless version >= minimum and version < bumped
+          unless version >= minimum and version < bumped
+            raise "Need #{shell} version ~> #{minimum}"
+          end
           # need to only check once
           SHELL_VERSION[shell] = nil
         else
           raise "Could not get the #{shell} version"
         end
       end
-      script, read  =  Rubbish.args(*args)
-      return Rubbish.shell(shell.to_s, script, read,  &block)
+      shell = shell.to_s
+      if kw.length > 0
+        shell << ' ' + kw.select{_2}.map{
+          "--#{_1}=#{_2}".sub(/=(true)?$/,'').sub(/^--(\w)$/, '-\1')}.join(' ')
+      end
+      script = args[0]
+      return Rubbish.shell(script, shell:shell, read:read,  &block)
     end
     super
   end
 end
-
 # Requires:
 #`ruby`
 #`bash`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubbish
 version: !ruby/object:Gem::Version
-  version: 0.2.200128
+  version: 1.0.210921
 platform: ruby
 authors:
-- carlosjhr64
-autorequire: 
+- CarlosJHR64
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies: []
 description: |
   A ruby-ish way to go to the shell.
@@ -25,7 +25,7 @@ homepage: https://github.com/carlosjhr64/rubbish
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -40,11 +40,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-linux]'
-- 'bash: GNU bash, version 5.0.11(1)-release (x86_64-redhat-linux-gnu)'
-- 'fish: fish, version 3.0.2'
-rubygems_version: 3.1.2
-signing_key: 
+- 'ruby: ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]'
+- 'bash: GNU bash, version 5.1.0(1)-release (x86_64-redhat-linux-gnu)'
+- 'fish: fish, version 3.3.1'
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A ruby-ish way to go to the shell.
 test_files: []