rubysh 0.0.1 → 0.0.2

data/README.md

@@ -22,8 +22,9 @@ are simple in __sh__, such as:
   - redirecting a program's output to a file
   - use a pre-tokenized array of arguments
 
-Rubysh tries to emulate __sh__'s interface and semantics as closely as
-possible.
+(Some existing libraries make some of these tasks easy, but not all of
+them at once.) Rubysh tries to emulate __sh__'s interface and
+semantics as closely as possible.
 
 ## Features
 
@@ -64,14 +65,28 @@ quite decided on the right API for this yet.
 
 ## API
 
-The Rubysh helper function produces instances of __BaseCommand__. You
-can run __run__ on these to spawn a subprocess and then __wait__ for
+The Rubysh helper function produces instances of `BaseCommand`. You
+can run `run` on these to spawn a subprocess and then `wait` for
 it to complete. Alternatively, you can do:
 
     command = Rubysh('ls')
     runner = command.run_async
     runner.wait
 
+If you don't want to type `Rubysh` all the time, you can alias it with
+the `AliasRubysh` helper:
+
+    AliasRubysh(:R)
+    R('ls')
+
+## Safety
+
+Rubysh takes a splatted array argument as a command specification. In
+particular, it doesn't convert it back and forth a command-line
+string, meaning you don't have to worry about spaces in
+variables. (You should still always think twice before putting
+untrusted arguments into a shell argument.)
+
 ## Installation
 
 Rubysh is hosted on Rubygems. You can install by adding this line to
@@ -86,3 +101,9 @@ Or by installing directly via
 ## Contributing
 
 Patches welcome! I'm happy to merge pull requests.
+
+## Future features
+
+- Support for environment variables
+- Finer-grained IO control
+- Subshell syntax (`cat <(ls)`, `echo $(ls)`)

data/lib/rubysh/fd.rb

@@ -31,6 +31,10 @@ module Rubysh
       Rubysh.<<(self)
     end
 
+    def inspect
+      to_s
+    end
+
     def to_s
       "FD: #{@fileno}"
     end

data/lib/rubysh/version.rb

@@ -1,3 +1,3 @@
 module Rubysh
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/rubysh.rb

@@ -13,7 +13,7 @@ require 'rubysh/subprocess'
 require 'rubysh/triple_less_than'
 require 'rubysh/util'
 
-# Command:
+# Basic usage:
 #
 # Rubysh('ls', '/tmp')
 # => Command: ls /tmp
@@ -24,39 +24,41 @@ require 'rubysh/util'
 # Rubysh('ls', '/tmp', Rubysh.>('/tmp/outfile.txt'))
 # => Command: ls /tmp > /tmp/outfile.txt
 #
-# TODO:
-# => Command: (ls; ls) | grep foo
-# => Command: echo <(ls /tmp)
-# => Command: echo >(cat)
-# something like the following to tee output:
-# Rubysh('cat', Rubysh.stdout >> :pipe)
-#
 # If you want to capture output:
 #
 # Rubysh('cat', Rubysh.stdout > :pipe)
 #
-# Or for interactivity:
-#
-# q = Rubysh('cat', Rubysh.stdout > :stdout, Rubysh.stderr > :stderr, Rubysh.stdin < :stdin)
-# q.write('my whole command')
-# q.communicate # closes writeable pipes and reads from all readable pipes
-# q.data_from(:stdout)
-# q.data_from(1)
-# q.status
-#
 # You can name pipes with whatever symbol name you want:
 #
 # Rubysh('cat', 2 > :stdout, 3 > :fd3)
 #
-# This API is a WIP:
+# TODOs:
+#
+# => Command: (ls; ls) | grep foo
+# => Command: echo <(ls /tmp)
+# => Command: echo >(cat)
+#
+# Something like the following to tee output:
+#
+# Rubysh('cat', Rubysh.stdout >> :pipe)
+#
+# The following rough API needs to be fleshed out. Maybe something
+# close to the following for interactivity:
+#
+# cmd = Rubysh('cat', Rubysh.stdout > :stdout, Rubysh.stderr > :stderr, Rubysh.stdin < :stdin)
+# q = cmd.run_async
+# q.write(:stdin, 'my whole command')
+# q.communicate # closes writeable pipes and reads from all readable pipes
+# q.data(:stdout)
+# q.exitstatus
 #
-# q.write('my first command') # write data (while also reading from readable pipes
-#                             # in a select() loop)
+# q.write(:stdin, 'my first command') # write data (while also reading from readable pipes
+#                                     # in a select() loop)
 # q.communicate(:partial => true) # read available data (don't close pipes)
-# q.data_from(:stdout)
-# q.write('my second command')
+# q.data(:stdout)
+# q.write(:stdin, 'my second command')
 #
-# Not sure this is needed:
+# It'd be possible to support &, but I don't think it's needed:
 # Rubysh('ls', '/tmp', Rubysh.&)
 # => Command: ls /tmp &
 
@@ -79,6 +81,12 @@ def Rubysh(*args, &blk)
   end
 end
 
+def AliasRubysh(name)
+  metaclass = class << self; self; end
+  metaclass.send(:alias_method, name, :Rubysh)
+  Object.const_set(name, Rubysh)
+end
+
 module Rubysh
   # Convenience methods
   def self.run(command)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubysh
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Greg Brockman