shellopts 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 943b9d0c44ba0291937be24cbc79d0155dfc22ac788c69a76639850d78af3303
-  data.tar.gz: f38e038f613c577b06e9d2facc6096b39eb18f28266ba8c58a8280adcf75fe47
+  metadata.gz: 4a081efe12e3a4e2f4b38eab4d2f6776c5dc3c748fb06178a4b42dbbba4e9612
+  data.tar.gz: 27a8d76c4de24c440bd330aa84d2e17014456c927af3c4a12807573df798c01a
 SHA512:
-  metadata.gz: 42cc6102c0c66dcffda0b03f9c584c32abc0e62a65dbe79e1389753b74af11f189e27a456e79fb2cb082595622ddbce0840dd22419204e276a48134ac8afd610
-  data.tar.gz: 6a3b2e35718a5ee1f52e5d56a50ea067da90fef35a4ac3322738e24d5ba80f4aba4ac4a692caace4bb094ccfb84432e9211fef2b15dfef2e194a95569ca80686
+  metadata.gz: 4f21b1f020dd04219272d5772cf0483b88c108af9991450e2532fcdab5322635a80a1cbac512c284358d10f271c03b4adef65ffb379d3df8a1d6635b9ca9f518
+  data.tar.gz: e88c6c0abcb49a7ba6568aa66c62267a63b92cfb9969387522a52b045fc34d4121cddb4b8c11ffe68d8ed3f13f925391e393e5b4ac292732696de019f7ed4217

data/README.md

@@ -275,20 +275,24 @@ class methods on `ShellOpts`. They can also be included in the global scope by
 #### Usage string
 
 The error handling methods prints a prettified version of the usage string
-given to `ShellOpts.parse`. It can be overridden by assigning to
-`ShellOpts.usage`. You'll often assign to the usage string when it needs to be
-split over several lines:
+given to `ShellOpts.parse`. The usage string can be overridden by assigning to
+`ShellOpts.usage`. A typical use case is when you want to split the usage
+description over multiple lines:
 
 ```ruby
 
 USAGE="long-and-complex-usage-string"
-ShellOpts.usage = %(
+ShellOpts.usage = <<~EOD
   usage explanation
   split over
   multiple lines
-)
+EOD
 ```
 
+Note that this only affects the module-level `ShellOpts.error` method and not
+object-level `ShellOpts::ShellOpts#error` method. This is considered a bug and
+will fixed at some point
+
 ## Example
 
 The rm(1) command could be implemented like this

data/lib/shellopts.rb

@@ -19,7 +19,7 @@ module ShellOpts
 
   # Prettified usage string used by #error and #fail. Default is +usage+ of
   # the current +ShellOpts::ShellOpts+ object
-  def self.usage() @usage ||= @shellopts&.usage end
+  def self.usage() @usage || @shellopts&.usage end
 
   # Set the usage string
   def self.usage=(usage) @usage = usage end
@@ -122,7 +122,7 @@ module ShellOpts
   def self.error(*msgs)
     program = @shellopts&.program_name || PROGRAM
     usage_string = usage || (defined?(USAGE) && USAGE ? Grammar.compile(PROGRAM, USAGE).usage : nil)
-    emit_and_exit(program, usage_string, *msgs)
+    emit_and_exit(program, @usage.nil?, usage_string, *msgs)
   end
 
   # Print error message and exit with status 1. It use the current ShellOpts
@@ -130,7 +130,7 @@ module ShellOpts
   # user-errors but system errors (like disk full)
   def self.fail(*msgs)
     program = @shellopts&.program_name || PROGRAM
-    emit_and_exit(program, nil, *msgs)
+    emit_and_exit(program, false, nil, *msgs)
   end
 
   # The compilation object
@@ -191,13 +191,13 @@ module ShellOpts
     # should be called in response to user-errors (eg. specifying an illegal
     # option)
     def error(*msgs)
-      ::ShellOpts.emit_and_exit(program_name, usage, msgs)
+      ::ShellOpts.emit_and_exit(program_name, true, 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)
-      ::ShellOpts.emit_and_exit(program_name, nil, msgs)
+      ::ShellOpts.emit_and_exit(program_name, false, nil, msgs)
     end
   end
 
@@ -218,9 +218,13 @@ module ShellOpts
 private
   @shellopts = nil
 
-  def self.emit_and_exit(program, usage, *msgs)
+  def self.emit_and_exit(program, use_usage, usage, *msgs)
     $stderr.puts "#{program}: #{msgs.join}"
-    $stderr.puts "Usage: #{program} #{usage}" if usage
+    if use_usage
+      $stderr.puts "Usage: #{program} #{usage}" if usage
+    else
+      $stderr.puts usage if usage
+    end
     exit 1
   end
 end

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module Shellopts
-  VERSION = "0.9.6"
+  VERSION = "0.9.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Claus Rasmussen