shellopts 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f97bd1dadffdc1a8e5eab5635bdb186ddb925bafc2fe60b478c84d3b9590fb63
-  data.tar.gz: 9909d8069a937593e7a583d6fd8db1989f7eb8e321d9c655e2d0f376caeffd24
+  metadata.gz: 710c9651cae2494969fe031b4d8a91bbcebd123c8d395b512bec5b193c50e6ea
+  data.tar.gz: e2a4901ea784ec6331ccd65ef4df58daf04aba44c0c395f736da27eee14f8f12
 SHA512:
-  metadata.gz: 161c50d8cb2dc9abaa91164c3898f57942a6d51fcaadcb83bfd52cb96115548772be5d244d7e620f71751b523fdd5db0ab8a8a8bc76624be40a94d0341ac53c3
-  data.tar.gz: abaa5c58dfc5aaa98a553b4cb582c738a4bcd3649e5681c034a32b550bb583d106e4b0240cb0c5225dc0c8f58b3a32af2bd314d5894209b39b72e26446c6f4e3
+  metadata.gz: ad85e178173ba17e7cfc0b452cc1bcdd50e7c17374885b8aecddd4495e04a5492c14bdecfdd13445738e63c8bfa2434c3f0957ab1e7d803dc18ba42722726761
+  data.tar.gz: be53d32e0fdcbcf4caee01762e5bb5d6b8452ffeaf6ae7f65e9746cf7a222aa65ab38ca8dd4db8de91c6f0507e4fc9df88d30c286e29a83d994d020bae4759a1

data/README.md

@@ -257,8 +257,8 @@ system (eg. disk full) and omits the usage summary
 ```
 
 The methods are defined as instance methods on `ShellOpts::ShellOpts` and as
-class methods on `ShellOpts`. The class methods stores program name and usage
-string in global variables that are reset by `ShellOpts.reset`
+class methods on `ShellOpts`. They can also be included in the global scope by
+`include ShellOpts::Utils`
 
 ## Example
 

data/TODO

@@ -1,5 +1,6 @@
 
 TODO
+  o Consolidate some of the 3 variations of #error and #fail
   o Add a option flag for solitary options (--help) 
   o Make a #to_yaml
   o Make an official dump method for debug

data/lib/shellopts/grammar/command.rb

@@ -19,7 +19,6 @@ module ShellOpts
       attr_reader :commands 
 
       # List of options in declaration order
-      # order
       attr_reader :option_list
 
       # List of commands in declaration order

data/lib/shellopts/utils.rb

@@ -0,0 +1,16 @@
+
+module ShellOpts
+  # Use `include ShellOpts::Utils` to include ShellOpts utility methods in the
+  # global namespace
+  module Utils
+    # Forwards to `ShellOpts.error`
+    def error(*msgs)
+      ::ShellOpts.error(*msgs)
+    end
+
+    # Forwards to `ShellOpts.fail`
+    def fail(*msgs)
+      ::ShellOpts.fail(*msgs)
+    end
+  end
+end

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module Shellopts
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/lib/shellopts.rb

@@ -7,6 +7,9 @@ require 'shellopts/parser.rb'
 # library API consists of the methods {ShellOpts.process}, {ShellOpts.error},
 # and {ShellOpts.fail} and the result class {ShellOpts::ShellOpts}
 #
+# ShellOpts inject the constant PROGRAM into the global scope. It contains the 
+# name of the program
+#
 module ShellOpts
   # Process command line options and arguments.  #process takes a usage string
   # defining the options and the array of command line arguments to be parsed
@@ -76,7 +79,7 @@ module ShellOpts
   #   shellopts.args.each { |arg| ... }
   #   shellopts.error("Something went wrong")
   #
-  def self.process(usage, argv, program_name: File.basename($0), &block)
+  def self.process(usage, argv, program_name: PROGRAM, &block)
     if !block_given?
       ShellOpts.new(usage, argv, program_name: program_name)
     else
@@ -93,15 +96,21 @@ module ShellOpts
     @shellopts = nil
   end
 
-  # Print error message and usage string and exit with status 1. Can only be
-  # called after #process. Forwards to {::ShellOpts#error}
+  # Print error message and usage string and exit with status 1. It use the
+  # current ShellOpts object if defined. This method should be called in
+  # response to user-errors (eg. specifying an illegal option)
   def self.error(*msgs)
-    @shellopts&.error(*msgs) or raise InternalError, "ShellOpts class variable not initialized"
+    program = @shellopts&.program_name || PROGRAM
+    usage = @shellopts&.usage || (defined?(USAGE) && USAGE ? Grammar.compile(PROGRAM, USAGE).usage : nil)
+    emit_and_exit(program, usage, *msgs)
   end
 
-  # Print error message and exit with status 1. Forwards to {::ShellOpts#fail}
+  # Print error message and exit with status 1. It use the current ShellOpts
+  # object if defined. This method should not be called in response to
+  # user-errors but system errors (like disk full)
   def self.fail(*msgs)
-    @shellopts&.fail(*msgs) or raise InternalError, "ShellOpts class variable not initialized"
+    program = @shellopts&.program_name || PROGRAM
+    emit_and_exit(program, nil, *msgs)
   end
 
   # The compilation object
@@ -162,16 +171,13 @@ module ShellOpts
     # should be called in response to user-errors (eg. specifying an illegal
     # option)
     def error(*msgs)
-      $stderr.puts "#{program_name}: #{msgs.join}"
-      $stderr.puts "Usage: #{program_name} #{usage}"
-      exit 1
+      ::ShellOpts.emit_and_exit(program_name, usage, msgs)
     end
 
     # Print error message and exit with status 1. This method should not be
     # called in response to user-errors but system errors (like disk full)
     def fail(*msgs)
-      $stderr.puts "#{program_name}: #{msgs.join}"
-      exit 1
+      ::ShellOpts.emit_and_exit(program_name, nil, msgs)
     end
   end
 
@@ -191,5 +197,12 @@ module ShellOpts
 
 private
   @shellopts = nil
+
+  def self.emit_and_exit(program, usage, *msgs)
+    $stderr.puts "#{program}: #{msgs.join}"
+    $stderr.puts "Usage: #{program} #{usage}" if usage
+    exit 1
+  end
 end
 
+PROGRAM = File.basename($PROGRAM_NAME)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-20 00:00:00.000000000 Z
+date: 2019-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/shellopts/grammar/option.rb
 - lib/shellopts/grammar/program.rb
 - lib/shellopts/parser.rb
+- lib/shellopts/utils.rb
 - lib/shellopts/version.rb
 - shellopts.gemspec
 homepage: http://github.com/clrgit/shellopts