shellopts 2.0.9 → 2.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d576d24bd0aec0dd43a2a3645ede04751d80ae22a4c88e8f66ed53bbe7e405
-  data.tar.gz: 9027ac55689a345099f6515e5280808528603dfafe385219e6cce77d1c166d96
+  metadata.gz: b2f378c7e7c04297221bfae81065ef06699e93b2dc4fda892b210ef4702c5836
+  data.tar.gz: f5d83b09b371aebd7cc07e73905edffb2f9f834ba5e382894277310e984e7ecc
 SHA512:
-  metadata.gz: b44a4d95aa0585dd0ec31abccde4942c98ad712d9e3bdf9f0c0b6ead7333ff4c5b555ec5b45786a6f539388b2460c93d12f3755b2e80cbb81fd269c42a9b4955
-  data.tar.gz: 3c948a743d809df7d22bc142dcfa9aa4e943fed144004c4fbf5d1995c314f4aea3f91b032533222eed953e5344a45c55666339797e5ae2b1be262eea17071cd5
+  metadata.gz: 6255a64a99ceefe0dc0a7a3195976d42b2db6b3a28d779cbeefbc9f36380e46a762939e2062ff9f32f4f78bd5bff8122606b5102d9d8473e86c0a742cd7db479
+  data.tar.gz: b54f74a5d8fd251d1492667bd8e1340c1f17a3e96936f423efd61e82fe665294936c1edd1ac9ac4ab9df118450ccefafcda117f84ef4e0726d78159196e075cf

data/TODO

@@ -1,18 +1,13 @@
 
-o Add brackets to optional option arguments: '--all=FILE?' -> '--all[=FILE]'
 o Ignore all text after ' # ' (doesn't conflict with option flag)
 o Command aliases
 o Add user-defined setions
 o Add a SOURCE section with link to git repo
 o Bullet-lists
 o Allow a USAGE section (and NAME)
-o Find source in code an adjust line number in error messages 
-o Rename line and char to lineno and charno
 o Client-defined argument types
 o Rename Expr -> ?
 o Find clean(er) procedural object model
-o Allow assignment to options (this makes practical stuff easier)
-o Special handling of --help arguments so that '--help command' is possible
 o Support for paging of help:
     begin 
       file = Tempfile.new("prick") 
@@ -23,6 +18,11 @@ o Support for paging of help:
       file.close 
     end 
 
++ Special handling of --help arguments so that '--help command' is possible
++ Allow assignment to options (this makes practical stuff easier)
++ Rename line and char to lineno and charno
++ Find source in code an adjust line number in error messages 
++ Add brackets to optional option arguments: '--all=FILE?' -> '--all[=FILE]'
 + Bold text output
 + Recursive format of commands
 + Rename Compiler -> Interpreter

data/lib/ext/array.rb

@@ -41,7 +41,9 @@ module Ext
 
     module Wrap
       refine ::Array do
-        # Concatenate strings into lines that are at most +width+ characters wide
+        # Concatenate array of words into lines that are at most +width+
+        # characters wide. +curr+ is the initial number of characters already
+        # used on the first line
         def wrap(width, curr = 0)
           lines = [[]]
           curr -= 1 # Simplifies conditions below

data/lib/shellopts/analyzer.rb

@@ -20,10 +20,6 @@ module ShellOpts
     end
 
     class Command
-      def set_supercommand
-        commands.each { |child| child.instance_variable_set(:@supercommand, self) }
-      end
-
       def collect_options
         @options = option_groups.map(&:options).flatten
       end
@@ -54,9 +50,9 @@ module ShellOpts
         }
       end
 
+      # TODO Check for dash-collision
       def compute_command_hashes
         commands.each { |command|
-          # TODO Check for dash-collision
           !@commands_hash.key?(command.name) or 
               analyzer_error command.token, "Duplicate command name: #{command.name}"
           @commands_hash[command.name] = command
@@ -76,41 +72,74 @@ module ShellOpts
       @grammar = grammar
     end
 
-    # Move commands that are nested within a different command than it belongs to
-    def move_commands
+    def create_implicit_commands(cmd)
+      path = cmd.path[0..-2]
+
+      
+    end
+
+    # Link up commands with supercommands. This is only done for commands that
+    # are nested within a different command than it belongs to. The
+    # parent/child relationship is not changed Example:
+    #
+    #   cmd!
+    #   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
+    # commands in the given order and with the given indentation level
+    #
+    def link_commands
       # We can't use Command#[] at this point so we collect the commands here
       h = {}
       @grammar.traverse(Grammar::Command) { |command|
         h[command.path] = command
+        # TODO: Pick up parent-less commands
+      }
+
+      # Command to link
+      link = []
+
+      # Create implicit commands
+      h.sort { |l,r| l.size <=> r.size }.each { |path, command|
+        path = path[0..-2]
+        while !h.key?(path)
+          cmd = Grammar::Command.new(nil, command.token)
+          cmd.set_name(path.last.to_s.sub(/!/, ""), path.dup)
+          link << cmd
+          h[cmd.path] = cmd
+          path.pop
+        end
       }
 
-      # Find commands to move
+      # Find commands to link
       #
-      # Commands are moved in two steps because the behaviour of #traverse is
-      # not defined when the data structure changes beneath it
-      move = []
+      # Commands are linked in two steps because the behaviour of #traverse is
+      # not defined when the data structure changes beneath it. (FIXME: Does it
+      # change when we don't touch the parent/child relationship?)
       @grammar.traverse(Grammar::Command) { |command|
         if command.path.size > 1 && command.parent && command.parent.path != command.path[0..-2]
-          move << command
+#       if command.path.size > 1 && command.parent.path != command.path[0..-2]
+          link << command
         else
           command.instance_variable_set(:@command, command.parent)
         end
       }
 
-      # Move commands but do not change parent/child relationship
-      move.each { |command|
-        supercommand = h[command.path[0..-2]] or analyzer_error "Can't find #{command.ident}!"
-        command.parent.commands.delete(command)
+      # Link commands but do not change parent/child relationship
+      link.each { |command|
+        path = command.path[0..-2]
+        path.pop while (supercommand = h[path]).nil?
+        command.parent.commands.delete(command) if command.parent
         supercommand.commands << command
         command.instance_variable_set(:@command, supercommand)
       }
     end
 
     def analyze()
-      move_commands
+      link_commands
 
       @grammar.traverse(Grammar::Command) { |command|
-        command.set_supercommand
         command.reorder_options
         command.collect_options
         command.compute_option_hashes

data/lib/shellopts/formatter.rb

@@ -1,12 +1,5 @@
 require 'terminfo'
 
-# TODO: Move to ext/indented_io.rb
-module IndentedIO
-  class IndentedIO
-    def margin() combined_indent.size end
-  end
-end
-
 module ShellOpts
   module Grammar
     class Node
@@ -81,7 +74,15 @@ module ShellOpts
       end
 
       def puts_descr(prefix, brief: !self.brief.nil?, name: :path)
-        puts Ansi.bold([prefix, render(:single, Formatter.rest)].flatten.compact.join(" "))
+        # Use one-line mode if all options are declared on one line
+        if options.all? { |option| option.token.lineno == token.lineno }
+          puts Ansi.bold([prefix, render(:single, Formatter.rest)].flatten.compact.join(" "))
+          puts_options = false
+        else
+          puts Ansi.bold([prefix, render(:abbr, Formatter.rest)].flatten.compact.join(" "))
+          puts_options = true
+        end
+
         indent {
           if brief
             puts self.brief.words.wrap(Formatter.rest)
@@ -93,7 +94,10 @@ module ShellOpts
 
               if child.is_a?(Command)
                 child.puts_descr(prefix, name: :path)
-               else
+              elsif child.is_a?(OptionGroup)
+                child.puts_descr if puts_options
+                newline = false
+              else
                 child.puts_descr
               end
             }
@@ -125,9 +129,9 @@ module ShellOpts
               section.delete(klass)
               section.delete(Paragraph)
               if klass <= OptionGroup
-                s = s + "S" if options.size > 1
+                s += "S" if options.size > 1
               elsif klass <= Command
-                s = s + "S" if commands.size > 1 || commands.first&.commands&.size != 0
+                s += "S" if commands.size > 1 || commands.size == 1 && commands.first.commands.size > 1
               end
               puts
               indent(-1).puts Ansi.bold s
@@ -139,7 +143,7 @@ module ShellOpts
             end
 
             if child.is_a?(Command)
-              prefix = child.supercommand == self ? nil : child.supercommand&.name
+              prefix = child.path[path.size..-2].map { |sym| sym.to_s.sub(/!/, "") }
               child.puts_descr(prefix, brief: false, name: :path)
               newline = true
              else
@@ -150,9 +154,10 @@ module ShellOpts
 
           # Also emit commands not declared in nested scope
           (commands - children.select { |child| child.is_a?(Command) }).each { |cmd|
+            next if cmd.parent.nil? # Skip implicit commands
             puts if newline
             newline = true
-            prefix = cmd.supercommand == self ? nil : cmd.supercommand&.name
+            prefix = cmd.command == self ? nil : cmd.command&.name
             cmd.puts_descr(prefix, brief: false, name: path)
           }
         }
@@ -204,7 +209,10 @@ module ShellOpts
     BRIEF_COL1_MAX_WIDTH = 40
 
     # Minimum width of second column in brief option and command lists
-    BRIEF_COL2_MAX_WIDTH = 50
+    BRIEF_COL2_MIN_WIDTH = 30
+
+    # Maximum width of second column in brief option and command lists
+    BRIEF_COL2_MAX_WIDTH = 70
 
     # Indent to use in help output
     HELP_INDENT = 4
@@ -214,29 +222,21 @@ module ShellOpts
 
     # Usage string in error messages
     def self.usage(subject)
-      subject = Grammar::Command.command(subject)
-      @command_prefix = subject.ancestors.map { |node| node.name + " " }.join
+      command = Grammar::Command.command(subject)
+      @command_prefix = command.ancestors.map { |node| node.name + " " }.join
       setup_indent(1) {
         print lead = "#{USAGE_STRING}: "
-        indent(lead.size, ' ', bol: false) { subject.puts_usage }
+        indent(lead.size, ' ', bol: false) { command.puts_usage }
       }
     end
 
-#   # TODO
-#   def self.usage=(usage_lambda)
-#   end
-
     # When the user gives a -h option
-    def self.brief(command)
-      command = Grammar::Command.command(command)
+    def self.brief(subject)
+      command = Grammar::Command.command(subject)
       @command_prefix = command.ancestors.map { |node| node.name + " " }.join
       setup_indent(BRIEF_INDENT) { command.puts_brief }
     end
 
-#   # TODO
-#   def self.brief=(brief_lambda)
-#   end
-
     # When the user gives a --help option
     def self.help(subject)
       subject = Grammar::Command.command(subject)
@@ -250,18 +250,6 @@ module ShellOpts
       obj.is_a?(Grammar::Command) ? obj : obj.__grammar__
     end
 
-#   # TODO
-#   def self.help_w_lambda(program)
-#     if @help_lambda
-#       #
-#     else
-#       program = Grammar::Command.command(program)
-#       setup_indent(HELP_INDENT) { program.puts_descr }
-#     end
-#   end
-#
-#   def self.help=(help_lambda) @help_lambda end
-
     def self.puts_columns(widths, fields)
       l = []
       first_width, second_width = *widths
@@ -272,40 +260,47 @@ module ShellOpts
           puts first
           indent(first_width + BRIEF_COL_SEP, ' ') { puts second.wrap(second_width) } if second
         elsif second
-          printf "%-#{first_width + BRIEF_COL_SEP}s", first
-          indent(first_width, bol: false) { puts second.wrap(second_width) }
+          indent_size = first_width + BRIEF_COL_SEP
+          printf "%-#{indent_size}s", first
+          indent(indent_size, ' ', bol: false) { puts second.wrap(second_width) }
         else
           puts first
         end
       end
     end
 
+    # Returns a tuple of [first-column-width, second-column-width]. +width+ is
+    # the maximum width of the colunms and the BRIEF_COL_SEP separator.
+    # +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 = [
-        (fields.map { |first, _| first.size } + [BRIEF_COL1_MIN_WIDTH]).max, 
-        BRIEF_COL1_MAX_WIDTH
-      ].min
-      second_max = fields.map { |_, second| second ? second&.map(&:size).sum + second.size - 1: 0 }.max
-
-      if first_max + BRIEF_COL_SEP + second_max <= width
-        first_width = first_max
-        second_width = second_max
-      elsif first_max + BRIEF_COL_SEP + BRIEF_COL2_MAX_WIDTH <= width
-        first_width = first_max
-        second_width = width - first_width - BRIEF_COL_SEP
+      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
+      first_width = [[first_max, BRIEF_COL1_MIN_WIDTH].max, BRIEF_COL1_MAX_WIDTH].min
+      rest = width - first_width - BRIEF_COL_SEP
+      second_min = [BRIEF_COL2_MIN_WIDTH, second_max].min
+      if rest < second_min
+        first_width = [first_max, width - second_min - BRIEF_COL_SEP].max
+        second_width = [width - first_width - BRIEF_COL_SEP, BRIEF_COL2_MIN_WIDTH].max
       else
-        first_width = [width - BRIEF_COL_SEP - BRIEF_COL2_MAX_WIDTH, BRIEF_COL1_MAX_WIDTH].min
-        second_width = BRIEF_COL2_MAX_WIDTH
+        second_width = [[rest, BRIEF_COL2_MIN_WIDTH].max, BRIEF_COL2_MAX_WIDTH].min
       end
-
       [first_width, second_width]
     end
 
     def self.width()
       @width ||= TermInfo.screen_width - MARGIN_RIGHT
+      @width
+    end
+
+    # Used in rspec
+    def self.width=(width)
+      @width = width
     end
 
-    def self.rest() width - $stdout.margin end
+    def self.rest() width - $stdout.tab end
 
   private
     # TODO Get rid of?

data/lib/shellopts/grammar.rb

@@ -45,16 +45,18 @@ module ShellOpts
     end
 
     class IdrNode < Node
-      # Command of this object. This is different from #parent when a
-      # subcommand is nested on a higher level than its supercommand.
-      # Initialized by the analyzer
+      # Command of this object (nil for the top-level Program object). This is
+      # different from #parent when a subcommand is nested textually on a
+      # higher level than its supercommand.  Initialized by the analyzer
       attr_reader :command
 
       # Unique identifier of node (String) within the context of a program. nil
-      # for the Program object. It is the list of path elements concatenated
-      # with '.' and with internal '!' removed (eg. "cmd.opt" or "cmd.cmd!").
-      # Initialized by the parser
-      attr_reader :uid
+      # 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(/!\./, ".") 
+      end
 
       # Path from Program object and down to this node. Array of identifiers.
       # Empty for the Program object. Initialized by the parser
@@ -84,6 +86,13 @@ module ShellOpts
       # #ident is a reserved word. Initialized by the parser
       attr_reader :attr
 
+      def set_name(name, path)
+        @name = name.to_s
+        @path = path
+        @ident = @path.last || :!
+        @attr = ::ShellOpts::Command::RESERVED_OPTION_NAMES.include?(@ident.to_s) ? nil : @ident
+      end
+
     protected
       def lookup(path)
         path.empty? or raise ArgumentError, "Argument should be empty"
@@ -189,10 +198,6 @@ module ShellOpts
     # methods are initialized by the analyzer
     #
     class Command < IdrNode
-      # Supercommand or nil if this is the top-level Program object.
-      # Initialized by the analyzer
-      attr_reader :supercommand
-
       # Brief description of command
       attr_accessor :brief
 

data/lib/shellopts/parser.rb

@@ -16,9 +16,9 @@ module ShellOpts
     class IdrNode
       # Assumes that @name and @path has been defined
       def parse
-        @ident = @path.last || :!
-        @attr = ::ShellOpts::Command::RESERVED_OPTION_NAMES.include?(ident.to_s) ? nil : ident
-        @uid = parent && @path.join(".").sub(/!\./, ".") # uid is nil for the Program object
+#       @ident = @path.last || :!
+#       @attr = ::ShellOpts::Command::RESERVED_OPTION_NAMES.include?(ident.to_s) ? nil : ident
+#       @uid = parent && @path.join(".").sub(/!\./, ".") # uid is nil for the Program object
       end
     end
 
@@ -56,8 +56,9 @@ module ShellOpts
         @long_names = names.map { |name| "--#{name}" }
         @long_idents = names.map { |name| name.tr("-", "_").to_sym }
 
-        @name = @long_names.first || @short_names.first
-        @path = command.path + [@long_idents.first || @short_idents.first]
+        set_name(
+          @long_names.first || @short_names.first,
+          command.path + [@long_idents.first || @short_idents.first])
 
         @argument = !arg.nil?
 
@@ -108,11 +109,11 @@ module ShellOpts
       def parse
         if parent
           path_names = token.source.sub("!", "").split(".")
-          @name = path_names.last
-          @path = path_names.map { |cmd| "#{cmd}!".to_sym }
+          set_name(
+              path_names.last,
+              path_names.map { |cmd| "#{cmd}!".to_sym })
         else
-          @path = []
-          @name = token.source
+          set_name(token.source, [])
         end
         super
       end
@@ -123,13 +124,15 @@ module ShellOpts
         super(nil, token)
       end
 
-      def add_stdopts
+      def add_version_option
         option_token = Token.new(:option, 1, 1, "--version")
         brief_token = Token.new(:brief, 1, 1, "Write version number and exit")
         group = OptionGroup.new(self, option_token)
         option = Option.parse(group, option_token)
         brief = Brief.parse(group, brief_token)
+      end
 
+      def add_help_options
         option_token = Token.new(:option, 1, 1, "-h,help")
         brief_token = Token.new(:brief, 1, 1, "Write help text and exit")
         paragraph_token = Token.new(:text, 1, 1, 

data/lib/shellopts/program.rb

@@ -49,10 +49,10 @@ module ShellOpts
         singleton_method_removed singleton_method_undefined
     )
 
-    # These methods can be overridden by an option (the value is not used -
+    # These methods can be overridden by an option or a command (the value is not used -
     # this is just for informational purposes)
-    OVERRIDEABLE_METHODS = %w(
-        subcommand
+    OVERRIDEABLE_METHOD_NAMES = %w(
+        subcommand subcommand! supercommand!
     )
 
     # Redefine ::new to call #__initialize__
@@ -107,6 +107,7 @@ module ShellOpts
     #
     # Note: Can be overridden by option, in that case use #__subcommand__ or
     # ShellOpts.subcommand(object) instead
+    #
     def subcommand() __subcommand__ end
 
     # The subcommand object or nil if not present. Per-subcommand methods
@@ -120,7 +121,12 @@ module ShellOpts
     def subcommand!() __subcommand__! end
 
     # The parent command or nil. Initialized by #add_command
-    attr_accessor :__supercommand__
+    #
+    # Note: Can be overridden by a subcommand declaration (but not an
+    # option), in that case use #__supercommand__! or
+    # ShellOpts.supercommand!(object) instead
+    #
+    def supercommand!() __supercommand__ end
 
     # UID of command/program
     def __uid__() @__grammar__.uid end
@@ -149,6 +155,9 @@ module ShellOpts
     # Map from identifier to option object or to a list of option objects if
     # the option is repeatable
     attr_reader :__option_hash__
+
+    # 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

data/lib/shellopts/renderer.rb

@@ -38,13 +38,19 @@ module ShellOpts
       #
       def render(format)
         constrain format, :enum, :long, :short
-        case format
-          when :enum; names.join(", ")
-          when :long; name
-          when :short; short_names.first || name
+        s = 
+            case format
+              when :enum; names.join(", ")
+              when :long; name
+              when :short; short_names.first || name
+            else
+              raise ArgumentError, "Illegal format: #{format.inspect}"
+            end 
+        if argument?
+          s + (optional? ? "[=#{argument_name}]" : "=#{argument_name}")
         else
-          raise ArgumentError, "Illegal format: #{format.inspect}"
-        end + (argument? ? "=#{argument_name}" : "")
+          s
+        end
       end
     end
 
@@ -75,17 +81,19 @@ module ShellOpts
       COMMANDS_ABBR = "[COMMANDS]"
       DESCRS_ABBR = "ARGS..."
 
-      # Format can be one of :single, :enum, or :multi. :single force one-line
-      # output and compacts options and commands if needed. :enum outputs a
-      # :single line for each argument specification/description, :multi tries
-      # one-line output but wrap options if needed. Multiple argument
-      # specifications/descriptions are always compacted
+      # Format can be one of :abbr, :single, :enum, or :multi. :abbr
+      # lists the command on one line with options abbreviated. :single force
+      # one-line output and compacts options and commands if needed. :enum
+      # outputs a :single line for each argument specification/description,
+      # :multi tries one-line output but wrap options if needed. Multiple
+      # argument specifications/descriptions are always compacted
       #
       def render(format, width, root: false, **opts)
         case format
+          when :abbr; render_abbr
           when :single; render_single(width, **opts)
           when :enum; render_enum(width, **opts)
-          when :multi; render_multi2(width, **opts)
+          when :multi; render_multi(width, **opts)
         else
           raise ArgumentError, "Illegal format: #{format.inspect}"
         end
@@ -96,6 +104,21 @@ module ShellOpts
       end
 
     protected
+      # TODO: Refactor and implement recursive detection of any argument
+      def get_args(args: nil)
+        case descrs.size
+          when 0; []
+          when 1; [descrs.first.text]
+          else [DESCRS_ABBR]
+        end
+      end
+
+      # Force one line and compact options to "[OPTIONS]"
+      def render_abbr
+        args = get_args 
+        ([name] + [options.empty? ? nil : "[OPTIONS]"] + args).compact.join(" ")
+      end
+
       # Force one line. Compact options, commands, arguments if needed
       def render_single(width, args: nil)
         long_options = options.map { |option| option.render(:long) }
@@ -104,13 +127,7 @@ module ShellOpts
         short_commands = commands.empty? ? [] : ["[#{commands.map(&:name).join("|")}]"]
         compact_commands = commands.empty? ? [] : [COMMANDS_ABBR]
 
-        # TODO: Refactor and implement recursive detection of any argument
-        args ||= 
-            case descrs.size
-              when 0; args = []
-              when 1; [descrs.first.text]
-              else [DESCRS_ABBR]
-            end
+        args ||= get_args
 
         begin # to be able to use 'break' below
           words = [name] + long_options + short_commands + args
@@ -149,36 +166,8 @@ module ShellOpts
         short_options = options.map { |option| option.render(:short) }
         short_commands = commands.empty? ? [] : ["[#{commands.map(&:name).join("|")}]"]
         compact_commands = [COMMANDS_ABBR]
-        args ||= self.descrs.size != 1 ? [DESCRS_ABBR] : descrs.map(&:text)
-
-        # On one line
-        words = long_options + short_commands + args
-        return [words.join(" ")] if pass?(words, width)
-        words = short_options + short_commands + args
-        return [words.join(" ")] if pass?(words, width)
-
-        # On multiple lines
-        options = long_options.wrap(width)
-        commands = [[short_commands, args].join(" ")]
-        return options + commands if pass?(commands, width)
-        options + [[compact_commands, args].join(" ")]
-      end
-
-      # Try to keep on one line but wrap options if needed. Multiple argument
-      # specifications/descriptions are always compacted
-      def render_multi2(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]
 
-        # TODO: Refactor and implement recursive detection of any argument
-        args ||= 
-            case descrs.size
-              when 0; args = []
-              when 1; [descrs.first.text]
-              else [DESCRS_ABBR]
-            end
+        args ||= get_args
 
         # On one line
         words = [name] + long_options + short_commands + args

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.9"
+  VERSION = "2.0.12"
 end

data/lib/shellopts.rb

@@ -1,12 +1,6 @@
 
-$quiet = nil
-$verb = nil
-$debug = nil
-$shellopts = nil
-
 require 'indented_io'
 
-#$LOAD_PATH.unshift "../constrain/lib"
 require 'constrain'
 include Constrain
 
@@ -98,14 +92,22 @@ module ShellOpts
     # Array of remaining arguments. Initialized by #interpret
     attr_reader :args
 
-    # Compiler flags
-    attr_accessor :stdopts
-    attr_accessor :msgopts
+    # Automatically add a -h and a --help option if true
+    attr_reader :help
+
+    # Version of client program. If not nil a --version option is added to the program
+    def version
+      return @version if @version
+      exe = caller.find { |line| line =~ /`<top \(required\)>'$/ }&.sub(/:.*/, "")
+      file = Dir.glob(File.dirname(exe) + "/../lib/*/version.rb").first
+      @version = IO.read(file).sub(/^.*VERSION\s*=\s*"(.*?)".*$/m, '\1') or
+          raise ArgumentError, "ShellOpts needs an explicit version"
+    end
 
-    # Version of client program. This is only used if +stdopts+ is true
-    attr_reader :version
+    # Add message options (TODO)
+    attr_accessor :msgopts
 
-    # Interpreter flags
+    # Floating options
     attr_accessor :float
 
     # True if ShellOpts lets exceptions through instead of writing an error
@@ -117,11 +119,14 @@ module ShellOpts
 
     # Debug: Internal variables made public
     attr_reader :tokens
-    alias_method :ast, :grammar # Oops - defined earlier FIXME
+    alias_method :ast, :grammar
 
-    def initialize(name: nil, stdopts: true, version: nil, msgopts: false, float: true, exception: false)
+    def initialize(name: nil, help: true, version: true, msgopts: false, float: true, exception: false)
       @name = name || File.basename($PROGRAM_NAME)
-      @stdopts, @version, @msgopts, @float, @exception = stdopts, version, msgopts, float, exception
+      @help = help
+      @use_version = version ? true : false
+      @version = @use_version && @version != true ? @version : nil
+      @msgopts, @float, @exception = msgopts, float, exception
     end
 
     # Compile source and return grammar object. Also sets #spec and #grammar.
@@ -133,7 +138,8 @@ module ShellOpts
         @file = find_caller_file
         @tokens = Lexer.lex(name, @spec, @oneline)
         ast = Parser.parse(tokens)
-        ast.add_stdopts if stdopts
+        ast.add_version_option if @use_version
+        ast.add_help_options if @help
         @grammar = Analyzer.analyze(ast)
       }
       self
@@ -146,19 +152,16 @@ module ShellOpts
       handle_exceptions { 
         @argv = argv.dup
         @program, @args = Interpreter.interpret(grammar, argv, float: float, exception: exception)
-        if stdopts
-          if @program.version?
-            version or raise ArgumentError, "Version not specified"
-            puts version 
-            exit
-          elsif @program.help?
-            if @program[:help].name == "-h"
-              ShellOpts.brief
-            else
-              ShellOpts.help
-            end
-            exit
+        if @program.version?
+          puts version 
+          exit
+        elsif @program.help?
+          if @program[:help].name == "-h"
+            ShellOpts.brief
+          else
+            ShellOpts.help
           end
+          exit
         end
       }
       self
@@ -189,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
@@ -219,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(".", " ")}'"
@@ -330,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
@@ -364,132 +376,3 @@ module ShellOpts
   end
 end
 
-
-
-
-
-
-
-
-__END__
-
-require "shellopts/version"
-
-require "ext/algorithm.rb"
-require "ext/ruby_env.rb"
-
-require "shellopts/constants.rb"
-require "shellopts/exceptions.rb"
-
-require "shellopts/grammar/analyzer.rb"
-require "shellopts/grammar/lexer.rb"
-require "shellopts/grammar/parser.rb"
-require "shellopts/grammar/command.rb"
-require "shellopts/grammar/option.rb"
-
-require "shellopts/ast/parser.rb"
-require "shellopts/ast/command.rb"
-require "shellopts/ast/option.rb"
-
-require "shellopts/args.rb"
-require "shellopts/formatter.rb"
-
-if RUBY_ENV == "development"
-  require "shellopts/grammar/dump.rb"
-  require "shellopts/ast/dump.rb"
-end
-
-$verb = nil
-$quiet = nil
-$shellopts = nil
-
-module ShellOpts
-  class ShellOpts
-    attr_reader :name # Name of program. Defaults to the name of the executable
-    attr_reader :spec
-    attr_reader :argv
-
-    attr_reader :grammar
-    attr_reader :program
-    attr_reader :arguments
-
-    def initialize(spec, argv, name: nil, exception: false)
-      @name = name || File.basename($PROGRAM_NAME)
-      @spec, @argv = spec, argv.dup
-      exprs = Grammar::Lexer.lex(@spec)
-      commands = Grammar::Parser.parse(@name, exprs)
-      @grammar = Grammar::Analyzer.analyze(commands)
-
-      begin
-        @program, @arguments = Ast::Parser.parse(@grammar, @argv)
-      rescue Error => ex
-        raise if exception
-        error(ex.subject, ex.message)
-      end
-    end
-
-    def error(subject = nil, message)
-      $stderr.puts "#{name}: #{message}"
-      usage(subject, device: $stderr)
-      exit 1
-    end
-
-    def fail(message)
-      $stderr.puts "#{name}: #{message}"
-      exit 1
-    end
-
-    def usage(subject = nil, device: $stdout, levels: 1, margin: "")
-      subject = find_subject(subject)
-      device.puts Formatter.usage_string(subject, levels: levels, margin: margin)
-    end
-
-    def help(subject = nil, device: $stdout, levels: 10, margin: "", tab: "  ")
-      subject = find_subject(subject)
-      device.puts Formatter.help_string(subject, levels: levels, margin: margin, tab: tab)
-    end
-
-  private
-    def lookup(name)
-      a = name.split(".")
-      cmd = grammar
-      while element = a.shift
-        cmd = cmd.commands[element]
-      end
-      cmd
-    end
-
-    def find_subject(obj)
-      case obj
-        when String; lookup(obj)
-        when Ast::Command; Command.grammar(obj)
-        when Grammar::Command; obj
-        when NilClass; grammar
-      else
-        raise Internal, "Illegal object: #{obj.class}"
-      end
-    end
-  end
-
-  def self.process(spec, argv, name: nil, exception: false)
-    $shellopts = ShellOpts.new(spec, argv, name: name, exception: exception)
-    [$shellopts.program, $shellopts.arguments]
-  end
-
-  def self.error(subject = nil, message)
-    $shellopts.error(subject, message)
-  end
-
-  def self.fail(message)
-    $shellopts.fail(message)
-  end
-
-  def self.help(subject = nil, device: $stdout, levels: 10, margin: "", tab: "  ")
-    $shellopts.help(subject, device: device, levels: levels, margin: margin, tab: tab)
-  end
-
-  def self.usage(subject = nil, device: $stdout, levels: 1, margin: "")
-    $shellopts.usage(subject, device: device, levels: levels, margin: margin)
-  end
-end
-

data/main

@@ -7,12 +7,15 @@ require 'shellopts'
 
 include ShellOpts
 
+p ShellOpts::ShellOpts.default_version
+exit
+
 VERSION = "1.2.3"
 
 SPEC = %(
   -a @ An option
 )
-opts, args = ShellOpts::process(SPEC, ARGV, version: VERSION)
+opts, args = ShellOpts.process(SPEC, ARGV, version: VERSION)
 #ShellOpts::ShellOpts.help
 
 

metadata

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