benry-cmdopt 1.1.0 → 2.0.0

data/README.md

@@ -1,38 +1,52 @@
-Benry::Cmdopt README
-====================
+# Benry-CmdOpt
 
-($Release: 1.1.0 $)
+($Release: 2.0.0 $)
 
-Benry::Cmdopt is a command option parser library, like `optparse.rb`.
 
-Compared to `optparse.rb`, Benry::Cmdopt is easy to use, easy to extend,
+
+## Overview
+
+Benry-CmdOpt is a command option parser library, like `optparse.rb`
+(Ruby standard library).
+
+Compared to `optparse.rb`, Benry-CmdOpt is easy to use, easy to extend,
 and easy to understahnd.
 
-(Benry::Cmdopt requires Ruby >= 2.3)
+* Document: <https://kwatch.github.io/benry-ruby/benry-cmdopt.html>
+* GitHub: <https://github.com/kwatch/benry-ruby/tree/main/benry-cmdopt>
+* Changes: <https://github.com/kwatch/benry-ruby/tree/main/benry-cmdopt/CHANGES.md>
 
+Benry-CmdOpt requires Ruby >= 2.3.
 
-Why not `optparse.rb`?
-======================
 
-* Source code of `optparse.rb` is very large and complicated, because
-  `OptParse` class does everything about command option parsing.
-  It is hard to customize or extend `OptionParser` class.
 
-  On the other hand, `benry/cmdopt.rb` consists of several classes
-  (schema class, parser class, and facade class).
-  Therefore it is easy to understand and extend these classes.
+## Table of Contents
 
-  File `optparse.rb` contains 1234 lines (without comments), while
-  `benry/cmdopt.rb` (v1.1.0) contains only 361 lines (without comments).
+<!-- TOC -->
 
-* `optparse.rb` regards `-x` as a short cut of `--xxx` automatically
-  even if you have not defined `-x` option.
-  That is, short options which are not defined can be available unexpectedly.
-  This feature is hard-coded in `OptionParser#parse_in_order()`
-  and hard to be disabled.
+* [Overview](#overview)
+* [Why not `optparse.rb`?](#why-not-optparserb)
+* [Install](#install)
+* [Usage](#usage)
+  * [Define, Parse, and Print Help](#define-parse-and-print-help)
+  * [Command Option Parameter](#command-option-parameter)
+  * [Argument Validation](#argument-validation)
+  * [Boolean (on/off) Option](#boolean-onoff-option)
+  * [Alternative Value](#alternative-value)
+  * [Multiple Value Option](#multiple-value-option)
+  * [Hidden Option](#hidden-option)
+  * [Global Options with Sub-Commands](#global-options-with-sub-commands)
+  * [Detailed Description of Option](#detailed-description-of-option)
+  * [Option Tag](#option-tag)
+  * [Not Supported](#not-supported)
+* [Internal Classes](#internal-classes)
+* [License and Copyright](#license-and-copyright)
 
-  On the other hand, `benry/cmdopt.rb` doesn't behave this way.
-  `-x` option is available only when `-x` is defined.
+<!-- /TOC -->
+
+
+
+## Why not `optparse.rb`?
 
 * `optparse.rb` can handle both `--name=val` and `--name val` styles.
   The later style is ambiguous; you may wonder whether `--name` takes
@@ -44,39 +58,20 @@ Why not `optparse.rb`?
   `optparse.rb` cannot disable `--name val` style.
   `benry/cmdopt.rb` supports only `--name=val` style.
 
-* `optparse.rb` enforces you to catch `OptionParser::ParseError` exception.
-  That is, you must know error class name.
-
-  `benry/cmdopt.rb` provides error handler without exception class name.
-  You don't need to know error class name on error handling.
-
-```ruby
-### optparse.rb
-require 'optparse'
-parser = OptionParser.new
-parser.on('-f', '--file=<FILE>', "filename")
-opts = {}
-begin
-  parser.parse!(ARGV, into: opts)
-rescue OptionParser::ParseError => ex   # specify error class
-  $stderr.puts "ERROR: #{ex.message}"
-  exit 1
-end
+* `optparse.rb` regards `-x` and `--x` as a short cut of `--xxx` automatically
+  even if you have not defined `-x` option.
+  That is, short options which are not defined can be available unexpectedly.
+  This feature is hard-coded in `OptionParser#parse_in_order()`
+  and hard to be disabled.
 
-### benry/cmdopt.rb
-require 'benry/cmdopt'
-cmdopt = Benry::Cmdopt.new
-cmdopt.add(:file, '-f, --file=<FILE>', "filename")
-opts = cmdopt.parse(ARGV) do |err|  # error handling wihtout error class name
-  $stderr.puts "ERROR: #{err.message}"
-  exit 1
-end
-```
+  In contact, `benry/cmdopt.rb` doesn't behave this way.
+  `-x` option is available only when `-x` is defined.
+  `benry/cmdopt.rb` does nothing superfluous.
 
 * `optparse.rb` uses long option name as hash key automatically, but
-  it doesn't provide the way to specify hash key of short-only option.
+  it doesn't provide the way to specify hash key for short-only option.
 
-  `benry/cmdopt.rb` can specify hash key of short-only option.
+  `benry/cmdopt.rb` can specify hash key for short-only option.
 
 ```ruby
 ### optparse.rb
@@ -95,7 +90,7 @@ p opts  #=> {:q=>true}            # hash key is short option name
 
 ### benry/cmdopt.rb
 require 'benry/cmdopt'
-cmdopt = Benry::Cmdopt.new
+cmdopt = Benry::CmdOpt.new
 cmdopt.add(:verbose, '-v, --verbose', "verbose mode") # short and long
 cmdopt.add(:quiet  , '-q'           , "quiet mode")   # short-only
 #
@@ -106,12 +101,49 @@ opts = cmdopt.parse(['-q'])   # short option
 p opts  #=> {:quiet=>true}    # independent hash key of option name
 ```
 
+* `optparse.rb` provides severay ways to validate option values, such as
+  type class, Regexp as pattern, or Array/Set as enum. But it doesn't
+  accept Range object. This means that, for examle, it is not simple to
+  validate whether integer or float value is positive or not.
+
+  In contract, `benry/cmdopt.rb` accepts Range object so it is very simple
+  to validate whether integer or float value is positive or not.
+
+```ruby
+### optparse.rb
+parser = OptionParser.new
+parser.on('-n <N>', "number", Integer, (1..))  #=> NoMethodError
+
+### benry/cmdopt.rb
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+cmdopt.add(:number, "-n <N>", "number", type: Integer, range: (1..)) #=> ok
+```
+
+* `optparse.rb` accepts Array or Set object as enum values. But values
+  of enum should be a String in spite that type class specified.
+  This seems very strange and not intuitive.
+
+  `benry/cmdopt.rb` accepts integer values as enum when type class is Integer.
+
+```ruby
+### optparse.rb
+parser = OptionParser.new
+parser.on('-n <N>', "number", Integer, [1, 2, 3])      # wrong
+parser.on('-n <N>', "number", Integer, ['1','2','3'])  # ok (but not intuitive)
+
+### benry/cmdopt.rb
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+cmdopt.add(:number, "-n <N>", "number", type: Integer, enum: [1, 2, 3]) # very intuitive
+```
+
 * `optparse.rb` adds `-h` and `--help` options automatically, and
-  terminates current process when `-v` or `--version` specified in terminal.
+  terminates current process when `-h` or `--help` specified in command-line.
   It is hard to remove these options.
 
-  On the other hand, `benry/cmdopt.rb` does not add these options.
-  benry/cmdopt.rb` does nothing extra.
+  In contract, `benry/cmdopt.rb` does not add these options.
+  `benry/cmdopt.rb` does nothing superfluous.
 
 ```ruby
 require 'optparse'
@@ -127,9 +159,11 @@ puts 'xxx'   #<== not printed because current process alreay terminated
 * `optparse.rb` adds `-v` and `--version` options automatically, and
   terminates current process when `-v` or `--version` specified in terminal.
   It is hard to remove these options.
+  This behaviour is not desirable because `optparse.rb` is just a library,
+  not framework.
 
-  On the other hand, `benry/cmdopt.rb` does not add these options.
-  benry/cmdopt.rb` does nothing extra.
+  In contract, `benry/cmdopt.rb` does not add these options.
+  `benry/cmdopt.rb` does nothing superfluous.
 
 ```ruby
 require 'optparse'
@@ -146,6 +180,15 @@ puts 'xxx'   #<== not printed because current process alreay terminated
   contain `-h`, `--help`, `-v`, nor `--version`.
   These options are available but not shown in help message. Strange.
 
+* `optparse.rb` generate help message which contains command usage string
+  such as `Usage: <command> [options]`. `optparse.rb` should NOT include
+  it in help message because it is just a library, not framework.
+  If you want to change '[options]' to '[<options>]', you must manipulate
+  help message string by yourself.
+
+  `benry/cmdopt.rb` doesn't include extra text (such as usage text) into
+  help message. `benry/cmdopt.rb` does nothing superfluous.
+
 * `optparse.rb` generates help message with too wide option name
   by default. You must specify proper width.
 
@@ -156,7 +199,7 @@ puts 'xxx'   #<== not printed because current process alreay terminated
 ### optparse.rb
 require 'optparse'
 banner = "Usage: blabla <options>"
-parser = OptionParser.new(banner)  # or OptionParser.new(banner, 25)
+parser = OptionParser.new(banner)  # or: OptionParser.new(banner, 25)
 parser.on('-f', '--file=<FILE>', "filename")
 parser.on('-m <MODE>'          , "verbose/quiet")
 puts parser.help
@@ -167,30 +210,77 @@ puts parser.help
 
 ### benry/cmdopt.rb
 require 'benry/cmdopt'
-cmdopt = Benry::Cmdopt.new()
+cmdopt = Benry::CmdOpt.new()
 cmdopt.add(:file, '-f, --file=<FILE>', "filename")
 cmdopt.add(:mode, '-m <MODE>'        , "verbose/quiet")
-puts "Usage: blabla <options>"
-puts cmdopt.option_help()
+puts "Usage: blabla [<options>]"
+puts cmdopt.to_s()
 ### output (calculated proper width)
-# Usage: blabla <options>
+# Usage: blabla [<options>]
 #   -f, --file=<FILE>    : filename
 #   -m <MODE>            : verbose/quiet
 ```
 
+* `optparse.rb` enforces you to catch `OptionParser::ParseError` exception.
+  That is, you must know the error class name.
+
+  `benry/cmdopt.rb` provides error handler without exception class name.
+  You don't need to know the error class name on error handling.
+
+```ruby
+### optparse.rb
+require 'optparse'
+parser = OptionParser.new
+parser.on('-f', '--file=<FILE>', "filename")
+opts = {}
+begin
+  parser.parse!(ARGV, into: opts)
+rescue OptionParser::ParseError => err   # specify error class
+  $stderr.puts "ERROR: #{err.message}"
+  exit 1
+end
+
+### benry/cmdopt.rb
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+cmdopt.add(:file, '-f, --file=<FILE>', "filename")
+opts = cmdopt.parse(ARGV) do |err|  # error handling wihtout error class name
+  $stderr.puts "ERROR: #{err.message}"
+  exit 1
+end
+```
+
+* Source code of `optparse.rb` is very large and complicated, because
+  `OptParse` class does everything about command option parsing.
+  It is hard to customize or extend `OptionParser` class.
+
+  In contract, `benry/cmdopt.rb` consists of several classes
+  (schema class, parser class, and facade class).
+  Therefore it is easy to understand and extend these classes.
+
+  File `optparse.rb` (in Ruby 3.2) contains 1143 lines (except comments and blanks),
+  while `benry/cmdopt.rb` (v2.0) contains 427 lines (except both, too).
+
+
+
+## Install
+
+```
+$ gem install benry-cmdopt
+```
+
 
-Usage
-=====
 
+## Usage
 
-Define, parse, and print help
------------------------------
+
+### Define, Parse, and Print Help
 
 ```ruby
 require 'benry/cmdopt'
 
 ## define
-cmdopt = Benry::Cmdopt.new
+cmdopt = Benry::CmdOpt.new
 cmdopt.add(:help   , '-h, --help'   , "print help message")
 cmdopt.add(:version, '    --version', "print version")
 
@@ -207,116 +297,349 @@ if options[:help]
   puts "Usage: foobar [<options>] [<args>...]"
   puts ""
   puts "Options:"
-  puts cmdopt.option_help()
-  ## or
+  puts cmdopt.to_s()
+  ## or: puts cmdopt.to_s(20)              # width
+  ## or: puts cmdopt.to_s("  %-20s : %s")  # format
+  ## or:
   #format = "  %-20s : %s"
-  #cmdopt.each_option_help {|opt, help| puts format % [opt, help] }
+  #cmdopt.each_option_and_desc {|opt, help| puts format % [opt, help] }
 end
 ```
 
+You can set `nil` to option name only if long option specified.
+
+```ruby
+## both are same
+cmdopt.add(:help, "-h, --help", "print help message")
+cmdopt.add(nil  , "-h, --help", "print help message")
+```
+
 
-Command option parameter
-------------------------
+### Command Option Parameter
 
 ```ruby
 ## required parameter
-cmdopt.add(:file, '-f, --file=<FILE>', "filename")
-cmdopt.add(:file, '    --file=<FILE>', "filename")
-cmdopt.add(:file, '-f <FILE>'        , "filename")
+cmdopt.add(:file, '-f, --file=<FILE>', "filename")   # short & long
+cmdopt.add(:file, '    --file=<FILE>', "filename")   # long only
+cmdopt.add(:file, '-f <FILE>'        , "filename")   # short only
 
 ## optional parameter
-cmdopt.add(:file, '-f, --file[=<FILE>]', "filename")
-cmdopt.add(:file, '    --file[=<FILE>]', "filename")
-cmdopt.add(:file, '-f[<FILE>]'         , "filename")
+cmdopt.add(:indent, '-i, --indent[=<N>]', "indent width")  # short & long
+cmdopt.add(:indent, '    --indent[=<N>]', "indent width")  # long only
+cmdopt.add(:indent, '-i[<N>]'           , "indent width")  # short only
 ```
 
-Notice that `"--file <FILE>"` style is not supported.
-Please use `"--file=<FILE>"` style.
+Notice that `"--file <FILE>"` style is **not supported for usability reason**.
+Use `"--file=<FILE>"` style instead.
 
+(From a usability perspective, the former style should not be supported.
+ `optparse.rb` is wrong because it supports both styles
+ and doesn't provide the way to disable the former style.)
 
-Argument varidation
--------------------
+
+### Argument Validation
 
 ```ruby
-## type
+## type (class)
 cmdopt.add(:indent , '-i <N>', "indent width", type: Integer)
-## pattern
-cmdopt.add(:indent , '-i <N>', "indent width", pattern: /\A\d+\z/)
-## enum
-cmdopt.add(:indent , '-i <N>', "indent width", enum: [2, 4, 8])
+## pattern (regular expression)
+cmdopt.add(:indent , '-i <N>', "indent width", rexp: /\A\d+\z/)
+## enum (Array or Set)
+cmdopt.add(:indent , '-i <N>', "indent width", enum: ["2", "4", "8"])
+## range (endless range such as ``1..`` available)
+cmdopt.add(:indent , '-i <N>', "indent width", range: (0..8))
 ## callback
 cmdopt.add(:indent , '-i <N>', "indent width") {|val|
   val =~ /\A\d+\z/  or
-    raise "integer expected."  # raise without exception class.
+    raise "Integer expected."  # raise without exception class.
   val.to_i                     # convert argument value.
 }
 ```
 
+(For backward compatibilidy, keyword parameter `pattern:` is available
+ which is same as `rexp:`.)
 
-Available types
----------------
+`type:` keyword argument accepts the following classes.
 
 * Integer   (`/\A[-+]?\d+\z/`)
 * Float     (`/\A[-+]?(\d+\.\d*\|\.\d+)z/`)
 * TrueClass (`/\A(true|on|yes|false|off|no)\z/`)
 * Date      (`/\A\d\d\d\d-\d\d?-\d\d?\z/`)
 
+Notice that Ruby doesn't have Boolean class.
+Benry-CmdOpt uses TrueClass instead.
+
+In addition:
+
+* Values of `enum:` or `range:` should match to type class specified by `type:`.
+* When `type:` is not specified, then String class will be used instead.
+
+```ruby
+## ok
+cmdopt.add(:lang, '-l <lang>', "language", enum: ["en", "fr", "it"])
+
+## error: enum values are not Integer
+cmdopt.add(:lang, '-l <lang>', "language", enum: ["en", "fr", "it"], type: Integer)
+
+## ok
+cmdopt.add(:indent, '-i <N>', "indent", range: (0..), type: Integer)
+
+## error: beginning value of range is not a String
+cmdopt.add(:indent, '-i <N>', "indent", range: (0..))
+```
+
+
+### Boolean (on/off) Option
+
+Benry-CmdOpt doens't support `--no-xxx` style option for usability reason.
+Use boolean option instead.
 
-Multiple parameters
--------------------
+ex3.rb:
 
 ```ruby
-cmdopt.add(:lib , '-I <NAME>', "library name") {|optdict, key, val|
-  arr = optdict[key] || []
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new()
+cmdopt.add(:foo, "--foo[=on|off]", "foo feature", type: TrueClass)  # !!!!
+## or:
+#cmdopt.add(:foo, "--foo=<on|off>", "foo feature", type: TrueClass)
+options = cmdopt.parse(ARGV)
+p options
+```
+
+Output example:
+
+```terminal
+$ ruby ex3.rb --foo           # enable
+{:foo=>true}
+$ ruby ex3.rb --foo=on        # enable
+{:foo=>true}
+$ ruby ex3.rb --foo=off       # disable
+{:foo=>false}
+```
+
+
+### Alternative Value
+
+Benry-CmdOpt supports alternative value.
+
+```ruby
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+cmdopt.add(:help1, "-h", "help")
+cmdopt.add(:help2, "-H", "help", value: "HELP")   # !!!!!
+
+options = cmdopt.parse(["-h", "-H"])
+p options[:help1]   #=> true          # normal
+p options[:help2]   #=> "HELP"        # alternative value
+```
+
+This is useful for boolean option.
+
+```ruby
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+cmdopt.add(:flag1, "--flag1[=<on|off>]", "f1", type: TrueClass)
+cmdopt.add(:flag2, "--flag2[=<on|off>]", "f2", type: TrueClass, value: false)  # !!!!
+
+## when `--flag2` specified, got `false` value.
+options = cmdopt.parse(["--flag1", "--flag2"])
+p options[:flag1]   #=> true
+p options[:flag2]   #=> false (!!!!!)
+```
+
+
+### Multiple Value Option
+
+```ruby
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+
+cmdopt.add(:lib , '-I <NAME>', "library name") {|options, key, val|
+  arr = options[key] || []
   arr << val
   arr
+  ## or:
+  #(options[key] || []) << val
 }
+
+options = cmdopt.parse(["-I", "foo", "-I", "bar", "-Ibaz"])
+p options   #=> {:lib=>["foo", "bar", "baz"]}
 ```
 
 
-Hidden option
--------------
+### Hidden Option
 
-If help string of command otpion is nil, it will not included
-in help message.
+Benry-CmdOpt regards the following options as hidden.
+
+* Key name starts with `_` (for example `:_debug`).
+* Or description is nil.
+
+The former is better than the latter, because even hidden option should have its own description.
+
+These hidden options are not included in help message.
 
 ```ruby
 require 'benry/cmdopt'
-cmdopt = Benry::Cmdopt.new
-cmdopt.add(:verbose, '-v, --verbose', "verbose mode")
-cmdopt.add(:debug  , '-d[<LEVEL>]'  , nil, type: Integer) # hidden
-puts cmdopt.option_help()
-### output ('-d' is not included)
-#  -v, --verbose        : verbose mode
+cmdopt = Benry::CmdOpt.new
+cmdopt.add(:help , '-h', "help message")
+cmdopt.add(:debug, '-D', nil)       # hidden (because description is nil)
+cmdopt.add(:_log , '-L', "logging") # hidden (because key starts with '_')
+puts cmdopt.to_s()
+
+### output (neither '-D' nor '-L' is shown because hidden options)
+#  -h             : help message
 ```
 
+To show all options including hidden ones, add `all: true` to `cmdopt.to_s()`.
+
+```ruby
+...(snip)...
+puts cmdopt.to_s(all: true)   # or: cmdopt.to_s(nil, all: true)
+
+### output
+#  -h             : help message
+#  -D             :
+#  -L             : logging
+```
+
+
+### Global Options with Sub-Commands
+
+`parse()` accepts boolean keyword argument `all`.
+
+* `parse(argv, all: true)` parses even options placed after arguments. This is the default.
+* `parse(argv, all: false)` only parses options placed before arguments.
+
+```ruby
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new()
+cmdopt.add(:help   , '--help'   , "print help message")
+cmdopt.add(:version, '--version', "print version")
+
+## `parse(argv, all: true)` (default)
+argv = ["--help", "arg1", "--version", "arg2"]
+options = cmdopt.parse(argv, all: true)          # !!!
+p options       #=> {:help=>true, :version=>true}
+p argv          #=> ["arg1", "arg2"]
+
+## `parse(argv, all: false)`
+argv = ["--help", "arg1", "--version", "arg2"]
+options = cmdopt.parse(argv, all: false)         # !!!
+p options       #=> {:help=>true}
+p argv          #=> ["arg1", "--version", "arg2"]
+```
+
+This is useful when parsing global options of sub-commands, like Git command.
+
+```ruby
+require 'benry/cmdopt'
+
+argv = ["-h", "commit", "xxx", "-m", "yyy"]
+
+## parse global options
+cmdopt = Benry::CmdOpt.new()
+cmdopt.add(:help, '-h', "print help message")
+global_opts = cmdopt.parse(argv, all: false)   # !!!false!!!
+p global_opts       #=> {:help=>true}
+p argv              #=> ["commit", "xxx", "-m", "yyy"]
+
+## get sub-command
+sub_command = argv.shift()
+p sub_command       #=> "commit"
+p argv              #=> ["xxx", "-m", "yyy"]
+
+## parse sub-command options
+cmdopt = Benry::CmdOpt.new()
+case sub_command
+when "commit"
+  cmdopt.add(:message, '-m <message>', "commit message")
+else
+  # ...
+end
+sub_opts = cmdopt.parse(argv, all: true)       # !!!true!!!
+p sub_opts          #=> {:message => "yyy"}
+p argv              #=> ["xxx"]
+```
+
+
+### Detailed Description of Option
 
-Not supported
--------------
+`#add()` method in `Benry::CmdOpt` or `Benry::CmdOpt::Schema` supports `detail:` keyword argument which takes detailed description of option.
+
+```ruby
+require 'benry/cmdopt'
+
+cmdopt = Benry::CmdOpt.new()
+cmdopt.add(:mode, "-m, --mode=<MODE>", "output mode", detail: <<"END")
+  v, verbose: print many output
+  q, quiet:   print litte output
+  c, compact: print summary output
+END
+puts cmdopt.to_s()
+## or:
+#cmdopt.each_option_and_desc do |optstr, desc, detail|
+#  puts "  %-20s : %s\n" % [optstr, desc]
+#  puts detail.gsub(/^/, ' ' * 25) if detail
+#end
+```
+
+Output:
+
+```
+  -m, --mode=<MODE>    : output mode
+                           v, verbose: print many output
+                           q, quiet:   print litte output
+                           c, compact: print summary output
+```
+
+
+### Option Tag
+
+`#add()` method in `Benry::CmdOpt` or `Benry::CmdOpt::Schema` supports `tag:` keyword argument.
+You can use it for any purpose.
+
+```ruby
+require 'benry/cmdopt'
+
+cmdopt = Benry::CmdOpt.new()
+cmdopt.add(:help, "-h, --help", "help message", tag: "important")  # !!!
+cmdopt.add(:version, "--version", "print version", tag: nil)
+cmdopt.schema.each do |item|
+  puts "#{item.key}: tag=#{item.tag.inspect}"
+end
+
+## output:
+#help: tag="important"
+#version: tag=nil
+```
+
+
+### Not Supported
 
 * default value
 * `--no-xxx` style option
 * bash/zsh completion
+* I18N of error message (may be supported in the future)
 
 
-Internal classes
-================
 
-* `Benry::Cmdopt::Schema` -- command option schema.
-* `Benry::Cmdopt::Parser` -- command option parser.
-* `Benry::Cmdopt::Facade` -- facade object including schema and parser.
+## Internal Classes
+
+* `Benry::CmdOpt::Schema` ... command option schema.
+* `Benry::CmdOpt::Parser` ... command option parser.
+* `Benry::CmdOpt::Facade` ... facade object including schema and parser.
 
 ```ruby
 require 'benry/cmdopt'
 
 ## define schema
-schema = Benry::Cmdopt::Schema.new
+schema = Benry::CmdOpt::Schema.new
 schema.add(:help  , '-h, --help'            , "show help message")
 schema.add(:file  , '-f, --file=<FILE>'     , "filename")
 schema.add(:indent, '-i, --indent[=<WIDTH>]', "enable indent", type: Integer)
 
 ## parse options
-parser = Benry::Cmdopt::Parser.new(schema)
+parser = Benry::CmdOpt::Parser.new(schema)
 argv = ['-hi2', '--file=blabla.txt', 'aaa', 'bbb']
 opts = parser.parse(argv) do |err|
   $stderr.puts "ERROR: #{err.message}"
@@ -326,20 +649,23 @@ p opts   #=> {:help=>true, :indent=>2, :file=>"blabla.txt"}
 p argv   #=> ["aaa", "bbb"]
 ```
 
-Notice that `Benry::Cmdopt.new()` returns facade object.
+Notice that `Benry::CmdOpt.new()` returns a facade object.
 
 ```ruby
 require 'benry/cmdopt'
 
-cmdopt = Benry::Cmdopt.new()             # new facade object
+cmdopt = Benry::CmdOpt.new()             # new facade object
 cmdopt.add(:help, '-h', "help message")  # same as schema.add(...)
 opts = cmdopt.parse(ARGV)                # same as parser.parse(...)
 ```
 
+Notice that `cmdopt.is_a?(Benry::CmdOpt)` results in false.
+Use `cmdopt.is_a?(Benry::CmdOpt::Facade)` instead if necessary.
+
+
 
-License and Copyright
-=====================
+## License and Copyright
 
 $License: MIT License $
 
-$Copyright: copyright(c) 2021 kuwata-lab.com all rights reserved $
+$Copyright: copyright(c) 2021 kwatch@gmail.com $