help_parser 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32640b3a82d8e685727ed7ff3e3aedbe8e9ca33c6f0593614605eac9d2d9f7e4
-  data.tar.gz: e30652f83532f4640d4e3759bea0fb3528b80a16dcf69029b2ac387442adb41b
+  metadata.gz: e50119d56d6b94ac58234ccfc24d3c5ddaf68a6f399753af89fc3fad2f210b3e
+  data.tar.gz: 591810bdc390d16c1ed6b4fc2332f6bc1b98a683c218cd446fa7726d820ff22e
 SHA512:
-  metadata.gz: 346ae0d84f82e9c274088f0855aedf234ead157bf4a52351702e3f6a3d5267bf80eda759df59e8abb01cb873168e3c3f3d3e898c2a9790fa8e4cb095a3077b0f
-  data.tar.gz: c19868f202f8247664b2e5006b915752609f22f7e98771edc108996dc456b858a353fbfa67079aa158704764feab96eb6902515e2b09fb0d6d7048950e0bfa86
+  metadata.gz: b64e50f235e4f53e2f85a0508212b38b4fb80f7616150864a68cf04f39bb3c9d88dad4a3b1764ee3a7410978d01f20ae15739610a79c92a25190bad00bd24526
+  data.tar.gz: 9ccf098df4a3226b39a85519251f172097ecb9854cd05adf95bc61d54a4fad9718703c6c2ed9a92abf61f1862fbe10738937b41473c34fa0eb75db34aca78b7e

data/README.md

@@ -42,7 +42,7 @@ I prefer easy.
     Blah blah blah
     HELP
 
-    VERSION = "6.0.0"
+    VERSION = "6.1.0"
 
     # Macros:
     HelpParser.string(name)  # for options.name    : String
@@ -63,6 +63,11 @@ I prefer easy.
 Well, what do you think?
 PERFECT!
 
+## New for 6.1.0:
+
+Running your `awesome` command with the `--help` flag will also check your help text for errors,
+on top of giving the help text. Otherwise, the parser no longer checks for help text errors.
+
 ## INSTALL:
 
     $ sudo gem install help_parser

data/lib/help_parser/constants.rb

@@ -1,4 +1,12 @@
 module HelpParser
+  @@validate = false
+  def self.validate!
+    @@validate = true
+  end
+  def self.validate?
+    @@validate
+  end
+
   USAGE = 'usage'
   TYPES = 'types'
   EXCLUSIVE = 'exclusive'
@@ -63,7 +71,7 @@ module HelpParser
   EXTRANEOUS_SPACES   = 'Extraneous spaces in help.'
 
   # lambda utilities
-  MSG = lambda{|msg,*keys| "#{msg}:  #{keys.join(' ')}"}
+  MSG = lambda{|msg,*keys| "\033[0;31m#{msg}:  #{keys.join(' ')}\033[0m"}
   F2K = lambda{|f| f[1]=='-' ? f[2..((f.index('=')||0)-1)] : f[1]}
   RESERVED = lambda{|k| [USAGE,TYPES,EXCLUSIVE].include?(k)} # reserved
 end

data/lib/help_parser/options.rb

@@ -1,17 +1,23 @@
 module HelpParser
   class Options
-    def initialize( version, help, argv)
+    def initialize(version, help, argv)
       @hash = HelpParser.parsea(argv)
       if version && (@hash.has_key?('v') || @hash.has_key?('version'))
         # -v or --version
         raise VersionException, version
       end
       if help
-        if @hash.has_key?('h') || @hash.has_key?('help')
-          # -h or --help
+        # -h or --help
+        if @hash.has_key?('h') || _=@hash.has_key?('help')
+          begin
+            # validates help
+            HelpParser.parseh(help, true)
+          rescue HelpError
+            $stderr.puts $!
+          end if _
           raise HelpException, help
         end
-        specs = HelpParser.parseh(help)
+        specs = HelpParser.parseh(help, HelpParser.validate?)
         Completion.new(@hash, specs)
         if xs=specs[EXCLUSIVE]
           xs.each{|x| raise HelpParser::UsageError, MSG[EXCLUSIVE_KEYS,*x] if @hash.keys.count{|k|x.include?(k)}>1}

data/lib/help_parser/parseh.rb

@@ -1,5 +1,5 @@
 module HelpParser
-  def self.parseh(help)
+  def self.parseh(help, validate=true)
     specs,name = NoDupHash.new,''
     help.each_line do |line|
       line.chomp!
@@ -12,27 +12,25 @@ module HelpParser
         break if line[0]=='#'
         next if line[0]!=' '
         spec = (index=line.rindex("\t"))? line[0,index].strip : line.strip
-        raise HelpError, EXTRANEOUS_SPACES if spec == ''
+        raise HelpError, EXTRANEOUS_SPACES if validate and spec==''
         case name
         when USAGE
           specs[name].push HelpParser.parseu spec
         when TYPES
-          raise HelpError, MSG[UNRECOGNIZED_TYPE,spec] unless spec=~TYPE_DEF
+          raise HelpError, MSG[UNRECOGNIZED_TYPE,spec] if validate and not spec=~TYPE_DEF
           specs[name].push spec.split(CSV)
         when EXCLUSIVE
-          raise HelpError, MSG[UNRECOGNIZED_X,spec] unless spec=~X_DEF
+          raise HelpError, MSG[UNRECOGNIZED_X,spec] if validate and not spec=~X_DEF
           specs[name].push spec.split(CSV)
         else
-          case spec
-          when SHORT, LONG, SHORT_LONG, SHORT_LONG_DEFAULT
-            specs[name].push spec.split(CSV)
-          else
+          if validate and not [SHORT, LONG, SHORT_LONG, SHORT_LONG_DEFAULT].any?{|_|_=~spec}
             raise HelpError, MSG[UNRECOGNIZED_OPTION,spec]
           end
+          specs[name].push spec.split(CSV)
         end
       end
     end
-    HelpParser.validate_usage_specs(specs)
+    HelpParser.validate_usage_specs(specs) if validate
     return specs
   end
 end

data/lib/help_parser/validations.rb

@@ -33,12 +33,11 @@ module HelpParser
     unless specs[EXCLUSIVE].nil?
       seen = {}
       specs[EXCLUSIVE].each do |xs|
-        k = xs.sort.join
+        k = xs.sort.join(',').to_sym
         raise HelpError, MSG[DUP_X,*xs] if seen[k]
         seen[k] = true
         xs.each do |x|
           raise HelpError, MSG[UNSEEN_FLAG, x] unless flags.include?(x)
-          k<<x
         end
       end
     end

data/lib/help_parser.rb

@@ -11,7 +11,7 @@ require_relative './help_parser/options'
 require_relative './help_parser/macros'
 
 module HelpParser
-  VERSION = '6.0.0'
+  VERSION = '6.1.0'
 
   def self.[](
     version = nil,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: help_parser
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - carlosjhr64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-02-25 00:00:00.000000000 Z
 dependencies: []
 description: |
   Welcome to the best Help Parser of all!