RubyGems - cmdparse - Versions diffs - 2.0.6 → 3.0.0 - Mend

cmdparse 2.0.6 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

checksums.yaml +4 -4
data/COPYING +21 -674
data/README.md +29 -26
data/Rakefile +58 -94
data/VERSION +1 -1
data/doc/api.api +5 -0
data/doc/api.template +24 -0
data/doc/default.scss +1987 -0
data/doc/default.template +47 -26
data/doc/images/bg01.png +0 -0
data/doc/images/bg02.png +0 -0
data/doc/index.page +81 -74
data/doc/{download.page → installation.page} +13 -14
data/doc/metainfo +14 -0
data/doc/news.page +113 -0
data/doc/tutorial.page +211 -115
data/doc/virtual +2 -5
data/example/net.rb +85 -0
data/lib/cmdparse.rb +675 -284
data/webgen.config +22 -0
metadata +39 -24
data/COPYING.LESSER +0 -165
data/doc/about.page +0 -24
data/doc/default.css +0 -152
data/doc/logo.png +0 -0
data/lib/cmdparse/wrappers/optparse.rb +0 -63
data/net.rb +0 -88
data/test/tc_commandhash.rb +0 -96

data/doc/default.template CHANGED

@@ -1,40 +1,61 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
+<!DOCTYPE HTML>
+<html>
   <head>
     <title>cmdparse: {title:}</title>
-    <link href="{relocatable: default.css}" rel="stylesheet" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="description" content="Advanced Ruby command line parser supporting nested commands" />
+    <meta name="keywords" content="ruby, CLI, command parser, command suite, option parser" />
+    <link href="{relocatable: default.css}" rel="stylesheet" />
   </head>
-  <body>
-    <div id="all">
-      <div id="header">
-        <table>
-          <tr>
-            <td><img src="{relocatable: logo.png}" alt="Logo" title="Logo" /></td>
-            <td><h1>cmdparse<span style="font-size: 60%"> - advanced command line parser supporting commands</span></h1>
-            </td>
-          </tr>
-        </table>
+  <body class="left-sidebar">
+    <div id="wrapper">
+      <div id="titleBar">
+        <a id="sidebar-show" href="#titleBar" class="toggle"></a>
+        <a id="sidebar-hide" href="#" class="toggle"></a><span class="title">cmdparse</span>
       </div>
-      <div id="headerbar" class="bar">
-        <span class="left">Navbar: {breadcrumb_trail: }</span>
-        <div style="clear:both"></div>
+      <div id="content">
+        <div class="inner">
+          <article class="box post">
+            <webgen:block name="content" />
+          </article>
+        </div>
       </div>
-      <div id="menu">
-        {menu: {options: {mi: {in_menu: true}, sort: true}}}
-      </div>
+      <!-- Sidebar -->
+      <div id="sidebar">
+        <h1 id="logo"><a href="{relocatable: /}">cmdparse</a><br /><span>v 3.0.0</span></h1>
-      <div id="body">
-        <webgen:block name="content" />
-      </div>
+        <!-- Nav -->
+        <nav id="nav">
+          {menu: {options: {mi: {in_menu: true}, sort: true, absolute_levels: [0, 1]},
+                  item_submenu_inhierarchy_class: current, item_selected_class: current}}
+        </nav>
+        <!-- Text -->
+        <section class="box text-style1">
+          <div class="inner">
+            <p>
+              <strong>cmdparse:</strong> An advanced Ruby command line parser supporting nested
+              commands
+            </p>
+          </div>
+        </section>
+        <!-- Copyright -->
+        <ul id="copyright">
+          <li itemscope="" itemtype="http://schema.org/Person">&copy; 2004-2015
+            <span itemprop="name">Thomas Leitner</span>
+            <meta itemprop="email" content="t_leitner@gmx.at" />
+            <meta itemprop="url" content="http://gettalong.org" />
+          </li>
+          <li>Generated by <a href="http://webgen.gettalong.org">webgen</a><br /> on <b>{date: }</b></li>
+          <li>Design based on<br />Striped by <a href="http://html5up.net">HTML5 UP</a></li>
+        </ul>
-      <div id="footer" class="bar">
-        Generated by <a href="http://webgen.gettalong.org">webgen</a> on <b>{date: }</b>
       </div>
     </div>
   </body>
 </html>

data/doc/images/bg01.png ADDED

Binary file

data/doc/images/bg02.png ADDED

Binary file

data/doc/index.page CHANGED

@@ -1,107 +1,114 @@
 ---
-title: Homepage
+title: Home
 in_menu: true
 routed_title: cmdparse
 sort_info: 1
 ---
-## Welcome
+## cmdparse
-... to the homepage of ***cmdparse***, an advanced command line parser supporting commands.
+... is an advanced Ruby command line parser supporting nested commands.
-## Feature List
+It allows the creation of "command style" programs, like `git` or `svn`, that perform different
+functions depending on which command is invoked. Additionally, nesting of commands, i.e. commands
+that take commands themselves, is also possible. For option parsing, the battle-tested Ruby standard
+library `optparse` is used.
-* Commands can have subcommands
-* Default commands for showing help and the version of the program
-* Option parsing library of choice can be used (after writing wrapper), default is `optparse`
-* Easy to use
-## News
-**2014-04-05 cmdparse 2.0.6 released!!!**
-There were no codewise changes but the used infrastructure and tools have been updated to newer
-versions. Also the license information has been added to the gem specification and the tests are now
-included in the distribution.
-**2012-06-09 cmdparse 2.0.5 released!!!**
-Changes:
-* Fixed backwards incompatible change
-**2012-06-07 cmdparse 2.0.4 released!!!**
+A typical command line for a program which uses commands looks like this:
-Changes:
+    $ net --verbose ipaddr add 192.168.0.1 193.150.0.1
-* Only some minor changes regarding the help output for commands which is nicer now.
+## Features
-**2006-06-17 cmdparse 2.0.2 released!!!**
-Changes:
-* Included two patches from Assaph Mehr:
-  * partial command matching can now be used (see the [tutorial page](tutorial.html))
-  * now a banner for the help and version commands can be specified
-**2006-04-05 cmdparse 2.0.1 released!!!**
-Changes:
-* Just a bug fix release for those using cmdparse with Rubygems. By issuing the command
-  `require_gem 'cmdparse'` the cmdparse library gets automagically loaded.
-* Minor documentation updates
-**2005-08-16 cmdparse 2.0.0 released!!!**
-This version is not compatible to previous versions of cmdparse as there have been major changes in
-the API. However, updating your code to use the new API is very easy!
-Changes:
+* Commands can have sub-commands
+* Built-in commands for showing help and the version of the program
+* Automatic discovery of names and number of required/optional command arguments
+* Truly global options that can be used on any command
+* No need to learn a special DSL
+* Use POROs (plain old Ruby objects) for creating commands or create them on the fly
+* All `OptionParser` goodies available for option parsing
+* Easy to use
-* Commands can now have subcommands which can have subcommands which can have subcommands...
-* No need to implement a whole new class for simple commands anymore
-* Default option parser library is `optparse`, however, any option parser library can be used after writing a small wrapper
+## Quickstart
-**2005-07-05 cmdparse 1.0.5 released!!!**
+Here are two short code samples which show how to use cmdparse. A complete example application can
+be found in the [tutorial](tutorial.html), also see the API documentation of
+[CmdParse::CommandParser] and [CmdParse::Command].
-Changes:
+A sample CLI program where commands are defined using classes:
-* added possibility to parse global options, command and local options separately
+~~~ ruby
+require 'cmdparse'
+class TestCmd < CmdParse::Command
+  def initialize
+    super('test')
+    short_desc('Short description of command')
+    add_command(TestSubCmd.new)
+  end
+end
-**2005-06-16 cmdparse 1.0.4 released!!!**
+class TestSubCmd < CmdParse::Command
+  def initialize
+    super('sub', takes_commands: false)
+    options.on('-x', '--example', 'Example option') { puts 'example' }
+  end
-Changes:
+  def execute(name, *opt)
+    puts "Hello #{name}, options: #{opt.join(', ')}"
+  end
+end
-* fix for older ruby versions
-* fixed bug where exception was not caught
+parser = CmdParse::CommandParser.new(handle_exceptions: :no_help)
+parser.add_command(CmdParse::HelpCommand.new)
+parser.add_command(TestCmd.new)
+parser.parse
+~~~
+The same program but with the commands defined on the fly:
-**2005-06-09 cmdparse 1.0.3 released!!!**
+~~~ ruby
+<%= context.render_block('sample') %>
+~~~
-Changes:
+Sample output for different invocations:
-* added optional graceful exception handling
+<%
+invocations = ['', 'help', 'test sub', 'test sub -h', 'test sub Thomas', 'test sub -x Thomas opt1 opt2']
+tmpfile = context.website.tmpdir('sample.rb', true)
+File.write(tmpfile, context.render_block('sample'))
+result = invocations.map do |args|
+  ["$ <strong>sample.rb #{args}</strong>", h(`ruby -I#{context.website.directory}/lib #{tmpfile} #{args}`)]
+end.flatten.join("\n")
+%>
+<pre>
+<%= result %>
+</pre>
-**2005-04-21 cmdparse 1.0.2 released!!!**
-Changes:
+## Author
-* splitted parsing of the arguments and executing the command into two methods
+* **Thomas Leitner**
+* Web: <http://cmdparse.gettalong.org>
+* e-Mail: <mailto:t_leitner@gmx.at>
-**2005-04-13 cmdparse 1.0.1 released!!!**
+--- name:sample pipeline:
+require 'cmdparse'
-Changes:
+parser = CmdParse::CommandParser.new(handle_exceptions: :no_help)
+parser.add_command(CmdParse::HelpCommand.new)
+parser.add_command('test') do |test_cmd|
+  test_cmd.short_desc('Short description of command')
-* Improved HelpCommand: the global options -h and --help take an optional command name now
-* Possibility to define a default command which is used when no command was specified
-* A `NoCommandGivenError` is thrown when no command on the CLI and no default command was specified
+  test_cmd.add_command('sub') do |sub_cmd|
+    sub_cmd.takes_commands(false)
+    sub_cmd.options.on('-x', '--example', 'Example option') { puts 'example' }
+    sub_cmd.action do |name, *opt|
+      puts "Hello #{name}, options: #{opt.join(', ')}"
+    end
+  end
+end
+parser.parse

data/doc/{download.page → installation.page} RENAMED

@@ -1,29 +1,19 @@
 ---
-title: Download & Installation
+title: Installation
 in_menu: true
 sort_info: 4
 ---
-## Download
+## Download & Installation
 The newest version of cmdparse can be downloaded from [Rubygems] or the [cmdparse Github
 page][github]!
-[Rubygems]: http://rubygems.org/gems/cmdparse
-[github]: http://github.com/gettalong/cmdparse
-## Dependencies
-This library has *no* dependencies.
-## Installation
 The preferred way of installing cmdparse is via RubyGems:
     $ gem install cmdparse
-If you do not have RubyGems installed, but Rake, you can use the following command:
+If you do not have RubyGems installed, but Rake, you can use the following command inside the
+cmdparse directory:
     $ rake install
@@ -32,3 +22,12 @@ If you have neither RubyGems nor Rake, use these commands:
     $ ruby setup.rb config
     $ ruby setup.rb setup
     $ ruby setup.rb install
+[Rubygems]: http://rubygems.org/gems/cmdparse
+[github]: http://github.com/gettalong/cmdparse
+### Dependencies
+This library has *no* dependencies.

data/doc/metainfo ADDED

@@ -0,0 +1,14 @@
+--- alcn
+/api/:
+  title: API
+  in_menu: true
+  sort_info: 10
+/api/**/*.html:
+  link:
+    css: /stylesheets/api.css
+  in_menu: true
+/api/**/index*.html:
+  in_menu: false

data/doc/news.page ADDED

@@ -0,0 +1,113 @@
+---
+title: News
+in_menu: true
+sort_info: 8
+---
+## News
+### 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.
+However, updating code to use the new API is straightforward and the new version offers more
+features!
+Changes:
+* License changed to MIT!
+* Top level options and global options are now separated
+* Easier on the fly definition of commands
+* Better help output (automatic formatting of long lines -- even for option descriptions --,
+  automatic argument name detection,&nbsp;...)
+* Keyword arguments are now used for better code readability
+* The `CmdParse::VERSION` constant is now a simple version string instead of an array
+* Better API documentation and expanded tutorial
+* Better website design and integration of the API documentation into the website
+### 2014-04-05 cmdparse 2.0.6 released!
+There were no codewise changes but the used infrastructure and tools have been updated to newer
+versions. Also the license information has been added to the gem specification and the tests are now
+included in the distribution.
+### 2012-06-09 cmdparse 2.0.5 released!
+Changes:
+* Fixed backwards incompatible change
+### 2012-06-07 cmdparse 2.0.4 released!
+Changes:
+* Only some minor changes regarding the help output for commands which is nicer now.
+### 2006-06-17 cmdparse 2.0.2 released!
+Changes:
+* Included two patches from Assaph Mehr:
+  * partial command matching can now be used (see the [tutorial page](tutorial.html))
+  * now a banner for the help and version commands can be specified
+### 2006-04-05 cmdparse 2.0.1 released!
+Changes:
+* Just a bug fix release for those using cmdparse with Rubygems. By issuing the command
+  `require_gem 'cmdparse'` the cmdparse library gets automagically loaded.
+* Minor documentation updates
+### 2005-08-16 cmdparse 2.0.0 released!
+This version is not compatible to previous versions of cmdparse as there have been major changes in
+the API. However, updating your code to use the new API is very easy!
+Changes:
+* Commands can now have subcommands which can have subcommands which can have subcommands...
+* No need to implement a whole new class for simple commands anymore
+* Default option parser library is `optparse`, however, any option parser library can be used after writing a small wrapper
+### 2005-07-05 cmdparse 1.0.5 released!
+Changes:
+* added possibility to parse global options, command and local options separately
+### 2005-06-16 cmdparse 1.0.4 released!
+Changes:
+* fix for older ruby versions
+* fixed bug where exception was not caught
+### 2005-06-09 cmdparse 1.0.3 released!
+Changes:
+* added optional graceful exception handling
+### 2005-04-21 cmdparse 1.0.2 released!
+Changes:
+* splitted parsing of the arguments and executing the command into two methods
+### 2005-04-13 cmdparse 1.0.1 released!
+Changes:
+* Improved HelpCommand: the global options -h and --help take an optional command name now
+* Possibility to define a default command which is used when no command was specified
+* A `NoCommandGivenError` is thrown when no command on the CLI and no default command was specified