help_parser 8.1.221206 → 9.0.240926

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157ae793a16a5b92ca1633306080465fcd2e9671aaed67dc01fb47cb318f0824
-  data.tar.gz: cc72ed9f03c94ef2f5455897807a49ba69e79786ceae5daa3d158d3265e9a931
+  metadata.gz: 60dd76f994f506e15f1593b7561ee1b23cc59c0cf3cd53cc1140dcbc59b7b0f5
+  data.tar.gz: c113698c66f7790c4977d57c7906dad639774dd315158677091e59c5db188cef
 SHA512:
-  metadata.gz: aea35622e25f8fd0cf84cc3115ce15b524440e698f516ebbd89188fa56d30c098dcc8711d61cee4b07aa7b77f935091222c2b0ff71465480d0e9cf76530810f5
-  data.tar.gz: 88a2613d9487be0b11e0da90bef805abc5fc1a7ca0012a97b32d5aa62540f382cc91e38b6714e4279bdba319475b323126625b4cf092e037742f30ba1c4ee22a
+  metadata.gz: f40ba2d34b2340c12d69812d8554a942dac423a2e5e764ac15d58cf644f978eb937e2104bef8ce288dd79f0875d8bda92998ad692e50ebbe6ff0f5cb6d130ec3
+  data.tar.gz: f12bfbd92bfe9101292598c69ceff2beb81bd92838b975f39d61e15e16fc6268ffb525896f5983186bced970e3e63d4e6a27cbd5d63cad91943a264236b184b4

data/README.md

@@ -1,114 +1,126 @@
-# Help Parser VIII: Helpland
+# Help Parser IX: Revelations
 
-* [VERSION 8.1.221206](https://github.com/carlosjhr64/help_parser/releases)
+* [VERSION 9.0.240926](https://github.com/carlosjhr64/help_parser/releases)
 * [github](https://www.github.com/carlosjhr64/help_parser)
 * [rubygems](https://rubygems.org/gems/help_parser)
 
 ## DESCRIPTION:
 
-Welcome to Help Parser!  
-Do you have your help text?  
-Let's parse!
+Options parsing based on your help text.
 
 ## INSTALL:
-
 ```console
 $ gem install help_parser
 ```
-
 ## SYNOPSIS:
 <!-- The following PREVIEW has been approved for ALL PROGRAMMERS by CarlosJHR64.
 For the README validator that checks against me lying....
 ```ruby
-unless File.basename($PROGRAM_NAME) == 'party'
+unless File.basename($PROGRAM_NAME) == 'revelations'
   # For example's sake say
-  $PROGRAM_NAME = 'party'
+  $PROGRAM_NAME = 'revelations'
   # and ARGV is
-  ARGV.concat ["-\-age", "-\-date=2020-09-07", 'touch', 'that']
-  # and proceed as if run as:
-  #     awesome -\-name=Doe -\-value  a b c
+  ARGV.concat ['1,2,3','4,5,6']
+  # and proceed as if run as: `revelations 1,2,3 4,5,6`
 end
 ```
 The following gem has been rated
-| M | Mature |
--->
-
+| M | Mature | -->
 ```ruby
-require "help_parser"
+#!/usr/bin/env ruby
+require 'help_parser'
 
-HELP = <<-HELP
+VERSION = '1.2.3'
+OPTIONS = HelpParser[VERSION, <<-HELP]
 # <= Hash here, parser skips
-# HelpParser: Party command example #
+# HelpParser command example #
+
+One can write any notes on the help text as long as
+it does not start with a space or a "Keyword:".
+
 Usage:
-  party :options+ [<args>+]
-  party [:alternate] <arg=FLOAT>
-  party literal <arg1=WORD> <arg2=WORD>
+  revelations :options+ [<arg>]
+  revelations :alternate <args=FLOAT>+
+  revelations literal <arg1=WORD> <arg2=WORD>
+  revelations <numbers=CSVI>+
+
+The ":keyword" refers to a flag in defined in the "Keyword:" section.
+A "[...]" is an optional part of the usage.
+A "+" means one or more of it is allowed.
+
 Options:
-  -v --version       \t Give version and quit
-  -h --help          \t Give help and quit
-  -s --long          \t Short long synonyms
-  --touch that       \t Defaulted
-  --date=DATE        \t Typed
-  --age=INTEGER 80   \t Typed and Defaulted
-  -a --all=YN y      \t Short, long, typed, and defaulted
-  --to_be
-  --not_to_be
+  -v --version \t Give version and quit
+  -h --help    \t Give help and quit
+  --verbose    \t Set $VERBOSE true
+  --debug      \t Set $DEBUG true
+
+The above(version, help, verbose, debug) are built-in options.
+The tab, "\t", splits the comment from the flags.
+On its own a flag is set to true, else it's nil.
+But you can also set a long flag value to a string as allowed by its type.
+
+  -a --all=YN y    \t Short, long, typed, and defaulted
+
+OPTIONS.all at first is nil. If set without a value, it's set to "y"
+One can set it to to either "n" of "y" as allowed by YN(see below under Types:).
+
+  --stop=NUMBER    \t Typed
+  --start=NUMBER 0 \t Typed and defaulted
+
   --rain
   --water
   --wet
+
+  --to_be
+  --not_to_be
+
 Exclusive:
-  to_be not_to_be    \t Tells parser these are mutually exclusive keys
+  to_be not_to_be \t Tells parser these are mutually exclusive keys
 Inclusive:
-  date age           \t Tells parser any of these must include all of these
+  start stop      \t Tells parser any of these must include all of these
 Conditional:
-  rain water wet     \t Tells parser if first then all
+  rain water wet  \t Tells parser if first then all
+                  \t Note how one can continue the comment as needed
+
 Alternate:
-  --invoke
-  --wut
+  --sum
+  --multiply
+
 Types:
   WORD    /^[A-Za-z]+$/
-  DATE    /^\\d\\d\\d\\d-\\d\\d-\\d\\d$/
-  INTEGER /^\\d+$/
+  NUMBER  /^\\d+$/
   FLOAT   /^\\d+\\.\\d+$/
   YN      /^[YNyn]$/
+  CSVI    /^\\d+(,\\d+)*$/
 # <= Hash here, parser breaks out
-# Notes #
-I wouldn't touch that!
+And now one can freely write whatever....
 HELP
 
-VERSION = "1.2.3"
-
-OPTIONS = HelpParser[VERSION, HELP] #~> HelpParser
-
-# Macros:
-HelpParser.strings?(:args)             # for OPTIONS.args      : Array(String) | Nil
-HelpParser.int?(:age)                  # for OPTIONS.age?      : Integer | Nil
-HelpParser.float(:arg)                 # for options.arg       : Float
-HelpParser.string(:arg1, :arg2, :arg3) # for OPTIONS.arg1, etc : String
-#=> [:arg1, :arg2, :arg3]
-
-## If run as:
-##   party --age --date=2020-09-07 touch that
-OPTIONS.age?                 #=> 80
-OPTIONS.age?.class           #=> Integer
-OPTIONS.args?                #=> ["touch", "that"]
-OPTIONS.args?.class          #=> Array
-OPTIONS.arg? and OPTIONS.arg #=> false
-OPTIONS.arg?.class           #=> FalseClass
-```
+# Tell HelpParser how to remap the string values:
+HelpParser.integer(:stop, :start) # HelpParser.map(:stop, :start, map: :to_i)
+HelpParser.float(:args)           # HelpParser.map(:args, map: :to_f)
+# Also available: HelpParser.rational(*name) = HelpParser.map(*names, map: to_r)
 
+# Tell HelpParser how to split the string values:
+HelpParser.split(:numbers, sep: ',', map: :to_i)
+# Also available: HelpParser.csv(*name) = HelpParser.split(*names)
+
+# If one runs `revelations 1,2,3 4,5,6`, then:
+OPTIONS.numbers #=> [[1, 2, 3], [4, 5, 6]]
+# And everything else is unset:
+OPTIONS.stop #=> nil
+```
 ## Features
 
-* `$DEBUG=true` on --debug
-* `$VERBOSE=true` on --verbose
 * -h and --help simultaneously will check help string for errors
+* `ARGV` setup for `ARGF` when one of the "Types:" given is "ARGF"
 * `HelpParser::REDTTY[msg]` will red color output `msg` to `$stderr`.
 
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2022 CarlosJHR64
+Copyright (c) 2024 CarlosJHR64
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/help_parser/aliases.rb

@@ -1,14 +1,14 @@
 module HelpParser
   class NoDupHash < Hash
     def []=(k,v)
-      raise HelpError, MSG[DUP_KEY,k]  if self.has_key?(k)
+      raise HelpError, MSG[DUP_KEY,k] if key?(k)
       super
     end
   end
 
   class ArgvHash < Hash
     def []=(k,v)
-      raise UsageError, MSG[DUP_KEY,k] if self.has_key?(k)
+      raise UsageError, MSG[DUP_KEY,k] if key?(k)
       super
     end
   end

data/lib/help_parser/completion.rb

@@ -3,26 +3,35 @@ module HelpParser
     def initialize(hash, specs)
       @hash,@specs = hash,specs
       @cache = NoDupHash.new
-      usage or diagnose  if @specs.has_key?(USAGE)
+      usage or diagnose if @specs.key?(USAGE)
       pad
-      types  if @specs.has_key?(TYPES)
+      if @specs.key?(TYPES)
+        k2t = types
+        handle_argf(k2t) if k2t.detect{|_,v|v=='ARGF'}
+      end
+    end
+
+    # Prepare ARGV for ARGF.
+    def handle_argf(k2t)
+      files = @hash.select{|k,_|k2t[k]=='ARGF'}.map{|_,v|v}.flatten
+      e = files.reject{File.exist?_1}.join(', ')
+      raise UsageError, MSG[NOT_EXIST, e] unless e.empty?
+      ARGV.replace files
     end
 
     # Which usage does the user's command options match?
     def usage
       @specs[USAGE].each do |cmd|
-        begin
-          i = matches(cmd)
-          raise NoMatch unless @hash.size==i
-          @cache.each{|k,v|@hash[k]=v} # Variables
-          return true # Good! Found matching usage.
-        rescue NoMatch
-          next
-        ensure
-          @cache.clear
-        end
+        i = matches(cmd)
+        raise NoMatch unless @hash.size==i
+        @cache.each{|k,v|@hash[k]=v} # Variables
+        return true # Good! Found matching usage.
+      rescue NoMatch
+        next
+      ensure
+        @cache.clear
       end
-      return false # Bad! Did not match any of the expected usage.
+      false # Bad! Did not match any of the expected usage.
     end
 
     # Diagnose user's usage.
@@ -37,7 +46,7 @@ module HelpParser
           end
         end
       end
-      typos = @hash.keys.select{|k|k.is_a? String and not dict[k]}
+      typos = @hash.keys.select{_1.is_a?(String) && !dict[_1]}
       raise UsageError, MSG[UNRECOGNIZED, typos] unless typos.empty?
 
       raise UsageError, MATCH_USAGE
@@ -46,26 +55,25 @@ module HelpParser
     def types
       t2r,k2t = HelpParser.t2r(@specs),HelpParser.k2t(@specs)
       @hash.each do |key,value|
-        next unless key.is_a?(String)
-        if type = k2t[key]
-          regex = t2r[type]
-          case value
-          when String
-            unless value=~regex
-              raise UsageError, "--#{key}=#{value} !~ #{type}=#{regex.inspect}"
-            end
-          when Array
-            value.each do |string|
-              unless string=~regex
-                raise UsageError,
-                  "--#{key}=#{string} !~ #{type}=#{regex.inspect}"
-              end
+        next unless key.is_a?(String) && (type=k2t[key])
+        regex = t2r[type]
+        case value
+        when String
+          unless value=~regex
+            raise UsageError, "--#{key}=#{value} !~ #{type}=#{regex.inspect}"
+          end
+        when Array
+          value.each do |string|
+            unless string=~regex
+              raise UsageError,
+                "--#{key}=#{string} !~ #{type}=#{regex.inspect}"
             end
-          else
-            raise UsageError, "--#{key} !~ #{type}=#{regex.inspect}"
           end
+        else
+          raise UsageError, "--#{key} !~ #{type}=#{regex.inspect}"
         end
       end
+      k2t
     end
 
     def pad
@@ -79,12 +87,12 @@ module HelpParser
             if second[0]=='-'
               i = second.index('=') || 0
               short,long = first[1],second[2..(i-1)]
-              if @hash.has_key?(short)
-                if @hash.has_key?(long)
+              if @hash.key?(short)
+                if @hash.key?(long)
                   raise UsageError, MSG[REDUNDANT, short, long]
                 end
-                @hash[long] = (default.nil?) ? true : default
-              elsif value = @hash[long]
+                @hash[long] = default.nil? ? true : default
+              elsif (value=@hash[long])
                 @hash[short] = true
                 if value==true && !default.nil?
                   @hash.delete(long) # ArgvHash reset
@@ -117,7 +125,7 @@ module HelpParser
             # OK, NEVERMIND!
           end
           next
-        elsif m=FLAG_GROUP.match(token)
+        elsif (m=FLAG_GROUP.match token)
           group,plus = m[:k],m[:p]
           key = keys[i]
           raise NoMatch unless key.is_a? String
@@ -126,11 +134,11 @@ module HelpParser
           unless plus.nil?
             loop do
               key = keys[i+1]
-              break unless key.is_a?(String) and list.include?(key)
+              break unless key.is_a?(String) && list.include?(key)
               i+=1
             end
           end
-        elsif m=VARIABLE.match(token)
+        elsif (m=VARIABLE.match(token))
           key = keys[i]
           raise NoMatch unless key.is_a?(Integer)
           variable,plus = m[:k],m[:p]
@@ -153,7 +161,7 @@ module HelpParser
         end
         i += 1
       end
-      return i
+      i
     end
   end
 end

data/lib/help_parser/constants.rb

@@ -1,6 +1,6 @@
 module HelpParser
-  VSN = ['v','version']
-  HLP = ['h','help']
+  VSN = %w[v version]
+  HLP = %w[h help]
   VRBS,DBG = 'verbose','debug'
 
   # reserved name
@@ -16,19 +16,19 @@ module HelpParser
   SECTION_NAME = /^(?<name>[A-Z]\w+):$/
 
   # usage
-  FLAG       = /^[-][-]?(?<k>\w+)$/
+  FLAG       = /^--?(?<k>\w+)$/
   LITERAL    = /^(?<k>\w[\w.-]*:?)$/
   VARIABLE   = /^<(?<k>\w+)(=(?<t>[A-Z]+))?>(?<p>[+])?$/
   FLAG_GROUP = /^:(?<k>\w+)(?<p>[+])?$/
 
   # spec --?w+
-  SHORT = /^[-](?<s>\w)$/
-  LONG  = /^[-][-](?<k>\w+)(=(?<t>[A-Z]+))?(,?\s+(?<d>[^-\s]\S*))?$/
+  SHORT = /^-(?<s>\w)$/
+  LONG  = /^--(?<k>\w+)(=(?<t>[A-Z]+))?(,?\s+(?<d>[^-\s]\S*))?$/
 
   # spec -w,? --w+
-  SHORT_LONG         = /^[-](?<s>\w),?\s+[-][-](?<k>\w+)$/
+  SHORT_LONG         = /^-(?<s>\w),?\s+--(?<k>\w+)$/
   SHORT_LONG_DEFAULT =
-    /^[-](?<s>\w),?\s+[-][-](?<k>\w+)(=(?<t>[A-Z]+))?,?\s+(?<d>\S*)$/
+    /^-(?<s>\w),?\s+--(?<k>\w+)(=(?<t>[A-Z]+))?,?\s+(?<d>\S*)$/
 
   # spec W+ /~/
   TYPE_DEF = /^(?<t>[A-Z]+),?\s+\/(?<r>\S+)\/$/
@@ -73,15 +73,16 @@ module HelpParser
   NOT_FLOATS          = 'Not all Floats'
   NOT_INTEGER         = 'Not an Integer'
   NOT_INTEGERS        = 'Not all Integers'
+  NOT_EXIST           = 'Does not exist'
   # error messages, full:
   NO_MATCH            = 'Software Error: NoMatch was not caught by HelpParser.'
   MATCH_USAGE         = 'Please match usage.'
   EXTRANEOUS_SPACES   = 'Extraneous spaces in help.'
 
   # lambda utilities
-  MSG = lambda{|msg,*keys| "#{msg}:  #{keys.join(' ')}"}
-  F2K = lambda{|f| f[1]=='-' ? f[2..((f.index('=')||0)-1)] : f[1]}
-  REDTTY = lambda{|msg,out=$stderr|
+  MSG = ->(msg,*keys){"#{msg}:  #{keys.join(' ')}"}
+  F2K = ->(f){f[1]=='-' ? f[2..((f.index('=')||0)-1)] : f[1]}
+  REDTTY = lambda do |msg,out=$stderr|
     out.tty? ? out.puts("\033[0;31m#{msg}\033[0m"): out.puts(msg)
-  }
+  end
 end

data/lib/help_parser/exceptions.rb

@@ -1,6 +1,8 @@
 module HelpParser
   class HelpParserException < Exception
-    def _init; @code = 1; end
+    def _init
+      @code = 1
+    end
 
     # Must give message
     def initialize(message)
@@ -9,35 +11,45 @@ module HelpParser
     end
 
     def exit
-      if @code > 0
-        REDTTY[self.message]
+      if @code.positive?
+        REDTTY[message]
       else
-        $stdout.puts self.message
+        $stdout.puts message
       end
       Kernel.exit @code
     end
   end
 
   class VersionException < HelpParserException
-    def _init; @code = 0; end
+    def _init
+      @code = 0
+    end
   end
 
   class HelpException < HelpParserException
-    def _init; @code = 0; end
+    def _init
+      @code = 0
+    end
   end
 
   class UsageError < HelpParserException
-    def _init; @code = EX_USAGE; end
+    def _init
+      @code = EX_USAGE
+    end
   end
 
   class SoftwareError < HelpParserException
     # Stuff that should not happen
-    def _init; @code = EX_SOFTWARE; end
+    def _init
+      @code = EX_SOFTWARE
+    end
   end
 
   class NoMatch < HelpParserException
     # used to short-circuit out
-    def _init; @code = EX_SOFTWARE; end
+    def _init
+      @code = EX_SOFTWARE
+    end
 
     # Forces it's own message
     def initialize
@@ -46,6 +58,8 @@ module HelpParser
   end
 
   class HelpError < HelpParserException
-    def _init; @code = EX_CONFIG; end
+    def _init
+      @code = EX_CONFIG
+    end
   end
 end

data/lib/help_parser/k2t2r.rb

@@ -3,14 +3,14 @@ module HelpParser
   def self.k2t(specs)
     k2t = NoDupHash.new
     # If specs section is not a RESERVED section, it's an options list.
-    tokens = specs.select{|k,v| k==USAGE or not RESERVED.include?(k)}
+    tokens = specs.select{|k,_| k==USAGE or !RESERVED.include?(k)}
       # Tokens associating a key to a type.
       .values.flatten.select{|v|v.include?('=')}
     tokens.each do |token|
-      if match = VARIABLE.match(token) || LONG.match(token)
+      if (match = VARIABLE.match(token) || LONG.match(token))
         name, type = match[:k], match[:t]
-        if _=k2t[name]
-          raise HelpError, MSG[INCONSISTENT,name,type,_]  unless type==_
+        if (_=k2t[name])
+          raise HelpError, MSG[INCONSISTENT,name,type,_] unless type==_
         else
           k2t[name] = type
         end
@@ -19,12 +19,12 @@ module HelpParser
         raise SoftwareError, MSG[UNEXPECTED,token]
       end
     end
-    return k2t
+    k2t
   end
 
   # t2r is an acronym for "type to regexp"
   def self.t2r(specs)
-    if types = specs[TYPES]
+    if (types=specs[TYPES])
       t2r = NoDupHash.new
       types.each do |pair|
         type, pattern = *pair
@@ -36,6 +36,6 @@ module HelpParser
       end
       return t2r
     end
-    return nil
+    nil
   end
 end

data/lib/help_parser/macros.rb

@@ -1,183 +1,29 @@
 module HelpParser
-  def self.string(*names)
+  def self.map(*names, map:)
     names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}
-      s = @hash['#{name}']
-      raise UsageError, MSG[NOT_STRING,'#{name}'] unless s.is_a?(String)
-      return s
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.string?(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}?
-      s = @hash['#{name}']
-      raise UsageError, MSG[NOT_STRING,'#{name}'] unless s.nil? ||
-        s.is_a?(String)
-      return s
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.strings(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}
-      a = @hash['#{name}']
-      raise UsageError, MSG[NOT_STRINGS,'#{name}'] unless a.is_a?(Array)
-      return a
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.strings?(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}?
-      a = @hash['#{name}']
-      raise UsageError, MSG[NOT_STRINGS,'#{name}'] unless a.nil? ||
-        a.is_a?(Array)
-      return a
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.float(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}
-      @hash['#{name}']&.to_f or raise
-    rescue
-      raise UsageError, MSG[NOT_FLOAT,'#{name}']
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.float?(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}?
-      @hash['#{name}']&.to_f
-    rescue
-      raise UsageError, MSG[NOT_FLOAT,'#{name}']
-    end
-  end
-      CODE
-      eval code
+      Options.instance_eval do
+        define_method(name) do
+          v = @hash[name.to_s] and (v.is_a?(Array) ?
+                                    v.map(&map) :
+                                    v.method(map).call)
+        end
+      end
     end
   end
+  def self.integer(*names)  = HelpParser.map(*names, map: :to_i)
+  def self.float(*names)    = HelpParser.map(*names, map: :to_f)
+  def self.rational(*names) = HelpParser.map(*names, map: :to_r)
 
-  def self.floats(*names)
+  def self.split(*names, sep:, map:)
     names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}
-      @hash['#{name}'].map{_1.to_f}
-    rescue
-      raise UsageError, MSG[#{NOT_FLOATS},'#{name}']
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.floats?(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}?
-      @hash['#{name}']&.map{_1.to_f}
-    rescue
-      raise UsageError, MSG[NOT_FLOATS,'#{name}']
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.int(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}
-      @hash['#{name}']&.to_i or raise
-    rescue
-      raise UsageError, MSG[NOT_INTEGER,'#{name}']
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.int?(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}?
-      @hash['#{name}']&.to_i
-    rescue
-      raise UsageError, MSG[NOT_INTEGER,'#{name}']
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.ints(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}
-      @hash['#{name}'].map{_1.to_i}
-    rescue
-      raise UsageError, MSG[NOT_INTEGERS,'#{name}']
-    end
-  end
-      CODE
-      eval code
-    end
-  end
-
-  def self.ints?(*names)
-    names.each do |name|
-      code = <<-CODE
-  class Options
-    def #{name}?
-      @hash['#{name}']&.map{_1.to_i}
-    rescue
-      raise UsageError, MSG[NOT_INTEGERS,'#{name}']
-    end
-  end
-      CODE
-      eval code
+      Options.instance_eval do
+        define_method(name) do
+          v = @hash[name.to_s] and (v.is_a?(Array) ?
+                                    v.map{_1.split(sep).map(&map)} :
+                                    v.split(sep).map(&map))
+        end
+      end
     end
   end
+  def self.csv(*names) = HelpParser.split(*names, sep: ',', map: :strip)
 end

data/lib/help_parser/options.rb

@@ -2,34 +2,35 @@ module HelpParser
   class Options
     def initialize(version, help, argv)
       @hash = HelpParser.parsea(argv)
-      if version && VSN.any?{@hash.has_key? _1}
+      if version && VSN.any?{@hash.key? _1}
         # -v or --version
-        raise VersionException, version
+        raise VersionException, String(version)
       end
       if help
+        help = String(help)
         if HLP.any?{@hash.key? _1}
-          HelpParser.parseh(help, validate: true)  if HLP.all?{@hash.key? _1}
+          HelpParser.parseh(help, validate: true) if HLP.all?{@hash.key? _1}
           raise HelpException, help
         end
         specs = HelpParser.parseh(help)
         Completion.new(@hash, specs)
-        if exclusive=specs[EXCLUSIVE]
+        if (exclusive=specs[EXCLUSIVE])
           exclusive.each do |x|
             count = x.count{@hash.key? _1}
             raise HelpParser::UsageError, MSG[EXCLUSIVE_KEYS,*x] if count > 1
           end
         end
-        if inclusive=specs[INCLUSIVE]
+        if (inclusive=specs[INCLUSIVE])
           inclusive.each do |i|
             count = i.count{@hash.key? _1}
-            unless count==0 or count==i.length
+            unless count.zero? || count==i.length
               raise HelpParser::UsageError, MSG[INCLUSIVE_KEYS,*i]
             end
           end
         end
-        if conditional=specs[CONDITIONAL]
+        if (conditional=specs[CONDITIONAL])
           conditional.each do |c|
-            if @hash.key? c[0] and not c.all?{@hash.key? _1}
+            if @hash.key?(c[0]) && !c.all?{@hash.key? _1}
               raise HelpParser::UsageError, MSG[CONDITIONAL_KEYS,*c]
             end
           end
@@ -47,17 +48,16 @@ module HelpParser
       @hash[k]
     end
 
-    def method_missing(mthd, *args, &block)
-      super if block or args.length > 0
-      m = mthd.to_s
-      case m[-1]
-      when '?'
-        @hash.key? m[0..-2]
-      when '!'
-        super
-      else
-        @hash[m]
+    def respond_to_missing?(m, include_all=false)
+      m[-1]=='!' ? super : true
+    end
+
+    def method_missing(m, *args, &block)
+      super unless respond_to_missing?(m)
+      unless args.empty? && block.nil?
+        raise ArgumentError, 'expected neither args nor block'
       end
+      m[-1]=='?' ? @hash.key?(m[0..-2].to_s) : @hash[m.to_s]
     end
   end
 end

data/lib/help_parser/parsea.rb

@@ -7,7 +7,7 @@ module HelpParser
         break if a.size==1 # '-' quits argv processing
         if a[1]=='-'
           break if a.size==2 # '--' also quits argv processing
-          s = a[2..-1]
+          s = a[2..]
           if s.include?('=')
             k,v = s.split('=',2)
             hsh[k] = v
@@ -15,7 +15,7 @@ module HelpParser
             hsh[s] = true
           end
         else
-          a.chars[1..-1].each do |c|
+          a.chars[1..].each do |c|
             hsh[c] = true
           end
         end
@@ -24,6 +24,6 @@ module HelpParser
         n += 1
       end
     end
-    return hsh
+    hsh
   end
 end

data/lib/help_parser/parseh.rb

@@ -4,15 +4,18 @@ module HelpParser
     help.each_line do |line|
       line.chomp!
       next if line==''
-      if md = SECTION_NAME.match(line)
+      if (md=SECTION_NAME.match(line))
         name = md[:name].downcase
         specs[name] = []
       else
         next if name==''
         break if line[0]=='#'
-        next if !(line[0]==' ')
-        spec = (index=line.rindex("\t"))? line[0,index].strip : line.strip
-        raise HelpError, EXTRANEOUS_SPACES if validate and spec==''
+        next unless line[0]==' '
+        spec,comment = line.split("\t", 2).map(&:strip)
+        if spec.empty?
+          raise HelpError, EXTRANEOUS_SPACES if validate && comment.to_s.empty?
+          next
+        end
         case name
         when USAGE
           Validate.balanced_brackets(spec.chars) if validate
@@ -20,29 +23,31 @@ module HelpParser
           Validate.usage_tokens(tokens) if validate
           specs[USAGE].push tokens
         when TYPES
-          if validate and not spec=~TYPE_DEF
+          if validate && !TYPE_DEF.match?(spec)
             raise HelpError, MSG[UNRECOGNIZED_TYPE,spec]
           end
           specs[TYPES].push spec.split(CSV)
         when *FLAG_CLUMPS # EXCLUSIVE,INCLUSIVE,CONDITIONAL,...
-          if validate and not spec=~X_DEF
+          if validate && !X_DEF.match?(spec)
             raise HelpError, MSG[UNRECOGNIZED_X,spec]
           end
           specs[name].push spec.split(CSV)
         else
-          raise HelpError, MSG[UNRECOGNIZED_OPTION,spec] if validate and
-              not [SHORT, LONG, SHORT_LONG, SHORT_LONG_DEFAULT].any?{_1=~spec}
+          if validate &&
+             [SHORT, LONG, SHORT_LONG, SHORT_LONG_DEFAULT].none?{_1=~spec}
+            raise HelpError, MSG[UNRECOGNIZED_OPTION,spec]
+          end
           specs[name].push spec.split(CSV)
         end
       end
     end
     if validate
       Validate.usage_specs(specs)
-      if t2r = HelpParser.t2r(specs)
+      if (t2r=HelpParser.t2r(specs))
         k2t = HelpParser.k2t(specs)
         Validate.k2t2r(specs, k2t, t2r)
       end
     end
-    return specs
+    specs
   end
 end

data/lib/help_parser/parseu.rb

@@ -5,7 +5,7 @@ module HelpParser
   # Tokens := Array(Token|Tokens)
   def self.parseu(chars)
     tokens,token = [],''
-    while c = chars.shift
+    while (c=chars.shift)
       case c
       when ' ','[',']'
         unless token==''
@@ -19,6 +19,6 @@ module HelpParser
       end
     end
     tokens.push(token) unless token==''
-    return tokens
+    tokens
   end
 end

data/lib/help_parser/validate.rb

@@ -3,14 +3,10 @@ module Validate
   def self.balanced_brackets(chars)
     count = 0
     chars.each do |c|
-      if c=='['
-        count += 1
-      elsif c==']'
-        count -= 1
-      end
-      break if count<0
+      c=='[' && (count+=1) or c==']' && (count-=1)
+      break if count.negative?
     end
-    raise HelpError, MSG[UNBALANCED,chars.join] unless count==0
+    raise HelpError, MSG[UNBALANCED,chars.join] unless count.zero?
   end
 
   def self.usage_tokens(tokens)
@@ -18,7 +14,7 @@ module Validate
     tokens.flatten.each do |token|
       raise HelpError, MSG[UNRECOGNIZED_TOKEN,token] unless
       [FLAG,LITERAL,VARIABLE,FLAG_GROUP]
-      .detect{_=token.match(_1) and words.push(_[:k])}
+      .detect{(_=token.match _1) && words.push(_[:k])}
     end
     words.each_with_index do |word,i|
       raise HelpError, MSG[DUP_WORD,word] unless i==words.rindex(word)
@@ -26,40 +22,47 @@ module Validate
   end
 
   def self.usage_specs(specs)
-    flags = specs.select{|a,b| not RESERVED.include? a}.values.flatten
-           .select{|f|f[0]=='-'}.map{|f| F2K[f]}
+    flags = specs.except(*RESERVED).values.flatten
+            .select{_1[0]=='-'}.map{F2K[_1]}
     FLAG_CLUMPS.each do |k|
-      if a=specs[k]
-        seen = {}
-        a.each do |xs|
-          k = xs.sort.join(' ').to_sym
-          if seen[k] or not xs.length==xs.uniq.length
-            raise HelpError, MSG[DUP_X,k]
-          end
-          seen[k] = true
-          xs.each do |x|
-            raise HelpError, MSG[UNSEEN_FLAG, x] unless flags.include?(x)
-          end
+      next unless (a=specs[k])
+      seen = {}
+      a.each do |xs|
+        k = xs.sort.join(' ').to_sym
+        if seen[k] || xs.length!=xs.uniq.length
+          raise HelpError, MSG[DUP_X,k]
+        end
+        seen[k] = true
+        xs.each do |x|
+          raise HelpError, MSG[UNSEEN_FLAG, x] unless flags.include?(x)
         end
       end
     end
     flags.each_with_index do |flag,i|
       raise HelpError, MSG[DUP_FLAG,flag] unless i==flags.rindex(flag)
-    end   
-    group = []
+    end
+    group,var = [],{}
     specs_usage = specs[USAGE]
-    unless specs_usage.nil?
-      specs_usage.flatten.each do |token|
-        if match = token.match(FLAG_GROUP)
-          key = match[:k]
-          raise HelpError, MSG[UNDEFINED_SECTION,key] unless specs[key]
-          group.push(key)
+    specs_usage&.flatten&.each do |token|
+      case token
+      when VARIABLE
+        key,bool = $~[:k],$~[:p].nil?
+        if var.key? key
+          unless var[key]==bool
+            raise HelpError, MSG[INCONSISTENT,"<#{key}>","<#{key}>+"]
+          end
+        else
+          var[key]=bool
         end
+      when FLAG_GROUP
+        key = $~[:k]
+        raise HelpError, MSG[UNDEFINED_SECTION,key] unless specs[key]
+        group.push(key)
       end
     end
     specs.each do |key,tokens|
-      raise HelpError, MSG[MISSING_CASES,key] unless tokens.size>0
-      next if specs_usage.nil? or RESERVED.include? key
+      raise HelpError, MSG[MISSING_CASES,key] if tokens.empty?
+      next if specs_usage.nil? || RESERVED.include?(key)
       raise HelpError, MSG[MISSING_USAGE,key] unless group.include?(key)
     end
   end
@@ -67,7 +70,7 @@ module Validate
   def self.k2t2r(specs, k2t, t2r)
     a,b = k2t.values.uniq.sort,t2r.keys.sort
     unless a==b
-      c = (a+b).uniq.select{|x|!(a.include?(x) && b.include?(x))}
+      c = (a+b).uniq.reject{|x|a.include?(x) && b.include?(x)}
       raise HelpError, MSG[UNCOMPLETED_TYPES,c.join(',')]
     end
     specs.each do |section,tokens|
@@ -80,7 +83,7 @@ module Validate
         i = long_type.index('=')
         next if i.nil?
         long = long_type[2..(i-1)]
-        type = long_type[(i+1)..-1]
+        type = long_type[(i+1)..]
         regex = t2r[type]
         unless regex=~default
           raise HelpError, MSG[BAD_DEFAULT,long,default,type,regex.inspect]

data/lib/help_parser.rb

@@ -10,7 +10,7 @@ require_relative 'help_parser/options'
 require_relative 'help_parser/macros'
 
 module HelpParser
-  VERSION = '8.1.221206'
+  VERSION = '9.0.240926'
   autoload :Validate, 'help_parser/validate'
 
   def self.[](
@@ -18,10 +18,10 @@ module HelpParser
     help    = nil,
     argv    = [File.basename($0)]+ARGV)
     Options.new(version, help, argv)
-  rescue HelpParserException => exception
-    exception.exit
+  rescue HelpParserException => e
+    e.exit
   end
 end
 
 # Requires:
-#`ruby`
+# `ruby`

metadata

@@ -1,22 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: help_parser
 version: !ruby/object:Gem::Version
-  version: 8.1.221206
+  version: 9.0.240926
 platform: ruby
 authors:
 - CarlosJHR64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-06 00:00:00.000000000 Z
-dependencies: []
-description: "Welcome to Help Parser!  \nDo you have your help text?  \nLet's parse!\n"
+date: 2024-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.2.0
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.66.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.66.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+description: 'Options parsing based on your help text.
+
+  '
 email: carlosjhr64@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.md
 - lib/help_parser.rb
 - lib/help_parser/aliases.rb
@@ -49,9 +150,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [aarch64-linux]'
-rubygems_version: 3.3.7
+- 'git: 2.30'
+- 'ruby: 3.3'
+rubygems_version: 3.5.19
 signing_key: 
 specification_version: 4
-summary: Welcome to Help Parser!   Do you have your help text?   Let's parse!
+summary: Options parsing based on your help text.
 test_files: []

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 carlosjhr64
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.