cmdparse 1.0.5 → 2.0.0

data/lib/cmdparse/wrappers/optparse.rb

@@ -0,0 +1,65 @@
+#
+#--
+#
+# $Id: optparse.rb 329 2005-08-14 15:39:05Z thomas $
+#
+# cmdparse: advanced command line parser supporting 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
+#
+#++
+#
+#
+
+require 'optparse'
+
+# Some extension to the standard option parser class
+class OptionParser
+
+  if const_defined?( 'Officious' )
+    Officious.delete( 'version' )
+    Officious.delete( 'help' )
+  else
+    DefaultList.long.delete( 'version' )
+    DefaultList.long.delete( 'help' )
+  end
+
+end
+
+module CmdParse
+
+  # Parser wrapper for OptionParser (included in Ruby Standard Library).
+  class OptionParserWrapper < ParserWrapper
+
+    # Initializes the wrapper with a default OptionParser instance or the +parser+ parameter and
+    # yields this instance.
+    def initialize( parser = OptionParser.new, &block )
+      @instance = parser
+      self.instance( &block )
+    end
+
+    def order( args )
+      @instance.order( args )
+    end
+
+    def permute( args )
+      @instance.permute( args )
+    end
+
+    def summarize
+      @instance.summarize
+    end
+
+  end
+
+end

data/net.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# if something is changed here -> change line numbers in doc/src/documentation.page
+
+$:.unshift "lib"
+require 'cmdparse'
+require 'ostruct'
+require 'yaml'
+
+class NetStatCommand < CmdParse::Command
+
+  def initialize
+    super( 'stat', false )
+    self.short_desc = "Show network statistics"
+    self.description = "This command shows very useful network statistics - eye catching!!!"
+  end
+
+  def execute( args )
+    puts "Showing network statistics" if $verbose
+    puts
+    puts "Yeah, I will do something now..."
+    puts
+    1.upto(10) do |row|
+      puts " "*(20-row) + "#"*(row*2 - 1)
+    end
+    puts
+  end
+
+end
+
+cmd = CmdParse::CommandParser.new( true )
+cmd.program_name = "net"
+cmd.program_version = [0, 1, 1]
+cmd.options = CmdParse::OptionParserWrapper.new do |opt|
+  opt.separator "Global options:"
+  opt.on("--verbose", "Be verbose when outputting info") {|t| $verbose = true }
+end
+cmd.add_command( CmdParse::HelpCommand.new )
+cmd.add_command( CmdParse::VersionCommand.new )
+cmd.add_command( NetStatCommand.new )
+
+# ipaddr
+ipaddr = CmdParse::Command.new( 'ipaddr', true )
+ipaddr.short_desc = "Manage IP addresses"
+cmd.add_command( ipaddr )
+
+# ipaddr add
+add = CmdParse::Command.new( 'add', false )
+add.short_desc = "Add an IP address"
+add.set_execution_block do |args|
+  puts "Adding ip addresses: #{args.join(', ')}" if $verbose
+  $ipaddrs += args
+end
+ipaddr.add_command( add )
+
+# ipaddr del
+del = CmdParse::Command.new( 'del', false )
+del.short_desc = "Delete an IP address"
+del.options = CmdParse::OptionParserWrapper.new do |opt|
+  opt.on( '-a', '--all', 'Delete all IP addresses' ) { $deleteAll = true }
+end
+del.set_execution_block do |args|
+  if $deleteAll
+    $ipaddrs = []
+  else
+    puts "Deleting ip addresses: #{args.join(', ')}" if $verbose
+    args.each {|ip| $ipaddrs.delete( ip ) }
+  end
+end
+ipaddr.add_command( del )
+
+# ipaddr list
+list = CmdParse::Command.new( 'list', false )
+list.short_desc = "Lists all IP addresses"
+list.set_execution_block do |args|
+  puts "Listing ip addresses:" if $verbose
+  puts $ipaddrs.to_yaml
+end
+ipaddr.add_command( list, true )
+
+if File.exists?( 'dumpnet' )
+  $ipaddrs = Marshal.load( File.read( 'dumpnet' ) )
+else
+  $ipaddrs = []
+end
+
+cmd.parse
+
+File.open( 'dumpnet', 'w+' ) {|f| f.write( Marshal.dump( $ipaddrs ) ) }

metadata

@@ -3,17 +3,18 @@ rubygems_version: 0.8.6
 specification_version: 1
 name: cmdparse
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
-date: 2005-07-05
-summary: An advanced command line parser using optparse which supports commands
+  version: 2.0.0
+date: 2005-08-16
+summary: Advanced command line parser supporting commands
 require_paths: 
   - lib
 email: t_leitner@gmx.at
 homepage: http://cmdparse.rubyforge.org
 rubyforge_project: cmdparse
-description: "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."
+description: "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."
 autorequire: 
 default_executable: 
 bindir: bin
@@ -35,10 +36,12 @@ files:
   - README
   - Rakefile
   - ChangeLog
-  - test.rb
+  - net.rb
   - VERSION
   - lib/cmdparse.rb
+  - lib/cmdparse/wrappers/optparse.rb
   - doc/src
+  - doc/config.yaml
   - doc/plugin
   - doc/src/default.css
   - doc/src/features.page
@@ -54,9 +57,8 @@ test_files: []
 rdoc_options: 
   - "--line-numbers"
   - "-m"
-  - README
-extra_rdoc_files: 
-  - README
+  - CmdParse::CommandParser
+extra_rdoc_files: []
 executables: []
 extensions: []
 requirements: []

data/test.rb

@@ -1,42 +0,0 @@
-#!/usr/bin/env ruby
-# if something is changed here -> change line numbers in doc/src/documentation.page
-$:.unshift "lib"
-require 'cmdparse'
-require 'ostruct'
-
-
-class TestCommand < CommandParser::Command
-  def initialize
-    super('test')
-    @internal = OpenStruct.new
-    @internal.function = nil
-    @internal.audible = false
-    options.separator "Options:"
-    options.on("-t", "--test FUNCTION", "Test only FUNCTION") do |func|
-      @internal.function = func
-    end
-    options.on("-a", "--[no-]audible", "Run audible") { |@internal.audible| }
-  end
-  def description
-    "Executes various tests"
-  end
-  def execute( commandParser, args )
-    puts "Additional arguments: "+ args.inspect
-    puts "Internal values: " + @internal.inspect
-  end
-end
-
-cmd = CommandParser.new(true)
-cmd.options do |opt|
-  opt.program_name = "test.rb"
-  opt.version = [0, 1, 0]
-  opt.release = "1.0"
-  opt.separator "Global options:"
-  opt.on("-r", "--require TEST",  "Require the TEST") {|t| puts "required: #{t}"}
-  opt.on("--delay N", Integer, "Delay test for N seconds before executing") {|d| puts "delay: #{d}"}
-end
-cmd.add_command TestCommand.new, true
-cmd.add_command CommandParser::HelpCommand.new
-cmd.add_command CommandParser::VersionCommand.new
-cmd.parse!( ARGV, false )
-cmd.execute