shellopts 2.0.19 → 2.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35b9e7b5699cc1a5637d4c00dd95c74047074f1227b0d05f9a9c8b04e1e2cc8b
-  data.tar.gz: c8deed23c8e6f0b26d080e15d2830edb5e65d1b5f2f821ccd83db7db27d7aefd
+  metadata.gz: d3f9f19d62ccf36d5de39421163eb70e7aa8ae621cee13381d48ce68e7ab593d
+  data.tar.gz: 13351ee8dceceea7c5da573de7c5bd257aa2efd1c4690be760f6ebe1445ca8c9
 SHA512:
-  metadata.gz: 5d3e96ec825ca58c0e653613ab84e2ede3e661737f5699571c81aaf9b2cb1252ea802581e5b981a1757d8a5a750ba998c43730c6d2da7d8228b721b06a45640e
-  data.tar.gz: e64eeac4c3bf784f8ef3a5e3a61c596e262bd23c4ee05857f76138f82ff2180afb72ccd5c2b7ffedc4e6aa2887b10c76e3a80c33e24ceadd20e71513549b5bf0
+  metadata.gz: 4afd636e92e1ff74b45c77399d4dbaba6afaccd441ee528800a727ed5e4db802d481d8dcaaddcd46bdbcd7c28f3b121b35e42b63e44f02d006c557eafda29692
+  data.tar.gz: 7c12cd6d9f0dede5c7931cf82b8e1ff32d4de738c2d3dd42fb5c2f65740ed0804078eb65ca0b951ce28a1095fd9b43289df01501275a5f9c178a965e569aa054

data/TODO

@@ -1,3 +1,19 @@
+
+o Make opts[] point at the main object
+    opts[].subcommand is the direct subcommand of main
+o Make opts be the aggrated set of options in a subcommand
+    opts.subcommand is the concatenated path of subcommands
+o Make opts[:some_command] be the set of options for that subcommand (already done)
+o Sub-command options can overshadow options of outer commands but it is an
+  error to access them using opts. Use opts[] or opts[:some_command] instead
+
+o Add a default argument to extract:
+    def extract(range, *defaults)
+    end
+
+    extract(3..4, 'dbo')
+
+o More strict parsing of option and command lines
 o --option can't be escaped if on the start of a block line?
 o Use require_relative
 o In the following list is a command with a mandatory sub-command

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/program.rb

@@ -84,19 +84,27 @@ module ShellOpts
       }
     end
 
-    # Returns a hash of the given options if defined. Returns all options if no
-    # options are given
+    # Returns a hash from option ident to value
+    #
+    # The value depends on the option type: If it is not repeatable, the value
+    # is the argument or nil if not present (or allowed). If the option is
+    # repeatable and has an argument, the value is an array of the arguments,
+    # if it doesn't have an argument, the value is the number of occurrences
+    #
     def to_h(*keys)
       keys = ::Kernel::Array(keys).flatten
-      if keys.empty?
-        self.to_h(@__grammar__.options.map(&:ident))
-      else
-        keys.map { |key|
-          self.__send__("#{key}?".to_sym) ? [key, self.__send__(key)] : nil
-        }.compact.to_h
-      end
+      __option_values__.select { |key,_| keys.empty? || keys.include?(key) }
     end
 
+    # Like #to_h but present options without arguments have a true value
+    #
+    def to_h?(*keys)
+      keys = ::Kernel::Array(keys).flatten
+      keys = keys.empty? ? __option_values__.keys : keys
+      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:
     #

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.19"
+  VERSION = "2.0.22"
 end

data/lib/shellopts.rb

@@ -382,7 +382,6 @@ module ShellOpts
     end
   end
 
-
   def self.process(spec, argv, quiet: nil, verbose: nil, debug: nil, **opts)
     constrain quiet, String, true, false, nil
     quiet = quiet.nil? ? Message.is_included? || Verbose.is_included? : quiet
@@ -410,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.19
+  version: 2.0.22
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-16 00:00:00.000000000 Z
+date: 2022-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to