cmdparse 2.0.5 → 2.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4dca04510d88cd70c3e4591eace794a13f9677a
+  data.tar.gz: db666d2c3f165c61b706fedbe2710bf263003444
+SHA512:
+  metadata.gz: 5e81070751e5b4e65e7f88f46c64ab89596e3fcaad7bfd18c36a8e58fb51514c65e863472279ecaaeab0c74a6351ac8fb2738979df855d3986c0457cb99690b2
+  data.tar.gz: 0bf1b2d6807b63aff149cb6cb4ac3101f7422e2cabfd3624a2910f420f6ec458a9a3e46b85fdd4e1b6cbedb170bd4df6576fe6853cccccfb2f1d975826a03bef

data/README.md

@@ -0,0 +1,59 @@
+**cmdparse** - an advanced command line parser using optparse which has support for commands
+
+Copyright (C) 2004-2014 Thomas Leitner
+
+## Description
+
+Some programs use a "command style" command line. Examples for such programs are the "svn" program
+from Subversion and the "gem" program from Rubygems. The standard Ruby distribution has no library
+to create programs that use such a command line interface.
+
+This library, cmdparse, can be used to create such a command line interface. Internally it uses
+optparse or any other option parser library to parse options and it provides a nice API for
+specifying commands.
+
+## License
+
+GNU LGPLv3 - see COPYING.LESSER for the LGPL and COPYING for the GPL
+
+## Dependencies
+
+none
+
+## 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:
+
+   $ rake install
+
+If you have neither RubyGems nor Rake, use these commands:
+
+   $ ruby setup.rb config
+   $ ruby setup.rb setup
+   $ ruby setup.rb install
+
+## Documentation
+
+You can build the documentation by invoking
+
+   $ rake doc
+
+This builds the API and the additional documentation. The additional documentation needs webgen
+>=1.0.0 (webgen.gettalong.org) for building.
+
+
+## Example
+
+There is an example of how to use cmdparse in the `net.rb` file.
+
+
+## Contact
+
+Author: Thomas Leitner
+
+* Web: <http://cmdparse.gettalong.org>
+* e-Mail: <t_leitner@gmx.at>

data/Rakefile

@@ -2,7 +2,7 @@
 #
 #--
 # cmdparse: advanced command line parser supporting commands
-# Copyright (C) 2004-2010 Thomas Leitner
+# Copyright (C) 2004-2014 Thomas Leitner
 #
 # This file is part of cmdparse.
 #
@@ -19,18 +19,22 @@
 #
 #++
 
-
 begin
   require 'rubygems'
-  require 'rake/gempackagetask'
+  require 'rubygems/package_task'
 rescue Exception
   nil
 end
 
+begin
+  require 'webgen/page'
+rescue LoadError
+end
+
 require 'rake/clean'
 require 'rake/packagetask'
-require 'rake/rdoctask'
 require 'rake/testtask'
+require 'rdoc/task'
 
 # General actions  ##############################################################
 
@@ -38,167 +42,133 @@ $:.unshift 'lib'
 require 'cmdparse'
 
 PKG_NAME = "cmdparse"
-PKG_VERSION = CmdParse::VERSION.join( '.' )
+PKG_VERSION = CmdParse::VERSION.join('.')
 PKG_FULLNAME = PKG_NAME + "-" + PKG_VERSION
 
-SRC_RB = FileList['lib/**/*.rb']
+# End user tasks ################################################################
 
 # The default task is run if rake is given no explicit arguments.
 
-desc "Default Task"
+desc "Default Task (does testing)"
 task :default => :test
 
-
-# End user tasks ################################################################
-
-desc "Prepares for installation"
-task :prepare do
+desc "Installs the package #{PKG_NAME} using setup.rb"
+task :install do
   ruby "setup.rb config"
   ruby "setup.rb setup"
-end
-
-
-desc "Installs the package #{PKG_NAME}"
-task :install => [:prepare]
-task :install do
   ruby "setup.rb install"
 end
 
-
 task :clean do
   ruby "setup.rb clean"
 end
 
-task :test do
-  ruby "-Ilib test/tc_commandhash.rb"
+Rake::TestTask.new do |test|
+  test.test_files = FileList['test/tc_*.rb']
 end
 
-CLOBBER << "doc/output"
-desc "Builds the documentation"
-task :doc => [:rdoc] do
-  chdir "doc" do
+if defined?(Webgen)
+  CLOBBER << "htmldoc"
+  CLOBBER << "webgen-tmp"
+  desc "Builds the documentation"
+  task :htmldoc do
     sh "webgen"
   end
 end
 
-rd = Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/output/rdoc'
-  rdoc.title    = PKG_NAME
-  rdoc.options << '--line-numbers' << '--inline-source' << '-m CmdParse::CommandParser'
-  rdoc.rdoc_files.include( 'lib/**/*.rb' )
+if defined? RDoc::Task
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = 'htmldoc/rdoc'
+    rdoc.title = PKG_NAME
+    rdoc.main = 'CmdParse::CommandParser'
+    rdoc.options << '--line-numbers'
+    rdoc.rdoc_files.include('lib')
+  end
 end
 
+if defined?(Webgen) && defined?(RDoc::Task)
+  desc "Build the whole user documentation"
+  task :doc => [:rdoc, :htmldoc]
+end
 
 # Developer tasks ##############################################################
 
+namespace :dev do
+
+  PKG_FILES = FileList.new( [
+                             'setup.rb',
+                             'COPYING',
+                             'COPYING.LESSER',
+                             'README.md',
+                             'Rakefile',
+                             'net.rb',
+                             'VERSION',
+                             'lib/**/*.rb',
+                             'doc/**/*',
+                             'test/*'
+                            ])
 
-PKG_FILES = FileList.new( [
-                            'setup.rb',
-                            'TODO',
-                            'COPYING',
-                            'COPYING.LESSER',
-                            'README',
-                            'Rakefile',
-                            'net.rb',
-                            'VERSION',
-                            'lib/**/*.rb',
-                            'doc/**/*'
-                          ]) do |fl|
-  fl.exclude( /\bsvn\b/ )
-  fl.exclude( 'doc/output' )
-end
+  CLOBBER << "VERSION"
+  file 'VERSION' do
+    puts "Generating VERSION file"
+    File.open('VERSION', 'w+') {|file| file.write(PKG_VERSION + "\n")}
+  end
 
-if !defined? Gem
-  puts "Package Target requires RubyGEMs"
-else
-  spec = Gem::Specification.new do |s|
+  Rake::PackageTask.new('cmdparse', PKG_VERSION) do |pkg|
+    pkg.need_tar = true
+    pkg.need_zip = true
+    pkg.package_files = PKG_FILES
+  end
 
-    #### Basic information
+  if defined? Gem
+    spec = Gem::Specification.new do |s|
 
-    s.name = PKG_NAME
-    s.version = PKG_VERSION
-    s.summary = "Advanced command line parser supporting commands"
-    s.description = <<-EOF
+      #### Basic information
+      s.name = PKG_NAME
+      s.version = PKG_VERSION
+      s.summary = "Advanced command line parser supporting commands"
+      s.description = <<-EOF
        cmdparse provides classes for parsing commands on the command line; command line options
        are parsed using optparse or any other option parser implementation. Programs that use
        such command line interfaces are, for example, subversion's 'svn' or Rubygem's 'gem' program.
-    EOF
-
-    #### Dependencies, requirements and files
-
-    s.files = PKG_FILES.to_a
-
-    s.require_path = 'lib'
-    s.autorequire = 'cmdparse'
-
-    #### Documentation
-
-    s.has_rdoc = true
-    s.extra_rdoc_files = rd.rdoc_files.reject do |fn| fn =~ /\.rb$/ end.to_a
-    s.rdoc_options = ['--line-numbers', '-m', 'CmdParse::CommandParser']
-
-    #### Author and project details
-
-    s.author = "Thomas Leitner"
-    s.email = "t_leitner@gmx.at"
-    s.homepage = "http://cmdparse.rubyforge.org"
-    s.rubyforge_project = "cmdparse"
-  end
-
-  task :package => [:generateFiles]
-  task :generateFiles do |t|
-    File.open('VERSION', 'w+') do |file| file.write( PKG_VERSION + "\n" ) end
-  end
+      EOF
+      s.license = 'LGPLv3'
+
+      #### Dependencies, requirements and files
+      s.files = PKG_FILES.to_a
+      s.require_path = 'lib'
+      s.autorequire = 'cmdparse'
+
+      #### Documentation
+      s.has_rdoc = true
+      s.rdoc_options = ['--line-numbers', '--main', 'CmdParse::CommandParser']
+
+      #### Author and project details
+      s.author = "Thomas Leitner"
+      s.email = "t_leitner@gmx.at"
+      s.homepage = "http://cmdparse.gettalong.org"
+    end
 
-  CLOBBER << "VERSION"
+    Gem::PackageTask.new(spec) do |pkg|
+      pkg.need_zip = true
+      pkg.need_tar = true
+    end
 
-  Rake::GemPackageTask.new( spec ) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = true
   end
 
-end
-
-desc "Upload documentation to homepage"
-task :uploaddoc => [:doc] do
-  Dir.chdir('doc/output')
-  sh "scp -r * gettalong@rubyforge.org:/var/www/gforge-projects/cmdparse/"
-end
-
-
-# Misc tasks ###################################################################
-
-
-def count_lines( filename )
-  lines = 0
-  codelines = 0
-  open( filename ) do |f|
-    f.each do |line|
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
+  if defined?(Gem)
+    desc "Upload the release to Rubygems"
+    task :publish_files => [:package] do
+      sh "gem push pkg/cmdparse-#{PKG_VERSION}.gem"
+      puts 'done'
     end
   end
-  [lines, codelines]
-end
 
+  if defined?(Webgen) && defined?(Gem) && defined?(Rake::RDocTask)
+    desc "Release cmdparse version " + PKG_VERSION
+    task :release => [:clobber, :package, :publish_files]
+  end
 
-def show_line( msg, lines, loc )
-  printf "%6s %6s   %s\n", lines.to_s, loc.to_s, msg
 end
 
-
-desc "Show statistics"
-task :statistics do
-  total_lines = 0
-  total_code = 0
-  show_line( "File Name", "Lines", "LOC" )
-  SRC_RB.each do |fn|
-    lines, codelines = count_lines fn
-    show_line( fn, lines, codelines )
-    total_lines += lines
-    total_code  += codelines
-  end
-  show_line( "Total", total_lines, total_code )
-end
+task :clobber => ['dev:clobber']

data/VERSION

@@ -1 +1 @@
-2.0.5
+2.0.6

data/doc/{src/about.page → about.page}

@@ -1,9 +1,9 @@
 ---
 title: About
-inMenu: true
-orderInfo: 2
+in_menu: true
+sort_info: 2
 ---
-h2. About @cmdparse@
+## About `cmdparse`
 
 Some new programs use a "command style" command line. Examples for such programs are the "svn"
 program from Subversion and the "gem" program from Rubygems. The standard Ruby distribution has no
@@ -15,14 +15,10 @@ specifying commands and subcommands.
 
 A typical command line for a program which uses commands looks like this:
 
-<pre>
-  $ net --verbose ipaddr add 192.168.0.1 193.150.0.1
-</pre>
+    $ net --verbose ipaddr add 192.168.0.1 193.150.0.1
 
+## Author
 
-h2. Author
-
-* *Thomas Leitner*
-* Web: "http://cmdparse.rubyforge.org":http://cmdparse.rubyforge.org
-* e-Mail: "t_leitner@gmx.at":mailto:t_leitner@gmx.at
-* GPG Key-Id: 0xD942E7F6
+* **Thomas Leitner**
+* Web: <http://cmdparse.gettalong.org>
+* e-Mail: <mailto:t_leitner@gmx.at>

data/doc/{src/default.css → default.css}

@@ -145,7 +145,8 @@
     border: 1px solid black;
   }
 
-  table.cmdparse-example td {
+  table.cmdparse-example td, pre {
     border: 1px solid #408040;
     background-color: white;
+    padding: 5px;
   }

data/doc/{src/default.template → default.template}

@@ -20,23 +20,20 @@
       </div>
 
       <div id="headerbar" class="bar">
-        <span class="left">Navbar: {breadcrumbTrail: }</span>
-        <span class="right">Language: {langbar: }</span>
+        <span class="left">Navbar: {breadcrumb_trail: }</span>
         <div style="clear:both"></div>
       </div>
 
       <div id="menu">
-        {menu:}
+        {menu: {options: {mi: {in_menu: true}, sort: true}}}
       </div>
 
       <div id="body">
-        {content:}
+        <webgen:block name="content" />
       </div>
 
       <div id="footer" class="bar">
-        <a href="http://validator.w3.org/check?uri=referer"><img src="{resource: w3c-valid-xhtml11}" alt="Valid XHTML 1.1!" height="31" width="88" /></a>
-        <a href="http://jigsaw.w3.org/css-validator/check/referer"><img src="{resource: w3c-valid-css}" alt="Valid CSS!" height="31" width="88" /></a>
-        <a href="http://webgen.rubyforge.org"><img src="{resource: webgen-generated}" alt="Generated by webgen" height="31" width="88"/></a> on <b>{date: }</b>
+        Generated by <a href="http://webgen.gettalong.org">webgen</a> on <b>{date: }</b>
       </div>
     </div>
   </body>

data/doc/download.page

@@ -0,0 +1,34 @@
+---
+title: Download & Installation
+in_menu: true
+sort_info: 4
+---
+## Download
+
+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:
+
+    $ rake install
+
+If you have neither RubyGems nor Rake, use these commands:
+
+    $ ruby setup.rb config
+    $ ruby setup.rb setup
+    $ ruby setup.rb install