shellopts 2.4.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4620f77a96e0e880d03301d91100824186c02ec20b68ffa22ff7032bb3b269d2
-  data.tar.gz: 628d2c0653ac9d565a860bb5941bc1ca9cf4c13c6d5709e78b355d4183c4d48b
+  metadata.gz: dc8c49d6d58b38a3fdff578630ef13abe8f3c6c5939cf5ff8098198eb8a17fbe
+  data.tar.gz: 181c71564cd5a755bc3e17a19652748b8a276c2cd910a25c1f8d3d39bd6d27c6
 SHA512:
-  metadata.gz: 691e8376f9b28bfdce08cbaf64fb2cf871d09417992433f4e48b77288e1b5ccf2cc049328607e8b94e35222e631fd29c01b96bb71602bc053ab4ce1ab1b435db
-  data.tar.gz: 44fe34f706f91a8cee7df43a48032a97ed31fd315e04edf7c5f6a2842a61bcb010663fc63ad78da38607342b90d8617c266f0b9e56e2c70fa6d3c7befcf9f10d
+  metadata.gz: c6fb75cc8baf4738276d25ebddb0dd7827ff816cd124486e5ac681f3fe2d9f80aee1bd9bc2d409eec4e65d476d897c481505f95ca60eb27b70259aac548657b1
+  data.tar.gz: ef3e4129aea6baab3b683b25c51bd77d0df222c0cfb18effc0b26e9d8497e66fc2735c32e53e1b67030030824e78bc4fe59c7fd8f17d6e0c8daffb31949f9434

data/README.md

@@ -74,11 +74,11 @@ to check presence and return an optional argument. Given the options "--alpha
 
 ```ruby
   # Returns true if the option is present and false otherwise
-  opts.alpha?()     
+  opts.alpha?()
   opts.beta?()
 
   # Returns the argument of the beta option or nil if missing
-  opts.beta()       
+  opts.beta()
 ```
 
 Given the commands "cmd1! cmd2!" the following methods are available:
@@ -87,7 +87,7 @@ Given the commands "cmd1! cmd2!" the following methods are available:
   # Returns the sub-command object or nil if not present
   opts.cmd1!
   opts.cmd2!
-  
+
   opts.subcommand!  # Returns the sub-command object or nil if not present
   opts.subcommand   # Returns the sub-command's identifier (eg. :cmd1!)
 ```
@@ -96,7 +96,7 @@ It is used like this
 
 ```ruby
   case opts.subcommand
-    when :cmd1 
+    when :cmd1
       # opts.cmd1 is defined here
     when :cmd2
       # opts.cmd2 is defined here
@@ -160,7 +160,7 @@ is paragraphs
   -a,alpha @ Brief comment for -a and --alpha options
     Longer description of the option that is used by `::help`
 
-  cmd! 
+  cmd!
     @ Alternative style of brief comment
 
     Longer description of the command
@@ -179,23 +179,28 @@ error messages:
 The general syntax for options is
 
 ```
-  <prefix><optionlist>[=argspec][?]
+  <prefix><optionlist>[=argspec][,][?]
 ```
 
+(TODO: Restructure: prefix,options,argument-spec,argument-spec-modifier,etc.)
+
 The option list is a comma-separated list of option names. It is prefixed with
 a '-' if the option list starts with a short option name and '--' if the option
 list starts with a long name. '-' and '--' can be replaced with '+' or '++' to
 indicate that the option can be repeated
 
 ```
-  -a,alpha      @ -a and --alpha
-  ++beta        @ --beta, can be repeated
-  --gamma=ARG?  @ --gamma, takes an optional argument
+  -a,alpha          @ '-a' and '--alpha'
+  ++beta            @ '--beta', can be repeated
+  --gamma=ARG?      @ '--gamma', takes an optional argument
+  --delta=ARG,      @ '--delta', takes a mandatory comma-separated list of arguments
+  --epsilon=ARG,?   @ '--delta', takes an optional list
 ```
 
 An option argument has a name and a type. The type can be specified as '#'
-(integer), '$' (float), or as a comma-separated list of allowed values. It can
-also be defined by a keyword that expects a file or directory argument:
+(integer), '$' (float), ',' (list) or as a comma-separated list of allowed
+values (enum). The name should be in capital letters. Some names are keywords
+with a special meaning:
 
   | Keyword   | Type |
   | --------- | ---- |
@@ -219,7 +224,7 @@ explicitly by separating it from the type with a ':'. Examples:
   -c=red,blue,green     @ -c takes one of the listed words
   -d=FILE               @ Fails if file exists and is not a file
   -d=EDIR               @ Fails if directory doesn't exist or is not a directory
-  -d=INPUT:EFILE        @ Takes and existing file. Shown as '-d=INPUT' in messages
+  -d=INPUT:EFILE        @ Expects an existing file. Shown as '-d=INPUT' in messages
 ```
 
 ## Commands
@@ -234,7 +239,7 @@ command line like this
   cmd!
     -b @ Command level option
     subcmd!
-      -c @ Sub-command level option 
+      -c @ Sub-command level option
 ```
 
 In single-line format, subcommands are specified by prefixing the supercommand's name:
@@ -256,7 +261,7 @@ SPEC = %(
   -f,force            @ ignore nonexisten files and arguments, never prompt
   -i                  @ prompt before every removal
 
-  -I                  
+  -I
       @ prompt once
 
       prompt once before removing more than three files, or when  removing

data/TODO

@@ -1,3 +1,25 @@
+# TODO
+o A program framework to make it easier to handle commands:
+    class Program
+      def check!() end
+      def fix!() end
+      def list!() end
+
+      def initialize(spec, argv)
+      end
+
+      def command(cmd)
+        self.send(cmd.subcommand)
+      end
+    end
+
+o We really need a global #indent/#outdent set of methods
+o Make it possible to override the documentation of built-in options (ex. --verbose)
+o Create global IO-like objects for each output channel: $mesg, $verb, $notice,
+  $warn, $error, $failure so that they can be used together with the usual
+  output functions #puts, #print, #printf, #indent etc.
+
+    ShellOpts.mesg "string" -> $mesg.puts "string"
 
 o Remove IFILE and OFILE. Alternatively document them
 o Document special-case file argument '-'

data/lib/shellopts/analyzer.rb

@@ -14,8 +14,8 @@ module ShellOpts
         children.delete_if { |node| node.is_a?(ArgSpec) }
       end
 
-      def analyzer_error(token, message) 
-        raise AnalyzerError.new(token), message 
+      def analyzer_error(token, message)
+        raise AnalyzerError.new(token), message
       end
     end
 
@@ -27,7 +27,7 @@ module ShellOpts
       # Move options before first command or before explicit COMMAND section
       def reorder_options
         if commands.any?
-          i = children.find_index { |child| 
+          i = children.find_index { |child|
             child.is_a?(Command) || child.is_a?(Section) && child.name == "COMMAND"
           }
           if i
@@ -40,10 +40,10 @@ module ShellOpts
       def compute_option_hashes
         options.each { |option|
           option.idents.zip(option.names).each { |ident, name|
-            !@options_hash.key?(name) or 
+            !@options_hash.key?(name) or
                 analyzer_error option.token, "Duplicate option name: #{name}"
             @options_hash[name] = option
-            !@options_hash.key?(ident) or 
+            !@options_hash.key?(ident) or
                 analyzer_error option.token, "Can't use both #{@options_hash[ident].name} and #{name}"
             @options_hash[ident] = option
           }
@@ -53,7 +53,7 @@ module ShellOpts
       # TODO Check for dash-collision
       def compute_command_hashes
         commands.each { |command|
-          !@commands_hash.key?(command.name) or 
+          !@commands_hash.key?(command.name) or
               analyzer_error command.token, "Duplicate command name: #{command.name}"
           @commands_hash[command.name] = command
           @commands_hash[command.ident] = command
@@ -75,7 +75,7 @@ module ShellOpts
     def create_implicit_commands(cmd)
       path = cmd.path[0..-2]
 
-      
+
     end
 
     # Link up commands with supercommands. This is only done for commands that
@@ -83,7 +83,7 @@ module ShellOpts
     # parent/child relationship is not changed Example:
     #
     #   cmd!
-    #   cmd.subcmd! 
+    #   cmd.subcmd!
     #
     # Here subcmd is added to cmd's list of commands. It keeps its position in
     # the program's parent/child relationship so that documentation will print the
@@ -147,8 +147,8 @@ module ShellOpts
 
       @grammar.compute_command_hashes
 
-      @grammar.traverse { |node| 
-        node.remove_brief_nodes 
+      @grammar.traverse { |node|
+        node.remove_brief_nodes
         node.remove_arg_descr_nodes
         node.remove_arg_spec_nodes
       }

data/lib/shellopts/args.rb

@@ -21,7 +21,7 @@ module ShellOpts
     # array. If the count is negative, the elements will be removed from the
     # end of the array. If +count_or_range+ is a range, the number of elements
     # returned will be in that range. Note that the range can't contain
-    # negative numbers 
+    # negative numbers
     #
     # #extract raise a ShellOpts::Error exception if there's is not enough
     # elements in the array to satisfy the request
@@ -51,7 +51,7 @@ module ShellOpts
     # As #extract except the array is expected to be emptied by the operation.
     # Raise a #inoa exception if count is negative
     #
-    # #expect raise a ShellOpts::Error exception if the array is not emptied 
+    # #expect raise a ShellOpts::Error exception if the array is not emptied
     # by the operation
     #
     # TODO: Better handling of ranges. Allow: 2..-1, -2..-4, etc.

data/lib/shellopts/argument_type.rb

@@ -37,9 +37,9 @@ module ShellOpts
     end
 
     class IntegerArgument < ArgumentType
-      def match?(name, literal) 
-        literal =~ /^-?\d+$/ or 
-            set_message "Illegal integer value in #{name}: #{literal}" 
+      def match?(name, literal)
+        literal =~ /^-?\d+$/ or
+            set_message "Illegal integer value in #{name}: #{literal}"
       end
 
       def value?(value) value.is_a?(Integer) end
@@ -47,9 +47,9 @@ module ShellOpts
     end
 
     class FloatArgument < ArgumentType
-      def match?(name, literal) 
+      def match?(name, literal)
         # https://stackoverflow.com/a/21891705/2130986
-        literal =~ /^[+-]?(?:0|[1-9]\d*)(?:\.(?:\d*[1-9]|0))?$/ or 
+        literal =~ /^[+-]?(?:0|[1-9]\d*)(?:\.(?:\d*[1-9]|0))?$/ or
             set_message "Illegal decimal value in #{name}: #{literal}"
       end
 
@@ -61,7 +61,7 @@ module ShellOpts
       attr_reader :kind
 
       def subject # Used in error messages
-        @subject ||= 
+        @subject ||=
             case kind
               when :file, :efile; "regular file"
               when :nfile, :ifile, :ofile; "file"
@@ -74,7 +74,7 @@ module ShellOpts
 
       def initialize(kind)
         constrain kind, :file, :dir, :path, :efile, :edir, :epath, :nfile, :ndir, :npath, :ifile, :ofile
-        @kind = kind 
+        @kind = kind
       end
 
       def match?(name, literal)
@@ -168,7 +168,7 @@ module ShellOpts
           end
 
         # file does not exist
-        else 
+        else
           if [:default, :new].include? mode
             dir = File.dirname(literal)
             if !File.directory?(dir)

data/lib/shellopts/dump.rb

@@ -79,9 +79,9 @@ module ShellOpts
       def dump_idr(short = false)
         if short
           s = [
-              name, 
-              argument? ? argument_type.name : nil, 
-              optional? ? "?" : nil, 
+              name,
+              argument? ? argument_type.name : nil,
+              optional? ? "?" : nil,
               repeatable? ? "*" : nil
           ].compact.join(" ")
           puts s
@@ -89,9 +89,9 @@ module ShellOpts
           puts "#{name}: #{classname}"
           dump_attrs(
               :uid, :path, :attr, :ident, :name, :idents, :names,
-              :repeatable?, 
-              :argument?, argument? && :argument_name, argument? && :argument_type, 
-              :enum?, enum? && :argument_enum, 
+              :repeatable?,
+              :argument?, argument? && :argument_name, argument? && :argument_type,
+              :enum?, enum? && :argument_enum,
               :optional?)
           indent { puts "brief: #{group.brief}" }
         end
@@ -102,11 +102,11 @@ module ShellOpts
       def dump_idr(short = false)
         if short
           puts name
-          indent { 
+          indent {
             options.each { |option| option.dump_idr(short) }
             commands.each { |command| command.dump_idr(short) }
             descrs.each { |descr| descr.dump_idr(short) }
-          } 
+          }
         else
           puts "#{name}: #{classname}"
           dump_attrs :uid, :path, :ident, :name, :options, :commands, :specs, :descrs, :brief

data/lib/shellopts/formatter.rb

@@ -34,15 +34,15 @@ module ShellOpts
         width = [Formatter.rest, max_width].min
         if descrs.size == 0
           print (lead = Formatter.command_prefix || "")
-          indent(lead.size, ' ', bol: bol && lead == "") { 
-            puts render(:multi, width) 
+          indent(lead.size, ' ', bol: bol && lead == "") {
+            puts render(:multi, width)
           }
         else
           lead = Formatter.command_prefix || ""
           descrs.each { |descr|
             print lead
-            puts render(:multi, width, args: descr.text.split(' ')) 
-          } 
+            puts render(:multi, width, args: descr.text.split(' '))
+          }
         end
       end
 
@@ -120,7 +120,7 @@ module ShellOpts
           Command => "COMMAND"
         }
         seen_sections = {}
-        newline = false # True if a newline should be printed before child 
+        newline = false # True if a newline should be printed before child
         indent {
           children.each { |child|
             klass = child.is_a?(Section) ?  section.key(child.name) : child.class
@@ -174,7 +174,7 @@ module ShellOpts
     module WrappedNode
       def puts_descr
         width = [Formatter.rest, Formatter::HELP_MAX_WIDTH].min
-        puts lines(width) 
+        puts lines(width)
       end
     end
 
@@ -220,7 +220,7 @@ module ShellOpts
     HELP_INDENT = 4
 
     # Max. width of help text (not including indent)
-    HELP_MAX_WIDTH = 85 
+    HELP_MAX_WIDTH = 85
 
     # Command prefix when subject is a sub-command
     def self.command_prefix() @command_prefix end
@@ -279,7 +279,7 @@ module ShellOpts
     # +fields+ is an array of [subject-string, descr-text] tuples where the
     # descr is an array of words
     def self.compute_columns(width, fields)
-      first_max = 
+      first_max =
           fields.map { |first, _| first.size }.select { |size| size <= BRIEF_COL1_MAX_WIDTH }.max ||
           BRIEF_COL1_MIN_WIDTH
       second_max = fields.map { |_, second| second ? second&.map(&:size).sum + second.size - 1 : 0 }.max

data/lib/shellopts/grammar.rb

@@ -54,8 +54,8 @@ module ShellOpts
       # for the Program object. It is the dot-joined elements of path with
       # internal exclamation marks removed (eg. "cmd.opt" or "cmd.cmd!").
       # Initialize by the analyzer
-      def uid() 
-        @uid ||= command && [command.uid, ident].compact.join(".").sub(/!\./, ".") 
+      def uid()
+        @uid ||= command && [command.uid, ident].compact.join(".").sub(/!\./, ".")
       end
 
       # Path from Program object and down to this node. Array of identifiers.
@@ -142,6 +142,7 @@ module ShellOpts
       def repeatable?() @repeatable end
       def argument?() @argument end
       def optional?() @optional end
+      def list?() @list end
 
       def integer?() @argument_type.is_a? IntegerArgument end
       def float?() @argument_type.is_a? FloatArgument end
@@ -250,7 +251,7 @@ module ShellOpts
 
       def key?(key) !self.[](key).nil? end
 
-      # Mostly for debug. Has questional semantics because it only lists local keys 
+      # Mostly for debug. Has questional semantics because it only lists local keys
       def keys() @options_hash.keys + @commands_hash.keys end
 
       # Shorthand to get the associated Grammar::Command object from a Program
@@ -312,7 +313,7 @@ module ShellOpts
       alias_method :spec, :parent
     end
 
-    # DocNode object has no children but lines. 
+    # DocNode object has no children but lines.
     #
     class DocNode < Node
       # Array of :text tokens. Assigned by the parser

data/lib/shellopts/interpreter.rb

@@ -80,15 +80,23 @@ module ShellOpts
       elsif !value.nil?
         error "No argument allowed for option '#{opt_name}'"
       end
-      
+
       Command.add_option(option_command, Option.new(option, name, value))
     end
 
     def interpret_option_value(option, name, value)
+      if option.list?
+        value.split(",").map { |elem| interpret_option_value_element(option, name, elem) }
+      else
+        interpret_option_value_element(option, name, value)
+      end
+    end
+
+    def interpret_option_value_element(option, name, elem)
       type = option.argument_type
-      if type.match?(name, value)
-        type.convert(value)
-      elsif value == ""
+      if type.match?(name, elem)
+        type.convert(elem)
+      elsif elem == ""
         nil
       else
         error type.message

data/lib/shellopts/lexer.rb

@@ -2,7 +2,7 @@
 module ShellOpts
   class Line
     attr_reader :source
-    attr_reader :lineno 
+    attr_reader :lineno
     attr_reader :charno
     attr_reader :text
 
@@ -52,7 +52,7 @@ module ShellOpts
     attr_reader :name # Name of program
     attr_reader :source
     attr_reader :tokens
-    
+
     def oneline?() @oneline end
 
     def initialize(name, source, oneline)
@@ -88,7 +88,7 @@ module ShellOpts
           @tokens << Token.new(:blank, line.lineno, line.charno, "")
           next
         end
-          
+
         # Ignore meta comments
         if line.charno < initial_indent
           next if line =~ /^#/
@@ -129,8 +129,8 @@ module ShellOpts
                 @tokens << Token.new(:usage_string, line.lineno, charno, source)
               when "++" # FIXME Rename argspec
                 @tokens << Token.new(:spec, line.lineno, charno, "++")
-                words.shift_while { |c,w| 
-                  w =~ SPEC_RE and @tokens << Token.new(:argument, line.lineno, c, w) 
+                words.shift_while { |c,w|
+                  w =~ SPEC_RE and @tokens << Token.new(:argument, line.lineno, c, w)
                 }
               when /^-|\+/
                 @tokens << Token.new(:option, line.lineno, charno, word)
@@ -143,7 +143,7 @@ module ShellOpts
           end
 
           # TODO: Move to parser and remove @oneline from Lexer
-          (token = @tokens.last).kind != :brief || !oneline? or 
+          (token = @tokens.last).kind != :brief || !oneline? or
               lexer_error token, "Briefs are only allowed in multi-line specifications"
 
         # Paragraph lines
@@ -151,13 +151,13 @@ module ShellOpts
           @tokens << Token.new(:text, line.lineno, line.charno, source)
         end
         # FIXME Not sure about this
-#       last_nonblank = @tokens.last 
-        last_nonblank = @tokens.last if ![:blank, :usage_string, :argument].include? @tokens.last.kind 
+#       last_nonblank = @tokens.last
+        last_nonblank = @tokens.last if ![:blank, :usage_string, :argument].include? @tokens.last.kind
       end
 
       # Move arguments and briefs before first command if one-line source
 #     if oneline? && cmd_index = @tokens.index { |token| token.kind == :command }
-#       @tokens = 
+#       @tokens =
 #           @tokens[0...cmd_index] +
 #           @tokens[cmd_index..-1].partition { |token| ![:command, :option].include?(token.kind) }.flatten
 #     end

data/lib/shellopts/option.rb

@@ -0,0 +1,27 @@
+module ShellOpts
+  # Option models an option as given by the user on the subcommand line.
+  # Compiled options (and possibly aggregated) options are stored in the
+  # Command#__option_values__ array
+  class Option
+    # Associated Grammar::Option object
+    attr_reader :grammar
+
+    # The actual name used on the shell command-line (String)
+    attr_reader :name
+
+    # Argument value or nil if not present. The value is a String, Integer,
+    # or Float depending the on the type of the option
+    attr_accessor :argument
+
+    forward_to :grammar,
+        :uid, :ident,
+        :repeatable?, :argument?, :integer?, :float?,
+        :file?, :enum?, :string?, :optional?, :list?,
+        :argument_name, :argument_type, :argument_enum,
+        :short_idents, :long_idents
+
+    def initialize(grammar, name, argument)
+      @grammar, @name, @argument = grammar, name, argument
+    end
+  end
+end

data/lib/shellopts/parser.rb

@@ -1,5 +1,6 @@
 
 module ShellOpts
+  # Extend Grammar classes with parse methods
   module Grammar
     class Node
       def parse() end
@@ -28,13 +29,13 @@ module ShellOpts
       NAME_RE = /(?:#{SHORT_NAME_RE}|#{LONG_NAME_RE})(?:,#{LONG_NAME_RE})*/
 
       def parse
-        token.source =~ /^(-|--|\+|\+\+)(#{NAME_RE})(?:=(.+?)(\?)?)?$/ or 
+        token.source =~ /^(-|--|\+|\+\+)(#{NAME_RE})(?:=(.+?)(,\??|\?,?)?)?$/ or
             parser_error token, "Illegal option: #{token.source.inspect}"
         initial = $1
         name_list = $2
         arg = $3
-        optional = $4
-
+        @optional = $4&.include?(??) || false
+        @list = $4&.include?(?,) || false
         @repeatable = %w(+ ++).include?(initial)
 
         @short_idents = []
@@ -48,8 +49,8 @@ module ShellOpts
           end
         end
 
-        names.each { |name| 
-          name.size > 1 or 
+        names.each { |name|
+          name.size > 1 or
               parser_error token, "Long names should be at least two characters long: '#{name}'"
         }
 
@@ -94,7 +95,6 @@ module ShellOpts
               @argument_name = arg
               @argument_type = StringType.new
           end
-          @optional = !optional.nil?
         else
           @argument_type = StringType.new
         end
@@ -182,7 +182,7 @@ module ShellOpts
           when :option
             # Collect options into option groups if on the same line and not in
             # oneline mode
-            options = [token] + @tokens.shift_while { |follow| 
+            options = [token] + @tokens.shift_while { |follow|
               !oneline && follow.kind == :option && follow.lineno == token.lineno
             }
             group = Grammar::OptionGroup.new(cmds.top, token)
@@ -266,7 +266,7 @@ module ShellOpts
             else
               if nodes.top.is_a?(Grammar::Command) || nodes.top.is_a?(Grammar::OptionGroup)
                 Grammar::Brief.new(nodes.top, token, token.source.sub(/\..*/, "")) if !nodes.top.brief
-                parent = nodes.top 
+                parent = nodes.top
               else
                 parent = nodes.top.parent
               end

data/lib/shellopts/program.rb

@@ -174,7 +174,7 @@ module ShellOpts
 
     # The parent command or nil. Initialized by #add_command
     attr_accessor :__supercommand__
-    
+
     # The subcommand identifier (a Symbol incl. the exclamation mark) or nil
     # if not present. Use #subcommand!, or the dynamically generated
     # '#<identifier>!' method to get the actual subcommand object
@@ -197,7 +197,7 @@ module ShellOpts
     def __initialize__(grammar)
       @__grammar__ = grammar
       @__option_values__ = {}
-      @__option_list__ = [] 
+      @__option_list__ = []
       @__option_hash__ = {}
       @__option_values__ = {}
       @__subcommand__ = nil
@@ -209,22 +209,22 @@ module ShellOpts
       @__grammar__.options.each { |opt|
         if !opt.repeatable?
           self.instance_eval %(
-            def #{opt.attr}?() 
-              @__option_values__.key?(:#{opt.attr}) 
+            def #{opt.attr}?()
+              @__option_values__.key?(:#{opt.attr})
             end
           )
         end
-        
+
         if opt.repeatable?
           if opt.argument?
             self.instance_eval %(
-              def #{opt.attr}?() 
-                (@__option_values__[:#{opt.attr}]&.size || 0) > 0 
+              def #{opt.attr}?()
+                (@__option_values__[:#{opt.attr}]&.size || 0) > 0
               end
             )
             self.instance_eval %(
               def #{opt.attr}(default = [])
-                if @__option_values__.key?(:#{opt.attr}) 
+                if @__option_values__.key?(:#{opt.attr})
                   @__option_values__[:#{opt.attr}]
                 else
                   default
@@ -233,12 +233,12 @@ module ShellOpts
             )
           else
             self.instance_eval %(
-              def #{opt.attr}?() 
-                (@__option_values__[:#{opt.attr}] || 0) > 0 
+              def #{opt.attr}?()
+                (@__option_values__[:#{opt.attr}] || 0) > 0
               end
             )
             self.instance_eval %(
-              def #{opt.attr}(default = 0) 
+              def #{opt.attr}(default = 0)
                 if default > 0 && (@__option_values__[:#{opt.attr}] || 0) == 0
                   default
                 else
@@ -251,7 +251,7 @@ module ShellOpts
         elsif opt.argument?
           self.instance_eval %(
             def #{opt.attr}(default = nil)
-              if @__option_values__.key?(:#{opt.attr}) 
+              if @__option_values__.key?(:#{opt.attr})
                 @__option_values__[:#{opt.attr}]
               else
                 default
@@ -261,8 +261,8 @@ module ShellOpts
 
         else
           self.instance_eval %(
-            def #{opt.attr}() 
-              @__option_values__.key?(:#{opt.attr}) 
+            def #{opt.attr}()
+              @__option_values__.key?(:#{opt.attr})
             end
           )
         end
@@ -279,7 +279,7 @@ module ShellOpts
       @__grammar__.commands.each { |cmd|
         next if cmd.attr.nil?
         self.instance_eval %(
-          def #{cmd.attr}() 
+          def #{cmd.attr}()
             :#{cmd.attr} == __subcommand__ ? __subcommand__! : nil
           end
         )
@@ -328,29 +328,4 @@ module ShellOpts
       @__debug__ = false
     end
   end
-
-  # Option models an option as given by the user on the subcommand line.
-  # Compiled options (and possibly aggregated) options are stored in the
-  # Command#__option_values__ array
-  class Option
-    # Associated Grammar::Option object
-    attr_reader :grammar
-
-    # The actual name used on the shell command-line (String)
-    attr_reader :name 
-
-    # Argument value or nil if not present. The value is a String, Integer,
-    # or Float depending the on the type of the option
-    attr_accessor :argument
-
-    forward_to :grammar, 
-        :uid, :ident,
-        :repeatable?, :argument?, :integer?, :float?,
-        :file?, :enum?, :string?, :optional?,
-        :argument_name, :argument_type, :argument_enum
-
-    def initialize(grammar, name, argument)
-      @grammar, @name, @argument = grammar, name, argument
-    end
-  end
 end

data/lib/shellopts/renderer.rb

@@ -26,7 +26,7 @@ require 'terminfo'
 #       [cmd1|cmd2] ARG1 ARG2
 #   cmd --all --beta
 #       <commands> ARGS
-#   
+#
 module ShellOpts
   module Grammar
     class Option
@@ -38,16 +38,23 @@ module ShellOpts
       #
       def render(format)
         constrain format, :enum, :long, :short
-        s = 
+        s =
             case format
               when :enum; names.join(", ")
               when :long; name
               when :short; short_names.first || name
             else
               raise ArgumentError, "Illegal format: #{format.inspect}"
-            end 
+            end
         if argument?
-          s + (optional? ? "[=#{argument_name}]" : "=#{argument_name}")
+          short = long_idents.empty? || format == :short
+          arg = ""
+          arg += "=" if !short
+          arg += argument_name
+          arg += "..." if list?
+          arg = "[#{arg}]" if optional?
+          arg = " " + arg if short
+          s += arg
         else
           s
         end
@@ -56,7 +63,7 @@ module ShellOpts
 
     class OptionGroup
       # Formats:
-      #     
+      #
       #     :enum   -a, --all -r, --recursive
       #     :long   --all --recursive
       #     :short  -a -r
@@ -115,7 +122,7 @@ module ShellOpts
 
       # Force one line and compact options to "[OPTIONS]"
       def render_abbr
-        args = get_args 
+        args = get_args
         ([name] + [options.empty? ? nil : "[OPTIONS]"] + args).compact.join(" ")
       end
 

data/lib/shellopts/token.rb

@@ -4,7 +4,7 @@ module ShellOpts
     # Each kind should have a corresponding Grammar class with the same name
     KINDS = [
         :program, :section, :option, :command, :spec, :argument, :usage,
-        :usage_string, :brief, :text, :blank 
+        :usage_string, :brief, :text, :blank
     ]
 
     # Kind of token
@@ -27,13 +27,13 @@ module ShellOpts
 
     forward_to :source, :to_s, :empty?
 
-    def pos(start_lineno = 1, start_charno = 1) 
-      "#{start_lineno + lineno - 1}:#{start_charno + charno - 1}" 
+    def pos(start_lineno = 1, start_charno = 1)
+      "#{start_lineno + lineno - 1}:#{start_charno + charno - 1}"
     end
 
     def to_s() source end
 
-    def inspect() 
+    def inspect()
       "<#{self.class.to_s.sub(/.*::/, "")} #{pos} #{kind.inspect} #{source.inspect}>"
     end
 

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.4.3"
+  VERSION = "2.5.0"
 end

data/lib/shellopts.rb

@@ -16,6 +16,7 @@ require_relative 'shellopts/stack.rb'
 require_relative 'shellopts/token.rb'
 require_relative 'shellopts/grammar.rb'
 require_relative 'shellopts/program.rb'
+require_relative 'shellopts/option.rb'
 require_relative 'shellopts/args.rb'
 require_relative 'shellopts/lexer.rb'
 require_relative 'shellopts/argument_type.rb'
@@ -32,7 +33,7 @@ require_relative 'shellopts/dump.rb'
 # Notes
 #   * Two kinds of exceptions: Expected & unexpected. Expected exceptions are
 #     RuntimeError or IOError. Unexpected exceptions are the rest. Both results
-#     in shellopts.failure messages if shellopts error handling is enabled 
+#     in shellopts.failure messages if shellopts error handling is enabled
 #   * Describe the difference between StandardError, RuntimeError, and IOError
 #   * Add an #internal error handling for the production environment that
 #     prints an intelligble error message and prettyfies stack dump. This
@@ -60,7 +61,7 @@ module ShellOpts
   #   <program>: <message>
   #   Usage: <program> ...
   #
-  class Error < ShellOptsError; end 
+  class Error < ShellOptsError; end
 
   # Default class for program failures. Failures are raised on missing files or
   # illegal paths. When ShellOpts handles the exception a message with the
@@ -74,7 +75,7 @@ module ShellOpts
   # source. Messages are formatted as '<file> <lineno>:<charno> <message>' when
   # handled by ShellOpts
   class CompilerError < ShellOptsError; end
-  class LexerError < CompilerError; end 
+  class LexerError < CompilerError; end
   class ParserError < CompilerError; end
   class AnalyzerError < CompilerError; end
 
@@ -92,7 +93,7 @@ module ShellOpts
     attr_reader :spec
 
     # Array of arguments. Initialized by #interpret
-    attr_reader :argv 
+    attr_reader :argv
 
     # Grammar. Grammar::Program object. Initialized by #compile
     attr_reader :grammar
@@ -139,10 +140,10 @@ module ShellOpts
     attr_reader :tokens
     alias_method :ast, :grammar
 
-    def initialize(name: nil, 
+    def initialize(name: nil,
         # Options
-        help: true, 
-        version: true, 
+        help: true,
+        version: true,
         silent: nil,
         quiet: nil,
         verbose: nil,
@@ -157,7 +158,7 @@ module ShellOpts
         # Let exceptions through
         exception: false
       )
-        
+
       @name = name || File.basename($PROGRAM_NAME)
       @help = help
       @version = version || (version.nil? && !version_number.nil?)
@@ -187,24 +188,24 @@ module ShellOpts
         verbose_spec = (@verbose == true ? "+v,verbose" : @verbose)
         debug_spec = (@debug == true ? "--debug" : @debug)
 
-        @silent_option = 
+        @silent_option =
             ast.inject_option(silent_spec, "Quiet", "Do not write anything to standard output") if @silent
-        @quiet_option = 
+        @quiet_option =
             ast.inject_option(quiet_spec, "Quiet", "Do not write anything to standard output") if @quiet
-        @verbose_option = 
+        @verbose_option =
             ast.inject_option(verbose_spec, "Increase verbosity", "Write verbose output") if @verbose
-        @debug_option = 
+        @debug_option =
             ast.inject_option(debug_spec, "Write debug information") if @debug
-        @help_option = 
+        @help_option =
             ast.inject_option(help_spec, "Write short or long help") { |option|
-              short_option = option.short_names.first 
+              short_option = option.short_names.first
               long_option = option.long_names.first
               [
                 short_option && "#{short_option} prints a brief help text",
                 long_option && "#{long_option} prints a longer man-style description of the command"
               ].compact.join(", ")
             } if @help
-        @version_option = 
+        @version_option =
             ast.inject_option(version_spec, "Write version number and exit") if @version
 
         @grammar = Analyzer.analyze(ast)
@@ -216,7 +217,7 @@ module ShellOpts
     # ShellOpts::Args tuple
     #
     def interpret(argv)
-      handle_exceptions { 
+      handle_exceptions {
         @argv = argv.dup
         @program, @args = Interpreter.interpret(grammar, argv, float: float, exception: exception)
 
@@ -356,7 +357,7 @@ module ShellOpts
         char_z = 0
 
         (0 ... text_lines.size).each { |text_i|
-          curr_char_i, curr_char_z = 
+          curr_char_i, curr_char_z =
               LCS.find_longest_common_substring_index(text_lines[text_i], spec_lines.first.strip)
           if curr_char_z > char_z
             line_i = text_i
@@ -372,7 +373,7 @@ module ShellOpts
             compare_lines(text_lines[text_i + spec_i], spec_lines[spec_i])
           }
         } or return [nil, nil]
-        char_i, char_z = 
+        char_i, char_z =
             LCS.find_longest_common_substring_index(text_lines[line_i], spec_lines.first.strip)
         [line_i, char_i || 0]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.5.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to
@@ -147,6 +147,7 @@ files:
 - lib/shellopts/grammar.rb
 - lib/shellopts/interpreter.rb
 - lib/shellopts/lexer.rb
+- lib/shellopts/option.rb
 - lib/shellopts/parser.rb
 - lib/shellopts/program.rb
 - lib/shellopts/renderer.rb