subcommand-optparse 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33646b64e094a13d9df10e21dd7efec280b109f8
-  data.tar.gz: f9f9c33ecadc11ecd51de2d8750963e35f518cec
+  metadata.gz: 634e18a8f111dd35ab12a98897abb16db057d351
+  data.tar.gz: 63beca167bd690d821b878f3265f6e1f876b62ca
 SHA512:
-  metadata.gz: 8c36a320be9f2f72c1d71766aaf0762e1b58ecd0bf016bb3e588617637dcf2df14c0ae91e8beb310b4f1c055aa0fa84002962278017d1036a1ae905d55d076ae
-  data.tar.gz: f2e289deb6723de5d741fe9ea8136c054d79b8be4ba7973b042d20861c0475e15e3110e5a7454ba9cc2e26a3f071fe40a5299b7825cd53df3319be3495939106
+  metadata.gz: aed83c4d4aa0a5abad231e614c7c41e66827353695d19faa91dc3d771635c480330cdd2720a068920f205796091e62518278cc5db90e2efddc874e5133a01179
+  data.tar.gz: cf9879e2f5d5fc11b900ffd169b14d12937950fb23dfea2feda4796c483c8a9f3537addec92d7ce97545681fbaf130f535a7e127ff03031a5a5bc5cacd414b7d

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,4 +1,4 @@
-# Subcommand::Optparse
+# subcommand-optparse
 
 Option parser for a command with subcommands, which is parsed by library 'optparse'
 
@@ -18,7 +18,11 @@ Or install it yourself as:
 
 ## Usage
 
-Please see the files in the directory 'examples'
+For now, please see the files in the directory 'examples' and source codes.
+
+## License
+
+GPLv3
 
 ## Contributing
 

data/examples/sample_command.rb

@@ -4,18 +4,22 @@ require "subcommand_optparse"
 options = {}
 
 parser = SubCmdOptParser.new(:help_command => true) do |sc|
+  sc.program_name = "sample_command.rb"
+  sc.version = "0.0.1"
+  sc.release = "hello world"
+
   sc.global_option do |opt|
     opt.on("--global-option", "Banner of global option") do |v|
       options[:global_option] = true
     end
   end
-  sc.subcommand("foo", "Banner of foo") do |opt|
+  sc.subcommand("foo", "Description of foo") do |opt|
     opt.on("--foo-option", "Foo option") do |v|
       options[:foo] = true
     end
   end
   sc.subcommand("bar") do |opt|
-    opt.on("--bar-option", "Bar option") do |v|
+    opt.on("--bar-option", "Description of bar") do |v|
       options[:bar] = true
     end
   end

data/lib/subcommand_optparse/version.rb

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

data/lib/subcommand_optparse.rb

@@ -5,31 +5,59 @@ require "active_support/core_ext/array/extract_options"
 class SubCmdOptParser
   class OptionParserForSubCmd < OptionParser
     attr_accessor :subcommand_name
+    attr_accessor :description
+
+    def initialize(subcmd, description, width, indent)
+      @subcommand_name = subcmd
+      @description = description
+      super(nil, width, indent)
+    end
 
     def banner
       unless @banner
         @banner = "Usage: #{program_name} #{@subcommand_name || '<command>'} [options]"
+        if @description
+          @banner << "\n\n#{@description}"
+        end
         visit(:add_banner, @banner)
       end
       @banner
     end
   end
 
-  # @overload initialize(banner = nil, width = 32, indent = ' ' * 4, opts = {})
-  #  @param [String,nil] banner An argument of OptionParser
-  #  @param [Fixnum] width An argument of OptionParser
-  #  @param [String] indent An argument of OptionParser
+  attr_accessor :program_name
+  attr_accessor :summary_width
+  attr_accessor :summary_indent
+  attr_accessor :version
+  attr_accessor :release
+  alias set_program_name program_name=
+  alias set_summary_width summary_width=
+  alias set_summary_indent summary_indent=
+
+  # @overload initialize(width = 32, indent = ' ' * 4, opts = {})
+  #  @param [Fixnum] width Width of summary
+  #  @param [String] indent Indent of summary
   #  @param [Hash] opts Options hash
-  #  @option opts [boolean] :help_command If the value is false then subcommand help is not set automatically
+  #  @option opts [boolean] :help_command
+  #      If the value is false then command "help" is not set automatically. Default is true
+  #  @option opts [boolean] :version_command
+  #      If the value is false then command "version" is not set automatically. Default is true
+  #  @option opts [boolean] :accept_undefined_command
+  #      If the value is false then show help for undefined commands. Default is false
+  #  @option opts [boolean] :parse_only
+  #      Commands (help and version) do not exit with printing messages and just parse options
   #  @yield [sc]
   #  @yieldparam [SubCmdOptParser] sc Option parser
   def initialize(*args, &block)
     opts = args.extract_options!
-    @default_banner = args.shift
-    @args_option_parser = args
+    @summary_width = args[0] || 32
+    @summary_indent = args[1] ||  ' ' * 4
     @global_option_setting = nil
     @subcommand = []
     @help_subcommand_use_p = (!opts.has_key?(:help_command) || opts[:help_command])
+    @version_subcommand_use_p = (!opts.has_key?(:version_command) || opts[:version_command])
+    @accept_undefined_command = opts[:accept_undefined_command]
+    @parse_only = opts[:parse_only]
     if block_given?
       yield(self)
     end
@@ -42,24 +70,36 @@ class SubCmdOptParser
     @global_option_setting = block
   end
 
-  # @overload subcommand(name, banner = nil, opts = {})
+  def subcommand_defined?(subcmd)
+    !!@subcommand.assoc(subcmd)
+  end
+
+  # @overload subcommand(name, description = nil, opts = {})
   #  @param [String] name Name of subcommand
+  #  @param [String] description Description of subcommand whose first line is shows in list of subcommands
   #  @param [Hash] opts Options hash
   #  @option opts [boolean] :load_global_options If the value is false then global options are not loaded
   #  @yield [opt]
   #  @yieldparam [OptionParserForSubCmd] opt Option parser for the subcommand
   def subcommand(name, *args, &block)
+    if subcommand_defined?(name)
+      raise ArgumentError, "Command '#{name}' has been already defined"
+    end
     opts = args.extract_options!
-    banner = args.shift
-    h = { :banner => banner, :setting => block }
+    description = args.shift
+    if args.size > 0
+      raise ArgumentError, "Too many arguments"
+    end
+    h = { :description => description, :setting => block }
     h[:load_global_options] = !(opts.has_key?(:load_global_options) && !opts[:load_global_options])
     @subcommand << [name, h]
   end
 
-  def get_banner(subcmd_data)
-    (subcmd_data && subcmd_data[:banner]) || @default_banner
+  def subcommand_clear(name)
+    @subcommand.delete_if do |subcmd, data|
+      subcmd == name
+    end
   end
-  private :get_banner
 
   def get_subcmd_data(subcmd)
     subcmd_data = nil
@@ -71,11 +111,12 @@ class SubCmdOptParser
   private :get_subcmd_data
 
   def get_option_parser(subcmd, subcmd_data)
-    opt = OptionParserForSubCmd.new(get_banner(subcmd_data), *@args_option_parser)
-    opt.subcommand_name = subcmd
-    if subcmd_data && subcmd_data[:setting]
-      subcmd_data[:setting].call(opt)
-    end
+    desc = subcmd_data && subcmd_data[:description]
+    opt = OptionParserForSubCmd.new(subcmd, desc, @summary_width, @summary_indent)
+    opt.program_name = program_name if @program_name
+    opt.version = version if @version
+    opt.release = release if @release
+    subcmd_data[:setting].call(opt) if subcmd_data && subcmd_data[:setting]
     if @global_option_setting && (!subcmd_data || subcmd_data[:load_global_options])
       @global_option_setting.call(opt)
     end
@@ -83,35 +124,80 @@ class SubCmdOptParser
   end
   private :get_option_parser
 
-  def message_list_subcommands(opt)
-    mes = "Subcommands of #{opt.program_name}:\n"
+  def message_list_subcommands
+    mes = "Commands are:\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|
-      mes << "    " << name << "\n"
+      desc = ((val && val[:description]) ? val[:description].each_line.first.strip : "")
+      mes << ("    %-#{str_size}s" % name) << desc << "\n"
     end
     mes
   end
   private :message_list_subcommands
 
-  def parse!(argv = ARGV)
+  def get_banner_help(opt)
+    "Usage: #{opt.program_name} <command> [options]\n\n" + message_list_subcommands
+  end
+  private :get_banner_help
+
+  def define_prepared_command
     if @help_subcommand_use_p
-      subcommand("help", :load_global_options => false)
+      unless subcommand_defined?("help")
+        subcommand("help", "Show help message", :load_global_options => false) do |opt|
+          opt.banner = get_banner_help(opt)
+        end
+      end
     end
+    if @version_subcommand_use_p
+      unless subcommand_defined?("version")
+        subcommand("version", "Show version", :load_global_options => false)
+      end
+    end
+  end
+  private :define_prepared_command
+
+  def exec_prepared_command(opt, argv)
+    unless @parse_only
+      case opt.subcommand_name
+      when "help"
+        if !argv.empty?
+          if !subcommand_defined?(argv[0])
+            puts "Unknown command: #{argv[0].inspect}"
+          else
+            opt = get_option_parser(argv[0], get_subcmd_data(argv[0]))
+          end
+        end
+        print opt.to_s
+        return true
+      when "version"
+        puts opt.ver || "Unknown version"
+        return true
+      end
+    end
+    nil
+  end
+  private :exec_prepared_command
 
+  def parse!(argv = ARGV)
+    define_prepared_command
     subcmd = argv[0]
     if subcmd_data = get_subcmd_data(subcmd)
       argv.shift
     else
       subcmd = nil
+      unless @accept_undefined_command
+        subcmd = "help"
+        unless subcmd_data = get_subcmd_data(subcmd)
+          raise "Unknown command #{subcmd.inspect}"
+        end
+      end
     end
     opt = get_option_parser(subcmd, subcmd_data)
-    opt.parse!(argv)
-
-    if @help_subcommand_use_p && subcmd == "help"
-      print opt.to_s + "\n"
-      puts message_list_subcommands(opt)
-      exit
+    if exec_prepared_command(opt, argv)
+      exit(0)
     end
-
+    opt.parse!(argv)
     subcmd
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH << File.expand_path(File.join(__dir__, "../lib"))
+
+require "subcommand_optparse"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus => true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/subcommand_optparse_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe SubCmdOptParser do
+  it "should raise error" do
+    opt = SubCmdOptParser.new do |opt_subcmd|
+      opt_subcmd.subcommand("hello")
+      expect do
+        opt_subcmd.subcommand("hello")
+      end.to raise_error
+    end
+  end
+
+  context "when executing prepared commands" do
+    before(:each) do
+      $stdout = StringIO.new
+    end
+
+    it "should exit in help command" do
+      opt = SubCmdOptParser.new
+      expect do
+        opt.parse!(["help"])
+      end.to raise_error(SystemExit)
+    end
+
+    it "should exit in version command" do
+      opt = SubCmdOptParser.new
+      expect do
+        opt.parse!(["version"])
+      end.to raise_error(SystemExit)
+    end
+
+    it "should not exit in help command" do
+      opt = SubCmdOptParser.new(:parse_only => true)
+      expect do
+        opt.parse!(["help"])
+      end.not_to raise_error
+    end
+
+    it "should not exit in version command" do
+      opt = SubCmdOptParser.new(:parse_only => true)
+      expect do
+        opt.parse!(["version"])
+      end.not_to raise_error
+    end
+
+    after(:each) do
+      $stdout = STDOUT
+    end
+  end
+end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: subcommand-optparse
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Takayuki YAMAGUCHI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Option parser for subcommands
@@ -87,7 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -95,6 +96,8 @@ files:
 - examples/sample_command.rb
 - lib/subcommand_optparse.rb
 - lib/subcommand_optparse/version.rb
+- spec/spec_helper.rb
+- spec/subcommand_optparse_spec.rb
 - subcommand-optparse.gemspec
 homepage: ''
 licenses:
@@ -106,20 +109,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Option parser for a command with subcommands, which is parsed by library
   'optparse'
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/subcommand_optparse_spec.rb
 has_rdoc: