rubbish 0.2.200128 → 1.1.221208

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4cf8bce4e93ddb99df77ab62e0223ef4dd3c3d7a9397ecfee07a7630a13606d
-  data.tar.gz: 6d5be379098c58eacac6b74ec5eedb5909f30be9bee03aeaf094f6726c04023a
+  metadata.gz: d6a9c2f7befeba1ee6244441d88f39abb7f3f955108913885c4a785d55b325dd
+  data.tar.gz: b7f136c136d7ab3711186afdc2334276432347010ddf899e09a4c85c9790a43c
 SHA512:
-  metadata.gz: de35ecaa12da6ca6c3888afd9271344eaec0501baa669a58b0c90a4c1aa730868697b68c5b850cefe1ca62ab3780c255a87109868e63ff785228ec7733b33431
-  data.tar.gz: 197de12725801e594fc1a5718f15e41e6998c57bd198c30d9f9d9fb44586c9ad3d00e34d763e5d7786a2fcf80811a1d919f5e4e164851706c84eae44c9066d03
+  metadata.gz: d8d6e4ce9dab28c64dde5a56f91178ad0dba87f2f20087722cad5c988733416f26633c95277bf5b14f6574c78d8537cd27e6fbc1609115bb9a370a9a0557d6e9
+  data.tar.gz: 1c9ba07b399f41aaff250b10fb09b151ce2122a65211b4cb8cc74fa8d9eee540ba06232b1ea0a7b9baeedb00e028df6991ff3420d5533c50f181c14d294dab34

data/README.md

@@ -1,5 +1,14 @@
 # rubbish
 
+* [VERSION 1.1.221208](https://github.com/carlosjhr64/rubbish/releases)
+* [github](https://www.github.com/carlosjhr64/rubbish)
+* [rubygems](https://rubygems.org/gems/rubbish)
+
+## Deprecation notice:
+
+This is my last `Rubbish` update.
+I've merged this project with [Helpema](https://www.github.com/carlosjhr64/helpema).
+
 ## DESCRIPTION:
 
 A ruby-ish way to go to the shell.
@@ -10,64 +19,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', R:true #=> "Tue, 21 Sep 2021 00:00:00 -0700\n"
+```
 ## INSTALL:
-
-    $ gem install rubbish
-
-== LICENSE:
+```console
+$ gem install rubbish
+```
+## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2020 carlosjhr64
+Copyright (c) 2022 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,10 @@
 module Rubbish
-  VERSION = '0.2.200128'
+  VERSION = '1.1.221208'
   SHELL_VERSION = {bash: nil, fish: nil}
+  # This is a contraction of Shellwords.escape function
+  SHELLWORDS_ESCAPE = lambda{|w|w.gsub(/[^\w\-.,:+\/@\n]/,'\\\\\\&').gsub(/\n/,"'\n'")}
 
-  # 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 +14,47 @@ 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
-      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
-          # need to only check once
-          SHELL_VERSION[shell] = nil
+  def self.method_missing(cmd, *args, **kw, &block)
+    cmd=cmd[0..-2].to_sym unless read=(cmd[-1]!='?')
+    return super unless SHELL_VERSION.has_key?(cmd) and args.length.between?(0,1)
+    if minimum = SHELL_VERSION[cmd]
+      minimum = Gem::Version.new minimum
+      if version = `#{cmd} --version`.match(/\d+\.\d+\.\d+/)&.match(0)
+        version  = Gem::Version.new version
+        bumped = minimum.bump
+        unless version >= minimum and version < bumped
+          raise "Need #{cmd} version ~> #{minimum}"
+        end
+        # need to only check once
+        SHELL_VERSION[cmd] = nil
+      else
+        raise "Could not get the #{cmd} version"
+      end
+    end
+    command = [cmd.to_s]
+    if kw.length > 0
+      kw.each do |k,w|
+        next if not w
+        if w==true
+          command << "#{k.length>1? '--':'-'}#{k}"
         else
-          raise "Could not get the #{shell} version"
+          command << "--#{k}=#{w}"
         end
       end
-      script, read  =  Rubbish.args(*args)
-      return Rubbish.shell(shell.to_s, script, read,  &block)
     end
-    super
+    script = args[0]
+    return Rubbish.shell(script, shell:command, read:read,  &block)
   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.1.221208
 platform: ruby
 authors:
-- carlosjhr64
+- CarlosJHR64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2022-12-10 00:00:00.000000000 Z
 dependencies: []
 description: |
   A ruby-ish way to go to the shell.
@@ -40,10 +40,10 @@ 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
+- 'ruby: ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [aarch64-linux]'
+- 'bash: GNU bash, version 5.1.4(1)-release (aarch64-unknown-linux-gnu)'
+- 'fish: fish, version 3.5.1'
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: A ruby-ish way to go to the shell.