benry-cmdapp 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed2f767ac217ab20e675f3f4d587f86c1f98555ce5e6905afa6c3b0899477dd
-  data.tar.gz: 6efef4f285017450fe9643c9c8aece094480f913d09de3afabc88f40f243bc14
+  metadata.gz: dd749bd655750efee168dacda0d1f2609548a31fff1dd2c9d53e323c0fad145b
+  data.tar.gz: a3484ad1a239396af73c7173ac7272ac156d2e424b2a4d90f732cd1e1196bf95
 SHA512:
-  metadata.gz: 7b091695b69be73c48e1dc9b91337be36a91814457ee606e1a2e605bc8960cf89db6af9f076cf7cdcb125cfe358ed0795165bc4772ec2c3380428d45892fc5eb
-  data.tar.gz: 98fdbdcf533ed4d12b5886dd66cc50b7eca5d6f21069cb2478481594a00f0f15dde49a3e5efc4cfa20aa404a6daab09de290b72c8f12be4337000fc785ea2898
+  metadata.gz: 8ede7e8ca3b150642c064343ec3a310164986595a313e97a9e96cb7766fa6b5725102f482a40edfcfa3edafdea681cf58459d8845fa4b0622716e709dfe07024
+  data.tar.gz: 87a6c333685eb856704c37c62692a177384dae41475a55402904cd4d3c24d1dcfde8211e8df5d7718ec981e5a452b61f1d02894f7ed47671e13b71fb930f3a20

data/CHANGES.md

@@ -2,6 +2,18 @@ CHANGES
 =======
 
 
+Release 1.1.1 (2023-12-29)
+--------------------------
+
+* [bugfix] Fix to print method parameter 'foo_' as 'foo' in help message.
+
+
+Release 1.1.0 (2023-12-04)
+--------------------------
+
+* [enhance] Supports multiple option by `@options.(..., multiple: true)`.
+
+
 Release 1.0.0 (2023-11-25)
 --------------------------
 

data/README.md

@@ -1,6 +1,6 @@
 # Benry-CmdApp
 
-($Release: 1.0.0 $)
+($Release: 1.1.1 $)
 
 
 ## What's This?
@@ -61,6 +61,7 @@ Benry-CmdApp requires Ruby >= 2.3.
   * [Hidden Action](#hidden-action)
   * [Hidden Option](#hidden-option)
   * [Important Actions or Options](#important-actions-or-options)
+  * [Multiple Option](#multiple-option)
 * [Configuratoin and Customization](#configuratoin-and-customization)
   * [Application Configuration](#application-configuration)
   * [Customization of Global Options](#customization-of-global-options)
@@ -77,7 +78,7 @@ Benry-CmdApp requires Ruby >= 2.3.
   * [Q: How to re-define an existing action?](#q-how-to-re-define-an-existing-action)
   * [Q: How to show entering into or exitting from actions?](#q-how-to-show-entering-into-or-exitting-from-actions)
   * [Q: How to enable/disable color mode?](#q-how-to-enabledisable-color-mode)
-  * [Q: How to define a multiple option, like `-I` option of Ruby?](#q-how-to-define-a-multiple-option-like--i-option-of-ruby)
+  * [Q: How to define `-vvv` style option?](#q-how-to-define--vvv-style-option)
   * [Q: How to show global option `-L <topic>` in help message?](#q-how-to-show-global-option--l-topic-in-help-message)
   * [Q: How to specify detailed description of options?](#q-how-to-specify-detailed-description-of-options)
   * [Q: How to list only aliases (or actions) excluding actions (or aliases) ?](#q-how-to-list-only-aliases-or-actions-excluding-actions-or-aliases-)
@@ -2100,6 +2101,37 @@ Options:
 ```
 
 
+### Multiple Option
+
+If you need multiple options like `-I` option of Ruby,
+pass `multiple: true` to `@option.()`.
+
+File: ex39.rb
+
+```ruby
+require 'benry/cmdapp'
+
+class TestAction < Benry::CmdApp::Action
+
+  @action.("multiple option test")
+  @option.(:path, "-I <path>", "path", multiple: true)
+  def test_(path: [])
+    puts "path=#{path.inspect}"     #=> path=["/tmp", "/var/tmp"]
+  end
+
+end
+
+exit Benry::CmdApp.main("test app")
+```
+
+Output:
+
+```console
+[bash]$ ruby ex39.rb test -I /tmp -I /var/tmp     # !!!!
+path=["/tmp", "/var/tmp"]                         # !!!!
+```
+
+
 
 ## Configuratoin and Customization
 
@@ -3025,7 +3057,7 @@ Actions:
 ```
 
 
-### Q: How to define a multiple option, like `-I` option of Ruby?
+### Q: How to define `-vvv` style option?
 
 A: Provide block parameter on `@option.()`.
 
@@ -3036,16 +3068,13 @@ require 'benry/cmdapp'
 
 class TestAction < Benry::CmdApp::Action
 
-  @action.("multiple option test")
-  @option.(:path, "-I <path>", "path") {|options, key, val|  # !!!!
-    arr = options[key] || []                                 # !!!!
-    arr << val                                               # !!!!
-    arr                                                      # !!!!
-    ## or:                                                   # !!!!
-    #(options[key] || []) << val                             # !!!!
-  }                                                          # !!!!
-  def test_(path: [])
-    puts "path=#{path.inspect}"     #=> path=["/tmp", "/var/tmp"]
+  @action.("set verbose level")
+  @option.(:verbose, "-v", "verbose level") {|opts, key, val|  # !!!!
+    opts[key] ||= 0                                            # !!!!
+    opts[key] += 1                                             # !!!!
+  }                                                            # !!!!
+  def test_(verbose: 0)
+    puts "verbose=#{verbose}"
   end
 
 end
@@ -3056,8 +3085,12 @@ exit Benry::CmdApp.main("test app")
 Output:
 
 ```console
-[bash]$ ruby ex65.rb test -I /tmp -I /var/tmp     # !!!!
-path=["/tmp", "/var/tmp"]                         # !!!!
+[bash]$ ruby ex65.rb test -v              # !!!!
+verbose=1
+[bash]$ ruby ex65.rb test -vv             # !!!!
+verbose=2
+[bash]$ ruby ex65.rb test -vvv            # !!!!
+verbose=3
 ```
 
 

data/benry-cmdapp.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name            = "benry-cmdapp"
-  spec.version         = "$Release: 1.0.0 $".split()[1]
+  spec.version         = "$Release: 1.1.1 $".split()[1]
   spec.author          = "kwatch"
   spec.email           = "kwatch@gmail.com"
   spec.platform        = Gem::Platform::RUBY
@@ -31,6 +31,6 @@ END
   #spec.extra_rdoc_files = ["README.md", "CHANGES.md"]
 
   spec.required_ruby_version = ">= 2.3"
-  spec.add_runtime_dependency     "benry-cmdopt"    , "~> 2", ">= 2.2.0"
+  spec.add_runtime_dependency     "benry-cmdopt"    , "~> 2", ">= 2.4.0"
   spec.add_development_dependency "oktest"          , "~> 1"
 end

data/doc/benry-cmdapp.html

@@ -21,7 +21,7 @@
   <ul class="nav">
   </ul>
 </nav>
-<p>($Release: 1.0.0 $)</p>
+<p>($Release: 1.1.1 $)</p>
 <section class="section" id="whats-this">
 <h2>What's This?</h2>
 <p>Benry-CmdApp is a framework to create command-line application.
@@ -80,6 +80,7 @@ like <code>git</code>, <code>docker</code>, or <code>npm</code>, Benry-CmdApp is
 <li><a href="#hidden-action">Hidden Action</a></li>
 <li><a href="#hidden-option">Hidden Option</a></li>
 <li><a href="#important-actions-or-options">Important Actions or Options</a></li>
+<li><a href="#multiple-option">Multiple Option</a></li>
 </ul></li>
 <li><a href="#configuratoin-and-customization">Configuratoin and Customization</a>
 <ul>
@@ -100,7 +101,7 @@ like <code>git</code>, <code>docker</code>, or <code>npm</code>, Benry-CmdApp is
 <li><a href="#q-how-to-re-define-an-existing-action">Q: How to re-define an existing action?</a></li>
 <li><a href="#q-how-to-show-entering-into-or-exitting-from-actions">Q: How to show entering into or exitting from actions?</a></li>
 <li><a href="#q-how-to-enabledisable-color-mode">Q: How to enable/disable color mode?</a></li>
-<li><a href="#q-how-to-define-a-multiple-option-like--i-option-of-ruby">Q: How to define a multiple option, like <code>-I</code> option of Ruby?</a></li>
+<li><a href="#q-how-to-define--vvv-style-option">Q: How to define <code>-vvv</code> style option?</a></li>
 <li><a href="#q-how-to-show-global-option--l-topic-in-help-message">Q: How to show global option <code>-L &lttopic&gt;</code> in help message?</a></li>
 <li><a href="#q-how-to-specify-detailed-description-of-options">Q: How to specify detailed description of options?</a></li>
 <li><a href="#q-how-to-list-only-aliases-or-actions-excluding-actions-or-aliases-">Q: How to list only aliases (or actions) excluding actions (or aliases) ?</a></li>
@@ -1925,6 +1926,32 @@ Options:
   <strong>--bar              : not important option</strong>  # !!!! gray color !!!!
 </pre>
 </section>
+<section class="subsection" id="multiple-option">
+<h3>Multiple Option</h3>
+<p>If you need multiple options like <code>-I</code> option of Ruby,
+pass <code>multiple: true</code> to <code>@option.()</code>.</p>
+<p>File: ex39.rb</p>
+<pre class="language-ruby">
+require 'benry/cmdapp'
+
+class TestAction &lt Benry::CmdApp::Action
+
+  @action.("multiple option test")
+  @option.(:path, "-I &ltpath&gt;", "path", <strong>multiple: true</strong>)
+  def test_(path: [])
+    puts "path=#{path.inspect}"     #=&gt; path=["/tmp", "/var/tmp"]
+  end
+
+end
+
+exit Benry::CmdApp.main("test app")
+</pre>
+<p>Output:</p>
+<pre class="language-console">
+[bash]$ ruby ex39.rb test <strong>-I /tmp -I /var/tmp</strong>     # !!!!
+path=<strong>["/tmp", "/var/tmp"]</strong>                         # !!!!
+</pre>
+</section>
 </section>
 <section class="section" id="configuratoin-and-customization">
 <h2>Configuratoin and Customization</h2>
@@ -2779,8 +2806,8 @@ Actions:
 [bash]$ ruby ex64.rb -h <strong>--color</strong>                  # !!!!
 </pre>
 </section>
-<section class="subsection" id="q-how-to-define-a-multiple-option-like--i-option-of-ruby">
-<h3>Q: How to define a multiple option, like <code>-I</code> option of Ruby?</h3>
+<section class="subsection" id="q-how-to-define--vvv-style-option">
+<h3>Q: How to define <code>-vvv</code> style option?</h3>
 <p>A: Provide block parameter on <code>@option.()</code>.</p>
 <p>File: ex65.rb</p>
 <pre class="language-ruby">
@@ -2788,16 +2815,13 @@ require 'benry/cmdapp'
 
 class TestAction &lt Benry::CmdApp::Action
 
-  @action.("multiple option test")
-  @option.(:path, "-I &ltpath&gt;", "path") <strong>{|options, key, val|</strong>  # !!!!
-    <strong>arr = options[key] || []</strong>                                 # !!!!
-    <strong>arr &lt&lt val</strong>                                               # !!!!
-    <strong>arr</strong>                                                      # !!!!
-    ## or:                                                   # !!!!
-    #<strong>(options[key] || []) &lt&lt val</strong>                             # !!!!
-  <strong>}</strong>                                                          # !!!!
-  def test_(path: [])
-    puts "path=#{path.inspect}"     #=&gt; path=["/tmp", "/var/tmp"]
+  @action.("set verbose level")
+  @option.(:verbose, "-v", "verbose level") <strong>{|opts, key, val|</strong>  # !!!!
+    <strong>opts[key] ||= 0</strong>                                            # !!!!
+    <strong>opts[key] += 1</strong>                                             # !!!!
+  <strong>}</strong>                                                            # !!!!
+  def test_(verbose: 0)
+    puts "verbose=#{verbose}"
   end
 
 end
@@ -2806,8 +2830,12 @@ exit Benry::CmdApp.main("test app")
 </pre>
 <p>Output:</p>
 <pre class="language-console">
-[bash]$ ruby ex65.rb test <strong>-I /tmp -I /var/tmp</strong>     # !!!!
-path=["/tmp", "/var/tmp"]                         # !!!!
+[bash]$ ruby ex65.rb test <strong>-v</strong>              # !!!!
+verbose=<strong>1</strong>
+[bash]$ ruby ex65.rb test <strong>-vv</strong>             # !!!!
+verbose=<strong>2</strong>
+[bash]$ ruby ex65.rb test <strong>-vvv</strong>            # !!!!
+verbose=<strong>3</strong>
 </pre>
 </section>
 <section class="subsection" id="q-how-to-show-global-option--l-topic-in-help-message">

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/cmdapp.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 ###
-### $Release: 1.0.0 $
+### $Release: 1.1.1 $
 ### $Copyright: copyright(c) 2023 kwatch@gmail.com $
 ### $License: MIT License $
 ###
@@ -91,18 +91,22 @@ module Benry::CmdApp
       sb << ("]" * n) if n > 0
       #; [!mbxy5] converts `.foo(x, *x_)` into `' <x>...'`.
       #; [!mh9ni] converts `.foo(x, *x2)` into `' <x>...'`.
-      return sb.join().sub(/<([^>]+)> \[<\1[-_2]>\.\.\.\]/, "<\\1>...")
+      return sb.join().sub(/<([^>]+)> \[<\1[-_2]?>\.\.\.\]/, "<\\1>...")
     end
 
     def param2arg(param)
       #; [!ahvsn] converts parameter name (Symbol) into argument name (String).
       #; [!27dpw] converts `:aa_or_bb_or_cc` into `'aa|bb|cc'`.
       #; [!to41h] converts `:aa__bb__cc` into `'aa.bb.cc'`.
+      #; [!cldax] converts `:aa_` into `'aa'`.
       #; [!2ma08] converts `:aa_bb_cc` into `'aa-bb-cc'`.
+      #; [!5d0qf] lefts `:_aa` as `'_aa'`.
       s = param.to_s
       s = s.gsub('_or_', '|')    # ex: 'file_or_dir' => 'file|dir'
       s = s.gsub('__'  , '.')    # ex: 'file__html'  => 'file.html'
+      s = s.gsub(/_+\z/, '')     # ex: 'end_'        => 'end'
       s = s.gsub('_'   , '-')    # ex: 'foo_bar_baz' => 'foo-bar-baz'
+      s = s.gsub(/\A-/ , '_')    # ex: '-aa'         => '_aa'
       return s
     end
 
@@ -525,7 +529,7 @@ module Benry::CmdApp
         #; [!en6n0] sets Proc object to `@option` in subclass.
         @option = lambda do |key, optstr, desc,
                              type: nil, rexp: nil, pattern: nil, enum: nil,
-                             range: nil, value: nil, detail: nil,
+                             range: nil, value: nil, multiple: nil, detail: nil,
                              tag: nil, important: nil, hidden: nil, &callback|
           #; [!68hf8] raises DefinitionError if `@option.()` called without `@action.()`.
           @__actiondef__ != nil  or
@@ -534,7 +538,7 @@ module Benry::CmdApp
           schema = @__actiondef__[1]
           schema.add(key, optstr, desc,
                      type: type, rexp: rexp, pattern: pattern, enum: enum,
-                     range: range, value: value, detail: detail,
+                     range: range, value: value, multiple: multiple, detail: detail,
                      tag: tag, important: important, hidden: hidden, &callback)
         end
         #; [!aiwns] `@copy_options.()` copies options from other action.

data/test/scope_test.rb

@@ -116,8 +116,9 @@ Oktest.scope do
           @action.("foobar")
           @option.(:lang, "-l <lang>", "language", detail: "blabla", hidden: true) {|val| val }
           @option.(:color, "--color[=<on|off>]", "color mode", type: TrueClass)
+          @option.(:ints, "-n <N>", "integers", multiple: true, type: Integer)
           tuple = @__actiondef__
-          def s2055(help: false, lang: nil, color: nil)
+          def s2055(help: false, lang: nil, color: nil, ints: nil)
           end
         end
         schema = tuple[1]
@@ -130,6 +131,7 @@ Oktest.scope do
         ok {x.desc} == "language"
         ok {x.type} == nil
         ok {x.detail} == "blabla"
+        ok {x.multiple?} == false
         ok {x.hidden?} == true
         ok {x.callback}.is_a?(Proc)
         #
@@ -140,8 +142,15 @@ Oktest.scope do
         ok {x.desc} == "color mode"
         ok {x.type} == TrueClass
         ok {x.detail} == nil
+        ok {x.multiple?} == false
         ok {x.hidden?} == false
         ok {x.callback} == nil
+        #
+        x = schema.get(:ints)
+        ok {x.key} == :ints
+        ok {x.short} == "n"
+        ok {x.long} == nil
+        ok {x.multiple?} == true
       end
 
       spec "[!aiwns] `@copy_options.()` copies options from other action." do

data/test/util_test.rb

@@ -109,10 +109,18 @@ Oktest.scope do
         ok {Benry::CmdApp::Util.param2arg(:aa__bb__cc)} == "aa.bb.cc"
       end
 
+      spec "[!cldax] converts `:aa_` into `'aa'`." do
+        ok {Benry::CmdApp::Util.param2arg(:aa_)} == "aa"
+      end
+
       spec "[!2ma08] converts `:aa_bb_cc` into `'aa-bb-cc'`." do
         ok {Benry::CmdApp::Util.param2arg(:aa_bb_cc)} == "aa-bb-cc"
       end
 
+      spec "[!5d0qf] lefts `:_aa` as `'_aa'`." do
+        ok {Benry::CmdApp::Util.param2arg(:_aa_bb_cc_)} == "_aa-bb-cc"
+      end
+
     end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benry-cmdapp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - kwatch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-25 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benry-cmdopt
@@ -19,7 +19,7 @@ dependencies:
         version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: oktest
   requirement: !ruby/object:Gem::Requirement