help_parser 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2403ec5690c6b29e5fa4fc82a4b2cabf7ce0d4d1
-  data.tar.gz: da462a01617bb2ae7dbda2f1f2c37fedd4023070
+  metadata.gz: 0e34375237fe8e17187ef472cdec33cecb71a604
+  data.tar.gz: ddb37f1e37e3900494b3099ad8d944cfbdb5847e
 SHA512:
-  metadata.gz: fb9d8fab785ca44653e3229f200df278eea63752c0ebc6b8116d4575d27d84b60ad12c2814f6a0febc43e4bb4433457ff7ec976d822918073fcafc04eceb342e
-  data.tar.gz: f48f5d9767b607dbcc3f57ada3bdc2b62c3aad506cf5844da077c036e1ab5571e82a55090cd47aadac15e91ccdf8ec035c1b190cbab1dbdf1e9819726d7b02f2
+  metadata.gz: 4eaf7e06d366440c40e7519656e1dc05a04b4efde4af03e691dcbbe693ba177165622dac7cb608c515ce7eece9ab9f9fed0b96c9c45f7000460a4d2c168b7ea4
+  data.tar.gz: 17a48d312dd790501189f5ab05a94f6c55d59d8aa613988223ce464415cb50ff05aae6eddccf1119d57772fff1ab35507cdff55315f797e3d5c2c65d7f546760

data/README.rdoc

@@ -24,11 +24,22 @@ HelpParser - Parses your help text to define your command line options.
     -v --version   Show the version and exit
     -q --quiet     Be quiet
     -V --verbose   Say more about whats going on
+    --value=5.0    Pass values, provide default.
   HELP
   begin
     OPTIONS = HelpParser.new('1.0.0', HELP)
     puts "Tracing..." unless OPTIONS[:quiet]
     puts "More tracing..." if OPTIONS[:V] # verbose
+    if value = OPTIONS[:value]
+      if value == 5.0
+        # --value by itself gives the give default.
+        puts "You gave the default value of 5.0."
+      else
+        puts "You gave different value #{value}."
+      end
+    else
+      puts "You did not give me a value."
+    end
     # mycmdapp code continues...
     # ...
   rescue UsageException

data/lib/help_parser.rb

@@ -1,9 +1,8 @@
-require 'help_parser/version.rb'
-require 'help_parser/usage_exception'
-require 'help_parser/help_exception'
-require 'help_parser/version_exception'
-require 'help_parser/implementation_error'
-require 'help_parser/usage_error'
+require 'help_parser/version'
+require 'help_parser/exceptions'
 require 'help_parser/errors'
-require 'help_parser/functions'
-require 'help_parser/help_parser.rb'
+require 'help_parser/refinements'
+require 'help_parser/help_parser'
+
+# Requires:
+#`ruby`

data/lib/help_parser/errors.rb

@@ -1,17 +1,16 @@
 module HELP_PARSER
-  # Used to *include* in a class.
-  module Errors
-    # HelpParser#usage_error will have make the HelpParser
-    # object raise a UsageError error with the given message.
-    def usage_error(msg)
-      raise UsageError, [msg, self]
-    end
 
-    # HelpParser#implementation_error will have make the
-    # HelpParser object raise a UsageError error with the
-    # given message.
-    def implementation_error(msg)
-      raise ImplementationError, [msg, self]
-    end
+  # ImplementationError is an error due to a
+  # inconsistent help text.  The raise is as follows:
+  #    raise ImplementationError, message
+  class ImplementationError < StandardError
   end
+
+  # UsageError is an error when the user passed command
+  # line options that are inconsistent with expectations.
+  # The raise is as follows:
+  #    raise UsageError, message
+  class UsageError < StandardError
+  end
+
 end

data/lib/help_parser/exceptions.rb

@@ -0,0 +1,25 @@
+module HELP_PARSER
+
+  # UsageException is an actual exception to normal flow.
+  # For example, when a user asks for help or version
+  # number in the command line options.
+  # The raise is as follows:
+  #    raise UsageException, message
+  class UsageException < Exception
+  end
+
+  # HelpException is a type of UsageException, where the
+  # user asks for help in the command line options.
+  # The raise is as follows:
+  #    raise HelpException, help_message
+  class HelpException < UsageException
+  end
+
+  # VersionException is a type of UsageException, where the
+  # user asks for version in the command line options.
+  # The raise is as follows:
+  #    raise VersionException, version_message
+  class VersionException < UsageException
+  end
+
+end

data/lib/help_parser/help_parser.rb

@@ -1,93 +1,126 @@
 module HELP_PARSER
   class HelpParser < Hash
-    include Errors
-    extend  Functions
+    using HELP_PARSER
 
-    def parse(&block)
-      HelpParser.parse(@argv, self, &block)
+    # HelpParser.parse parses the argv for command line
+    # options, shifting them out, and passes on the key-value
+    # pairs to the block. no-key values are negated.
+    def self.parse(argv, &block)
+      while argv[0] and argv[0][0]=='-'
+        option = argv.shift[1..-1]
+        if option[0]=='-'
+          loption, value = option[1..-1].split('=', 2)
+          if loption[0..2]=='no-'
+            loption = loption[3..-1]
+            if value
+              raise UsageError, "no-key should not have value: no-#{loption}=#{value}"
+            end
+            value = :F
+          end
+          block.call loption, value
+        else
+          # These are single character options...
+          option.each_char do |c|
+            block.call c, :T
+          end
+        end
+      end
     end
 
-
     # HelpParser.new(version, help, argv=ARGV, dict={})
     # Not necessarily in that order, see the code.
-    attr_reader :version, :help, :dict
     def initialize(*parameters)
       super()
 
       # Figure out what parameters you were given...
-      @argv      = parameters.detect{|parameter| parameter.class == Array} || ARGV
-      @dict      = parameters.detect{|parameter| parameter.class == Hash } || {}
+      argv      = parameters.detect{|parameter| parameter.class == Array} || ARGV
+      dict      = parameters.detect{|parameter| parameter.class == Hash } || {}
       parameters = parameters.select{|parameter| parameter.class == String}
-      @version   = parameters.shift
-      @help      = parameters.pop
+      version   = parameters.shift
+      help      = parameters.pop
+      preferred = {}
  
-      raise "Need help" unless @help
-      raise "Need version" unless @version
+      raise "Need help" unless help
+      raise "Need version" unless version
 
-      # We ensure the following two mappings...
-      @dict[:help] = :h
-      @dict[:version] = :v
+      # We ensure the following mappings...
+      dict[:help],    preferred[:help]    = :h, :T
+      dict[:version], preferred[:version] = :v, :T
 
       # Using the help for the options definition
-      @help.split("\n").select{|l|
+      help.split("\n").select{|l|
         (l=~/^\s*-/)
       }.map{|l|
-        l.strip.split(/[,\s]+/)[0..1].select{|o|
+        l.strip.split(/\s+/)[0..1].select{|o|
           o[0]=='-'
         }.map{|o|
-          HelpParser.str2sym o.sub(/--?/,'').sub(/=.*$/,'')
+          v = :T
+          if i = o.index('=')
+            v = o[i+1..-1]
+            o = o[0...i]
+          end
+          o = o.to_key
+          preferred[o] = v
+          o
         }.reverse
       }.each do |k,v|
-        unless @dict[k].nil?
+        unless dict[k].nil?
           # This is an implementation error.  The help text is inconsistent.
-          # Note that we may have been given @dict, and we're verifying the help.
-          implementation_error "#{k} redefinition from #{@dict[k]} to #{v}." unless @dict[k]==v
+          # Note that we may have been given dict, and we're verifying the help.
+          unless dict[k]==v
+            raise ImplementationError, "#{k} redefinition from #{dict[k]} to #{v}."
+          end
         end
-        @dict[k]=v
+        dict[k]=v
       end
 
       # Values must be terminal states, that is for example:
       # if :version => :v, then :v => nil.
       terminals = []
-      @dict.each do |k,v|
+      dict.each do |k,v|
         next if v.nil?
-        if @dict.has_key?(v)
-          unless @dict[v].nil?
-            implementation_error "Expected terminal #{v}:  #{k} => #{v} => #{@dict[v]}"
+        if dict.has_key?(v)
+          unless dict[v].nil?
+            raise ImplementationError, "Expected terminal #{v}:  #{k} => #{v} => #{dict[v]}"
           end
         else
           terminals.push(v)
         end
       end
-      terminals.each{|v| @dict[v] = nil}
+      terminals.each{|v| dict[v] = nil}
 
       # Parsing command line options
-      parse do |opt, value|
-        key = HelpParser.str2sym opt
+      HelpParser.parse(argv) do |opt, value|
+        key = opt.to_key
+        value = preferred[key] if value.nil?
         # Translate key to the terminal key.
-        key = @dict[key] unless @dict[key].nil?
+        key = dict[key] unless dict[key].nil?
         # Ensure user only uses the defined keys.
-        usage_error "not a valid option:  #{opt}" unless @dict.has_key?(key)
+        unless dict.has_key?(key)
+          raise UsageError, "Not a valid option:  #{opt}"
+        end
         # As we parse ARGV, we should only be setting keys once.
-        usage_error "duplicate command line option:  #{opt}" if self.has_key?(key)
-        self[key] = value
+        if self.has_key?(key)
+          raise UsageError, "Duplicate command line option:  #{opt}"
+        end
+        self[key] = value.to_value
       end
 
       # The parse takes all options to its terminal value.
-      # Now set the synonims...
-      @dict.each do |synonim, terminal|
+      # Now set the synonyms...
+      dict.each do |synonym, terminal|
         next if terminal.nil?
         if self.has_key?(terminal)
           # I did not mean for the synonyms to have been set yet, so if I do,
           # I have a bug somewhere.
-          raise "unexpected key overwrite" if self.has_key?(synonim)
-          self[synonim] = self[terminal]
+          raise "unexpected key overwrite" if self.has_key?(synonym)
+          self[synonym] = self[terminal]
         end
       end
 
       # Did the user ask for help or version?
-      raise HelpException,    self if self[:h]==true
-      raise VersionException, self if self[:v]==true
+      raise HelpException,    help    if self[:h]==true
+      raise VersionException, version if self[:v]==true
     end
 
     # HelpParser#defaults is a helper method to []
@@ -97,7 +130,9 @@ module HELP_PARSER
       value = (a.nil?)? default1 : a
       value = default2 if value==true
       # !value is true if value is false or nil.
-      usage_error "type error: #{symbol} needs to be #{type}" unless !value or value.class == type
+      unless !value or value.class == type
+        raise UsageError, "Type error: #{symbol} needs to be #{type}"
+      end
       return value
     end
 

data/lib/help_parser/refinements.rb

@@ -0,0 +1,40 @@
+module HELP_PARSER
+  # Refinements
+
+  refine Symbol do
+    def to_value
+      case self
+      when :T
+        return true
+      when :F
+        return false
+      end
+      raise "Unrecognized key: #{self}"
+    end
+  end
+
+  refine String do
+    def to_value
+      case self
+      when /^[-+]?\d+$/
+        return self.to_i
+      when /^[-+]?\d+\.\d+([eE][+-]?\d+)?$/
+        return self.to_f
+      when /,/
+        return self.split(',').map{|s| s.to_value}
+      else
+        return self
+      end
+    end
+
+    # Converts String keys to Symbol.
+    # Symbol keys can have '-', but it's cumbersome notation:
+    #    :"a-b"
+    # So I translate it to underscore:
+    #    :a_b
+    def to_key
+      self.sub(/^--?/,'').gsub('-','_').to_sym
+    end
+
+  end
+end

data/lib/help_parser/version.rb

@@ -1,3 +1,3 @@
 module HELP_PARSER
-  VERSION = '1.3.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: help_parser
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - carlosjhr64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-23 00:00:00.000000000 Z
+date: 2015-12-25 00:00:00.000000000 Z
 dependencies: []
 description: |
   HelpParser - Parses your help text to define your command line options.
@@ -21,14 +21,10 @@ files:
 - README.rdoc
 - lib/help_parser.rb
 - lib/help_parser/errors.rb
-- lib/help_parser/functions.rb
-- lib/help_parser/help_exception.rb
+- lib/help_parser/exceptions.rb
 - lib/help_parser/help_parser.rb
-- lib/help_parser/implementation_error.rb
-- lib/help_parser/usage_error.rb
-- lib/help_parser/usage_exception.rb
+- lib/help_parser/refinements.rb
 - lib/help_parser/version.rb
-- lib/help_parser/version_exception.rb
 homepage: https://github.com/carlosjhr64/help_parser
 licenses:
 - MIT
@@ -49,7 +45,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- 'ruby: ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-linux]'
 rubyforge_project: 
 rubygems_version: 2.4.5.1
 signing_key: 

data/lib/help_parser/functions.rb

@@ -1,62 +0,0 @@
-module HELP_PARSER
-  # I'm wrapping class functions in a Function module.
-  # Used to *extend* a class.
-  module Functions
-
-    # HelpParser.to_value
-    def to_value(string)
-      case string
-      when /^-?\d+$/
-        return string.to_i
-      when /^-?\d+\.\d+([eE][+-]?\d+)?$/
-        return string.to_f
-      when /,/
-        return string.split(',').map{|s| to_value(s)}
-      end
-      return string
-    end
-
-    # HelpParser.str2sym converts String keys to
-    # Symbol.  Symbol keys can have '-', but it's cumbersome
-    # notation:
-    #    :"a-b"
-    # So I translate it to underscore:
-    #    :a_b
-    def str2sym(str)
-      str.gsub('-','_').to_sym
-    end
-
-    # HelpParser.parse parses the @argv for command line
-    # options, shifting them out, and passes on the key-value
-    # pairs to the block.  The keys are translated to their
-    # short version if available, and the values are converted
-    # to their best interpreted form as per Funtion.to_value.
-    # Furthermore, no-key values are negated.
-    def parse(argv, obj, &block)
-      while argv[0] and argv[0][0]=='-'
-        option = argv.shift[1..-1]
-        if option[0]=='-'
-          loption, value = option[1..-1].split('=', 2)
-          if loption=~/no-(\w.*)$/
-            loption = $1
-            if value
-              raise UsageError, ["no-key should not have value: no-#{loption}=#{value}", obj]
-            end
-            value = false
-          end
-          if value.nil?
-            value = true
-            block.call loption, value
-          else
-            block.call loption, self.to_value(value)
-          end
-        else
-          # These are single character options...
-          option.each_char do |c|
-            block.call c, true
-          end
-        end
-      end
-    end
-  end
-end

data/lib/help_parser/help_exception.rb

@@ -1,16 +0,0 @@
-module HELP_PARSER
-  # HelpException is a type of UsageException, where the
-  # user asks for help in the command line options.  The
-  # raise in a class method is as follows:
-  #    raise HelpException, self
-  # The object that raised the exception will be available
-  # as:
-  #    $!.obj
-  # The message will be the help text:
-  #    $!.message == $!.obj.help # => true
-  class HelpException < UsageException
-    def initialize(help_parser)
-      super([help_parser.help, help_parser])
-    end
-  end
-end

data/lib/help_parser/implementation_error.rb

@@ -1,16 +0,0 @@
-module HELP_PARSER
-  # **ImplementationError** is an error due to a
-  # inconsistent help text.  The raise in a class method is
-  # as follows:
-  #    raise ImplementationError, [message, self]
-  # The object that raised the error will be available as:
-  #    $!.obj
-  class ImplementationError < StandardError
-    attr_accessor :obj
-    def initialize(array)
-      self.obj = array.pop
-      msg = array.pop
-      super(msg)
-    end
-  end
-end

data/lib/help_parser/usage_error.rb

@@ -1,16 +0,0 @@
-module HELP_PARSER
-  # **UsageError** is an error when the user passed command
-  # line options that are inconsistent with expectations.
-  # The raise in a class method is as follows:
-  #    raise UsageError, [message, self]
-  # The object that raised the error will be available as:
-  #    $!.obj
-  class UsageError < StandardError
-    attr_accessor :obj
-    def initialize(array)
-      self.obj = array.pop
-      msg = array.pop
-      super(msg)
-    end
-  end
-end

data/lib/help_parser/usage_exception.rb

@@ -1,18 +0,0 @@
-module HELP_PARSER
-  # UsageException is an actual exception to normal flow.
-  # For example, when a user asks for help or version
-  # number in the command line options.  The raise in a
-  # class method is as follows:
-  #    raise UsageException, [message, self]
-  # The object that raised the exception will be available
-  # as:
-  #    $!.obj
-  class UsageException < Exception
-    attr_accessor :obj
-    def initialize(array)
-      self.obj = array.pop
-      msg = array.pop
-      super(msg)
-    end
-  end
-end

data/lib/help_parser/version_exception.rb

@@ -1,16 +0,0 @@
-module HELP_PARSER
-  # VersionException is a type of UsageException, where the
-  # user asks for version in the command line options.  The
-  # raise in a class method is as follows:
-  #    raise VersionException, self
-  # The object that raised the exception will be available
-  # as:
-  #    $!.obj
-  # The message will be the version text:
-  #    $!.message == $!.obj.version # => true
-  class VersionException < UsageException
-    def initialize(help_parser)
-      super([help_parser.version, help_parser])
-    end
-  end
-end