benry-cmdopt 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9308d0182f3f4a17d45f3b7a1f212a4f5f2112f4084d725b2de05271a908bb1d
-  data.tar.gz: f9b8e9066b9857d2693382f03bcbeacdd040695287d426d8ef8c28cf242f1cd1
+  metadata.gz: cb625857a40a61b165810acf4ee25cb3c9db54ac6e2c9e14678206a1036817a5
+  data.tar.gz: a47a9b936e4d63ea088945498d9469af67855af74c39680ae909ef36a6292945
 SHA512:
-  metadata.gz: e231075a8a9fdd99a0379390ebc1fae07c812f8229d1689e0b7f04b91d5c0c596122835dde000c3ba609681898c3048fa51d08232cd33d4b9df0bacbc22036c6
-  data.tar.gz: bcabe45f475efd7c95e989c9f7f2c9b61c65396b6373cbb0a68427ce10798a942c4af3cfd8ae66a34928c710b2cac24388d8848a6a1271ca40d3e9458a217898
+  metadata.gz: 4a35732c27d59d58ab02e23e22b7b52750975a728988b3f78c0d26bdcf52cfaffb7caa8d1feb2e1928a3455220e44dca0673720072dc31f164a87c08b6ed637c
+  data.tar.gz: 8ad1c06cb5b9e5adeb84fc01c4c236162a894c3fbea1f9470dbc87d67bb315c8669f8c84036cc1e594ac22f7047d5bb10fa790e298b24624d26858cc2ff3e127

data/CHANGES.md

@@ -2,10 +2,22 @@ CHANGES
 =======
 
 
+Release 2.4.0 (2023-12-04)
+--------------------------
+
+* [enhance] `Schema.add()` supports `multiple: true` keyword arg which enables to specify option multiple times.
+
+
+Release 2.3.0 (2023-11-26)
+--------------------------
+
+* [change] `Schema#add()` raises SchemaError if option key, short or long option duplicated.
+
+
 Release 2.2.0 (2023-10-28)
 --------------------------
 
-* [enhance] Define `SchemaItem#add_item()` which adds option item into the schema. This is for Benry-CmdApp framework.
+* [enhance] Define `Schema#add_item()` which adds option item into the schema. This is for Benry-CmdApp framework.
 * [change] (EXPERIMENTAL) Make `desc`, `detail`, `hidden`, `important`, `tag` attrubtes of `SchemaItem` object to be writable. This is for Benry-CmdApp framework.
 
 

data/README.md

@@ -1,6 +1,6 @@
 # Benry-CmdOpt
 
-($Release: 2.2.0 $)
+($Release: 2.4.0 $)
 
 
 
@@ -41,6 +41,9 @@ Benry-CmdOpt requires Ruby >= 2.3.
   * [Important Options](#important-options)
   * [Not Supported](#not-supported)
 * [Internal Classes](#internal-classes)
+* [FAQ](#faq)
+  * [Q: How to change or customize error messages?](#q-how-to-change-or-customize-error-messages)
+  * [Q: Is it possible to support `-vvv` style option?](#q-is-it-possible-to-support--vvv-style-option)
 * [License and Copyright](#license-and-copyright)
 
 <!-- /TOC -->
@@ -139,6 +142,23 @@ cmdopt = Benry::CmdOpt.new
 cmdopt.add(:number, "-n <N>", "number", type: Integer, enum: [1, 2, 3]) # very intuitive
 ```
 
+* `optparse.rb` doesn't report error even when options are duplicated.
+  This specification makes debugging hard.
+
+  `benry/cmdopt.rb` reports error when options are duplicated.
+
+```ruby
+require 'optparse'
+
+options = {}
+parser = OptionParser.new
+parser.on('-v', '--version') { options[:version] = true }
+parser.on('-v', '--verbose') { options[:verbose] = true }  # !!!!
+argv = ["-v"]
+parser.parse!(argv)
+p options     #=> {:verbose=>true}, not {:version=>true}
+```
+
 * `optparse.rb` adds `-h` and `--help` options automatically, and
   terminates current process when `-h` or `--help` specified in command-line.
   It is hard to remove these options.
@@ -260,13 +280,13 @@ end
 
   In fact, file `optparse.rb` and `optparse/*.rb` (in Ruby 3.2)
   contains total 1298 lines (except comments and blanks), while
-  `benry/cmdopt.rb` (v2.0.0) contains only 429 lines (except both, too).
+  `benry/cmdopt.rb` (v2.4.0) contains only 479 lines (except both, too).
 
 
 
 ## Install
 
-```
+```console
 $ gem install benry-cmdopt
 ```
 
@@ -450,11 +470,24 @@ p options[:flag2]   #=> false (!!!!!)
 
 ### Multiple Value Option
 
+Release 2.4 or later supports `multiple: true` keyword arg.
+
+```ruby
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+
+cmdopt.add(:inc , '-I <path>', "include path", multiple: true)  # !!!!
+options = cmdopt.parse(["-I", "/foo", "-I", "/bar", "-I/baz"])
+p options   #=> {:inc=>["/foo", "/bar", "/baz"]}
+```
+
+On older version:
+
 ```ruby
 require 'benry/cmdopt'
 cmdopt = Benry::CmdOpt.new
 
-cmdopt.add(:lib , '-I <NAME>', "library name") {|options, key, val|
+cmdopt.add(:inc , '-I <path>', "include path") {|options, key, val|
   arr = options[key] || []
   arr << val
   arr
@@ -462,8 +495,8 @@ cmdopt.add(:lib , '-I <NAME>', "library name") {|options, key, val|
   #(options[key] || []) << val
 }
 
-options = cmdopt.parse(["-I", "foo", "-I", "bar", "-Ibaz"])
-p options   #=> {:lib=>["foo", "bar", "baz"]}
+options = cmdopt.parse(["-I", "/foo", "-I", "/bar", "-I/baz"])
+p options   #=> {:inc=>["/foo", "/bar", "/baz"]}
 ```
 
 
@@ -687,6 +720,34 @@ Use `cmdopt.is_a?(Benry::CmdOpt::Facade)` instead if necessary.
 
 
 
+## FAQ
+
+
+### Q: How to change or customize error messages?
+
+A: Currently not supported. Maybe supported in the future.
+
+
+### Q: Is it possible to support `-vvv` style option?
+
+A: Yes.
+
+```ruby
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+
+cmdopt.add(:verbose , '-v', "verbose level") {|opts, key, val|
+  opts[key] ||= 0
+  opts[key] += 1
+}
+
+p cmdopt.parse(["-v"])     #=> {:verbose=>1}
+p cmdopt.parse(["-vv"])    #=> {:verbose=>2}
+p cmdopt.parse(["-vvv"])   #=> {:verbose=>3}
+```
+
+
+
 ## License and Copyright
 
 $License: MIT License $

data/benry-cmdopt.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name            = "benry-cmdopt"
-  spec.version         = "$Release: 2.2.0 $".split()[1]
+  spec.version         = "$Release: 2.4.0 $".split()[1]
   spec.author          = "kwatch"
   spec.email           = "kwatch@gmail.com"
   spec.platform        = Gem::Platform::RUBY

data/doc/benry-cmdopt.html

@@ -21,7 +21,7 @@
   <ul class="nav">
   </ul>
 </nav>
-<p>($Release: 2.2.0 $)</p>
+<p>($Release: 2.4.0 $)</p>
 <section class="section" id="whats-this">
 <h2>What's This?</h2>
 <p>Benry-CmdOpt is a command option parser library, like <code>optparse.rb</code>
@@ -57,6 +57,11 @@ and easy to understahnd.</p>
 <li><a href="#not-supported">Not Supported</a></li>
 </ul></li>
 <li><a href="#internal-classes">Internal Classes</a></li>
+<li><a href="#faq">FAQ</a>
+<ul>
+<li><a href="#q-how-to-change-or-customize-error-messages">Q: How to change or customize error messages?</a></li>
+<li><a href="#q-is-it-possible-to-support--vvv-style-option">Q: Is it possible to support <code>-vvv</code> style option?</a></li>
+</ul></li>
 <li><a href="#license-and-copyright">License and Copyright</a></li>
 </ul>
 </div>
@@ -155,6 +160,23 @@ cmdopt = Benry::CmdOpt.new
 cmdopt.add(:number, "-n &ltN&gt;", "number", type: Integer, <strong>enum: [1, 2, 3]</strong>) # very intuitive
 </pre>
 <ul>
+<li><code>optparse.rb</code> doesn't report error even when options are duplicated.
+  This specification makes debugging hard.
+<p></p>
+  <code>benry/cmdopt.rb</code> reports error when options are duplicated.</li>
+</ul>
+<pre class="language-ruby">
+require 'optparse'
+
+options = {}
+parser = OptionParser.new
+parser.on(<strong>'-v'</strong>, '--version') { options[:version] = true }
+parser.on(<strong>'-v'</strong>, '--verbose') { options[:verbose] = true }  # !!!!
+argv = ["-v"]
+parser.parse!(argv)
+p options     #=&gt; {:verbose=&gt;true}, not {:version=&gt;true}
+</pre>
+<ul>
 <li><code>optparse.rb</code> adds <code>-h</code> and <code>--help</code> options automatically, and
   terminates current process when <code>-h</code> or <code>--help</code> specified in command-line.
   It is hard to remove these options.
@@ -276,12 +298,12 @@ end
 <p></p>
   In fact, file <code>optparse.rb</code> and <code>optparse/*.rb</code> (in Ruby 3.2)
   contains total 1298 lines (except comments and blanks), while
-  <code>benry/cmdopt.rb</code> (v2.0.0) contains only 429 lines (except both, too).</li>
+  <code>benry/cmdopt.rb</code> (v2.4.0) contains only 479 lines (except both, too).</li>
 </ul>
 </section>
 <section class="section" id="install">
 <h2>Install</h2>
-<pre>
+<pre class="language-console">
 $ gem install benry-cmdopt
 </pre>
 </section>
@@ -443,11 +465,21 @@ p options[:flag2]   #=&gt; <strong>false</strong> (!!!!!)
 </section>
 <section class="subsection" id="multiple-value-option">
 <h3>Multiple Value Option</h3>
+<p>Release 2.4 or later supports <code>multiple: true</code> keyword arg.</p>
+<pre class="language-ruby">
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+
+cmdopt.add(:inc , '-I &ltpath&gt;', "include path", <strong>multiple: true</strong>)  # !!!!
+options = cmdopt.parse(["-I", "/foo", "-I", "/bar", "-I/baz"])
+p options   #=&gt; <strong>{:inc=&gt;["/foo", "/bar", "/baz"]}</strong>
+</pre>
+<p>On older version:</p>
 <pre class="language-ruby">
 require 'benry/cmdopt'
 cmdopt = Benry::CmdOpt.new
 
-cmdopt.add(:lib , '-I &ltNAME&gt;', "library name") <strong>{|options, key, val|</strong>
+cmdopt.add(:inc , '-I &ltpath&gt;', "include path") <strong>{|options, key, val|</strong>
   <strong>arr = options[key] || []</strong>
   <strong>arr &lt&lt val</strong>
   <strong>arr</strong>
@@ -455,8 +487,8 @@ cmdopt.add(:lib , '-I &ltNAME&gt;', "library name") <strong>{|options, key, val|
   #(options[key] || []) &lt&lt val
 <strong>}</strong>
 
-options = cmdopt.parse(["-I", "foo", "-I", "bar", "-Ibaz"])
-p options   #=&gt; <strong>{:lib=&gt;["foo", "bar", "baz"]}</strong>
+options = cmdopt.parse(["-I", "/foo", "-I", "/bar", "-I/baz"])
+p options   #=&gt; <strong>{:inc=&gt;["/foo", "/bar", "/baz"]}</strong>
 </pre>
 </section>
 <section class="subsection" id="hidden-option">
@@ -661,6 +693,30 @@ opts = <strong>cmdopt.parse</strong>(ARGV)                # same as <strong>pars
 <p>Notice that <code>cmdopt.is_a?(Benry::CmdOpt)</code> results in false.
 Use <code>cmdopt.is_a?(Benry::CmdOpt::Facade)</code> instead if necessary.</p>
 </section>
+<section class="section" id="faq">
+<h2>FAQ</h2>
+<section class="subsection" id="q-how-to-change-or-customize-error-messages">
+<h3>Q: How to change or customize error messages?</h3>
+<p>A: Currently not supported. Maybe supported in the future.</p>
+</section>
+<section class="subsection" id="q-is-it-possible-to-support--vvv-style-option">
+<h3>Q: Is it possible to support <code>-vvv</code> style option?</h3>
+<p>A: Yes.</p>
+<pre class="language-ruby">
+require 'benry/cmdopt'
+cmdopt = Benry::CmdOpt.new
+
+cmdopt.add(:verbose , '-v', "verbose level") {|opts, key, val|
+  opts[key] ||= 0
+  opts[key] += 1
+}
+
+p cmdopt.parse(["-v"])     #=&gt; {:verbose=&gt;1}
+p cmdopt.parse(["-vv"])    #=&gt; {:verbose=&gt;2}
+p cmdopt.parse(["-vvv"])   #=&gt; {:verbose=&gt;3}
+</pre>
+</section>
+</section>
 <section class="section" id="license-and-copyright">
 <h2>License and Copyright</h2>
 <p>$License: MIT License $</p>

data/doc/css/style.css

@@ -74,12 +74,12 @@ pre > strong {
 	font-weight: bold;
 	color: #900;
 }
-pre.language-terminal {
+pre.language-terminal, pre.language-console {
 	background: #333;
 	color: #fff;
 	border-color: #000;
 }
-pre.language-terminal > strong {
+pre.language-terminal > strong, pre.language-console > strong {
 	color: #f66;
 }
 code {

data/lib/benry/cmdopt.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 ###
-### $Release: 2.2.0 $
+### $Release: 2.4.0 $
 ### $Copyright: copyright(c) 2021 kwatch@gmail.com $
 ### $License: MIT License $
 ###
@@ -23,7 +23,7 @@ end
 module Benry::CmdOpt
 
 
-  VERSION = '$Release: 2.2.0 $'.split()[1]
+  VERSION = '$Release: 2.4.0 $'.split()[1]
 
 
   def self.new()
@@ -40,11 +40,12 @@ module Benry::CmdOpt
 
     attr_reader :schema
 
-    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
+    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, multiple: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
       rexp ||= pattern    # for backward compatibility
       #; [!vmb3r] defines command option.
       #; [!71cvg] type, rexp, enum, and range are can be passed as positional args as well as keyword args.
-      @schema.add(key, optdef, desc, *rest, type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, hidden: hidden, important: important, tag: tag, &callback)
+      @schema.add(key, optdef, desc, *rest,
+                  type: type, rexp: rexp, enum: enum, range: range, value: value, multiple: multiple, detail: detail, hidden: hidden, important: important, tag: tag, &callback)
       #; [!tu4k3] returns self.
       self
     end
@@ -103,7 +104,7 @@ module Benry::CmdOpt
       self
     end
 
-    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
+    def add(key, optdef, desc, *rest, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, multiple: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
       rexp ||= pattern    # for backward compatibility
       #; [!kuhf9] type, rexp, enum, and range are can be passed as positional args as well as keyword args.
       rest.each do |x|
@@ -137,17 +138,38 @@ module Benry::CmdOpt
       end
       #; [!yht0v] keeps command option definitions.
       item = SchemaItem.new(key, optdef, desc, short, long, param, required,
-                 type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, hidden: hidden, important: important, tag: tag, &callback)
-      @items << item
+                 type: type, rexp: rexp, enum: enum, range: range, value: value, multiple: multiple, detail: detail, hidden: hidden, important: important, tag: tag, &callback)
+      add_item(item)
       item
     end
 
     def add_item(item)
+      #; [!qyjp9] raises SchemaError if invalid item added.
+      errmsg = _validate_item(item)
+      errmsg == nil  or
+        raise SchemaError.new(errmsg)
       #; [!a693h] adds option item into current schema.
       @items << item
       self
     end
 
+    def _validate_item(item)
+      key = item.key; short = item.short; long = item.long
+      for x in @items
+        #; [!ewl20] returns error message if option key duplicated.
+        key != x.key  or
+          return "#{key}: Option key duplicated."
+        #; [!xg56v] returns error message if short option duplicated.
+        short == nil || short != x.short  or
+          return "-#{short}: Short option duplicated (key: #{key} and #{x.key})."
+        #; [!izezi] returns error message if long option duplicated.
+        long == nil || long != x.long  or
+          return "--#{long}: Long option duplicated (key: #{key} and #{x.key})."
+      end
+      return nil
+    end
+    private :_validate_item
+
     def option_help(width_or_format=nil, all: false)
       #; [!0aq0i] can take integer as width.
       #; [!pcsah] can take format string.
@@ -301,7 +323,7 @@ module Benry::CmdOpt
 
   class SchemaItem    # avoid Struct
 
-    def initialize(key, optdef, desc, short, long, param, required, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, detail: nil, value: nil, hidden: nil, important: nil, tag: nil, &callback)
+    def initialize(key, optdef, desc, short, long, param, required, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, multiple: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
       rexp ||= pattern    # for backward compatibility
       _init_validation(param, required, type, rexp, enum, range, value)
       @key      = key       unless nil == key
@@ -315,8 +337,9 @@ module Benry::CmdOpt
       @rexp     = rexp      unless nil == rexp
       @enum     = enum      unless nil == enum
       @range    = range     unless nil == range
-      @detail   = detail    unless nil == detail
       @value    = value     unless nil == value
+      @multiple = multiple  unless nil == multiple
+      @detail   = detail    unless nil == detail
       @hidden   = hidden    unless nil == hidden
       @important = important unless nil == important
       @tag      = tag       unless nil == tag
@@ -325,7 +348,7 @@ module Benry::CmdOpt
       @enum.freeze() if @enum
     end
 
-    attr_reader :key, :optdef, :desc, :short, :long, :param, :type, :rexp, :enum, :range, :detail, :value, :tag, :callback
+    attr_reader :key, :optdef, :desc, :short, :long, :param, :type, :rexp, :enum, :range, :value, :detail, :tag, :callback
     attr_writer :desc, :detail, :hidden, :important, :tag    # !!experimental!!
     alias pattern rexp   # for backward compatibility
     alias help desc      # for backward compatibility
@@ -346,6 +369,12 @@ module Benry::CmdOpt
       return :optional
     end
 
+    def multiple?()
+      #; [!1lj8v] returns true if @multiple is truthy.
+      #; [!cun23] returns false if @multiple is falthy.
+      return !! @multiple
+    end
+
     def hidden?()
       #; [!no6ov] returns true if @hidden is true.
       #; [!ej8ot] returns false if @hidden is false.
@@ -608,7 +637,8 @@ module Benry::CmdOpt
       rescue RuntimeError => ex
         raise _error("#{optstr}: #{ex.message}")
       end
-      optdict[item.key] = val
+      #; [!1m87b] supports multiple option.
+      store_option_value(optdict, item, val)
     end
 
     def parse_short_options(optstr, optdict, &block)
@@ -648,7 +678,8 @@ module Benry::CmdOpt
             raise _error("-#{char}#{sp}#{val}: #{ex.message}")
           end
         end
-        optdict[item.key] = val
+        #; [!187r2] supports multiple option.
+        store_option_value(optdict, item, val)
       end
     end
 
@@ -657,6 +688,16 @@ module Benry::CmdOpt
       return OPTIONS_CLASS.new
     end
 
+    def store_option_value(optdict, item, val)
+      #; [!my86j] stores multiple values if multiple option item.
+      if item.multiple?
+        (optdict[item.key] ||= []) << val
+      #; [!tm7xw] stores singile value if not multiple option item.
+      else
+        optdict[item.key] = val
+      end
+    end
+
     def handle_unknown_long_option(optstr, name, val)
       #; [!0q78a] raises OptionError.
       raise _error("#{optstr}: Unknown long option.")