cmdparse 1.0.0

data/Rakefile

@@ -0,0 +1,207 @@
+# -*- ruby -*-
+#
+# $Id$
+#
+# cmdparse: an advanced command line parser using optparse which supports commands
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+require 'rake/clean'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+# General actions  ##############################################################
+
+require 'lib/cmdparse'
+
+PKG_NAME = "cmdparse"
+PKG_VERSION = CommandParser::VERSION.join( '.' )
+PKG_FULLNAME = PKG_NAME + "-" + PKG_VERSION
+
+SRC_RB = FileList['lib/**/*.rb']
+
+# The default task is run if rake is given no explicit arguments.
+
+desc "Default Task"
+task :default => :doc
+
+
+# End user tasks ################################################################
+
+desc "Prepares for installation"
+task :prepare 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
+
+
+CLOBBER << "doc/output"
+desc "Builds the documentation"
+task :doc => [:rdoc] do
+  Dir.chdir("doc")
+  sh "webgen -V 4"
+  Dir.chdir("..")
+end
+
+rd = Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/output/rdoc'
+  rdoc.title    = PKG_NAME
+  rdoc.options << '--line-numbers' << '--inline-source' << '-m README'
+  rdoc.rdoc_files.include( 'README' )
+  rdoc.rdoc_files.include( 'lib/**/*.rb' )
+end
+
+
+# Developer tasks ##############################################################
+
+
+PKG_FILES = FileList.new( [
+                            'setup.rb',
+                            'TODO',
+                            'COPYING',
+                            'README',
+                            'Rakefile',
+                            'ChangeLog',
+                            'VERSION',
+                            'lib/**/*.rb',
+                            'doc/**/*'
+                          ]) do |fl|
+  fl.exclude( /\bsvn\b/ )
+  fl.exclude( 'doc/output' )
+end
+
+if !defined? Gem
+  puts "Package Target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+
+    #### Basic information
+
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.summary = "An advanced command line parser using optparse which supports commands"
+    s.description = <<-EOF
+       cmdparse extends the default option parser 'optparse' by adding
+       support for commands. 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 = nil
+
+    #### 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 README']
+
+    #### Author and project details
+
+    s.author = "Thomas Leitner"
+    s.email = "t_leitner@gmx.at"
+    s.homepage = "cmdparse.rubyforge.org"
+    s.rubyforge_project = "cmdparse"
+  end
+
+  task :package => [:generateFiles]
+  task :generateFiles do |t|
+    sh "svn log -r HEAD:1 -v > ChangeLog"
+    File.open('VERSION', 'w+') do |file| file.write( PKG_VERSION + "\n" ) end
+  end
+
+  CLOBBER << "ChangeLog" << "VERSION"
+
+  Rake::GemPackageTask.new( spec ) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+
+end
+
+
+desc "Creates a tag in the repository"
+task :tag do
+  repositoryPath = File.dirname( $1 ) if `svn info` =~ /^URL: (.*)$/
+  fail "Tag already created in repository " if /#{PKG_FULLNAME}/ =~ `svn ls #{repositoryPath}/versions`
+  sh "svn cp -m 'Created version #{PKG_FULLNAME}' #{repositoryPath}/trunk #{repositoryPath}/versions/#{PKG_FULLNAME}"
+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
+    end
+  end
+  [lines, codelines]
+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

data/TODO

@@ -0,0 +1,5 @@
+
+
+---- DONE ----
+
+* define banner in a common way (like option parser), maybe use the one from option parser

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/doc/src/default.css

@@ -0,0 +1,137 @@
+  html {
+	margin: 0px 5%;
+	background-color: #eee;
+  }
+
+  body {
+	margin: 0px;
+	padding: 0px;
+	background-color: #fff;
+	font-size: 12px;
+	font-family: Verdana, Arial, Helvetica;
+  }
+
+  /* General layout of the page */
+
+  #header, #footer {
+	width: 100%;
+	background-color: #58b;
+	color: #fff;
+  }
+
+  #menu {
+	float: left;
+	width: 230px;
+    padding: 20px 0px 0px 20px;
+	border: 3px solid #58b;
+  }
+
+  #body {
+	margin-left: 250px;
+	padding: 20px;
+  }
+
+  #footer {
+	clear: both;
+	padding: 5px 0px;
+	text-align: center;
+  }
+
+
+  /* styling the header */
+
+  #headerbar {
+	width: 100%;
+	font-size: 90%;
+  }
+
+  span#navbar, span#languages {
+	padding: 3px;
+	width: 45%;
+  }
+
+  span#navbar {
+	float: left;
+	text-align: left;
+  }
+
+  span#languages {
+	float: right;
+	text-align: right;
+  }
+
+  div#header h1, h2 {
+	margin: 0px;
+	padding: 15px 50px 0px;
+
+    font-size: 300%;
+	font-style: italic;
+	font-weight: normal;
+  }
+
+  div#header h2 {
+    padding-top: 0px;
+    padding-bottom: 15px;
+    font-size: 100%;
+  }
+
+  /* styling the menu */
+
+  #menu a {
+	text-decoration: none;
+	color: #b55;
+	font-weight: bold;
+	font-size: 130%;
+  }
+
+  #menu a:hover {
+	text-decoration: underline;
+  }
+
+  #menu .webgen-menuitem-selected {
+	border-left: 3px solid #58b;
+  }
+
+  #menu .webgen-submenu {
+  }
+
+  #menu ul {
+	list-style-type: none;
+	padding: 0px;
+	margin-left: 10px;
+  }
+
+  #menu li > ul {
+	font-size: 95%;
+  }
+
+  #menu li {
+    margin: 0.0em 0px;
+    padding: 2px 0px;
+    padding-left: 5px;
+    border-left: 3px solid #CCCCCC;
+  }
+
+  /* styling the content */
+
+  div.section {
+	margin-bottom: 30px;
+  }
+
+  h2.section_header {
+	padding: 0px;
+	border-bottom: 3px double #8b5;
+
+	letter-spacing: 0.2em;
+	font-size: 150%;
+	font-weight: bold;
+	color: #8b5;
+  }
+
+  pre.webgen-file {
+    padding-left: 10px;
+    margin: 0px 10px;
+    border-left: 3px solid #8b5;
+  }
+
+}

data/doc/src/default.template

@@ -0,0 +1,32 @@
+<?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="en">
+  <head>
+    <title>CommandParser: {title: }</title>
+    <link href="{relocatable: default.css}" rel="stylesheet" />
+  </head>
+  <body>
+    <div id="header">
+      <h1>{title: }</h1>
+      <h2>cmdparse: an advanced command line parser using optparse which supports commands</h2>
+      <div id="headerbar">
+        <span id="navbar">{navbar: }</span>
+        <span id="languages">{lang: }</span>
+        <div style="clear: both; border-top: 1px solid #58b"></div>
+      </div>
+    </div>
+
+    <div id="menu">
+      {menu: }
+    </div>
+
+    <div id="body">
+      {content: }
+    </div>
+
+    <div id="footer">
+        generated with <em><b><a href="http://webgen.rubyforge.org">webgen</a></b></em> on <b>{date: }</b>
+    </div>
+
+  </body>
+</html>

data/doc/src/download.fragment

@@ -0,0 +1,32 @@
+<div class="section">
+<h2 class="section_header">Download</h2>
+<p>The newest version of cmdparse can be downloaded from Rubyforge.</p>
+<p>Homepage: <a href="http://cmdparse.rubyforge.org">cmdparse.rubyforge.org</a><br />
+Download: <a href="http://rubyforge.org/frs/?group_id=396">http://rubyforge.org/frs/?group_id=396</a>
+</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Dependencies</h2>
+<p>optparse - part of the standard ruby distribution, so nothing to do here</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Installation</h2>
+You can use the standard way to install cmdparse:
+<pre>
+ $ ruby setup.rb config
+ $ ruby setup.rb setup
+ $ ruby setup.rb install
+</pre>
+
+Or you could use Rake and substitute the above commands with this:
+<pre>
+ $ rake install
+</pre>
+
+Or you could install cmdparse the "GEM way":
+<pre>
+ $ gem install cmdparse
+</pre>
+</div>

data/doc/src/features.fragment

@@ -0,0 +1,8 @@
+<div class="section">
+<h2 class="section_header">Feature list</h2>
+<ul>
+  <li>Based upon the standard library <code>optparse</code></li>
+  <li>Each command is implemented via a class</li>
+  <li>As easy to use as <code>optparse</code> itself</li>
+</ul>
+</div>

data/doc/src/index.fragment

@@ -0,0 +1,21 @@
+<div class="section">
+<h2 class="section_header">Welcome</h2>
+<p>... to the homepage of <i><b>cmdparse</b></i>, an advanced command line parser.</p>
+<p>Have a look around the site!</p>
+</div>
+
+<div class="section">
+<h2 class="section_header">Description</h2>
+<p>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
+library to create programs that use such a command line interface.</p>
+
+<p>This library, cmdparse, can be used to create such a command line interface. Internally it uses
+optparse to parse options and it provides a nice API for specifying commands.</p>
+
+</div>
+
+<div class="section">
+<h2 class="section_header">And so ...</h2>
+<p>... have fun!</p>
+</div>