cmdparse 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33a196cd6254f66b778a929a732504effd20e170
-  data.tar.gz: 07691ec8406bdaaa936fb3e7572cafe1e8ec4234
+  metadata.gz: d8fcb2e570f788efd92d168dc0c3f4dc2008502e
+  data.tar.gz: 42fcef0757b5bfc74ce00dd517e448103aad1f8e
 SHA512:
-  metadata.gz: cc1ced1a1fea8c62eaa11761d78c172bdb0769291fe27637a4ae5199bea8294a0cb78c71d7610012cc7ec36338a3625fed99d9bd5dfea13526342235f2b8170f
-  data.tar.gz: 6f494cb30fb84875aaa584a360332e0fbd2c2cb3009afd4913ee8e22c7ea69d30396c86490ec505daadd97c430910c54aaaa50d3832cb40151dd46cc4a4b089e
+  metadata.gz: b75dca182871ab46fc25b11a32d4373104dc994fde0aefa3887d6b51e4eecf69260c7b740963703ab0383dbbbc196809b5293e7ea08e949c1883553677709a7c
+  data.tar.gz: e959185d687ed0134e3358804c6390dbb4067aa77b1f6184c33b01918935721b9451b51d297c10b444043305b6779eea04cc372d840266f1cd54f0995255459e

data/VERSION

@@ -1 +1 @@
-3.0.1
+3.0.2

data/doc/default.scss

@@ -270,7 +270,7 @@ $logo-color: #3A974D;
 /***************************************/
 /***************************************/
 
-@import url("http://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400italic,700|Open+Sans+Condensed:300,700");
+@import url("https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400italic,700|Open+Sans+Condensed:300,700");
 
 /*********************************************************************************/
 /* Basic                                                                         */

data/doc/default.template

@@ -24,7 +24,7 @@
 
       <!-- Sidebar -->
       <div id="sidebar">
-        <h1 id="logo"><a href="{relocatable: /}">cmdparse</a><br /><span>v 3.0.1</span></h1>
+        <h1 id="logo"><a href="{relocatable: /}">cmdparse</a><br /><span>v 3.0.2</span></h1>
 
         <!-- Nav -->
         <nav id="nav">
@@ -62,13 +62,10 @@
       var sc_project=10338773;
       var sc_invisible=1;
       var sc_security="7779f3af";
+      var scJsHost = (("https:" == document.location.protocol) ? "https://secure." : "http://www.");
+      document.write("<sc"+"ript type='text/javascript' src='" + scJsHost+ "statcounter.com/counter/counter.js'></"+"script>");
     </script>
-    <script type="text/javascript" src="http://www.statcounter.com/counter/counter_xhtml.js"></script>
-    <noscript><div class="statcounter">
-        <a title="free hit counters" href="http://statcounter.com/" class="statcounter">
-          <img class="statcounter" src="http://c.statcounter.com/10338773/0/7779f3af/1/" alt="free hit counters" />
-        </a>
-    </div></noscript>
+    <noscript><div class="statcounter"><a title="website statistics" href="http://statcounter.com/" target="_blank"><img class="statcounter" src="//c.statcounter.com/10338773/0/7779f3af/1/" alt="website statistics" /></a></div></noscript>
     <!-- End of StatCounter Code for Default Guide -->
   </body>
 </html>

data/doc/news.page

@@ -5,6 +5,14 @@ sort_info: 8
 ---
 ## News
 
+### 2016-12-28 cmdparse 3.0.2 released!
+
+Changes:
+
+* Raise an error if too many arguments are provided for a command
+* Better error message if not enough arguments are provided for a command
+
+
 ### 2015-03-14 cmdparse 3.0.1 released!
 
 Changes:

data/lib/cmdparse.rb

@@ -12,13 +12,42 @@ require 'optparse'
 OptionParser::Officious.delete('version')
 OptionParser::Officious.delete('help')
 
+
+# Extension for OptionParser objects to allow access to some internals.
+class OptionParser #:nodoc:
+
+  # Access the option list stack.
+  attr_reader :stack
+
+  # Returns +true+ if at least one local option is defined.
+  #
+  # The zeroth stack element is not respected when doing the query because it contains either the
+  # OptionParser::DefaultList or a CmdParse::MultiList with the global options of the
+  # CmdParse::CommandParser.
+  def options_defined?
+    stack[1..-1].each do |list|
+      list.each_option do |switch|
+        return true if switch.kind_of?(OptionParser::Switch) && (switch.short || switch.long)
+      end
+    end
+    false
+  end
+
+  # Returns +true+ if a banner has been set.
+  def banner?
+    !@banner.nil?
+  end
+
+end
+
+
 # Namespace module for cmdparse.
 #
 # See CmdParse::CommandParser and CmdParse::Command for the two important classes.
 module CmdParse
 
   # The version of this cmdparse implemention
-  VERSION = '3.0.1'
+  VERSION = '3.0.2'.freeze
 
 
   # Base class for all cmdparse errors.
@@ -76,6 +105,11 @@ module CmdParse
     reason 'Not enough arguments provided, minimum is'
   end
 
+  # This error is thrown when too many arguments are provided for the command.
+  class TooManyArgumentsError < ParseError
+    reason 'Too many arguments provided, maximum is'
+  end
+
   # Command Hash - will return partial key matches as well if there is a single non-ambigous
   # matching key
   class CommandHash < Hash #:nodoc:
@@ -85,7 +119,7 @@ module CmdParse
     end
 
     def [](cmd_name) #:nodoc:
-      super or begin
+      super || begin
         possible = keys.select {|key| key[0, cmd_name.length] == cmd_name }
         fetch(possible[0]) if possible.size == 1
       end
@@ -125,33 +159,6 @@ module CmdParse
 
   end
 
-  # Extension for OptionParser objects to allow access to some internals.
-  class ::OptionParser #:nodoc:
-
-    # Access the option list stack.
-    attr_reader :stack
-
-    # Returns +true+ if at least one local option is defined.
-    #
-    # The zeroth stack element is not respected when doing the query because it contains either the
-    # OptionParser::DefaultList or a CmdParse::MultiList with the global options of the
-    # CmdParse::CommandParser.
-    def options_defined?
-      stack[1..-1].each do |list|
-        list.each_option do |switch|
-          return true if ::OptionParser::Switch === switch && (switch.short || switch.long)
-        end
-      end
-      false
-    end
-
-    # Returns +true+ if a banner has been set.
-    def banner?
-      !@banner.nil?
-    end
-
-  end
-
   # === Base class for commands
   #
   # This class implements all needed methods so that it can be used by the CommandParser class.
@@ -258,8 +265,8 @@ module CmdParse
     #
     # The argument +val+ needs to be +true+ or +false+.
     def takes_commands(val)
-      if !val && commands.size > 0
-        raise Error, "Can't change value of takes_commands to false because there are already sub-commands"
+      if !val && !commands.empty?
+        raise Error, "Can't change takes_commands to false because there are already sub-commands"
       else
         @takes_commands = val
       end
@@ -486,7 +493,7 @@ module CmdParse
     #
     #   {command | other_command | another_command }
     def usage_commands
-      (commands.size > 0 ? "{#{commands.keys.sort.join(" | ")}}" : '')
+      (commands.empty? ? '' : "{#{commands.keys.sort.join(" | ")}}")
     end
 
     # Returns the formatted short description.
@@ -511,7 +518,7 @@ module CmdParse
     def help_commands
       describe_commands = lambda do |command, level = 0|
         command.commands.sort.collect do |name, cmd|
-          str =  "  "*level << name << (name == command.default_command ? " (*)" : '')
+          str = "  " * level << name << (name == command.default_command ? " (*)" : '')
           str = str.ljust(command_parser.help_desc_indent) << cmd.short_desc.to_s
           str = format(str, width: command_parser.help_line_width - command_parser.help_indent,
                        indent: command_parser.help_desc_indent)
@@ -527,7 +534,7 @@ module CmdParse
     # For the output format see #cond_format_help_section
     def help_arguments
       desc = @argument_desc.map {|k, v| k.to_s.ljust(command_parser.help_desc_indent) << v.to_s}
-      cond_format_help_section('Arguments', desc, condition: @argument_desc.size > 0)
+      cond_format_help_section('Arguments', desc, condition: !@argument_desc.empty?)
     end
 
     # Returns the formatted option descriptions for the given OptionParser instance.
@@ -554,7 +561,7 @@ module CmdParse
 
     # For sorting commands by name.
     def <=>(other)
-      self.name <=> other.name
+      name <=> other.name
     end
 
     protected
@@ -585,7 +592,7 @@ module CmdParse
         out = "#{title}:\n"
         lines = lines.flatten.join("\n").split(/\n/)
         if preformatted
-          lines.map! {|l| ' '*command_parser.help_indent << l} if indent
+          lines.map! {|l| ' ' * command_parser.help_indent << l} if indent
           out << lines.join("\n")
         else
           out << format(lines.join("\n"), indent: (indent ? command_parser.help_indent : 0), indent_first_line: true)
@@ -617,11 +624,11 @@ module CmdParse
 
       content.split(/\n\n/).map do |paragraph|
         lines = []
-          while paragraph.length > 0
+        unless paragraph.empty?
           unless (str = paragraph.slice!(pattern).sub(/[ \n]\z/, ''))
             str = paragraph.slice!(0, line_length)
           end
-          lines << (lines.empty? && !indent_first_line ? '' : ' '*indent) + str.gsub(/\n/, ' ')
+          lines << (lines.empty? && !indent_first_line ? '' : ' ' * indent) + str.tr("\n", ' ')
           pattern = other_lines_pattern
         end
         lines.join("\n")
@@ -648,8 +655,8 @@ module CmdParse
     def initialize #:nodoc:
       super('help', takes_commands: false)
       short_desc('Provide help for individual commands')
-      long_desc('This command prints the program help if no arguments are given. If one or ' <<
-                'more command names are given as arguments, these arguments are interpreted ' <<
+      long_desc('This command prints the program help if no arguments are given. If one or ' \
+                'more command names are given as arguments, these arguments are interpreted ' \
                 'as a hierachy of commands and the help for the right most command is show.')
       argument_desc(COMMAND: 'The name of a command or sub-command')
     end
@@ -666,7 +673,7 @@ module CmdParse
     end
 
     def execute(*args) #:nodoc:
-      if args.length > 0
+      if !args.empty?
         cmd = command_parser.main_command
         arg = args.shift
         while !arg.nil? && cmd.commands.key?(arg)
@@ -789,8 +796,8 @@ module CmdParse
     #
     # handle_exceptions:: Set to +true+ if exceptions should be handled gracefully by showing the
     #                     error and a help message, or to +false+ if exception should not be handled
-    #                     at all. If this options is set to :no_help, the exception is handled but no
-    #                     help message is shown.
+    #                     at all. If this options is set to :no_help, the exception is handled but
+    #                     no help message is shown.
     #
     # takes_commands:: Specifies whether the main program takes any commands.
     def initialize(handle_exceptions: false, takes_commands: true)
@@ -868,7 +875,11 @@ module CmdParse
         else
           original_n = @current_command.arity
           n = (original_n < 0 ? -original_n - 1 : original_n)
-          raise NotEnoughArgumentsError.new(n) if argv.size < n
+          if argv.size < n
+            raise NotEnoughArgumentsError.new("#{n} - #{@current_command.usage_arguments}")
+          elsif argv.size > n && original_n > 0
+            raise TooManyArgumentsError.new("#{n} - #{@current_command.usage_arguments}")
+          end
 
           argv.slice!(n..-1) unless original_n < 0
           @current_command.execute(*argv)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmdparse
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webgen
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Advanced command line parser supporting commands