rexe 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 148f8f91ef5ee20f245d74ee2b16b75550622b7ba80c139a671a26e2e383a482
-  data.tar.gz: 495447fbd26d0b8205d5c703e6c02577e5b9f85df11ec0892d4717689c17837e
+  metadata.gz: 79b7eb979cbeb0ba6d95c150e58bccecef867212b4783808f06381d9e247aa55
+  data.tar.gz: e737abbe83eee2bd71d83466a336db48b49ceea1ef88a51615557dcfa623d1d5
 SHA512:
-  metadata.gz: fae8f53b62e75773a1245ea5b7e411328146a8bb80538522ec344dd18a86df65523e3226e15421537865a1db7196352f2cd25004303e63b5d0af3fb944e52dcf
-  data.tar.gz: eacd19481d49bd663ce6d8a9033a73c6eec711031ac766593b60aeca28296c4dacfb38450893ab857bc005663bd29b95883d7a638d45e878d36b7dab7388d5b3
+  metadata.gz: 729475e954a39717db0f64b1dbfa2e267c41cf23742fb26de919ba2c80347b25adb1951d4c9ae2a3069068a5ac3baa52c9e8761b235bb72491a1fd0b32f82d94
+  data.tar.gz: 53b3ae64d2f92db487299ce46a2808cb82afea02e8b1ed66dbe4d3dfd5d2eddcc31f2697a1f87194f60c9ac7ffa15cfef8d5d11f5bc0e04b666e9e6d4f7d6f79

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 ## rexe -- Ruby Command Line Executor
 
 
+### v0.12.0
+
+* Change verbose -v boolean option to log output format -g option.
+* Print error message and exit with nonzero exit code if no source code provided.
+* Add $RC.i alias for $RC.count.
+
+
 ### v0.11.0
 
 * Make global $RC (Rexe Context) OpenStruct available to user code; added `count` for record count in `-ml` mode.

data/README.md

@@ -61,7 +61,7 @@ line, tipping the scale so that it is practical to do it more often.
 Here is `rexe`'s help text as of the time of this writing:
 
 ```
-rexe -- Ruby Command Line Executor/Filter -- v0.11.0 -- https://github.com/keithrbennett/rexe
+rexe -- Ruby Command Line Executor/Filter -- v0.12.0 -- https://github.com/keithrbennett/rexe
 
 Executes Ruby code on the command line, optionally taking standard input and writing to standard output.
 
@@ -70,8 +70,9 @@ rexe [options] 'Ruby source code'
 Options:
 
 -c  --clear_options        Clear all previous command line options specified up to now
+-g  --log_format FORMAT    Log format, logs to stderr, defaults to none (see -o for format options)
 -h, --help                 Print help and exit
--i, --input_format FORMAT  Input format (none is default)
+-i, --input_format FORMAT  Input format (defaults to none)
                              -ij  JSON
                              -im  Marshal
                              -in  None
@@ -81,9 +82,10 @@ Options:
                              -ml  line mode; each line is ingested as a separate string
                              -me  enumerator mode
                              -mb  big string mode; all lines combined into single multiline string
-                             -mn  (default) no input mode; no special handling of input; self is an Object.new 
--n, --[no-]noop            Do not execute the code (useful with -v); see note (1) below
--o, --output_format FORMAT Output format (puts is default):
+                             -mn  (default) no input mode; no special handling of input; self is an Object.new
+-n, --[no-]noop            Do not execute the code (useful with -g); the following are valid:
+                             -n no, -n yes, -n false, -n true, -n n, -n y, -n +, but not -n -
+-o, --output_format FORMAT Output format (defaults to puts):
                              -oi  Inspect
                              -oj  JSON
                              -oJ  Pretty JSON
@@ -93,16 +95,12 @@ Options:
                              -os  to_s
                              -oy  YAML
 -r, --require REQUIRE(S)   Gems and built-in libraries to require, comma separated, or ! to clear
--v, --[no-]verbose         verbose mode (logs to stderr); see note (1) below
 
-If there is an .rexerc file in your home directory, it will be run as Ruby code 
+If there is an .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"`)
-
-(1) For boolean 'verbose' and 'noop' options, the following are valid:
--v no, -v yes, -v false, -v true, -v n, -v y, -v +, but not -v -
 ```
 
 ### Simplifying the Rexe Invocation
@@ -178,14 +176,16 @@ end
 Alternatively you could escape the parentheses with backslashes.)
 
 
-### Verbose Mode
+### Logging
 
-Verbose mode will display the version, date/time of execution, source code
-to be evaluated, options specified (by all approaches), that the global file has been loaded (if it was found),
+A log entry is optionally output to standard error after completion of the code.
+The entry is a hash containing the version, date/time of execution, source code
+to be evaluated, options (specified by all approaches),
 and the execution time of your Ruby code:
  
 ```
-➜  ~   echo $EUR_RATES_JSON | rexe -v -rjson,awesome_print "ap JSON.parse(STDIN.read)"
+➜  ~   echo $EUR_RATES_JSON | rexe -gy -rjson,awesome_print "ap JSON.parse(STDIN.read)"
+...
 ---
 :count: 0
 :rexe_version: 0.11.0
@@ -214,11 +214,9 @@ use it programatically.
 If you would like to append this informational output to a file, you could do something like this:
 
 ```
-➜  ~   rexe ... -v 2>>rexe.log
+➜  ~   rexe ... -gy 2>>rexe.log
 ```
 
-If verbose mode is enabled in configuration and you want to disable it, you can
-do so by using any of the following: `--[no-]verbose`, `-v n`, or `-v false`.
 
 ### Input Modes
 
@@ -359,13 +357,13 @@ parameterization of the output format.
 
 For your convenience, the information displayed in verbose mode is available to your code at runtime
 by accessing the `$RC` global variable, which contains an OpenStruct. Probably most useful in that object
-is the record count (as `$RC.count`). This is only really useful in line mode, because in the others
+is the record count, accessible with both `$RC.count` and `$RC.i`.
+This is only really useful in line mode, because in the others
 it will always be 0 or 1. Here is an example of how you might use it:
 
 ```
 ➜  ~   ➜  ~   find / | rexe -ml -on \
-'n = $RC.count; if n % 1000 == 0; puts %Q{File entry ##{n} is #{self}}; end'
-
+'if $RC.i % 1000 == 0; puts %Q{File entry ##{$RC.i} is #{self}}; end'
 ...
 File entry #106000 is /usr/local/Cellar/go/1.11.5/libexec/src/cmd/vendor/github.com/google/pprof/internal/driver/driver_test.go
 File entry #107000 is /usr/local/Cellar/go/1.11.5/libexec/src/go/types/testdata/cycles1.src
@@ -422,6 +420,13 @@ An excellent reference for how they differ is [here](https://stackoverflow.com/q
 Feel free to fall back on Ruby's super useful `%q{}` and `%Q{}`, equivalent to single and double quotes, respectively.
 
 
+### No Op Mode
+
+The `-n` no-op mode will result in the specified source code _not_ being executed. This can sometimes be handy
+in conjunction with a `-g` (logging) option; if you have a command ready to go but 
+you want to see the configuration options before running it for real.
+
+
 ### Mimicking Method Arguments
 
 You may want to support arguments in your code. One of the previous examples downloaded currency conversion rates. Let's find out the available currency codes:
@@ -562,10 +567,10 @@ Files loaded with the `-l` option are treated the same way.
 Requiring gems and modules for _all_ invocations of `rexe` will make your commands simpler and more concise, but will be a waste of execution time if they are not needed. You can inspect the execution times to see just how much time is being wasted. For example, we can find out that nokogiri takes about 0.15 seconds to load on my laptop by observing and comparing the execution times with and without the require (output has been abbreviated using the redirection and grep):
 
 ```
-➜  ~   rexe -v 2>&1 | grep duration
+➜  ~   rexe -gy 2>&1 | grep duration
 :duration_secs: 0.0012
 
-➜  ~   rexe -v -r nokogiri 2>&1 | grep duration
+➜  ~   rexe -gy -r nokogiri 2>&1 | grep duration
 :duration_secs: 0.148671
 ```
 

data/exe/rexe

@@ -10,9 +10,17 @@ require 'optparse'
 require 'ostruct'
 require 'shellwords'
 
-class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :requires, :verbose, :noop)
+class Rexe < Struct.new(
+    :input_format,
+    :input_mode,
+    :loads,
+    :output_format,
+    :requires,
+    :log_format,
+    :noop)
 
-  VERSION = '0.11.0'
+
+  VERSION = '0.12.0'
 
 
   def initialize
@@ -82,7 +90,7 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
   end
 
 
-  def parser_and_format_requires
+  def require_format_require(format)
     @format_requires ||= {
         json:          'json',
         pretty_json:   'json',
@@ -90,19 +98,20 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
         pretty_print:  'pp',
         yaml:          'yaml'
     }
+    r = @format_requires[format]
+    require(r) if r
   end
 
 
   # Used as an initializer and also when `-!` is specified on the command line.
   def clear_options
-    self.input_format = :none
-    self.input_mode = :no_input
+    self.input_format  = :none
+    self.input_mode    = :no_input
     self.output_format = :puts
-    self.loads = []
-    self.requires = []
-    self.verbose = false
-    self.noop = false
-    @output_formatter = nil
+    self.loads         = []
+    self.requires      = []
+    self.log_format    = :none
+    self.noop          = false
   end
 
 
@@ -118,8 +127,9 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
     Options:
 
     -c  --clear_options        Clear all previous command line options specified up to now
+    -g  --log_format FORMAT    Log format, logs to stderr, defaults to none (see -o for format options)
     -h, --help                 Print help and exit
-    -i, --input_format FORMAT  Input format (none is default)
+    -i, --input_format FORMAT  Input format (defaults to none)
                                  -ij  JSON
                                  -im  Marshal
                                  -in  None
@@ -130,8 +140,9 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
                                  -me  enumerator mode
                                  -mb  big string mode; all lines combined into single multiline string
                                  -mn  (default) no input mode; no special handling of input; self is an Object.new 
-    -n, --[no-]noop            Do not execute the code (useful with -v); see note (1) below
-    -o, --output_format FORMAT Output format (puts is default):
+    -n, --[no-]noop            Do not execute the code (useful with -g); the following are valid:
+                                 -n no, -n yes, -n false, -n true, -n n, -n y, -n +, but not -n -
+    -o, --output_format FORMAT Output format (defaults to puts):
                                  -oi  Inspect
                                  -oj  JSON
                                  -oJ  Pretty JSON
@@ -141,7 +152,6 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
                                  -os  to_s
                                  -oy  YAML
     -r, --require REQUIRE(S)   Gems and built-in libraries to require, comma separated, or ! to clear
-    -v, --[no-]verbose         verbose mode (logs to stderr); see note (1) below
 
     If there is an .rexerc file in your home directory, it will be run as Ruby code 
     before processing the input.
@@ -149,9 +159,6 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
     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"`)
 
-    (1) For boolean 'verbose' and 'noop' options, the following are valid:
-    -v no, -v yes, -v false, -v true, -v n, -v y, -v +, but not -v -
-
     HEREDOC
   end
 
@@ -169,6 +176,14 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
 
     OptionParser.new do |parser|
 
+      parser.on('-g', '--log_format FORMAT', 'Log format, logs to stderr, defaults to none (see -o for format options)') do |v|
+        self.log_format = output_formats[v]
+        if self.log_format.nil?
+          puts help_text
+          raise "Output mode was '#{v}' but must be one of #{output_formats.keys}."
+        end
+      end
+
       parser.on("-h", "--help", "Show help") do |_help_requested|
         puts help_text
         exit
@@ -227,23 +242,19 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
         end
       end
 
-      # See https://stackoverflow.com/questions/54576873/ruby-optionparser-short-code-for-boolean-option
-      # for an excellent explanation of this optparse incantation.
-      # According to the answer, valid options are:
-      # -v no, -v yes, -v false, -v true, -v n, -v y, -v +, but not -v -.
-      parser.on('-v', '--[no-]verbose [FLAG]', TrueClass, 'Verbose mode (logs to stderr)') do |v|
-        self.verbose = (v.nil? ? true : v)
-      end
-
       parser.on('-c', '--clear_options', "Clear all previous command line options") do |v|
         clear_options
       end
 
-      parser.on('-n', '--[no-]noop [FLAG]', TrueClass, "Do not execute the code (useful with -v)") do |v|
+      # See https://stackoverflow.com/questions/54576873/ruby-optionparser-short-code-for-boolean-option
+      # for an excellent explanation of this optparse incantation.
+      # According to the answer, valid options are:
+      # -n no, -n yes, -n false, -n true, -n n, -n y, -n +, but not -n -.
+      parser.on('-n', '--[no-]noop [FLAG]', TrueClass, "Do not execute the code (useful with -g)") do |v|
         self.noop = (v.nil? ? true : v)
       end
 
-      parser.on('', '--version', 'Print version') do
+      parser.on('-v', '--version', 'Print version') do
         puts VERSION
         exit
       end
@@ -280,7 +291,12 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
 
     prepend_environment_options
     parse_command_line
+
     user_source_code = ARGV.join(' ')
+    if user_source_code.empty?
+      STDERR.puts "No source code provided.  Use -h to display help."
+      exit(-1)
+    end
 
     requires.each { |r| require(r) }
     load_global_config_if_exists
@@ -289,9 +305,9 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
     callable = eval("Proc.new { #{user_source_code} }")
 
     actions = {
-        line:           -> { STDIN.each { |l| execute(l.chomp, callable);            $RC[:count] += 1 } },
-        enumerator:     -> { execute(STDIN.each_line, callable);                     $RC[:count] += 1 },
-        one_big_string: -> { big_string = STDIN.read; execute(big_string, callable); $RC[:count] += 1 },
+        line:           -> { STDIN.each { |l| execute(l.chomp, callable);            $RC.count += 1 } },
+        enumerator:     -> { execute(STDIN.each_line, callable);                     $RC.count += 1 },
+        one_big_string: -> { big_string = STDIN.read; execute(big_string, callable); $RC.count += 1 },
         no_input:       -> { execute(Object.new, callable) }
     }
 
@@ -306,12 +322,13 @@ class Rexe < Struct.new(:input_format, :input_mode, :loads, :output_format, :req
     $RC.source_code   = user_source_code
     $RC.options       = self.to_h
 
+    def $RC.i; count end  # `i` aliases `count` so you can more concisely get the count in your user code
+
     actions[input_mode].() unless self.noop
 
-    if verbose
+    if log_format != :none
       $RC.duration_secs = Time.now - start_time.to_time
-      require 'yaml'
-      STDERR.puts($RC.to_h.to_yaml)
+      STDERR.puts(log_formatter.($RC.to_h))
     end
   end
 end
@@ -319,8 +336,7 @@ end
 
 def input_parser
   if @input_parser.nil?
-    require_spec = parser_and_format_requires[input_format]
-    require require_spec if require_spec
+    require_format_require(input_format)
     @input_parser = input_parsers[input_format]
   end
   @input_parser
@@ -329,14 +345,22 @@ end
 
 def output_formatter
   if @output_formatter.nil?
-    require_spec = parser_and_format_requires[output_format]
-    require require_spec if require_spec
+    require_format_require(output_format)
     @output_formatter = formatters[output_format]
   end
   @output_formatter
 end
 
 
+def log_formatter
+  if @log_formatter.nil?
+    require_format_require(log_format)
+    @log_formatter = formatters[log_format]
+  end
+  @log_formatter
+end
+
+
 # This is needed because the gemspec file loads this file to access Rexe::VERSION
 # and must not have it run at that time:
 called_as_script = (File.basename($0) == File.basename(__FILE__))

data/rexe.gemspec

@@ -51,10 +51,13 @@ Gem::Specification.new do |spec|
       WARNING!
 
       The default rexe input mode was changed from -ms to -mn in version 0.6.0
-      and
-      the -ms (separate string mode) mode name was changed
+
+      The -ms (separate string mode) mode name was changed
       to -ml (line mode) in version 0.9.0.
 
+      The verbose mode boolean switch (-v) was changed to the
+      log format option (-g) in version 0.12.0. 
+
       !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
       HEREDOC

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rexe
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-11 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,19 +94,11 @@ metadata:
   homepage_uri: https://github.com/keithrbennett/rexe
   source_code_uri: https://github.com/keithrbennett/rexe
   changelog_uri: https://github.com/keithrbennett/rexe/blob/master/README.md
-post_install_message: |2+
-
-  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-  WARNING!
-
-  The default rexe input mode was changed from -ms to -mn in version 0.6.0
-  and
-  the -ms (separate string mode) mode name was changed
-  to -ml (line mode) in version 0.9.0.
-
-  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
+post_install_message: "\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\nWARNING!\n\nThe
+  default rexe input mode was changed from -ms to -mn in version 0.6.0\n\nThe -ms
+  (separate string mode) mode name was changed\nto -ml (line mode) in version 0.9.0.\n\nThe
+  verbose mode boolean switch (-v) was changed to the\nlog format option (-g) in version
+  0.12.0. \n\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n"
 rdoc_options: []
 require_paths:
 - lib