shellopts 2.0.11 → 2.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 485e81c58a890240d2a77e24a5f3a7a291551da968f395f3aaa4f5b2dac3cc9b
-  data.tar.gz: 2d6c92ca01ce1207f6311cf9b0e9bab3e555e309142ba6916d589396f215afb8
+  metadata.gz: 2101f633ad0e166982b108842a83f91b3d216869f9fe3d6ac7ecea5256f2b437
+  data.tar.gz: da77f695902e5e921e598dd8d1327af4ce07ffe7b9cfadb88fe1b0889b95b4e0
 SHA512:
-  metadata.gz: 31f3801b98585bed378ff77ae6632d18951ef37a49b3cfde843df9718dc5b46da40e777dff3f7b29e01bf8b32f2ebe0e1e7ab76ddb66744a461acf0061f75b1f
-  data.tar.gz: d72bcf1d58e9afdf4f92477af1f2824e01031a46b4cacf5283878ce1045ad91dd930c1c1a15cd588a2552a4ad90fe5ac3add6019b50e099693aa184b7747153f
+  metadata.gz: 36dbd8d33d74a5b985463df5fb514501c2881881bdd68f1fa479c7ecac3de2bc4a2bc3a713acfe735d3e53ccdde10f5abf5ecc066d370fa8e795a77e290f9988
+  data.tar.gz: b364c8d00de2f7ece58d3c721ef3d4f40a892a232aa39a0c94df2b7ef37cf86e78c99df25c07e8802b0e48640ec928c4157bd89a2cb0851955484ed5957733ca

data/TODO

@@ -1,4 +1,24 @@
 
+o In the following list is a command with a mandatory sub-command
+
+  list.tables!
+  list.uuids!
+
+  It should be rendered as
+    list tables|uuids
+
+  and not as
+    list tables
+    list uuids
+
+  and not as 
+    list [tables|uuids]
+
+
+o Replace -h with -? when -h is specified by the user (eg. as a shorthand for --host)
+o Limit text width to -10 chars of what it is today (same as stackexchange width in characters)
+o Fix formatting error in long arguments (see ms2pg)
+o Macro that can be used in the SPEC for the program name (eg. <PROGRAM>)
 o Ignore all text after ' # ' (doesn't conflict with option flag)
 o Command aliases
 o Add user-defined setions

data/lib/shellopts/program.rb

@@ -45,12 +45,12 @@ module ShellOpts
 
     # These names can't be used as option or command names
     RESERVED_OPTION_NAMES = %w(
-        is_a instance_eval instance_exec method_missing singleton_method_added
+        is_a to_h instance_eval instance_exec method_missing singleton_method_added
         singleton_method_removed singleton_method_undefined
     )
 
-    # These methods can be overridden by an option or a command (the value is not used -
-    # this is just for informational purposes)
+    # These methods can be overridden by an option or a command (this constant
+    # is not used - it is just for informational purposes)
     OVERRIDEABLE_METHOD_NAMES = %w(
         subcommand subcommand! supercommand!
     )
@@ -96,6 +96,19 @@ module ShellOpts
       end
     end
       
+    # Returns a hash of the given options if defined. Returns all options if no
+    # options are given
+    def to_h(*keys)
+      keys = ::Kernel::Array(keys).flatten
+      if keys.empty?
+        @__option_values__
+      else
+        keys.map { |key|
+          @__option_values__.key?(key) ? [key, @__option_values__[key]] : nil
+        }.compact.to_h
+      end
+    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:
     #
@@ -181,33 +194,36 @@ module ShellOpts
 
     def __define_option_methods__
       @__grammar__.options.each { |opt|
-        if opt.argument? || opt.repeatable?
-          if opt.optional?
-            self.instance_eval %(
-              def #{opt.attr}(default = nil)
-                if @__option_values__.key?(:#{opt.attr}) 
-                  @__option_values__[:#{opt.attr}]
-                else
-                  default
-                end
+        if opt.argument?
+          self.instance_eval %(
+            def #{opt.attr}(default = nil)
+              if @__option_values__.key?(:#{opt.attr}) 
+                @__option_values__[:#{opt.attr}]
+              else
+                default
               end
-            )
-          elsif !opt.argument? # Repeatable w/o argument
-            self.instance_eval %(
-              def #{opt.attr}(default = []) 
-                if @__option_values__.key?(:#{opt.attr})
-                  @__option_values__[:#{opt.attr}]
-                else
-                  default
-                end
+            end
+          )
+
+        elsif opt.repeatable?
+          self.instance_eval %(
+            def #{opt.attr}(default = 0) 
+              if default > 0 && @__option_values__[:#{opt.attr}] == 0
+                default
+              else
+                @__option_values__[:#{opt.attr}]
               end
-            )
-          else
-            self.instance_eval("def #{opt.attr}() @__option_values__[:#{opt.attr}] end")
-          end
+            end
+          )
+        else
+          self.instance_eval("def #{opt.attr}() @__option_values__[:#{opt.attr}] end")
+        end
+
+        if opt.argument? || opt.repeatable?
           self.instance_eval("def #{opt.attr}=(value) @__option_values__[:#{opt.attr}] = value end")
           @__option_values__[opt.attr] = 0 if !opt.argument?
         end
+
         self.instance_eval("def #{opt.attr}?() @__option_values__.key?(:#{opt.attr}) end")
       }
 

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.11"
+  VERSION = "2.0.14"
 end

data/lib/shellopts.rb

@@ -192,23 +192,23 @@ 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(subject = nil, message)
-      saved = $stdout
-      $stdout = $stderr
       $stderr.puts "#{name}: #{message}"
-      Formatter.usage(grammar)
-      exit 1
-    ensure
-      $stdout = saved
+      saved = $stdout
+      begin
+        $stdout = $stderr
+        Formatter.usage(grammar)
+        exit 1
+      ensure
+        $stdout = saved
+      end
     end
 
     # Write error message to standard error and terminate program with status 1
     #
-    # #failure is supposed to be used the used specified the correct arguments
-    # but something went wrong during processing. Since the used didn't cause
-    # the problem, only the error message is written
-    #
+    # #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)
       $stderr.puts "#{name}: #{message}"
       exit 1
@@ -222,7 +222,6 @@ module ShellOpts
 
     # Print help for the given subject or the full documentation if +subject+
     # is nil. Clears the screen beforehand if :clear is true
-    #
     def help(subject = nil, clear: true)
       node = (subject ? @grammar[subject] : @grammar) or
           raise ArgumentError, "No such command: '#{subject&.sub(".", " ")}'"
@@ -333,7 +332,17 @@ module ShellOpts
   def self.instance=(instance) @instance = instance end
   def self.shellopts() instance end
 
-  forward_self_to :instance, :error, :failure
+  def self.error(subject = nil, message)
+    instance.error(subject, message) if instance? # Never returns
+    $stderr.puts "#{File.basename($PROGRAM_NAME)}: #{message}"
+    exit 1
+  end
+
+  def self.failure(message)
+    instance.failure(message) if instance?
+    $stderr.puts "#{File.basename($PROGRAM_NAME)}: #{message}"
+    exit 1
+  end
 
   # The Include module brings the reporting methods into the namespace when
   # included

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.11
+  version: 2.0.14
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to