help_parser 8.0.210917 → 8.1.221206

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89d031ef15e33460fc4f23ccec23cc98f01cb9808fd77bb478c63be6a638f034
-  data.tar.gz: 9521262caa0b0a1617fc52bdeec42c4e305a4fc4ce34c5871128c64eecf5aae7
+  metadata.gz: 157ae793a16a5b92ca1633306080465fcd2e9671aaed67dc01fb47cb318f0824
+  data.tar.gz: cc72ed9f03c94ef2f5455897807a49ba69e79786ceae5daa3d158d3265e9a931
 SHA512:
-  metadata.gz: 4e6c0faa99fd04e8b8e2f289b0f1894538747defaeb557400b36904f7c330961b9cc068aa8bdbe06493f8339af19cd4397cfdca9e1f82bc20ddbf84b91553955
-  data.tar.gz: 135b86c92d72faa5b49cdfedd7b6c66a9e568e592ae5b8afc86c612efa23020c828acb45693435d5f5349679f61a963bac81041da6d6bdae9549c1ab2de3214b
+  metadata.gz: aea35622e25f8fd0cf84cc3115ce15b524440e698f516ebbd89188fa56d30c098dcc8711d61cee4b07aa7b77f935091222c2b0ff71465480d0e9cf76530810f5
+  data.tar.gz: 88a2613d9487be0b11e0da90bef805abc5fc1a7ca0012a97b32d5aa62540f382cc91e38b6714e4279bdba319475b323126625b4cf092e037742f30ba1c4ee22a

data/README.md

@@ -1,6 +1,6 @@
 # Help Parser VIII: Helpland
 
-* [VERSION 8.0.210917](https://github.com/carlosjhr64/help_parser/releases)
+* [VERSION 8.1.221206](https://github.com/carlosjhr64/help_parser/releases)
 * [github](https://www.github.com/carlosjhr64/help_parser)
 * [rubygems](https://rubygems.org/gems/help_parser)
 
@@ -102,13 +102,13 @@ OPTIONS.arg?.class           #=> FalseClass
 * `$DEBUG=true` on --debug
 * `$VERBOSE=true` on --verbose
 * -h and --help simultaneously will check help string for errors
-* `HelpParser::REDTTY[msg]` will red color output `msg` to `STDERR`.
+* `HelpParser::REDTTY[msg]` will red color output `msg` to `$stderr`.
 
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2021 CarlosJHR64
+Copyright (c) 2022 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/completion.rb

@@ -28,9 +28,14 @@ module HelpParser
     # Diagnose user's usage.
     def diagnose
       dict = {}
-      @specs.each do |k,v|
-        next if RESERVED.include? k
-        v.flatten.map{_1.scan(/\w+/).first}.each{dict[_1]=true}
+      @specs.each do |section,list|
+        next if RESERVED.include? section
+        list.flatten.select{_1[0]=='-'}.each do |key_type|
+          key_type.scan(/\w+/) do |key|
+            dict[key]=true
+            break
+          end
+        end
       end
       typos = @hash.keys.select{|k|k.is_a? String and not dict[k]}
       raise UsageError, MSG[UNRECOGNIZED, typos] unless typos.empty?
@@ -66,7 +71,7 @@ module HelpParser
     def pad
       # Synonyms and defaults:
       @specs.each do |section,options|
-        next if section==USAGE || section==TYPES
+        next if RESERVED.any?{section==_1}
         options.each do |words|
           next unless words.size>1
           first,second,default = words[0],words[1],words[2]
@@ -95,6 +100,8 @@ module HelpParser
                 @hash[long] = default
               end
             end
+          else
+            raise SoftwareError, MSG[UNEXPECTED, words]
           end
         end
       end
@@ -113,13 +120,13 @@ module HelpParser
         elsif m=FLAG_GROUP.match(token)
           group,plus = m[:k],m[:p]
           key = keys[i]
-          raise NoMatch if key.nil? || key.is_a?(Integer)
+          raise NoMatch unless key.is_a? String
           list = @specs[group].flatten.select{|f|f[0]=='-'}.map{|f| F2K[f]}
           raise NoMatch unless list.include?(key)
           unless plus.nil?
             loop do
               key = keys[i+1]
-              break if key.nil? || key.is_a?(Integer) || !list.include?(key)
+              break unless key.is_a?(String) and list.include?(key)
               i+=1
             end
           end

data/lib/help_parser/constants.rb

@@ -1,6 +1,6 @@
 module HelpParser
-  V,VSN = 'v','version'
-  H,HLP = 'h','help'
+  VSN = ['v','version']
+  HLP = ['h','help']
   VRBS,DBG = 'verbose','debug'
 
   # reserved name
@@ -13,7 +13,7 @@ module HelpParser
   RESERVED = [USAGE,TYPES,EXCLUSIVE,INCLUSIVE,CONDITIONAL]
 
   # sections
-  SECTION_NAME = /^[A-Z]\w+:$/
+  SECTION_NAME = /^(?<name>[A-Z]\w+):$/
 
   # usage
   FLAG       = /^[-][-]?(?<k>\w+)$/
@@ -28,7 +28,7 @@ module HelpParser
   # spec -w,? --w+
   SHORT_LONG         = /^[-](?<s>\w),?\s+[-][-](?<k>\w+)$/
   SHORT_LONG_DEFAULT =
-    /^[-](?<s>\w),?\s+[-][-](?<k>\w+)(=(?<t>[A-Z]+))?,?\s+(?<d>[^-\s]\S*)$/
+    /^[-](?<s>\w),?\s+[-][-](?<k>\w+)(=(?<t>[A-Z]+))?,?\s+(?<d>\S*)$/
 
   # spec W+ /~/
   TYPE_DEF = /^(?<t>[A-Z]+),?\s+\/(?<r>\S+)\/$/

data/lib/help_parser/k2t2r.rb

@@ -1,8 +1,11 @@
 module HelpParser
+  # k2t is an acronym for the "key to type" mapping
   def self.k2t(specs)
     k2t = NoDupHash.new
-    tokens = specs.select{|k,v| !(k==TYPES)}.values.flatten
-      .select{|v|v.include?('=')}
+    # 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 associating a key to a type.
+      .values.flatten.select{|v|v.include?('=')}
     tokens.each do |token|
       if match = VARIABLE.match(token) || LONG.match(token)
         name, type = match[:k], match[:t]
@@ -19,6 +22,7 @@ module HelpParser
     return k2t
   end
 
+  # t2r is an acronym for "type to regexp"
   def self.t2r(specs)
     if types = specs[TYPES]
       t2r = NoDupHash.new

data/lib/help_parser/macros.rb

@@ -66,9 +66,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}
-      f = @hash['#{name}']
-      raise if f.nil?
-      f.to_f
+      @hash['#{name}']&.to_f or raise
     rescue
       raise UsageError, MSG[NOT_FLOAT,'#{name}']
     end
@@ -83,9 +81,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}?
-      f = @hash['#{name}']
-      f = f.to_f if f
-      return f
+      @hash['#{name}']&.to_f
     rescue
       raise UsageError, MSG[NOT_FLOAT,'#{name}']
     end
@@ -100,9 +96,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}
-      f = @hash['#{name}']
-      raise unless f.is_a?(Array)
-      f.map{_1.to_f}
+      @hash['#{name}'].map{_1.to_f}
     rescue
       raise UsageError, MSG[#{NOT_FLOATS},'#{name}']
     end
@@ -117,10 +111,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}?
-      f = @hash['#{name}']
-      return nil unless f
-      raise unless f.is_a?(Array)
-      f.map{_1.to_f}
+      @hash['#{name}']&.map{_1.to_f}
     rescue
       raise UsageError, MSG[NOT_FLOATS,'#{name}']
     end
@@ -135,9 +126,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}
-      f = @hash['#{name}']
-      raise if f.nil?
-      f.to_i
+      @hash['#{name}']&.to_i or raise
     rescue
       raise UsageError, MSG[NOT_INTEGER,'#{name}']
     end
@@ -152,9 +141,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}?
-      f = @hash['#{name}']
-      f = f.to_i if f
-      return f
+      @hash['#{name}']&.to_i
     rescue
       raise UsageError, MSG[NOT_INTEGER,'#{name}']
     end
@@ -169,9 +156,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}
-      f = @hash['#{name}']
-      raise unless f.is_a?(Array)
-      f.map{_1.to_i}
+      @hash['#{name}'].map{_1.to_i}
     rescue
       raise UsageError, MSG[NOT_INTEGERS,'#{name}']
     end
@@ -186,10 +171,7 @@ module HelpParser
       code = <<-CODE
   class Options
     def #{name}?
-      f = @hash['#{name}']
-      return nil unless f
-      raise unless f.is_a?(Array)
-      f.map{_1.to_i}
+      @hash['#{name}']&.map{_1.to_i}
     rescue
       raise UsageError, MSG[NOT_INTEGERS,'#{name}']
     end

data/lib/help_parser/options.rb

@@ -2,14 +2,13 @@ module HelpParser
   class Options
     def initialize(version, help, argv)
       @hash = HelpParser.parsea(argv)
-      if version && (@hash.has_key?(V) || @hash.has_key?(VSN))
+      if version && VSN.any?{@hash.has_key? _1}
         # -v or --version
         raise VersionException, version
       end
       if help
-        h = [H, HLP]
-        if h.any?{@hash.key? _1}
-          HelpParser.parseh(help, validate: true)  if h.all?{@hash.key? _1}
+        if HLP.any?{@hash.key? _1}
+          HelpParser.parseh(help, validate: true)  if HLP.all?{@hash.key? _1}
           raise HelpException, help
         end
         specs = HelpParser.parseh(help)

data/lib/help_parser/parseh.rb

@@ -4,8 +4,8 @@ module HelpParser
     help.each_line do |line|
       line.chomp!
       next if line==''
-      if line=~SECTION_NAME
-        name = line[0..-2].downcase
+      if md = SECTION_NAME.match(line)
+        name = md[:name].downcase
         specs[name] = []
       else
         next if name==''
@@ -15,7 +15,7 @@ module HelpParser
         raise HelpError, EXTRANEOUS_SPACES if validate and spec==''
         case name
         when USAGE
-          Validate.line_chars(spec.chars) if validate
+          Validate.balanced_brackets(spec.chars) if validate
           tokens = HelpParser.parseu(spec.chars)
           Validate.usage_tokens(tokens) if validate
           specs[USAGE].push tokens

data/lib/help_parser/parseu.rb

@@ -1,4 +1,8 @@
 module HelpParser
+  # Chars := String.split(/\t/,2).first.strip.chars
+  # Token := String=~/^[^ \[\]]$/
+  # Note that emergent Token is String=~/^[^\s\[\]]$/
+  # Tokens := Array(Token|Tokens)
   def self.parseu(chars)
     tokens,token = [],''
     while c = chars.shift

data/lib/help_parser/validate.rb

@@ -1,6 +1,6 @@
 module HelpParser
 module Validate
-  def self.line_chars(chars)
+  def self.balanced_brackets(chars)
     count = 0
     chars.each do |c|
       if c=='['
@@ -16,12 +16,9 @@ module Validate
   def self.usage_tokens(tokens)
     words = []
     tokens.flatten.each do |token|
-      match = token.match(FLAG)     ||
-              token.match(LITERAL)  ||
-              token.match(VARIABLE) ||
-              token.match(FLAG_GROUP)
-      raise HelpError, MSG[UNRECOGNIZED_TOKEN,token] unless match
-      words.push match[:k] # key
+      raise HelpError, MSG[UNRECOGNIZED_TOKEN,token] unless
+      [FLAG,LITERAL,VARIABLE,FLAG_GROUP]
+      .detect{_=token.match(_1) and words.push(_[:k])}
     end
     words.each_with_index do |word,i|
       raise HelpError, MSG[DUP_WORD,word] unless i==words.rindex(word)
@@ -29,8 +26,8 @@ module Validate
   end
 
   def self.usage_specs(specs)
-    option_specs = specs.select{|a,b| not RESERVED.include? a}
-    flags = option_specs.values.flatten.select{|f|f[0]=='-'}.map{|f| F2K[f]}
+    flags = specs.select{|a,b| not RESERVED.include? a}.values.flatten
+           .select{|f|f[0]=='-'}.map{|f| F2K[f]}
     FLAG_CLUMPS.each do |k|
       if a=specs[k]
         seen = {}
@@ -74,7 +71,7 @@ module Validate
       raise HelpError, MSG[UNCOMPLETED_TYPES,c.join(',')]
     end
     specs.each do |section,tokens|
-      next if section==USAGE || section==TYPES
+      next if RESERVED.include? section
       tokens.each do |words|
         next if words.size<2
         default = words[-1]

data/lib/help_parser.rb

@@ -10,7 +10,7 @@ require_relative 'help_parser/options'
 require_relative 'help_parser/macros'
 
 module HelpParser
-  VERSION = '8.0.210917'
+  VERSION = '8.1.221206'
   autoload :Validate, 'help_parser/validate'
 
   def self.[](

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: help_parser
 version: !ruby/object:Gem::Version
-  version: 8.0.210917
+  version: 8.1.221206
 platform: ruby
 authors:
 - CarlosJHR64
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+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"
 email: carlosjhr64@gmail.com
@@ -34,7 +34,7 @@ homepage: https://github.com/carlosjhr64/help_parser
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -49,9 +49,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]'
-rubygems_version: 3.2.22
-signing_key:
+- 'ruby: ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [aarch64-linux]'
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Welcome to Help Parser!   Do you have your help text?   Let's parse!
 test_files: []