shellopts 2.0.20 → 2.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e0ce72f27c72eec2087bee9296378fc0d84fc1124f830af27f21340cefffcc
-  data.tar.gz: 6c3b2363c1ca392b0950c792c48e353181f352ca22bfe16e7c42490248511b29
+  metadata.gz: 48ea51e0cf39fea203412215192cb9328dd9fb9dbf9f0db345948e8692ff0669
+  data.tar.gz: fc529055f34445a55ef2a078b60a618dba9b715223e2dfc5382a7440ea5d0aa6
 SHA512:
-  metadata.gz: dcc6e2271a451f494e007c78e9054c49bbb6f65f0f0fcf5be07158488157782c8216fc0f6fce7e4c25dda6bf0e39ac8ae2096f733cb4af7c4b1360b28a978129
-  data.tar.gz: e1d60f792447e5884f2ad939fbf408d5c053ef413328e2e2a42a082e34e9672537d8d64916fbc136f11797ac2c87894c148939d4feac9cc43489d3c66faa538d
+  metadata.gz: 1b12355e432018020308e1772d81c7ca8058487e5d013ed33ff1168283dc2335afbe06d456bf5372ac349cfb3b54273f913aba80f7979b8cc11935b756c6eb28
+  data.tar.gz: c48a2ba4c201eef6e3fcde96abbf3f1625bb82548c7bab096d9f27d498bab7c8094503284919d42c5b4440ae453fa598d1771450c5e64f2b2b2845b84cfafbc9

data/lib/shellopts/formatter.rb

@@ -30,8 +30,8 @@ module ShellOpts
     class Command
       using Ext::Array::Wrap
 
-      def puts_usage(bol: false)
-        width = [Formatter.rest, Formatter::USAGE_MAX_WIDTH].min
+      def puts_usage(bol: false, max_width: Formatter::USAGE_MAX_WIDTH)
+        width = [Formatter.rest, max_width].min
         if descrs.size == 0
           print (lead = Formatter.command_prefix || "")
           indent(lead.size, ' ', bol: bol && lead == "") { 
@@ -41,7 +41,7 @@ module ShellOpts
           lead = Formatter.command_prefix || ""
           descrs.each { |descr|
             print lead
-            puts render(:single, width, args: [descr.text]) 
+            puts render(:multi, width, args: descr.text.split(' ')) 
           } 
         end
       end
@@ -58,7 +58,7 @@ module ShellOpts
         end
 
         puts "Usage"
-        indent { puts_usage(bol: true) }
+        indent { puts_usage(bol: true, max_width: Formatter::HELP_MAX_WIDTH) }
 
         if options.any?
           puts
@@ -112,14 +112,13 @@ module ShellOpts
         puts
 
         puts Ansi.bold "USAGE"
-        indent { puts_usage(bol: true) }
+        indent { puts_usage(bol: true, max_width: Formatter::HELP_MAX_WIDTH) }
 
         section = {
           Paragraph => "DESCRIPTION",
           OptionGroup => "OPTION",
           Command => "COMMAND"
         }
-
         seen_sections = {}
         newline = false # True if a newline should be printed before child 
         indent {
@@ -173,7 +172,10 @@ module ShellOpts
     end
 
     module WrappedNode
-      def puts_descr(width = Formatter.rest) puts lines(width) end
+      def puts_descr
+        width = [Formatter.rest, Formatter::HELP_MAX_WIDTH].min
+        puts lines(width) 
+      end
     end
 
     class Code
@@ -217,6 +219,9 @@ module ShellOpts
     # Indent to use in help output
     HELP_INDENT = 4
 
+    # Max. width of help text (not including indent)
+    HELP_MAX_WIDTH = 85 
+
     # Command prefix when subject is a sub-command
     def self.command_prefix() @command_prefix end
 

data/lib/shellopts/renderer.rb

@@ -15,9 +15,9 @@ require 'terminfo'
 #
 # Command rendering
 #   cmd --all --beta [cmd1|cmd2] ARG1 ARG2    # Single-line formats (:single)
-#   cmd --all --beta [cmd1|cmd2] ARGS...     
+#   cmd --all --beta [cmd1|cmd2] ARGS...      # Not used
 #   cmd -a -b [cmd1|cmd2] ARG1 ARG2
-#   cmd -a -b [cmd1|cmd2] ARGS...
+#   cmd -a -b [cmd1|cmd2] ARGS...             # Not used
 #
 #   cmd -a -b [cmd1|cmd2] ARG1 ARG2           # One line for each argument description (:enum)
 #   cmd -a -b [cmd1|cmd2] ARG3 ARG4           # (used in the USAGE section)
@@ -108,7 +108,7 @@ module ShellOpts
       def get_args(args: nil)
         case descrs.size
           when 0; []
-          when 1; [descrs.first.text]
+          when 1; descrs.first.text.split(' ')
           else [DESCRS_ABBR]
         end
       end
@@ -120,6 +120,7 @@ module ShellOpts
       end
 
       # Force one line. Compact options, commands, arguments if needed
+      #
       def render_single(width, args: nil)
         long_options = options.map { |option| option.render(:long) }
         short_options = options.map { |option| option.render(:short) }
@@ -164,32 +165,30 @@ module ShellOpts
       def render_multi(width, args: nil)
         long_options = options.map { |option| option.render(:long) }
         short_options = options.map { |option| option.render(:short) }
-        short_commands = commands.empty? ? [] : ["[#{commands.map(&:name).join("|")}]"]
-        compact_commands = [COMMANDS_ABBR]
+        compact_options = options.empty? ? [] : [OPTIONS_ABBR]
+
+        # Only compact commands if they can't fit on one line
+        if commands.empty?
+          use_commands = []
+        else
+          short_command = "[#{commands.map(&:name).join("|")}]"
+          use_commands = [short_command.size > width ? COMMANDS_ABBR : short_command]
+        end
 
         args ||= get_args
 
         # On one line
-        words = [name] + long_options + short_commands + args
+        words = [name] + long_options + use_commands + args
         return [words.join(" ")] if pass?(words, width)
-        words = [name] + short_options + short_commands + args
+        words = [name] + short_options + use_commands + args
+        return [words.join(" ")] if pass?(words, width)
+        words = [name] + compact_options + use_commands + args
         return [words.join(" ")] if pass?(words, width)
 
         # On multiple lines
         lead = name + " "
-        options = long_options.wrap(width - lead.size)
-        options = [lead + options[0]] + indent_lines(lead.size, options[1..-1])
-
-        begin
-          words = short_commands + args
-          break if pass?(words, width)
-          words = compact_commands + args
-          break if pass?(words, width)
-          words = compact_commands + [DESCRS_ABBR]
-        end while false
-
-        cmdargs = words.empty? ? [] : [words.join(" ")]
-        options + indent_lines(lead.size, cmdargs)
+        words = (long_options + use_commands + args).wrap(width - lead.size)
+        lines = [lead + words[0]] + indent_lines(lead.size, words[1..-1])
       end
 
     protected

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.20"
+  VERSION = "2.0.23"
 end

data/lib/shellopts.rb

@@ -140,7 +140,7 @@ module ShellOpts
         float: true,
 
         # Let exceptions through
-        exceptions: false
+        exception: false
       )
         
       @name = name || File.basename($PROGRAM_NAME)
@@ -409,8 +409,7 @@ module ShellOpts
   end
 
   def self.notice(message)
-    $stderr.puts "#{instance.program.__grammar__.name}: #{message}" \
-        if !instance.quiet || !instance.program.quiet?
+    $stderr.puts message if !instance.quiet || !instance.program.quiet?
   end
 
   def self.mesg(message)

metadata

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