subcommand 1.0.6 → 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2dd79eb88dc954b9ba2cae70a841e3fd51072f3caa93b92a5aac8649b595f4df
+  data.tar.gz: 7cb7704fe0cf5602db2f9bb1281dce48d95fadb46b018312dc36d79bb2a362a2
+SHA512:
+  metadata.gz: 9aef53319c4814a566ded8ab4ccbfe21cb4e5cf544f76fde3c917cfbc465933c33731a677f046ab23113334ee1e8f4578c2b8d6e4ac8cd1b20fdac521accfebd
+  data.tar.gz: 0a43b94bbe4049db9ddc97df7cf833ee6018cfaa369c6cf1656ce81fa47d7849116d96503024a561bd0d0d24f353054bfb797360beb0274df424f037e9d849c5

data/CHANGELOG.rdoc

@@ -1,9 +1,12 @@
+= subcommand 1.0.6 2011-10-6 
+* added list_actions to facilitate dynamic custom completion using compctl etc
+
 = subcommand 1.0.4 2010-06-24 15:51 
 * text for subcommands was being processed always before execution, so the
 point of lazy loading was lost. I've moved it away so it's only processed if
 actually printing help.
 
-Howeve, this means that if you are relying on OptionParser's implicit --help,
+However, this means that if you are relying on OptionParser's implicit --help,
 that won't print subcommands. So i've added a method add_help_option which
 adds a correct help option, to print subcommands. This way, command help and
 command --help print identical output.

data/README.rdoc

@@ -1,7 +1,7 @@
-
 = 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.
 
 Options parsers are lazy-loaded thanks to a suggestion and sample code by Robert Klemme on ruby-forum.org.
@@ -38,7 +38,7 @@ Assuming a program "prog" with subcommands "del" and "add"
      ruby subcommand.rb baz --quiet "some text"
      ruby subcommand.rb --verbose foo --force file.zzz
 
-== STEPS 
+== STEPS
 
     1. define global_options (optional)
 
@@ -72,6 +72,25 @@ Assuming a program "prog" with subcommands "del" and "add"
 
     selected_command_name = opt_parse()
 
+== Custom Completion
+   The command list_actions can be called from your application, so that the user
+   can have custom completion.
+
+    opts.on("--list-actions", "list actions for autocompletion ") do |v|
+      Subcommands::list_actions
+      exit 0
+    end
+
+  Now we can place something like this in a configuration file. Here's what i placed
+  in .zshrc for bugzyrb.
+
+    _bugzyrb() {
+            reply=(`bugzyrb --list-actions`)
+        }
+    compctl -K _bugzyrb bugzyrb
+
+  Now, on the command line when I type "bugzyrb <TAB>" the actions are prompted in a menu.
+
 == Sample Output
 
     $ ruby subcommand.rb help
@@ -86,7 +105,7 @@ Assuming a program "prog" with subcommands "del" and "add"
        foo : desc for foo
        baz : desc for baz
 
-    Aliases: 
+    Aliases:
        goo - foo
 
     See 'subcommand.rb help COMMAND' for more information on a specific command.
@@ -117,16 +136,11 @@ You should have no errors. The test cases are in the **tests** folder.
 
 http://subcommand.rubyforge.org/doc/
 
-== 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.
+Copyright (c) 2010-2019 Rahul Kumar. See LICENSE for details.
+
+== Others
+
+This simple gem is still working fine. No need for a new release.
+Working with ruby 1.9 through 2.6.

data/Rakefile

@@ -1,54 +1,2 @@
-require 'rubygems'
-require 'rake'
+require "bundler/gem_tasks"
 
-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 (wrapping OptionParser) 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.rubyforge_project = "subcommand"
-    #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/lib/subcommand.rb

@@ -5,9 +5,9 @@
 # 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 
+# @date 2010-06-20 22:33
 #
 # @examples
 # if a program has subcommands foo and baz
@@ -19,7 +19,7 @@
 # ruby subcommand.rb baz --quiet "some text"
 # ruby subcommand.rb --verbose foo --force file.zzz
 #
-# == STEPS 
+# == STEPS
 #    1. define global_options (optional)
 #
 #     global_options do |opts|
@@ -66,7 +66,7 @@ module Subcommands
     @commands ||= {}
     @aliases ||= {}
     if names.length > 0
-      names.each do |n| 
+      names.each do |n|
         #puts "aliases #{n} => #{name} "
         @aliases[n.to_s] = name.to_s
       end
@@ -91,6 +91,7 @@ module Subcommands
     end
   end
 
+
   # Added so applications can print out a bare listing of top level commands
   #  for dynamic custom completion.
   def list_actions
@@ -100,7 +101,7 @@ module Subcommands
 
   def print_actions
     cmdtext = "Commands are:"
-    @commands.each_pair do |c, opt| 
+    @commands.each_pair do |c, opt|
       #puts "inside opt.call loop"
       desc = opt.call.description
       cmdtext << "\n   #{c} : #{desc}"
@@ -108,7 +109,7 @@ module Subcommands
 
     # print aliases
     unless @aliases.empty?
-      cmdtext << "\n\nAliases: \n" 
+      cmdtext << "\n\nAliases: \n"
       @aliases.each_pair { |name, val| cmdtext << "   #{name} - #{val}\n"  }
     end
 
@@ -134,12 +135,17 @@ module Subcommands
   def add_help_option
     global_options do |opts|
       opts.on("-h", "--help", "Print this help") do |v|
-        add_subcommand_help
-        puts @global
+        print_help
         exit
       end
     end
   end
+
+  def print_help
+    add_subcommand_help
+    puts @global
+  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)
@@ -154,8 +160,7 @@ module Subcommands
         opts.separator ""
         opts.separator "Global options are:"
         opts.on("-h", "--help", "Print this help") do |v|
-          add_subcommand_help
-          puts @global
+          print_help
           exit
         end
         opts.separator ""
@@ -167,7 +172,7 @@ module Subcommands
     cmd = ARGV.shift
     if cmd
       #$stderr.puts "Command: #{cmd}, args:#{ARGV}, #{@commands.keys} "
-      sc = @commands[cmd] 
+      sc = @commands[cmd]
       #puts "sc: #{sc}: #{@commands}"
       unless sc
         # see if an alias exists
@@ -190,20 +195,22 @@ module Subcommands
           if sc
             #puts " 111 help #{cmd}"
             puts sc.call
-          else 
+          else
             # no help for this command XXX check for alias
             puts "Invalid command: #{cmd}."
-            add_subcommand_help
-            puts @global
+            print_help
           end
         else
-          # invalid command 
+          # invalid command
           puts "Invalid command: #{cmd}" unless cmd == "help"
-          add_subcommand_help
-          puts @global 
+          print_help
         end
         exit 0
       end
+    else
+      puts "Empty command!"
+      print_help
+      exit 1
     end
     return @command_name
   end

data/subcommand.gemspec

@@ -1,17 +1,14 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{subcommand}
-  s.version = "1.0.6"
+  s.name = 'subcommand'
+  s.version = '1.0.7'
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Rahul Kumar}]
   s.date = %q{2011-10-06}
   s.description = %q{Subcommand and alias facility (wrapping OptionParser) for command line programs with elegant help printing}
-  s.email = %q{sentinel.1879@gmail.com}
+  s.email = %q{oneness.univ@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc",
@@ -47,7 +44,6 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/rkumar/subcommand}
   s.require_paths = [%q{lib}]
   s.rubyforge_project = %q{subcommand}
-  s.rubygems_version = %q{1.8.8}
   s.summary = %q{A tiny wrapper over OptionParser giving simple, elegant subcommand facility}
 
   if s.respond_to? :specification_version then
@@ -62,4 +58,3 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
   end
 end
-

metadata

@@ -1,45 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: subcommand
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.6
+version: !ruby/object:Gem::Version
+  version: 1.0.7
 platform: ruby
-authors: 
+authors:
 - Rahul Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Subcommand and alias facility (wrapping OptionParser) for command line programs with elegant help printing
-email: sentinel.1879@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Subcommand and alias facility (wrapping OptionParser) for command line
+  programs with elegant help printing
+email: oneness.univ@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
 - TODO
-files: 
-- .document
+files:
+- ".document"
 - CHANGELOG.rdoc
 - LICENSE
 - Makefile
 - README.rdoc
 - Rakefile
+- TODO
 - VERSION
 - lib/subcommand.rb
 - subcommand.gemspec
@@ -59,33 +60,26 @@ files:
 - tests/test-lib.sh
 - tests/test.rb
 - tests/test1.rb
-- TODO
 homepage: http://github.com/rkumar/subcommand
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: subcommand
-rubygems_version: 1.8.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 3
 summary: A tiny wrapper over OptionParser giving simple, elegant subcommand facility
 test_files: []
-