benry-cmdapp 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ac71b6b3c1d20a3b3fda343372b791c284e77e3a1b475ff9ac6a7c6adec123
-  data.tar.gz: 01a0568d79c5e94c4be53aaa9eb0766406a695c55b4c2c11222cf1c396700b87
+  metadata.gz: 55cda8dcd81c8ebb9de51a568d94408fc177d6f9425e25bba54b2b3cf6836762
+  data.tar.gz: c5d12034ccedd2fe0c18916a566588f21e58267d7e0d20d42c807d5f3134fbc1
 SHA512:
-  metadata.gz: 71a365339d5b71b5acb46558e116991fcce7c900261b98b15dddeb50ba4fa7d50b7b6e278b22db4b3413fb171432f92369a0860df86c484b35fca8aacbb76bc3
-  data.tar.gz: e795e95e65f1c50f3ba7123f050747f8c504f1b233839df775c8451b33983f7da5ca7829df7b6854a1e17ea6b410c336829d023a4b5659bb19b1725c66345d97
+  metadata.gz: d4991a36655d4ab69e709a83e8e5965c00c704d91fb9323a79db33c29d47fb08f2787add47270d42e12180cc8dbdd0a80bfe840c6624105e63fe209e09ca0f1c
+  data.tar.gz: d9b9a8b181fbcf9741aa4685b23a0efcf3ddf507c2363a63a8eab1d96b35f8f60e64a980834c47b37eedef71a404b28e00d4e93aa956a10b09b3f5b5e809e2ba

data/CHANGES.md

@@ -2,6 +2,19 @@ CHANGES
 =======
 
 
+Release 1.1.2 (2024-09-30)
+--------------------------
+
+* [change] Change to report error when prefix not matched any task names.
+* [bugfix] Fix a minor bug related to listing candidates.
+
+
+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)
 --------------------------
 

data/README.md

@@ -1,6 +1,6 @@
 # Benry-CmdApp
 
-($Release: 1.1.0 $)
+($Release: 1.1.2 $)
 
 
 ## What's This?

data/benry-cmdapp.gemspec

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

data/doc/benry-cmdapp.html

@@ -21,7 +21,7 @@
   <ul class="nav">
   </ul>
 </nav>
-<p>($Release: 1.1.0 $)</p>
+<p>($Release: 1.1.2 $)</p>
 <section class="section" id="whats-this">
 <h2>What's This?</h2>
 <p>Benry-CmdApp is a framework to create command-line application.

data/lib/benry/cmdapp.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 ###
-### $Release: 1.1.0 $
+### $Release: 1.1.2 $
 ### $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
 
@@ -1487,12 +1491,12 @@ module Benry::CmdApp
         #; [!nwwrd] if prefix is 'xxx:' and alias name is 'xxx' and action name of alias matches to 'xxx:', skip it because it will be shown in 'Aliases:' section.
         _category_action?(metadata, prefix)
       }
-      #s1 = str.empty? ? nil : render_section(header(:HEADER_ACTIONS), str)
-      s1 = render_section(header(:HEADER_ACTIONS), str)
+      s1 = str.empty? ? nil : render_section(header(:HEADER_ACTIONS), str)
       #; [!otvbt] includes name of alias which corresponds to action starting with prefix.
+      #; [!bgpsm] includes name of alias which is equal to prefix name excluding tailing ':'.
       #; [!h5ek7] includes hidden aliases when `all: true` passed.
       str = _render_metadata_list(c.format_action, all: all) {|metadata|
-        metadata.alias? && metadata.action.start_with?(prefix)
+        metadata.alias? && (metadata.action.start_with?(prefix) || metadata.action == prefix2)
       }
       #; [!9lnn2] alias names in candidate list are sorted by action name.
       str = str.each_line.sort_by {|line|
@@ -1501,9 +1505,12 @@ module Benry::CmdApp
       }.join()
       #; [!80t51] alias names are displayed in separated section from actions.
       s2 = str.empty? ? nil : render_section(header(:HEADER_ALIASES), str)
-      #; [!rqx7w] returns header string if both no actions nor aliases found with names starting with prefix.
+      #; [!jek9k] raises error when no actions nor aliases found starting with prefix.
+      arr = [s1, s2].compact()
+      ! arr.empty?  or
+        raise CommandError, "'#{prefix}' : Unknown prefix. (Hint: try ':' instead of '#{prefix}' to list all prefixes.)"
       #; [!3c3f1] returns list of actions which name starts with prefix specified.
-      return [s1, s2].compact().join("\n")
+      return arr.join("\n")
     end
 
     def _category_action?(md, prefix)

data/test/help_test.rb

@@ -728,6 +728,30 @@ END
 END
       end
 
+      spec "[!bgpsm] includes name of alias which is equal to prefix name excluding tailing ':'." do
+        HelpTestAction.class_eval do
+          category "p5983:", action: "aaa" do
+            @action.("AAA")
+            def aaa()
+            end
+            @action.("BBB")
+            def bbb()
+            end
+          end
+        end
+        Benry::CmdApp.define_alias("p59", ["p5983", "-h"])  # !!!!
+        x = @builder.section_candidates("p5983:")
+        ok {x} == <<"END"
+\e[1;34mActions:\e[0m
+  p5983              : AAA
+\e[2m                       (alias: p59 (with '-h'))\e[0m
+  p5983:bbb          : BBB
+
+\e[1;34mAliases:\e[0m
+  p59                : alias for 'p5983 -h'
+END
+      end
+
       spec "[!h5ek7] includes hidden aliases when `all: true` passed." do
         Benry::CmdApp.define_alias("add", "git:stage", hidden: true)
         at_end { Benry::CmdApp.undef_alias("add") }
@@ -798,9 +822,11 @@ END
         ok {x} =~ /^\e\[1;34mAliases:\e\[0m$/
       end
 
-      spec "[!rqx7w] returns header string if both no actions nor aliases found with names starting with prefix." do
-        x = @builder.section_candidates("blabla:")
-        ok {x} == "\e[1;34mActions:\e[0m\n\n"
+      spec "[!jek9k] raises error when no actions nor aliases found starting with prefix." do
+        pr = proc { @builder.section_candidates("blabla:") }
+        ok {pr}.raise?(Benry::CmdApp::CommandError,
+                       "'blabla:' : Unknown prefix."\
+                       " (Hint: try ':' instead of 'blabla:' to list all prefixes.)")
       end
 
     end

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.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - kwatch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benry-cmdopt
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Command-line application framework