rexe 1.0.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76e23653efa666a3b5ebf1b991614dd9b98bed082d54cda2f660e1991a62d7d8
-  data.tar.gz: d01960aa820c05b2a933f0cee0fa78f894afd43ae275da31b5efad96ae5ee89e
+  metadata.gz: 8ab00704245578c9561f0505ecf8bd7e89726a1c8c6df3ffd6a7ac42cd47cde9
+  data.tar.gz: f9a016b6c972c9960f6e42042ad5531b095fb69ccee8409b770d3da52c40f3d6
 SHA512:
-  metadata.gz: b5c57cc8ff200ae90c8d6d143b444f0c0b58ad91a93dc7027be280b5c0396b01da2a67f67f475db7108924b117f53e0d6f7ac3583502846a8c5941edeba6693f
-  data.tar.gz: 1e6227b7c651668a7ca306c3bb70fba18a80fd8c6018a3db9fdca2185b94f988fcf289898fa432b33af118261a6dcb9ca426c5cdb29ab31e2bb878929785edbd
+  metadata.gz: 34399b21ef6425c9107f42fe5809c4d3e4b98e5a1e88680dfdfb074f0b8c5b3f5e94c2b83d31299a948d2b54b873e41580d0cb1d4f1c57de2f10a29bce3a4da6
+  data.tar.gz: 7956d7b7b7f0ee154f345c9fd375e86913d9abf8b38f0e2d0d69cd5b2354ec6db9675bb3b425f077f0b4b1f572970c177daa64ce299a3293cd86dd45da219eee

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## rexe -- Ruby Command Line Executor/Filter
 
+### 1.3.0
+
+* Document --project-url option.
+* Add undocumented option --open-project to output Github project URL.
+* Simplify test as per @davetron5000's array based approach.
+* Fix context do/end in test code.
+* Froze strings: VERSION, PROJECT_URL, help_text.
+
+
+### 1.2.0
+
+* Add --project-url option to output project URL on Github, then exit
+
+
+### 1.1.0
+
+* Enable specifying different output formats for tty and block devices. (#4)
+* Outputs exception text on error instead of just exception class.
+
 
 ### 1.0.3
 

data/README.md

@@ -73,7 +73,7 @@ Rexe is at https://github.com/keithrbennett/rexe and can be installed with `gem
 Here is rexe's help text as of the time of this writing:
 
 ```
-rexe -- Ruby Command Line Executor/Filter -- v1.0.3 -- https://github.com/keithrbennett/rexe
+rexe -- Ruby Command Line Executor/Filter -- v1.3.0 -- https://github.com/keithrbennett/rexe
 
 Executes Ruby code on the command line, 
 optionally automating management of standard input and standard output,
@@ -115,6 +115,8 @@ Options:
                              -op  Puts
                              -os  to_s
                              -oy  YAML
+                             If 2 letters are provided, 1st is for tty devices, 2nd for block
+--project-url              Outputs project URL on Github, then exits
 -r, --require REQUIRE(S)   Gems and built-in libraries to require, comma separated;
                              ! to clear all, or precede a name with '-' to remove
 -v, --version              Prints version and exits
@@ -263,12 +265,13 @@ If you would like to append this informational output to a file(e.g. `rexe.log`)
 Rexe tries to make it simple and convenient for you to handle standard input, and in different ways. Here is the help text relating to input modes:
 
 ```
--m, --input_mode MODE      Input preprocessing mode (determines what `self` will be):
+-m, --input_mode MODE      Input preprocessing mode (determines what `self` will be)
+                           defaults to -mn (none)
                              -ml  line; each line is ingested as a separate string
                              -me  enumerator (each_line on STDIN or File)
                              -mb  big string; all lines combined into one string
-                             -mn  none (default); no input preprocessing; 
-                                  self is an Object.new 
+                             -mn  none (default); no input preprocessing;
+                                  self is an Object.new
 ```
 
 The first three are _filter_ modes; they make standard input available to your code as `self`.
@@ -369,6 +372,8 @@ All formats will implicitly `require` anything needed to accomplish their task (
 
 The default is `-on` to produce no output at all (unless explicitly coded to do so). If you prefer a different default such as `-op` for _puts_ mode, you can specify that in your `REXE_OPTIONS` environment variable.
 
+If two letters are provided, the first will be used for tty devices (e.g. the terminal when not redirected or piped), and the second for block devices (e.g. when redirected or piped to another process).
+
 You may wonder why these formats are provided, given that their functionality could be included in the custom code instead. Here's why:
 
 * The savings in command line length goes a long way to making these commands more readable and feasible.

data/exe/rexe

@@ -12,9 +12,9 @@ require 'shellwords'
 
 class Rexe
 
-  VERSION = '1.0.3'
+  VERSION = '1.3.0'.freeze
 
-  PROJECT_URL = 'https://github.com/keithrbennett/rexe'
+  PROJECT_URL = 'https://github.com/keithrbennett/rexe'.freeze
 
 
   module Helpers
@@ -25,7 +25,7 @@ class Rexe
         yield
       rescue Exception => e
         unless e.class == SystemExit
-          $stderr.puts('rexe: ' << e.class.to_s)
+          $stderr.puts('rexe: ' << e.to_s)
           $stderr.puts("Use the -h option to get help.")
           exit(-1)
         end
@@ -40,6 +40,8 @@ class Rexe
       :input_mode,
       :loads,
       :output_format,
+      :output_format_tty,
+      :output_format_block,
       :requires,
       :log_format,
       :noop)
@@ -53,13 +55,15 @@ class Rexe
 
     def clear
       self.input_filespec = nil
-      self.input_format   = :none
-      self.input_mode     = :none
-      self.output_format  = :none
-      self.loads          = []
-      self.requires       = []
-      self.log_format     = :none
-      self.noop           = false
+      self.input_format        = :none
+      self.input_mode          = :none
+      self.output_format       = :none
+      self.output_format_tty   = :none
+      self.output_format_block = :none
+      self.loads               = []
+      self.requires            = []
+      self.log_format          = :none
+      self.noop                = false
     end
   end
 
@@ -173,69 +177,77 @@ class Rexe
 
 
     private def help_text
-      <<~HEREDOC
-
-    rexe -- Ruby Command Line Executor/Filter -- v#{VERSION} -- #{PROJECT_URL}
-
-    Executes Ruby code on the command line, 
-    optionally automating management of standard input and standard output,
-    and optionally parsing input and formatting output with YAML, JSON, etc.
-
-    rexe [options] [Ruby source code]
-
-    Options:
-
-    -c  --clear_options        Clear all previous command line options specified up to now
-    -f  --input_file           Use this file instead of stdin for preprocessed input; 
-                               if filespec has a YAML and JSON file extension,
-                               sets input format accordingly and sets input mode to -mb
-    -g  --log_format FORMAT    Log format, logs to stderr, defaults to -gn (none)
-                               (see -o for format options)
-    -h, --help                 Print help and exit
-    -i, --input_format FORMAT  Input format, defaults to -in (None)
-                                 -ij  JSON
-                                 -im  Marshal
-                                 -in  None (default)
-                                 -iy  YAML
-    -l, --load RUBY_FILE(S)    Ruby file(s) to load, comma separated;
-                                 ! to clear all, or precede a name with '-' to remove
-    -m, --input_mode MODE      Input preprocessing mode (determines what `self` will be)
-                               defaults to -mn (none)
-                                 -ml  line; each line is ingested as a separate string
-                                 -me  enumerator (each_line on STDIN or File)
-                                 -mb  big string; all lines combined into one string
-                                 -mn  none (default); no input preprocessing; 
-                                      self is an Object.new 
-    -n, --[no-]noop            Do not execute the code (useful with -g);
-                               For true: yes, true, y, +; for false: no, false, n
-    -o, --output_format FORMAT Output format, defaults to -on (no output):
-                                 -oi  Inspect
-                                 -oj  JSON
-                                 -oJ  Pretty JSON
-                                 -om  Marshal
-                                 -on  No Output (default)
-                                 -op  Puts
-                                 -os  to_s
-                                 -oy  YAML
-    -r, --require REQUIRE(S)   Gems and built-in libraries to require, comma separated;
-                                 ! to clear all, or precede a name with '-' to remove
-    -v, --version              Prints version and exits
-
-    ---------------------------------------------------------------------------------------
-                                                                                                
-    In many cases you will need to enclose your source code in single or double quotes.
-
-    If source code is not specified, it will default to 'self', 
-    which is most likely useful only in a filter mode (-ml, -me, -mb).
-
-    If there is a .rexerc file in your home directory, it will be run as Ruby code 
-    before processing the input.
-
-    If there is a REXE_OPTIONS environment variable, its content will be prepended
-    to the command line so that you can specify options implicitly 
-    (e.g. `export REXE_OPTIONS="-r awesome_print,yaml"`)
+      unless @help_text
+        @help_text ||= <<~HEREDOC
+
+          rexe -- Ruby Command Line Executor/Filter -- v#{VERSION} -- #{PROJECT_URL}
+      
+          Executes Ruby code on the command line, 
+          optionally automating management of standard input and standard output,
+          and optionally parsing input and formatting output with YAML, JSON, etc.
+      
+          rexe [options] [Ruby source code]
+      
+          Options:
+      
+          -c  --clear_options        Clear all previous command line options specified up to now
+          -f  --input_file           Use this file instead of stdin for preprocessed input; 
+                                     if filespec has a YAML and JSON file extension,
+                                     sets input format accordingly and sets input mode to -mb
+          -g  --log_format FORMAT    Log format, logs to stderr, defaults to -gn (none)
+                                     (see -o for format options)
+          -h, --help                 Print help and exit
+          -i, --input_format FORMAT  Input format, defaults to -in (None)
+                                       -ij  JSON
+                                       -im  Marshal
+                                       -in  None (default)
+                                       -iy  YAML
+          -l, --load RUBY_FILE(S)    Ruby file(s) to load, comma separated;
+                                       ! to clear all, or precede a name with '-' to remove
+          -m, --input_mode MODE      Input preprocessing mode (determines what `self` will be)
+                                     defaults to -mn (none)
+                                       -ml  line; each line is ingested as a separate string
+                                       -me  enumerator (each_line on STDIN or File)
+                                       -mb  big string; all lines combined into one string
+                                       -mn  none (default); no input preprocessing; 
+                                            self is an Object.new 
+          -n, --[no-]noop            Do not execute the code (useful with -g);
+                                     For true: yes, true, y, +; for false: no, false, n
+          -o, --output_format FORMAT Output format, defaults to -on (no output):
+                                       -oi  Inspect
+                                       -oj  JSON
+                                       -oJ  Pretty JSON
+                                       -om  Marshal
+                                       -on  No Output (default)
+                                       -op  Puts
+                                       -os  to_s
+                                       -oy  YAML
+                                       If 2 letters are provided, 1st is for tty devices, 2nd for block
+          --project-url              Outputs project URL on Github, then exits
+          -r, --require REQUIRE(S)   Gems and built-in libraries to require, comma separated;
+                                       ! to clear all, or precede a name with '-' to remove
+          -v, --version              Prints version and exits
+      
+          ---------------------------------------------------------------------------------------
+                                                                                                      
+          In many cases you will need to enclose your source code in single or double quotes.
+      
+          If source code is not specified, it will default to 'self', 
+          which is most likely useful only in a filter mode (-ml, -me, -mb).
+      
+          If there is a .rexerc file in your home directory, it will be run as Ruby code 
+          before processing the input.
+      
+          If there is a REXE_OPTIONS environment variable, its content will be prepended
+          to the command line so that you can specify options implicitly 
+          (e.g. `export REXE_OPTIONS="-r awesome_print,yaml"`)
 
       HEREDOC
+
+        @help_text.freeze
+      end
+
+      @help_text
     end
 
 
@@ -348,10 +360,11 @@ class Rexe
 
         parser.on('-o', '--output_format FORMAT',
                   'Mode with which to format values for output (`-o` + [aijJmnpsy])') do |v|
-
-          options.output_format = lookups.output_formats[v]
-          if options.output_format.nil?
-            raise("Output mode was '#{v}' but must be one of #{lookups.output_formats.keys}.")
+          options.output_format_tty   = lookups.output_formats[v[0]]
+          options.output_format_block = lookups.output_formats[v[-1]]
+          options.output_format = ($stdout.tty? ? options.output_format_tty : options.output_format_block)
+          if [options.output_format_tty, options.output_format_block].include?(nil)
+            raise("Bad output mode '#{v}'; each must be one of #{lookups.output_formats.keys}.")
           end
         end
 
@@ -375,12 +388,17 @@ class Rexe
           exit(0)
         end
 
-        # Undocumented feature
+        # Undocumented feature: open Github project with default web browser on a Mac
         parser.on('', '--open-project') do
           open_resource(PROJECT_URL)
           exit(0)
         end
 
+        parser.on('', '--project-url') do
+          puts PROJECT_URL
+          exit(0)
+        end
+
       end.parse!
 
       # We want to do this after all options have been processed because we don't want any clearing of the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexe
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print