shellopts 2.0.4 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0170d9ce5144afcf716b90a3904250c0afa5d769b7a64f39db0b8084e77b4fb7
-  data.tar.gz: 81495a3802c472c65812594d847c43b0f59849ea0ebe093c74c2fb7d3e822658
+  metadata.gz: 6e8933ca7084aea3e51858cd679eec2a6b34b2fc7ae9a55ccce131947ccc7375
+  data.tar.gz: 125309b75338e9205fb05c5c556fca54cbc1cc77ef890a4ca2d6992c69eff302
 SHA512:
-  metadata.gz: 195801ea89b22920fca88216ed4bd7ac426b3370e482b61547dac085d1c7d9f1bd0a2d0edc7c3368bf126cd5f4da815dd882ee3149cd291549ff631d6302e93a
-  data.tar.gz: 6dcd50871438db9f5b0520e4f670f6df6ad04756685838d309874a9601770ee79a7370ebc11b0469d19a9f2be89868c7cfd12cfe028c0c01719b4d8d0593fc59
+  metadata.gz: 123b17ded3c4943267612959f3b8ab56a37249e38ea9c338c577ad254ebc1c7c9c305ca9a7a3ee2661d9474e905ddd193c5da8e7a5adc3e711c236349095a636
+  data.tar.gz: a3115c875274fccf6628d4c839e3eac36804157f7c56e90b599e8201c1bf8f1070b5b92b7e22cbe2c6615e20b81f4de8b81233227aaccdb873f1016e129d99ae

data/TODO

@@ -1,4 +1,5 @@
 
+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

data/lib/shellopts/args.rb

@@ -2,18 +2,23 @@
 module ShellOpts
   # Specialization of Array for arguments lists. Args extends Array with a
   # #extract and an #expect method to extract elements from the array. The
-  # methods raise a ShellOpts::UserError exception in case of errors
+  # methods raise a ShellOpts::Error exception in case of errors
   #
   class Args < Array
+    # :call-seq:
+    #   extract(count, message = nil)
+    #   extract(range, message = nil)
+    #
     # Remove and return elements from beginning of the array
     #
     # If +count_or_range+ is a number, that number of elements will be
     # returned.  If the count is one, a simple value is returned instead of an
     # 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. The range can't contain negative numbers 
+    # returned will be in that range. Note that the range can't contain
+    # negative numbers 
     #
-    # #extract raise a ShellOpts::UserError exception if there's is not enough
+    # #extract raise a ShellOpts::Error exception if there's is not enough
     # elements in the array to satisfy the request
     #
     def extract(count_or_range, message = nil) 
@@ -30,16 +35,16 @@ module ShellOpts
           count.abs <= self.size or inoa(message)
           start = count >= 0 ? 0 : size + count
           r = slice!(start, count.abs)
-          r.size <= 0 ? nil : (r.size == 1 ? r.first : r)
+          r.size == 1 ? r.first : r
         else
           raise ArgumentError
       end
     end
 
     # As #extract except it doesn't allow negative counts and that the array is
-    # expect to be emptied by the operation
+    # expected to be emptied by the operation
     #
-    # #expect raise a ShellOpts::UserError exception if the array is not emptied 
+    # #expect raise a ShellOpts::Error exception if the array is not emptied 
     # by the operation
     #
     def expect(count_or_range, message = nil)
@@ -55,7 +60,7 @@ module ShellOpts
 
   private
     def inoa(message = nil) 
-      raise ArgumentError, message || "Illegal number of arguments"
+      raise ShellOpts::Error, message || "Illegal number of arguments"
     end
   end
 end

data/lib/shellopts/formatter.rb

@@ -38,16 +38,17 @@ module ShellOpts
       using Ext::Array::Wrap
 
       def puts_usage(bol: false)
+        width = [Formatter.rest, Formatter::USAGE_MAX_WIDTH].min
         if descrs.size == 0
           print (lead = Formatter.command_prefix || "")
           indent(lead.size, ' ', bol: bol && lead == "") { 
-            puts render(:multi, Formatter::USAGE_MAX_WIDTH) 
+            puts render(:multi, width) 
           }
         else
           lead = Formatter.command_prefix || ""
           descrs.each { |descr|
             print lead
-            puts render(:single, Formatter::USAGE_MAX_WIDTH, args: [descr.text]) 
+            puts render(:single, width, args: [descr.text]) 
           } 
         end
       end
@@ -199,8 +200,8 @@ module ShellOpts
     # Number of characters between columns in brief output
     BRIEF_COL_SEP = 2
 
-    # Maximum width of first column in brief option and command lists
-    BRIEF_COL1_MIN_WIDTH = 6
+    # Minimum width of first column in brief option and command lists
+    BRIEF_COL1_MIN_WIDTH = 20
 
     # Maximum width of first column in brief option and command lists
     BRIEF_COL1_MAX_WIDTH = 40

data/lib/shellopts/parser.rb

@@ -122,6 +122,22 @@ module ShellOpts
       def self.parse(token)
         super(nil, token)
       end
+
+      def add_stdopts
+        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)
+
+        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, "-h prints a brief help text, --help prints a longer man-style description of the command")
+        group = OptionGroup.new(self, option_token)
+        option = Option.parse(group, option_token)
+        brief = Brief.parse(group, brief_token)
+        paragraph = Paragraph.parse(group, paragraph_token)
+      end
     end
 
     class ArgSpec
@@ -146,6 +162,14 @@ module ShellOpts
       @nodes = {}
     end
 
+#   def add_stdopts
+#     version_token = Token.new(:option, 1, 1, "--version")
+#     version_brief = Token.new(:brief, 1, 1, "Gryf gryf")
+#     group = Grammar::OptionGroup.new(@program, version_token)
+#     option = Grammar::Option.parse(group, version_token)
+#     brief = Grammr::Brief.parse(option, version_brief)
+#   end
+
     def parse()
       @program = Grammar::Program.parse(@tokens.shift)
       oneline = @tokens.first.lineno == @tokens.last.lineno

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.4"
+  VERSION = "2.0.7"
 end

data/lib/shellopts.rb

@@ -102,6 +102,9 @@ module ShellOpts
     attr_accessor :stdopts
     attr_accessor :msgopts
 
+    # Version of client program. This is only used if +stdopts+ is true
+    attr_reader :version
+
     # Interpreter flags
     attr_accessor :float
 
@@ -116,9 +119,9 @@ module ShellOpts
     attr_reader :tokens
     alias_method :ast, :grammar # Oops - defined earlier FIXME
 
-    def initialize(name: nil, stdopts: true, msgopts: false, float: true, exception: false)
+    def initialize(name: nil, stdopts: true, version: nil, msgopts: false, float: true, exception: false)
       @name = name || File.basename($PROGRAM_NAME)
-      @stdopts, @msgopts, @float, @exception = stdopts, msgopts, float, exception
+      @stdopts, @version, @msgopts, @float, @exception = stdopts, version, msgopts, float, exception
     end
 
     # Compile source and return grammar object. Also sets #spec and #grammar.
@@ -130,7 +133,7 @@ module ShellOpts
         @file = find_caller_file
         @tokens = Lexer.lex(name, @spec, @oneline)
         ast = Parser.parse(tokens)
-        # TODO: Add standard and message options and their handlers
+        ast.add_stdopts if stdopts
         @grammar = Analyzer.analyze(ast)
       }
       self
@@ -143,6 +146,20 @@ 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
+          end
+        end
       }
       self
     end
@@ -177,7 +194,7 @@ module ShellOpts
       saved = $stdout
       $stdout = $stderr
       $stderr.puts "#{name}: #{message}"
-      Formatter.usage(program)
+      Formatter.usage(grammar)
       exit 1
     ensure
       $stdout = saved
@@ -203,9 +220,10 @@ 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: false)
+    def help(subject = nil, clear: true)
       node = (subject ? @grammar[subject] : @grammar) or
           raise ArgumentError, "No such command: '#{subject&.sub(".", " ")}'"
+      print '' if clear
       Formatter.help(node)
     end
 
@@ -310,6 +328,7 @@ module ShellOpts
   def self.instance?() !@instance.nil? end
   def self.instance() @instance or raise Error, "ShellOpts is not initialized" end
   def self.instance=(instance) @instance = instance end
+  def self.shellopts() instance end
 
   forward_self_to :instance, :error, :failure
 

data/main

@@ -7,18 +7,33 @@ require 'shellopts'
 
 include ShellOpts
 
+VERSION = "1.2.3"
 
 SPEC = %(
-  -a,alpha        @ Brief comment for -a and --alpha options
-      Longer and more elaborate description of the --alpha option
+  -a @ An option
+)
+opts, args = ShellOpts::process(SPEC, ARGV, version: VERSION)
+#ShellOpts::ShellOpts.help
 
-  -b,beta=ARG
-      @ Alternative style of brief comment
 
-      Longer and more elaborate description of the --beta option
-)
 
-opts, args = ShellOpts.process(SPEC, ARGV)
+
+
+
+__END__
+
+
+#SPEC = %(
+# -a,alpha        @ Brief comment for -a and --alpha options
+#     Longer and more elaborate description of the --alpha option
+#
+# -b,beta=ARG
+#     @ Alternative style of brief comment
+#
+#     Longer and more elaborate description of the --beta option
+#)
+#
+#opts, args = ShellOpts.process(SPEC, ARGV)
 #puts "opts.alpha?: #{opts.alpha?.inspect}"
 #puts "opts.alpha: #{opts.alpha.inspect}"
 #puts "opts.beta?: #{opts.beta?.inspect}"
@@ -266,8 +281,9 @@ SPEC4 = %(
 
 SPEC5 = "cmd! cmd!"
 
-shellopts = ShellOpts::ShellOpts.new(exception: false)
+shellopts = ShellOpts::ShellOpts.new(exception: true)
 #shellopts.compile("cmd! cmd!")
+
 shellopts.compile(SPEC)
 #shellopts.compile(SPEC2)
 #shellopts.compile(SPEC3)
@@ -277,9 +293,9 @@ shellopts.compile(SPEC)
 #shellopts.tokens.each(&:dump)
 #exit
 
-shellopts.usage
+#shellopts.usage
 #shellopts.brief
-#shellopts.help
+shellopts.help
 #shellopts.help("cmd")
 #shellopts.help(ARGV.first)
 

metadata

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