shellopts 2.7.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3906747a497d13ee1e7ba9c102184c8b331f8a02333e6a96c2b7c7c9748c6006
-  data.tar.gz: e4b407b8ab49895b7b2e222d59a35fcb88bb3df75449f94bbb797dbb80e5b362
+  metadata.gz: 5c095c6dc48613d922a0e45d567422fa09d3907fb266415b5f37faab5d1d61a1
+  data.tar.gz: 76824b5dd2abfd66d919ddca7ba7d47a219d653c7ed32fb60c0a09382d9d7f88
 SHA512:
-  metadata.gz: 4f008f01dcc0909988aeed3e1e0def4bf9372bd31c5bdad0d3c65efb56a4b841324984ddce8bf59a49a0d16b6375538322c581489bdb64d74866c4797c39aa45
-  data.tar.gz: 44d1fe0700802ef288b5a087edcfb58110cc9b51e56b2282dc70bce8b161efa45f3601866709f317b81e42c47f16fd5379949da74eff76193ae31286e3717443
+  metadata.gz: 4a5b67e387057c0da8146ea4e65b08015a65d4834710c43a6fb42eacccad4981ad74e4760941e0d41e40b1b4f99d80b9d4f11b35d5b7c8f8d5fd048bc20d5a17
+  data.tar.gz: 72f40f34cdea62cd58ed6990f45f037b061853539d6face68e4194827f04a0895c288b12260d0f0640fa8fb3e15727894d173046a774910e7e839774af4b4fcc

data/lib/shellopts/program.rb

@@ -104,7 +104,6 @@ module ShellOpts
       keys.filter_map { |key| __option_values__.key?(key) && [key, self.__send__(key)] }.to_h
     end
 
-
     # Subcommand identifier or nil if not present. #subcommand is often used in
     # case statement to branch out to code that handles the given subcommand:
     #
@@ -123,9 +122,9 @@ module ShellOpts
     # (#<identifier>!) are often used instead of #subcommand! to get the
     # subcommand
     #
-    # Note: Can be overridden by a subcommand declaration (but not an
-    # option), in that case use #__subcommand__! or
-    # ShellOpts.subcommand!(object) instead
+    # Note: Can be overridden by a subcommand declaration (but not an option),
+    # in that case use #__subcommand__! or ShellOpts.subcommand!(object)
+    # instead
     #
     def subcommand!() __subcommand__! end
 

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.7.0"
+  VERSION = "2.9.0"
 end

data/lib/shellopts.rb

@@ -268,14 +268,14 @@ module ShellOpts
     #
     # #error is supposed to be used when the user made an error and the usage
     # is written to help correcting the error
-    def error(message)
+    def error(message, exit: 1)
       raise ShellOpts::Error.new(message) if ::ShellOpts.exception
       $stderr.puts "#{name}: #{message}"
       saved = $stdout
       begin
         $stdout = $stderr
         Formatter.usage(grammar)
-        exit 1
+        ::ShellOpts.handle_exit(exit)
       ensure
         $stdout = saved
       end
@@ -286,10 +286,10 @@ module ShellOpts
     # #failure doesn't print the program usage because is supposed to be used
     # when the user specified the correct arguments but something else went
     # wrong during processing
-    def failure(message)
+    def failure(message, exit: 1)
       raise ShellOpts::Failure.new(message) if ::ShellOpts.exception
       $stderr.puts "#{name}: #{message}"
-      exit 1
+      ::ShellOpts.handle_exit(exit)
     end
 
     # Print usage
@@ -403,7 +403,11 @@ module ShellOpts
   # The full path to the program. This is initialized when shellopts.rb is
   # loaded so it is not affected by later changes of directory
   @@PROGRAM_PATH = File.absolute_path($PROGRAM_NAME)
-  def self.path = @@PROGRAM_PATH
+  def self.program_path = @@PROGRAM_PATH
+
+  # The full path to the user's current directory when the program was called
+  @@ENVIRONMENT_PATH = File.absolute_path(Dir.getwd)
+  def self.environment_path = @@ENVIRONMENT_PATH
 
   def self.process(spec, argv, silent: nil, quiet: nil, verbose: nil, debug: nil, **opts)
     constrain silent, String, true, false, nil
@@ -441,18 +445,18 @@ module ShellOpts
   def self.verbose?(level = 1) level <= instance.program.__verbose__ end
   def self.debug?() instance.program.__debug__ end
 
-  def self.error(message)
+  def self.error(message, exit: 1)
     raise Error.new(message) if exception
-    instance.error(message) if instance? # Never returns
+    instance.error(message, exit: exit) if instance? # Never returns
     $stderr.puts "#{File.basename($PROGRAM_NAME)}: #{message}"
-    exit 1
+    handle_exit(exit)
   end
 
-  def self.failure(message)
+  def self.failure(message, exit: 1)
     raise Error.new(message) if exception
-    instance.failure(message) if instance?
+    instance.failure(message, exit: exit) if instance?
     $stderr.puts "#{File.basename($PROGRAM_NAME)}: #{message}"
-    exit 1
+    handle_exit(exit)
   end
 
   # Emit a message on standard error. The --silent option suppresses these messages
@@ -490,6 +494,14 @@ module ShellOpts
     end
   end
 
+private
+  # Exit program with the given status if an integer and status 1 if not. Do
+  # not exit if status is falsy
+  def self.handle_exit(value)
+    exit(value.is_a?(Integer) ? value : 1) if value
+  end
+
+public
   module Message
     @is_included = false
     def self.is_included?() @is_included end

metadata

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