cmdparse 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e414fd7955af00e870b2561d5c25a52021bfdede
-  data.tar.gz: 67959e99ad88ce48ec6d7169d0fa71f4c57af3d6
+  metadata.gz: 33a196cd6254f66b778a929a732504effd20e170
+  data.tar.gz: 07691ec8406bdaaa936fb3e7572cafe1e8ec4234
 SHA512:
-  metadata.gz: b920d98ca7204ac027cd6746f03dcf5432afcdcc8f2aa75207c3f93a736833348bc5e5d3ca1ce21e6345fb5bac66ad8c2d0022618c7cadbf428196ba526ea820
-  data.tar.gz: 839020aed5e17ce55773564d8b6c75dcbba44c251ee775f006eaf132689cd48a375f1acd13a74b5c5d6fb099cb2ed33153fe36be98fdf5672b82ac814c9b92d5
+  metadata.gz: cc1ced1a1fea8c62eaa11761d78c172bdb0769291fe27637a4ae5199bea8294a0cb78c71d7610012cc7ec36338a3625fed99d9bd5dfea13526342235f2b8170f
+  data.tar.gz: 6f494cb30fb84875aaa584a360332e0fbd2c2cb3009afd4913ee8e22c7ea69d30396c86490ec505daadd97c430910c54aaaa50d3832cb40151dd46cc4a4b089e

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.0.1

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.0</span></h1>
+        <h1 id="logo"><a href="{relocatable: /}">cmdparse</a><br /><span>v 3.0.1</span></h1>
 
         <!-- Nav -->
         <nav id="nav">
@@ -57,5 +57,18 @@
 
     </div>
 
+    <!-- Start of StatCounter Code for Default Guide -->
+    <script type="text/javascript">
+      var sc_project=10338773;
+      var sc_invisible=1;
+      var sc_security="7779f3af";
+    </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>
+    <!-- End of StatCounter Code for Default Guide -->
   </body>
 </html>

data/doc/news.page

@@ -5,6 +5,15 @@ sort_info: 8
 ---
 ## News
 
+### 2015-03-14 cmdparse 3.0.1 released!
+
+Changes:
+
+* Commands in usage line are now shown sorted
+* Long lines with embedded new lines are now correctly formatted
+* The built-in version command can now be told to not add the `-v` and `--version` switches
+
+
 ### 2015-03-12 cmdparse 3.0.0 released!
 
 This version is not compatible with previous versions of cmdparse and requires at least Ruby 2.0.

data/doc/sitemap.sitemap

@@ -0,0 +1,5 @@
+---
+entries:
+  alcn: /**/*.html
+default_change_freq: monthly
+---

data/lib/cmdparse.rb

@@ -18,7 +18,7 @@ OptionParser::Officious.delete('help')
 module CmdParse
 
   # The version of this cmdparse implemention
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 
 
   # Base class for all cmdparse errors.
@@ -486,7 +486,7 @@ module CmdParse
     #
     #   {command | other_command | another_command }
     def usage_commands
-      (commands.size > 0 ? "{#{commands.keys.join(" | ")}}" : '')
+      (commands.size > 0 ? "{#{commands.keys.sort.join(" | ")}}" : '')
     end
 
     # Returns the formatted short description.
@@ -519,7 +519,7 @@ module CmdParse
         end.join('')
       end
       cond_format_help_section("Available commands", describe_commands.call(self),
-                               condition: takes_commands?)
+                               condition: takes_commands?, preformatted: true)
     end
 
     # Returns the formatted arguments of this command.
@@ -542,7 +542,7 @@ module CmdParse
         summary << format(line, width: command_parser.help_line_width - command_parser.help_indent,
                           indent: summary_width + 1, indent_first_line: false) << "\n"
       end
-      cond_format_help_section(title, summary, condition: !summary.empty?)
+      cond_format_help_section(title, summary, condition: !summary.empty?, preformatted: true)
     end
 
     # This hook method is called when the command (or one of its super-commands) is added to another
@@ -571,11 +571,26 @@ module CmdParse
     #
     #   Summary:
     #       help - Provide help for individual commands
-    def cond_format_help_section(title, *lines, condition: true, indent: true)
+    #
+    # Options:
+    #
+    # condition:: The formatted help section is only returned if the condition is +true+.
+    #
+    # indent:: Whether the lines should be indented with CommandParser#help_indent spaces.
+    #
+    # preformatted:: Assume that the given lines are already correctly formatted and don't try to
+    #                reformat them.
+    def cond_format_help_section(title, *lines, condition: true, indent: true, preformatted: false)
       if condition
-        "#{title}:\n" << format(lines.flatten.join("\n"),
-                                indent: (indent ? command_parser.help_indent : 0),
-                                indent_first_line: true) << "\n\n"
+        out = "#{title}:\n"
+        lines = lines.flatten.join("\n").split(/\n/)
+        if preformatted
+          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)
+        end
+        out << "\n\n"
       else
         ''
       end
@@ -596,8 +611,8 @@ module CmdParse
                indent: command_parser.help_indent, indent_first_line: false)
       content = (content || '').dup
       line_length = width - indent
-      first_line_pattern = other_lines_pattern = /\A.{1,#{line_length}}\z|\A.{1,#{line_length}}[ \n]/
-      (first_line_pattern = /\A.{1,#{width}}\z|\A.{1,#{width}}[ \n]/) unless indent_first_line
+      first_line_pattern = other_lines_pattern = /\A.{1,#{line_length}}\z|\A.{1,#{line_length}}[ \n]/m
+      (first_line_pattern = /\A.{1,#{width}}\z|\A.{1,#{width}}[ \n]/m) unless indent_first_line
       pattern = first_line_pattern
 
       content.split(/\n\n/).map do |paragraph|
@@ -673,7 +688,8 @@ module CmdParse
 
   # The default version command.
   #
-  # It adds the options "-v" and "--version" to the CommandParser#global_options.
+  # It adds the options "-v" and "--version" to the CommandParser#main_options but this can be
+  # changed in ::new.
   #
   # When the command is specified on the command line (or one of the above mentioned options), it
   # shows the version of the program configured by the settings
@@ -682,15 +698,22 @@ module CmdParse
   # * command_parser.main_options.version
   class VersionCommand < Command
 
-    def initialize #:nodoc:
+    # Create a new version command.
+    #
+    # Options:
+    #
+    # add_switches:: Specifies whether the '-v' and '--version' switches should be added to the
+    #                CommandParser#main_options
+    def initialize(add_switches: true)
       super('version', takes_commands: false)
       short_desc("Show the version of the program")
+      @add_switches = add_switches
     end
 
     def on_after_add #:nodoc:
       command_parser.main_options.on_tail("--version", "-v", "Show the version of the program") do
         execute
-      end
+      end if @add_switches
     end
 
     def execute #:nodoc:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmdparse
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webgen
@@ -46,6 +46,7 @@ files:
 - doc/installation.page
 - doc/metainfo
 - doc/news.page
+- doc/sitemap.sitemap
 - doc/tutorial.page
 - doc/virtual
 - example/net.rb
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Advanced command line parser supporting commands