subcommand 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rahul Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,108 @@
+= subcommand
+
+A tiny wrapper over ruby's awesome OptionParser (standard) which gives easy facility of subcommands.
+It has a similar interface to git and prints subcommands summary as well.
+
+== Features:
+
+1. subcommands using all of OptionParser's features
+2. aliases for subcommands
+
+
+e.g
+Assuming a program "prog" with subcommands "del" and "add"
+
+    prog help
+    prog --help
+
+    prog help del
+    prog del --help
+
+    prog del --force file.a
+    prog --verbose del --force file.a
+
+== Examples
+
+ if a program has subcommands foo and baz
+
+     ruby subcommand.rb help
+     ruby subcommand.rb --help
+     ruby subcommand.rb help foo
+     ruby subcommand.rb foo --help
+     ruby subcommand.rb baz --quiet "some text"
+     ruby subcommand.rb --verbose foo --force file.zzz
+
+== STEPS 
+
+    1. define global_options (optional)
+
+     global_options do |opts|
+       opts.banner = "Usage: subcommand.rb [options] [subcommand [options]]"
+       opts.description = "Stupid program that does something"
+       opts.separator ""
+       opts.separator "Global options are:"
+       opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+         options[:verbose] = v
+       end
+     end
+
+    2. define commands using command(). Send multiple names for aliases.
+
+     command :foo do |opts|
+       opts.banner = "Usage: foo [options]"
+       opts.description = "desc for foo"
+       opts.on("-f", "--[no-]force", "force action") do |v|
+         options[:force] = v
+       end
+     end
+
+     # aliases init and create
+     command :init, :create do |opts| ...
+
+    3. call opt_parse()
+
+== Sample Output
+
+    $ ruby subcommand.rb help
+
+    Usage: subcommand.rb [options] [subcommand [options]]
+    Stupid program that does something
+
+    Global options are:
+        -v, --[no-]verbose               Run verbosely
+
+    Commands are:
+       foo : desc for foo
+       baz : desc for baz
+
+    Aliases: 
+       goo - foo
+
+    See 'subcommand.rb help COMMAND' for more information on a specific command.
+
+
+    $ ruby subcommand.rb help foo
+
+    Usage: foo [options]
+    desc for foo
+        -f, --[no-]force                 force action
+
+== Install
+
+   sudo gem install subcommand
+
+Or, copy into your lib directory and require (see source for sample usage)
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Rahul Kumar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "subcommand"
+    gem.summary = %Q{A tiny wrapper over OptionParser giving simple, elegant subcommand facility}
+    gem.description = %Q{Subcommand and alias facility for command line programs with elegant help printing}
+    gem.email = "sentinel.1879@gmail.com"
+    gem.homepage = "http://github.com/rkumar/subcommand"
+    gem.authors = ["Rahul Kumar"]
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/TODO

@@ -0,0 +1 @@
+Add aliases

data/VERSION

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

data/lib/subcommand.rb

@@ -0,0 +1,209 @@
+#!/usr/bin/env ruby -w
+######################################
+# A tiny wrapper over optparse that gives easy subcommand facility.
+# It also neatly prints help for global and subcommands
+# as well as summarizes subcommands in global help.
+#
+# Thanks to Robert Klemme for his idea on lazy loading the subcommand option parsers.
+# 
+# @author Rahul Kumar, Jun  2010
+# @date 2010-06-20 22:33 
+#
+# @examples
+# if a program has subcommands foo and baz
+#
+# ruby opt.rb help
+# ruby opt.rb --help
+# ruby opt.rb help foo
+# ruby opt.rb foo --help
+# ruby opt.rb baz --quiet "some text"
+# ruby opt.rb --verbose foo --force file.zzz
+#
+# == STEPS 
+#    1. define global_options (optional)
+#
+#     global_options do |opts|
+#       opts.banner = "Usage: #{$0} [options] [subcommand [options]]"
+#       opts.description = "Stupid program that does something"
+#       opts.separator ""
+#       opts.separator "Global options are:"
+#       opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+#         options[:verbose] = v
+#       end
+#     end
+#
+#    2. define commands using command().
+#     command :foo do |opts|
+#       opts.banner = "Usage: foo [options]"
+#       opts.description = "desc for foo"
+#       opts.on("-f", "--[no-]force", "force verbosely") do |v|
+#         options[:force] = v
+#       end
+#     end
+#
+#    3. call opt_parse()
+#
+#    4. As before, handle ARGS and options hash.
+#
+# TODO: add aliases for commands
+######################################
+require 'optparse'
+
+# Allow command to have a description to generate help
+class OptionParser
+  attr_accessor :description
+  #attr_accessor :action
+end
+
+module Subcommands
+  ##
+  # specify a single command and all its options
+  # If multiple names are given, they are treated as aliases.
+  # Do repeatedly for each command
+  # Yields the optionparser
+  def command *names
+    #puts "inside command with #{names} "
+    name = names.shift
+    @commands ||= {}
+    @aliases ||= {}
+    if names.length > 0
+      names.each do |n| 
+        #puts "aliases #{n} => #{name} "
+        @aliases[n.to_s] = name.to_s
+      end
+    end
+    # Thanks to Robert Klemme for the lazy loading idea.
+    opt = lambda { OptionParser.new do |opts|
+      yield opts
+      # append desc to banner in next line
+      opts.banner << "\n#{opts.description}\n" if opts.description
+    end }
+    @commands[name.to_s] = opt
+  end
+  # specify global options and banner and description
+  # Yields the optionparser
+  def global_options
+    if !defined? @global
+      @global = OptionParser.new do |opts|
+        yield opts
+      end
+    else
+      yield @global
+    end
+  end
+  # first parse global optinos
+  # then parse subcommand options if valid subcommand
+  # special case of "help command" so we print help of command - git style (3)
+  # in all invalid cases print global help
+  def opt_parse
+    # if user has not defined global, we need to create it
+    if !defined? @global
+      global_options do |opts|
+        opts.banner = "Usage: #{$0} [options] [subcommand [options]]"
+        opts.separator ""
+        opts.separator "Global options are:"
+        opts.on("-h", "--help", "Print this help") do |v|
+          puts @global
+          exit
+        end
+        opts.separator ""
+        opts.separator subtext
+      end
+    else
+      # user has defined some, but lets add subcommand information
+      cmdtext = "Commands are:"
+      @commands.each_pair do |c, opt| 
+        desc = opt.call.description
+        cmdtext << "\n   #{c} : #{desc}"
+      end
+      
+      # print aliases
+      unless @aliases.empty?
+        cmdtext << "\n\nAliases: \n" 
+        @aliases.each_pair { |name, val| cmdtext << "   #{name} - #{val}"  }
+      end
+
+      cmdtext << "\n\nSee '#{$0} help COMMAND' for more information on a specific command."
+
+      global_options do |opts|
+        # lets add the description user gave into banner
+        opts.banner << "\n#{opts.description}\n" if opts.description
+        opts.separator ""
+        opts.separator cmdtext
+      end
+    end
+    @global.order!
+    cmd = ARGV.shift
+    if cmd
+      #puts "Command: #{cmd} "
+      sc = @commands[cmd] 
+      unless sc
+        # see if an alias exists
+        #puts "sc nil #{@aliases} "
+        alas = @aliases[cmd]
+        #puts "sc nil #{alas} "
+        sc = @commands[alas] if alas
+        #puts "sc nil #{sc} "
+      end
+      # if valid command parse the args
+      if sc
+        sc.call.order!
+      else
+        # else if help <command> then print its help GIT style (3)
+        if !ARGV.empty? and cmd == "help"
+          cmd = ARGV.shift
+          sc = @commands[cmd]
+          # if valid command print help, else print global help
+          if sc
+            #puts " 111 help foo/baz"
+            puts sc.call
+          else puts @global
+          end
+        else
+          # invalid command 
+          puts @global 
+        end
+        exit 0
+      end
+    end
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  include Subcommands
+  options = {}
+  appname = File.basename($0)
+  # global is optional
+  global_options do |opts|
+    opts.banner = "Usage: #{appname} [options] [subcommand [options]]"
+    opts.description = "Stupid program that does something"
+    opts.separator ""
+    opts.separator "Global options are:"
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      options[:verbose] = v
+    end
+  end
+  # define a command
+  command :foo, :goo do |opts|
+    opts.banner = "Usage: foo [options]"
+    opts.description = "desc for foo"
+    opts.on("-f", "--[no-]force", "force verbosely") do |v|
+      options[:force] = v
+    end
+  end
+  command :baz do |opts|
+    opts.banner = "Usage: baz [options]"
+    opts.description = "desc for baz"
+    opts.on("-q", "--[no-]quiet", "quietly run ") do |v|
+      options[:quiet] = v
+    end
+  end
+
+  # do the parsing.
+  opt_parse()
+
+  puts "options ......"
+  p options
+  puts "ARGV:"
+  p ARGV
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'subcommand'
+
+class Test::Unit::TestCase
+end

data/test/test_subcommand.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSubcommand < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: subcommand
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rahul Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-21 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Subcommand and alias facility for command line programs with elegant help printing
+email: sentinel.1879@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/subcommand.rb
+- test/helper.rb
+- test/test_subcommand.rb
+- TODO
+has_rdoc: true
+homepage: http://github.com/rkumar/subcommand
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A tiny wrapper over OptionParser giving simple, elegant subcommand facility
+test_files: 
+- test/helper.rb
+- test/test_subcommand.rb