subcommand-optparse 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 634e18a8f111dd35ab12a98897abb16db057d351
-  data.tar.gz: 63beca167bd690d821b878f3265f6e1f876b62ca
+  metadata.gz: d5254886d098c538ae00e28d7795c05c0b1e6f2c
+  data.tar.gz: 9cd2000a1319ee66fef314571ece3230405e8456
 SHA512:
-  metadata.gz: aed83c4d4aa0a5abad231e614c7c41e66827353695d19faa91dc3d771635c480330cdd2720a068920f205796091e62518278cc5db90e2efddc874e5133a01179
-  data.tar.gz: cf9879e2f5d5fc11b900ffd169b14d12937950fb23dfea2feda4796c483c8a9f3537addec92d7ce97545681fbaf130f535a7e127ff03031a5a5bc5cacd414b7d
+  metadata.gz: 9ff59e3a2b8fef696a11efd555b8b1faa88be6a54f0891621b3658d84edb1aba627719f8dbba649e1fb4325d6a6b5d4ea5ba6273093ca9f5e8feae5a5f57ac37
+  data.tar.gz: 61c811561c75a88e256fbca0c26bd5ea40668038dae9fa8975244bc1a828c8a144e8bee476c72fe50f5c1cd8da20b8494619b8a4346ce9600d052e2bdb8e9164

data/examples/sample_command.rb

@@ -7,6 +7,7 @@ parser = SubCmdOptParser.new(:help_command => true) do |sc|
   sc.program_name = "sample_command.rb"
   sc.version = "0.0.1"
   sc.release = "hello world"
+  sc.summary = "Sample program"
 
   sc.global_option do |opt|
     opt.on("--global-option", "Banner of global option") do |v|
@@ -19,6 +20,14 @@ parser = SubCmdOptParser.new(:help_command => true) do |sc|
     end
   end
   sc.subcommand("bar") do |opt|
+    opt.usage = <<USAGE
+sample_command.rb bar ARGS
+                  [--bar-option] args...
+USAGE
+    opt.example = <<EXAMPLE
+ruby sample_command.rb bar 100 200
+ruby sample_command.rb bar --bar-option
+EXAMPLE
     opt.on("--bar-option", "Description of bar") do |v|
       options[:bar] = true
     end

data/lib/subcommand_optparse.rb

@@ -6,25 +6,66 @@ class SubCmdOptParser
   class OptionParserForSubCmd < OptionParser
     attr_accessor :subcommand_name
     attr_accessor :description
+    attr_accessor :summary
+    attr_writer :usage
+    attr_writer :example
 
     def initialize(subcmd, description, width, indent)
       @subcommand_name = subcmd
       @description = description
+      @summary = nil
       super(nil, width, indent)
     end
 
+    def usage
+      usage_str = "Usage: "
+      if @usage
+        @usage.each_line.with_index do |line, ind|
+          usage_str << "       " if ind > 0
+          usage_str << line.sub(/\n?\z/, "\n")
+        end
+      else
+        usage_str << "#{program_name} #{@subcommand_name || '<command>'} [options]\n"
+      end
+      usage_str
+    end
+
     def banner
       unless @banner
-        @banner = "Usage: #{program_name} #{@subcommand_name || '<command>'} [options]"
-        if @description
-          @banner << "\n\n#{@description}"
+        @banner = usage
+        if @summary
+          @banner << "\n#{@summary.sub(/\n?\z/, "\n")}"
+        elsif @description
+          @banner << "\n#{@description.sub(/\n?\z/, "\n")}"
+        end
+        if @example
+          if @example.each_line.count == 1
+            @banner << "\nExample: #{@example.strip}"
+          else
+            @banner << "\nExamples:\n"
+            @example.each_line do |line|
+              @banner << "    #{line.sub(/\n?\z/, "\n")}"
+            end
+          end
         end
-        visit(:add_banner, @banner)
       end
       @banner
     end
+
+    def help
+      str_banner = "#{banner}".sub(/\n?\z/, "\n")
+      str_summary =  summarize("")
+      if str_summary.size > 0
+        str_banner << "\nOptions:\n"
+      end
+      str_banner + str_summary
+    end
+
+    alias_method :to_s, :help
   end
 
+  # summary is shows in help message
+  attr_accessor :summary
   attr_accessor :program_name
   attr_accessor :summary_width
   attr_accessor :summary_indent
@@ -55,6 +96,7 @@ class SubCmdOptParser
     @global_option_setting = nil
     @subcommand = []
     @help_subcommand_use_p = (!opts.has_key?(:help_command) || opts[:help_command])
+    @summary = nil
     @version_subcommand_use_p = (!opts.has_key?(:version_command) || opts[:version_command])
     @accept_undefined_command = opts[:accept_undefined_command]
     @parse_only = opts[:parse_only]
@@ -125,7 +167,7 @@ class SubCmdOptParser
   private :get_option_parser
 
   def message_list_subcommands
-    mes = "Commands are:\n"
+    mes = "Commands:\n"
     max_size_subcmd = (@subcommand.map { |name, val| name.size }).max
     str_size = (max_size_subcmd.even? ? max_size_subcmd : max_size_subcmd + 1) + 4
     @subcommand.each do |name, val|
@@ -137,7 +179,12 @@ class SubCmdOptParser
   private :message_list_subcommands
 
   def get_banner_help(opt)
-    "Usage: #{opt.program_name} <command> [options]\n\n" + message_list_subcommands
+    mes = "Usage: #{opt.program_name} <command> [options]\n\n"
+    if @summary
+      mes << @summary << "\n\n"
+    end
+    mes << message_list_subcommands
+    mes
   end
   private :get_banner_help
 

data/lib/subcommand_optparse/version.rb

@@ -1,3 +1,3 @@
 class SubCmdOptParser
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: subcommand-optparse
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Takayuki YAMAGUCHI