benry-cmdopt 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e37b3eb5a8294bfae3627f384720f843e2c6ae9c79ec0cc704b732368d46437
-  data.tar.gz: 3a3b34226485ae5c0aaa3f3b90d6ba281b34f7843d5e03179235784af0fc2467
+  metadata.gz: bfcbb37a1e33df36573f607fc8a5b7f81761b0535422023b64648ac596b1ce4c
+  data.tar.gz: d9b57e362e8d3e6ec7bf808b661436cbe827b3f5ba7d87f6ea5c55c0bafce69c
 SHA512:
-  metadata.gz: f1aae8384f952ddbc0ba5408e39e5b289d09c9b9e768a4cee237c723d7f0bef459b2ab7c8e3639705e8495790fb02bb6fced99bf9a3676e772d4b0c2d622961d
-  data.tar.gz: 737074f681fa450d2e0fc9b82b85aedba8088db313b522c32b1c01cae6a68ed091da08ca437f58e543b0a6d896618c42a078ded25bba9fba971c3e3ec90bc82f
+  metadata.gz: 1710700fceb026a2fe422ccaf5681dd83e4160a25c9f2fc3bc35662cfb695b7588fb2d9eea0ec7211c65a6e297bb3675e7dd3af63cfc9eaa4eb05561dc9714ca
+  data.tar.gz: 43c560b46bb5de501f5d82442092644961d711a46770161bcebb0bd8fcebfb5fabf15add17f5f875c32f66a07d8bdb6ce45eab3bf493ce54f64336add6cd0817

data/CHANGES.md

@@ -2,6 +2,19 @@ CHANGES
 =======
 
 
+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 `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.
+
+
 Release 2.1.0 (2023-10-15)
 --------------------------
 

data/README.md

@@ -1,6 +1,6 @@
 # Benry-CmdOpt
 
-($Release: 2.1.0 $)
+($Release: 2.3.0 $)
 
 
 
@@ -139,6 +139,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.

data/benry-cmdopt.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name            = "benry-cmdopt"
-  spec.version         = "$Release: 2.1.0 $".split()[1]
+  spec.version         = "$Release: 2.3.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.1.0 $)</p>
+<p>($Release: 2.3.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>
@@ -155,6 +155,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.

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.1.0 $
+### $Release: 2.3.0 $
 ### $Copyright: copyright(c) 2021 kwatch@gmail.com $
 ### $License: MIT License $
 ###
@@ -23,7 +23,7 @@ end
 module Benry::CmdOpt
 
 
-  VERSION = '$Release: 2.1.0 $'.split()[1]
+  VERSION = '$Release: 2.3.0 $'.split()[1]
 
 
   def self.new()
@@ -138,10 +138,37 @@ module Benry::CmdOpt
       #; [!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
+      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.
@@ -320,6 +347,7 @@ module Benry::CmdOpt
     end
 
     attr_reader :key, :optdef, :desc, :short, :long, :param, :type, :rexp, :enum, :range, :detail, :value, :tag, :callback
+    attr_writer :desc, :detail, :hidden, :important, :tag    # !!experimental!!
     alias pattern rexp   # for backward compatibility
     alias help desc      # for backward compatibility
 

data/test/cmdopt_test.rb

@@ -256,6 +256,68 @@ Oktest.scope do
     end
 
 
+    topic '#add_item()' do
+
+      spec "[!qyjp9] raises SchemaError if invalid item added." do
+        sc = Benry::CmdOpt::Schema.new
+        sc.add(:quiet, "-q, --quiet", "quiet mode")
+        #
+        item1 = Benry::CmdOpt::SchemaItem.new(:quiet, "-q", "quiet", "q", nil, nil, false)
+        pr = proc { sc.add_item(item1) }
+        ok {pr}.raise?(Benry::CmdOpt::SchemaError,
+                       "quiet: Option key duplicated.")
+        #
+        item2 = Benry::CmdOpt::SchemaItem.new(:quiet2, "-q", "quiet", "q", nil, nil, false)
+        pr = proc { sc.add_item(item2) }
+        ok {pr}.raise?(Benry::CmdOpt::SchemaError,
+                       "-q: Short option duplicated (key: quiet2 and quiet).")
+        #
+        item3 = Benry::CmdOpt::SchemaItem.new(:quiet3, "--quiet", "quiet", nil, "quiet", nil, false)
+        pr = proc { sc.add_item(item3) }
+        ok {pr}.raise?(Benry::CmdOpt::SchemaError,
+                       "--quiet: Long option duplicated (key: quiet3 and quiet).")
+      end
+
+      spec "[!a693h] adds option item into current schema." do
+        item = Benry::CmdOpt::SchemaItem.new(:quiet, "-q", "quiet", "q", nil, nil, false)
+        sc = Benry::CmdOpt::Schema.new
+        sc.add_item(item)
+        ok {sc.to_s} == <<"END"
+  -q       : quiet
+END
+      end
+
+    end
+
+
+    topic '#_validate_item()' do
+
+      before do
+        @schema = Benry::CmdOpt::Schema.new
+        @schema.add(:quiet, "-q, --quiet", "quiet mode")
+      end
+
+      spec "[!ewl20] returns error message if option key duplicated." do
+        item = Benry::CmdOpt::SchemaItem.new(:quiet, "-q", "quiet mode", "q", nil, nil, false)
+        ret = @schema.__send__(:_validate_item, item)
+        ok {ret} == "quiet: Option key duplicated."
+      end
+
+      spec "[!xg56v] returns error message if short option duplicated." do
+        item = Benry::CmdOpt::SchemaItem.new(:quiet2, "-q", "quiet mode", "q", nil, nil, false)
+        ret = @schema.__send__(:_validate_item, item)
+        ok {ret} == "-q: Short option duplicated (key: quiet2 and quiet)."
+      end
+
+      spec "[!izezi] returns error message if long option duplicated." do
+        item = Benry::CmdOpt::SchemaItem.new(:quiet3, "--quiet", "quiet mode", nil, "quiet", nil, false)
+        ret = @schema.__send__(:_validate_item, item)
+        ok {ret} == "--quiet: Long option duplicated (key: quiet3 and quiet)."
+      end
+
+    end
+
+
     topic '#option_help()' do
 
       before do
@@ -761,10 +823,10 @@ END
 
         spec "[!melyd] raises SchemaError when enum is not an Array nor Set." do
           sc = @schema
-          sc.add(:indent, "-i <N>", "indent width", enum: ["2", "4", "8"])
-          sc.add(:indent, "-i <N>", "indent width", enum: Set.new(["2", "4", "8"]))
+          sc.add(:indent1, "-i <N>", "indent width", enum: ["2", "4", "8"])
+          sc.add(:indent2, "-j <N>", "indent width", enum: Set.new(["2", "4", "8"]))
           pr = proc {
-            sc.add(:indent, "-i <N>", "indent width", enum: "2,4,8")
+            sc.add(:indent3, "-k <N>", "indent width", enum: "2,4,8")
           }
           ok {pr}.raise?(Benry::CmdOpt::SchemaError,
                          '"2,4,8": Array or set expected.')
@@ -834,7 +896,6 @@ END
               @schema.add(:indent1, "-i <N>", "indent", type: Integer, range: range1)
               @schema.add(:indent2, "-j <N>", "indent", type: Integer, range: range2)
             }
-            pr.call
             ok {pr}.NOT.raise?(Exception)
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benry-cmdopt
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - kwatch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-15 00:00:00.000000000 Z
+date: 2023-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oktest