main 2.4.0 → 2.5.0

data/README

@@ -370,6 +370,47 @@ DOCS
   API section below
 
 HISTORY
+  2.5.0
+    - added 'examples', 'samples', and 'api' kewords to main dsl.  each
+      keyword takes a list of strings which will be included in the help
+      message
+        
+        Main {
+          examples "foobar example", "barfoo example"
+
+          samples <<-txt
+            do this
+
+            don't do that
+          txt
+
+          api %(
+            foobar string, hash
+
+            barfoo hash, string
+          ) 
+        }
+
+      results in a usage message with sections like
+
+      ...
+
+      EXAMPLES
+        foobar example
+        barfoo example
+
+      SAMPLES
+        do this
+
+        don't do that
+
+      API
+        foobar string, hash
+
+        barfoo hash, string
+
+      ...
+
   2.4.0
     - fixed bug where 'abort("message")' would print "message" twice on exit
       if running under a nested mode.

data/a.rb

@@ -3,6 +3,13 @@ require 'main'
 Main {
   option 'bar'
 
+  examples 'a', 'b'
+
+  api <<-txt
+    foobar
+    barfoo
+  txt
+
   mode 'foo' do
     option('bar'){ required }
 

data/lib/main.rb

@@ -2,7 +2,7 @@ module Main
 #
 # top level constants
 #
-  Main::VERSION = '2.3.0' unless
+  Main::VERSION = '2.5.0' unless
     defined? Main::VERSION
   def self.version() Main::VERSION end
 

data/lib/main/base.rb

@@ -175,6 +175,15 @@ module Main
           end
         modes.add klass
       end
+
+      %w[ examples samples api ].each do |chunkname|
+        module_eval <<-code
+          def #{ chunkname } *a, &b 
+            txt = b ? b.call : a.join("\\n")
+            usage['#{ chunkname }'] = txt
+          end
+        code
+      end
     end
     extend DSL
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: main
 version: !ruby/object:Gem::Version 
-  version: 2.4.0
+  version: 2.5.0
 date: 2007-11-02 00:00:00 -06:00
 summary: main
 require_paths: