rexe 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '036597bf795aea3d05206bec898b2688dc1b75cf51c2dec772574a86734f56ef'
-  data.tar.gz: 6d404ef04a3fdcf8913e654da1cb71e18191f3796e70f0da2dc249f467f88f5a
+  metadata.gz: 7d4ad1a24022659314b09d706db797d17702d6b879b4b52d0d4068b7fef4ef9c
+  data.tar.gz: 04b6759f33142d6e738bd12ce0bad997385f77c02c7e0537ea5f3c609df8ef7b
 SHA512:
-  metadata.gz: 6002bbc565faf3861ec08752b22160453b2b35dbab126e4e7d53b9e4e7b68da49545fb615f48eb4a8bddc087943cf33572e36521b38d1e0fe12a17812e0ea4a8
-  data.tar.gz: 63cfec0e25406005aa3c030376755333842f294530ee96fc7d9344460f9b7efbd4c7380eeffed689905bf2331c836b8935e297278237cb8721ba19e0a19c81e9
+  metadata.gz: 7a51a900c81e65878e13a795708c35e57d41f7226300932bea17105707aa03f9b5246e386ecdb7e3d437361614ccbdbaab63b7fb1b4c6bc59ee28bbd33dcd18a
+  data.tar.gz: cc4acaa0817872e3e9ec7960246c721152c7311708abd8bed7bf9e206332c8c6bf579d876c0240d2a98a1780eaade154fd7412b3c3e5fa28d5f8383308ea0323

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## rexe -- Ruby Command Line Executor/Filter
 
+### 1.7.0
+
+* Replace amazing_print dependency with awesome_print.
+* Effectively disable `try` method, i.e. print stack trace on errors.
+* In `try` method, rescue StandardError instead of Exception.
+
+
+### 1.6.0
+
+* Replace calls to `exists?`, which has been removed, with `exist?`.
+* Add warning messages to stderr for unspecified options (input/output format, input mode), 
+  but only when logging is disabled.
+
 ### 1.5.1
 
 * Change string concatenations using << to creation of new strings with += to accommodate default-frozen strings.

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.5.0 -- https://github.com/keithrbennett/rexe
+rexe -- Ruby Command Line Executor/Filter -- v1.7.0 -- https://github.com/keithrbennett/rexe
 
 Executes Ruby code on the command line, 
 optionally automating management of standard input and standard output,
@@ -135,7 +135,7 @@ 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 amazing_print,yaml"`)
+(e.g. `export REXE_OPTIONS="-r awesome_print,yaml"`)
 ```
 
 ### Simplifying the Rexe Invocation
@@ -239,11 +239,11 @@ $ echo $EUR_RATES_JSON | rexe -gy -ij -mb -oa -n self
   :input_format: :json
   :input_mode: :one_big_string
   :loads: []
-  :output_format: :amazing_print
-  :output_format_tty: :amazing_print
-  :output_format_block: :amazing_print
+  :output_format: :awesome_print
+  :output_format_tty: :awesome_print
+  :output_format_block: :awesome_print
   :requires:
-  - amazing_print
+  - awesome_print
   - json
   - yaml
   :log_format: :yaml
@@ -741,7 +741,7 @@ For consistency with the `ruby` interpreter, rexe supports requires with the `-r
 
 ```bash
                                  vvvvvvvvvvvvvvvvvv
-$ echo $EUR_RATES_JSON | rexe -r json,amazing_print 'ap JSON.parse(STDIN.read)'
+$ echo $EUR_RATES_JSON | rexe -r json,awesome_print 'ap JSON.parse(STDIN.read)'
                                  ^^^^^^^^^^^^^^^^^^
 ```
 

data/exe/rexe

@@ -15,24 +15,26 @@ require 'shellwords'
 
 class Rexe
 
-  VERSION = '1.5.1'
+  VERSION = '1.7.0'
 
   PROJECT_URL = 'https://github.com/keithrbennett/rexe'
 
 
   module Helpers
 
-    # Try executing code. If error raised, print message (but not stack trace) & exit -1.
+    # Originally the entire run was wrapped in this rescue to make error output more concise.
+    # However, I am concerned that hiding the stack trace will make it harder to debug,
+    # and be worse than the ugliness of showing it when it is not needed. So, I am commenting
+    # out the rescue for now, and will see how it goes. If you have any opinions on this,
+    # please let me know at https://github.com/keithrbennett/rexe/issues/5 .
+    #
+    # (disabled) Try executing code. If error raised, print message (but not stack trace) & exit -1.
     def try
-      begin
-        yield
-      rescue Exception => e
-        unless e.class == SystemExit
-          $stderr.puts("rexe: #{e}")
-          $stderr.puts("Use the -h option to get help.")
-          exit(-1)
-        end
-      end
+      yield
+    # rescue StandardError => e
+    #   $stderr.puts("rexe ERROR: #{e}")
+    #   $stderr.puts('Use the -h option to get help.')
+    #   exit(-1)
     end
   end
 
@@ -57,7 +59,7 @@ class Rexe
 
 
     def clear
-      self.input_filespec = nil
+      self.input_filespec      = nil
       self.input_format        = :none
       self.input_mode          = :none
       self.output_format       = :none
@@ -71,9 +73,6 @@ class Rexe
   end
 
 
-
-
-
   class Lookups
     def input_modes
       @input_modes ||= {
@@ -107,7 +106,7 @@ class Rexe
 
     def output_formats
       @output_formats ||= {
-          'a' => :amazing_print,
+          'a' => :awesome_print,
           'i' => :inspect,
           'j' => :json,
           'J' => :pretty_json,
@@ -123,7 +122,7 @@ class Rexe
 
     def formatters
       @formatters ||=  {
-          amazing_print: ->(obj)  { obj.ai + "\n" },
+          awesome_print: ->(obj)  { obj.ai + "\n" },
           inspect:       ->(obj)  { obj.inspect + "\n" },
           json:          ->(obj)  { obj.to_json },
           marshal:       ->(obj)  { Marshal.dump(obj) },
@@ -141,7 +140,7 @@ class Rexe
       @format_requires ||= {
           json:          'json',
           pretty_json:   'json',
-          amazing_print: 'amazing_print',
+          awesome_print: 'awesome_print',
           pretty_print:  'pp',
           yaml:          'yaml'
       }
@@ -149,7 +148,6 @@ class Rexe
   end
 
 
-
   class CommandLineParser
 
     include Helpers
@@ -245,9 +243,9 @@ class Rexe
       
           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 amazing_print,yaml"`)
+          (e.g. `export REXE_OPTIONS="-r awesome_print,yaml"`)
 
-      HEREDOC
+    HEREDOC
 
         @help_text.freeze
       end
@@ -261,7 +259,7 @@ class Rexe
       extension = File.extname(filespec).downcase
       if extension == '.json'
         :json
-      elsif extension == '.yml' || extension == '.yaml'
+      elsif %w{.yml .yaml}.include?(extension)
         :yaml
       else
         :none
@@ -289,9 +287,32 @@ class Rexe
 
       prepend_environment_options
 
+      input_mode_specified = false
+      input_format_specified = false
+      output_format_specified = false
+
+      report_unspecified_options = -> do
+        messages = []
+
+        unless input_mode_specified
+          messages << 'Input mode not specified. Defaulting to -mn (none).'
+        end
+        unless input_format_specified
+          messages << 'Input format not specified. Defaulting to -in (none).'
+        end
+        unless output_format_specified
+          messages << 'Output mode not specified. Defaulting to -on (none).'
+        end
+
+        if messages.any?
+          $stderr.puts(messages.join("\n"))
+          $stderr.puts("See help (run with -h) for more information.\n\n")
+        end
+      end
+
       OptionParser.new do |parser|
 
-        parser.on('-c', '--clear_options', "Clear all previous command line options") do |v|
+        parser.on('-c', '--clear_options', 'Clear all previous command line options') do |v|
           options.clear
         end
 
@@ -302,8 +323,10 @@ class Rexe
           end
           options.input_filespec = v
           options.input_format = autodetect_file_format(v)
+          input_format_specified = true
           if [:json, :yaml].include?(options.input_format)
             options.input_mode = :one_big_string
+            input_mode_specified = true
           end
         end
 
@@ -314,7 +337,7 @@ class Rexe
           end
         end
 
-        parser.on("-h", "--help", "Show help") do |_help_requested|
+        parser.on("-h", "--help", 'Show help') do |_help_requested|
           puts help_text
           exit
         end
@@ -326,6 +349,7 @@ class Rexe
           if options.input_format.nil?
             raise("Input mode was '#{v}' but must be one of #{lookups.input_formats.keys}.")
           end
+          input_format_specified = true
         end
 
         parser.on('-l', '--load RUBY_FILE(S)', 'Ruby file(s) to load, comma separated, or ! to clear') do |v|
@@ -335,7 +359,7 @@ class Rexe
             loadfiles = v.split(',').map(&:strip).map { |s| File.expand_path(s) }
             removes, adds = loadfiles.partition { |filespec| filespec[0] == '-' }
 
-            existent, nonexistent = adds.partition { |filespec| File.exists?(filespec) }
+            existent, nonexistent = adds.partition { |filespec| File.exist?(filespec) }
             if nonexistent.any?
               raise("\nDid not find the following files to load: #{nonexistent}\n\n")
             else
@@ -353,6 +377,7 @@ class Rexe
           if options.input_mode.nil?
             raise("Input mode was '#{v}' but must be one of #{lookups.input_modes.keys}.")
           end
+          input_mode_specified = true
         end
 
         # See https://stackoverflow.com/questions/54576873/ruby-optionparser-short-code-for-boolean-option
@@ -371,6 +396,7 @@ class Rexe
           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
+          output_format_specified = true
         end
 
         parser.on('-r', '--require REQUIRE(S)',
@@ -413,6 +439,7 @@ class Rexe
       options.requires = options.requires.sort.uniq
       options.loads.uniq!
 
+      report_unspecified_options.() if options.log_format == :none
       options
 
     end
@@ -436,7 +463,7 @@ class Rexe
 
     private def load_global_config_if_exists
       filespec = File.join(Dir.home, '.rexerc')
-      load(filespec) if File.exists?(filespec)
+      load(filespec) if File.exist?(filespec)
     end
 
 
@@ -508,17 +535,15 @@ class Rexe
     # Bypasses Bundler's restriction on loading gems
     # (see https://stackoverflow.com/questions/55144094/bundler-doesnt-permit-using-gems-in-project-home-directory)
     private def require!(the_require)
-      begin
+      require the_require
+    rescue LoadError => error
+      gem_path = `gem which #{the_require}`
+      if gem_path.chomp.strip.empty?
+        raise error # re-raise the error, can't fix it
+      else
+        load_dir = File.dirname(gem_path)
+        $LOAD_PATH += load_dir
         require the_require
-      rescue LoadError => error
-        gem_path = `gem which #{the_require}`
-        if gem_path.chomp.strip.empty?
-          raise error # re-raise the error, can't fix it
-        else
-          load_dir = File.dirname(gem_path)
-          $LOAD_PATH += load_dir
-          require the_require
-        end
       end
     end
 
@@ -566,4 +591,4 @@ def bundler_run(&block)
 end
 
 
-bundler_run { Rexe::Main.new.call }
+bundler_run { Rexe::Main.new.call }

data/rexe.gemspec

@@ -3,6 +3,9 @@ Gem::Specification.new do |spec|
   spec.name          = "rexe"
 
   spec.version       = -> do
+    # This is a bit of a kludge. If there is a commented out VERSION line preceding the active line,
+    # this will read the commented line.
+    # TODO: Ignore comment lines.
     rexe_file = File.join(File.dirname(__FILE__), 'exe', 'rexe')
     version_line = File.readlines(rexe_file).grep(/\s*VERSION\s*=\s*'/).first.chomp
     version_line.match(/'(.+)'/)[0].gsub("'", '')
@@ -38,11 +41,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "amazing_print"
+  spec.add_dependency "awesome_print"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "os"
   spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
 
+  # Remove this message (added November 2023) later (maybe July 2024).
+  spec.post_install_message = <<~MESSAGE
+    Starting with v1.7.0, awesome_print is now used instead of amazing_print 
+    for fancy human readable output.
+  MESSAGE
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rexe
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Keith Bennett
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: amazing_print
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 description: Ruby Command Line Executor
 email:
 - keithrbennett@gmail.com
@@ -110,7 +110,8 @@ 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: 
+post_install_message: "Starting with v1.7.0, awesome_print is now used instead of
+  amazing_print \nfor fancy human readable output.\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: Ruby Command Line Executor
 test_files: []