help_parser 8.2.230210 → 9.0.240926

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f19d24ec56736d0d1bbcce1e0a847ac45e9d82defc89c7799c7b9c8c7c4ae078
-  data.tar.gz: fe92cf2d740771329bee184dd205d59bc72c1265d79ac50af3a6c4d0fa735297
+  metadata.gz: 60dd76f994f506e15f1593b7561ee1b23cc59c0cf3cd53cc1140dcbc59b7b0f5
+  data.tar.gz: c113698c66f7790c4977d57c7906dad639774dd315158677091e59c5db188cef
 SHA512:
-  metadata.gz: f20dad3a1453e625236af9cb176328652352e9f2f35f00da02cc6ab1853671c82ae13d5ec8226247be116cbd82bdbb4aee24490200f04b2ddba79e380822f36b
-  data.tar.gz: 0aebde782784afb644dd1047f32af8de07d07af4c53435ec47ed8c8f7e54a3997a6e6a08c372f23e1a38f37c10f6e0604c26afcb5f16b8d7677120891f10ed71
+  metadata.gz: f40ba2d34b2340c12d69812d8554a942dac423a2e5e764ac15d58cf644f978eb937e2104bef8ce288dd79f0875d8bda92998ad692e50ebbe6ff0f5cb6d130ec3
+  data.tar.gz: f12bfbd92bfe9101292598c69ceff2beb81bd92838b975f39d61e15e16fc6268ffb525896f5983186bced970e3e63d4e6a27cbd5d63cad91943a264236b184b4

data/README.md

@@ -1,14 +1,12 @@
-# Help Parser VIII: Helpland
+# Help Parser IX: Revelations
 
-* [VERSION 8.2.230210](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
@@ -18,94 +16,111 @@ $ gem install help_parser
 <!-- 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
 
-* `ARGV` setup for `ARGF` when one of the "Types:" given is "ARGF"
-* `$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) 2023 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/macros.rb

@@ -1,145 +1,29 @@
 module HelpParser
-  def self.string(*names)
+  def self.map(*names, map:)
     names.each do |name|
       Options.instance_eval do
         define_method(name) do
-          s = @hash[name.to_s]
-          raise UsageError, MSG[NOT_STRING,name] unless s.is_a?(String)
-          s
+          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.string?(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method("#{name}?") do
-          s = @hash[name.to_s]
-          raise UsageError,MSG[NOT_STRING,name] unless s.nil? || s.is_a?(String)
-          s
-        end
-      end
-    end
-  end
-
-  def self.strings(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method(name) do
-          a = @hash[name.to_s]
-          raise UsageError, MSG[NOT_STRINGS,name] unless a.is_a?(Array)
-          a
-        end
-      end
-    end
-  end
-
-  def self.strings?(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method("#{name}?") do
-          a = @hash[name.to_s]
-          raise UsageError,MSG[NOT_STRINGS,name] unless a.nil? || a.is_a?(Array)
-          a
-        end
-      end
-    end
-  end
-
-  def self.float(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method(name) do
-          @hash[name.to_s]&.to_f or raise
-        rescue
-          raise UsageError, MSG[NOT_FLOAT,name]
-        end
-      end
-    end
-  end
-
-  def self.float?(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method("#{name}?") do
-          @hash[name.to_s]&.to_f
-        rescue
-          raise UsageError, MSG[NOT_FLOAT,name]
-        end
-      end
-    end
-  end
-
-  def self.floats(*names)
+  def self.split(*names, sep:, map:)
     names.each do |name|
       Options.instance_eval do
         define_method(name) do
-          @hash[name.to_s].map(&:to_f)
-        rescue
-          raise UsageError, MSG[NOT_FLOATS,name]
-        end
-      end
-    end
-  end
-
-  def self.floats?(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method("#{name}?") do
-          @hash[name.to_s]&.map(&:to_f)
-        rescue
-          raise UsageError, MSG[NOT_FLOATS,name]
-        end
-      end
-    end
-  end
-
-  def self.int(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method(name) do
-          @hash[name.to_s]&.to_i or raise
-        rescue
-          raise UsageError, MSG[NOT_INTEGER,name]
-        end
-      end
-    end
-  end
-
-  def self.int?(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method("#{name}?") do
-          @hash[name.to_s]&.to_i
-        rescue
-          raise UsageError, MSG[NOT_INTEGER,name]
-        end
-      end
-    end
-  end
-
-  def self.ints(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method(name) do
-          @hash[name.to_s].map(&:to_i)
-        rescue
-          raise UsageError, MSG[NOT_INTEGERS,name]
-        end
-      end
-    end
-  end
-
-  def self.ints?(*names)
-    names.each do |name|
-      Options.instance_eval do
-        define_method("#{name}?") do
-          @hash[name.to_s]&.map(&:to_i)
-        rescue
-          raise UsageError, MSG[NOT_INTEGERS,name]
+          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/parseh.rb

@@ -11,8 +11,11 @@ module HelpParser
         next if name==''
         break if line[0]=='#'
         next unless line[0]==' '
-        spec = (index=line.rindex("\t"))? line[0,index].strip : line.strip
-        raise HelpError, EXTRANEOUS_SPACES if validate && spec.empty?
+        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

data/lib/help_parser/validate.rb

@@ -41,11 +41,21 @@ module Validate
     flags.each_with_index do |flag,i|
       raise HelpError, MSG[DUP_FLAG,flag] unless i==flags.rindex(flag)
     end
-    group = []
+    group,var = [],{}
     specs_usage = specs[USAGE]
     specs_usage&.flatten&.each do |token|
-      if (match=token.match FLAG_GROUP)
-        key = match[:k]
+      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

data/lib/help_parser.rb

@@ -10,7 +10,7 @@ require_relative 'help_parser/options'
 require_relative 'help_parser/macros'
 
 module HelpParser
-  VERSION = '8.2.230210'
+  VERSION = '9.0.240926'
   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.2.230210
+  version: 9.0.240926
 platform: ruby
 authors:
 - CarlosJHR64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -16,61 +16,103 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        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.2'
+        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: 3.2.0
+        version: 1.66.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.66'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 1.66.1
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.7
+        version: 3.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.7
-description: "Welcome to Help Parser!  \nDo you have your help text?  \nLet's parse!\n"
+        version: 3.6.2
+description: 'Options parsing based on your help text.
+
+  '
 email: carlosjhr64@gmail.com
 executables: []
 extensions: []
@@ -109,8 +151,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - 'git: 2.30'
-rubygems_version: 3.4.6
+- '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: []