benry-cmdapp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4cae92d627c080f4c25ca3cb607871ecd45ae815a7af19252bbeac7c48def32
-  data.tar.gz: 32f9ac8fa0c8f3659e286553536b96ee7f21d8ecb706ddee36901ebd483e3dad
+  metadata.gz: 8b0a5dd7e1572d8202763acc806cd7299f40b5b4696f9a59c255afca03608f24
+  data.tar.gz: 56739d3a911e3027c8e7d632355db38531c64cca519b51ac4f8c2857d4c41b64
 SHA512:
-  metadata.gz: ac4a3ac4ddec5f058fc4f0f7d7b19f18c5bed5c4a242b85eb2f2578c481c57807958c1e957b9db2ed8048185547573754feca0c6694ba6c9a5987adbc816d132
-  data.tar.gz: bffae3d01e9852d10cfeaef85eaf7c3d6e6538c15402620f4e0088bb6d26bfe9c303d257f9d1ccd551ab7eb4eb3c6f7928ef902673dac404b8076ef4c816ea23
+  metadata.gz: 3581a4d1ac62a2ce6143e648eee9fd30a364977aec7b25b9896ee8f659e9b544d7d7fd8f8cafaacd49bae001df8384fcc6f58914fc511f8d281c4456e5cbf284
+  data.tar.gz: 274ac6bbfc184243eedbc37911c9d41397ff5271f8bffbc7e363d6feaa63d292f09e51d83d7a95aa13c2ed35b9f102909b254f2a36b66e9e39bccddc64aee3cc

data/CHANGES.md

@@ -2,6 +2,14 @@ CHANGES
 =======
 
 
+Release 0.2.0 (2023-10-18)
+--------------------------
+
+* [change] Requires Benry-CmdOpt 2.1.0 or higher.
+* [enhance] `@action.()` and `@option.()` supports `hidden: true` keyword argument.
+* [change] Rename `#run_action!()` in Action class to `#run_action_anyway()`.
+
+
 Release 0.1.0 (2023-10-12)
 --------------------------
 

data/README.md

@@ -1,6 +1,6 @@
 # Benry-CmdApp
 
-($Release: 0.1.0 $)
+($Release: 0.2.0 $)
 
 
 ## What's This?
@@ -1181,7 +1181,8 @@ Actions:
 
 ### Private (Hidden) Action
 
-* If action method is private, Benry::CmdApp regards that action as private.
+* If `hidden: true` keyword argument passed to `@action.()`,
+  or action method is private, then Benry::CmdApp regards that action as private.
 * Private actions are hidden in help message.
 * Private actions are shown when `-a` or `--all` option enabled and specified.
 
@@ -1198,13 +1199,12 @@ class SampleAction < Benry::CmdApp::Action
     puts __method__
   end
 
-  @action.("test action #2")
+  @action.("test action #2", hidden: true)  # !!!!
   def test2()
     puts __method__
   end
-  private :test2               # !!!! private method !!!!
 
-  private                      # !!!! private method !!!!
+  private                      # !!!!
 
   @action.("test action #3")
   def test3()
@@ -1258,7 +1258,7 @@ Actions:
 
 ### Private (Hidden) Option
 
-* Options which name stars with `_` are treated as private option.
+* Options defined with `hidden: true` keyword argument are treated as private option.
 * Private options are hidden in help message of action.
 * Private options are shown when `-a` or `--all` option enabled and specified.
 
@@ -1272,9 +1272,9 @@ class SampleAction < Benry::CmdApp::Action
 
   @action.("test action")
   @option.(:verbose, "-v", "verbose mode")
-  @option.(:_debug , "-D", "debug mode")      # !!!!
-  def test1(verbose: false, _debug: false)
-    puts "verbose=#{verbose}, _debug=#{_debug}"
+  @option.(:debug , "-D", "debug mode", hidden: true)      # !!!!
+  def test1(verbose: false, debug: false)
+    puts "verbose=#{verbose}, debug=#{_debug}"
   end
 
 end

data/benry-cmdapp.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name            = "benry-cmdapp"
-  spec.version         = "$Release: 0.1.0 $".split()[1]
+  spec.version         = "$Release: 0.2.0 $".split()[1]
   spec.author          = "kwatch"
   spec.email           = "kwatch@gmail.com"
   spec.platform        = Gem::Platform::RUBY
@@ -21,9 +21,7 @@ END
   spec.files           = Dir[
                            "README.md", "MIT-LICENSE", "CHANGES.md",
                            "#{spec.name}.gemspec",
-                           #"Rakefile.rb", "task/**/*.rb",,
-                           "lib/**/*.rb", "test/**/*.rb",
-                           #"bin/*", "examples/**/*",
+                           "lib/**/*.rb", "test/**/*.rb", #"bin/*", "examples/**/*",
                            "doc/*.html", "doc/css/*.css",
                          ]
   #spec.executables     = []
@@ -33,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"
+  spec.add_runtime_dependency     "benry-cmdopt"    , "~> 2", ">= 2.1.0"
   spec.add_development_dependency "oktest"          , "~> 1"
 end

data/doc/benry-cmdapp.html

@@ -21,7 +21,7 @@
   <ul class="nav">
   </ul>
 </nav>
-<p>($Release: 0.1.0 $)</p>
+<p>($Release: 0.2.0 $)</p>
 <section class="section" id="whats-this">
 <h2>What's This?</h2>
 <p>Benry-CmdApp is a framework to create command-line application.
@@ -1116,7 +1116,8 @@ Actions:
 <section class="subsection" id="private-hidden-action">
 <h3>Private (Hidden) Action</h3>
 <ul>
-<li>If action method is private, Benry::CmdApp regards that action as private.</li>
+<li>If <code>hidden: true</code> keyword argument passed to <code>@action.()</code>,
+  or action method is private, then Benry::CmdApp regards that action as private.</li>
 <li>Private actions are hidden in help message.</li>
 <li>Private actions are shown when <code>-a</code> or <code>--all</code> option enabled and specified.</li>
 </ul>
@@ -1132,13 +1133,12 @@ class SampleAction &lt Benry::CmdApp::Action
     puts __method__
   end
 
-  @action.("test action #2")
+  @action.("test action #2", <strong>hidden: true</strong>)  # !!!!
   def test2()
     puts __method__
   end
-  <strong>private :test2</strong>               # !!!! private method !!!!
 
-  <strong>private</strong>                      # !!!! private method !!!!
+  <strong>private</strong>                      # !!!!
 
   @action.("test action #3")
   def test3()
@@ -1188,7 +1188,7 @@ Actions:
 <section class="subsection" id="private-hidden-option">
 <h3>Private (Hidden) Option</h3>
 <ul>
-<li>Options which name stars with <code>_</code> are treated as private option.</li>
+<li>Options defined with <code>hidden: true</code> keyword argument are treated as private option.</li>
 <li>Private options are hidden in help message of action.</li>
 <li>Private options are shown when <code>-a</code> or <code>--all</code> option enabled and specified.</li>
 </ul>
@@ -1201,9 +1201,9 @@ class SampleAction &lt Benry::CmdApp::Action
 
   @action.("test action")
   @option.(:verbose, "-v", "verbose mode")
-  @option.(<strong>:_debug</strong> , "-D", "debug mode")      # !!!!
-  def test1(verbose: false, _debug: false)
-    puts "verbose=#{verbose}, _debug=#{_debug}"
+  @option.(:debug , "-D", "debug mode", <strong>hidden: true</strong>)      # !!!!
+  def test1(verbose: false, debug: false)
+    puts "verbose=#{verbose}, debug=#{_debug}"
   end
 
 end

data/lib/benry/cmdapp.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 ###
-### $Release: 0.1.0 $
+### $Release: 0.2.0 $
 ### $Copyright: copyright(c) 2023 kwatch@gmail.com $
 ### $License: MIT License $
 ###
@@ -277,7 +277,7 @@ module Benry::CmdApp
 
   class ActionMetadata
 
-    def initialize(name, klass, method, desc, schema, detail: nil, postamble: nil, important: nil, tag: nil)
+    def initialize(name, klass, method, desc, schema, detail: nil, postamble: nil, important: nil, tag: nil, hidden: nil)
       @name   = name
       @klass  = klass
       @method = method
@@ -287,14 +287,15 @@ module Benry::CmdApp
       @postamble = postamble if postamble != nil
       @important = important if important != nil
       @tag    = tag          if tag != nil
+      @hidden = hidden       if hidden != nil
     end
 
-    attr_reader :name, :method, :klass, :schema, :desc, :detail, :postamble, :important, :tag
+    attr_reader :name, :method, :klass, :schema, :desc, :detail, :postamble, :important, :tag, :hidden
 
     def hidden?()
       #; [!kp10p] returns true when action method is private.
       #; [!nw322] returns false when action method is not private.
-      return ! @klass.method_defined?(@method)
+      return @hidden != nil ? @hidden : ! @klass.method_defined?(@method)
     end
 
     def important?()
@@ -581,7 +582,7 @@ module Benry::CmdApp
       return __run_action(action_name, true, args, kwargs)
     end
 
-    def run_action!(action_name, *args, **kwargs)
+    def run_action_anyway(action_name, *args, **kwargs)
       #; [!2yrc2] invokes action even if already invoked.
       return __run_action(action_name, false, args, kwargs)
     end
@@ -636,18 +637,18 @@ module Benry::CmdApp
         @__aliasof__  = nil    # ex: :method_name or "action-name"
         @__default__  = nil    # ex: :method_name or "action-name"
         #; [!1qv12] @action is a Proc object and saves args.
-        @action = proc do |desc, detail: nil, postamble: nil, important: nil, tag: nil|
-          @__action__ = [desc, {detail: detail, postamble: postamble, important: important, tag: tag}]
+        @action = proc do |desc, detail: nil, postamble: nil, important: nil, tag: nil, hidden: nil|
+          @__action__ = [desc, {detail: detail, postamble: postamble, important: important, tag: tag, hidden: hidden}]
         end
         #; [!33ma7] @option is a Proc object and saves args.
-        @option = proc do |param, optdef, desc, *rest, type: nil, rexp: nil, enum: nil, range: nil, value: nil, detail: nil, tag: nil, &block|
+        @option = proc do |param, optdef, desc, *rest, type: nil, rexp: nil, enum: nil, range: nil, value: nil, detail: nil, important: nil, tag: nil, hidden: nil, &block|
           #; [!gxybo] '@option.()' raises error when '@action.()' not called.
           @__action__ != nil  or
             raise OptionDefError.new("@option.(#{param.inspect}): `@action.()` Required but not called.")
           schema = (@__option__ ||= SCHEMA_CLASS.new)
           #; [!ga6zh] '@option.()' raises error when invalid option info specified.
           begin
-            schema.add(param, optdef, desc, *rest, type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, tag: nil, &block)
+            schema.add(param, optdef, desc, *rest, type: type, rexp: rexp, enum: enum, range: range, value: value, detail: detail, important: important, tag: tag, hidden: hidden, &block)
           rescue Benry::CmdOpt::SchemaError => exc
             raise OptionDefError.new(exc.message)
           end

data/test/action_test.rb

@@ -389,19 +389,19 @@ END
     end
 
 
-    topic '#run_action!()' do
+    topic '#run_action_anyway()' do
 
       spec "[!2yrc2] invokes action even if already invoked." do
         sout, serr = capture_sio() do
-          @action.run_action!("test3:foo:invoke3", "Alice", lang: "fr")
+          @action.run_action_anyway("test3:foo:invoke3", "Alice", lang: "fr")
         end
         ok {sout} == "Bonjour, Alice!\n"
         sout, serr = capture_sio() do
-          @action.run_action!("test3:foo:invoke3", "Alice", lang: "fr")
+          @action.run_action_anyway("test3:foo:invoke3", "Alice", lang: "fr")
         end
         ok {sout} == "Bonjour, Alice!\n"
         sout, serr = capture_sio() do
-          @action.run_action!("test3:foo:invoke3", "Alice", lang: "en")
+          @action.run_action_anyway("test3:foo:invoke3", "Alice", lang: "en")
         end
         ok {sout} == "Hello, Alice!\n"
       end
@@ -510,10 +510,10 @@ END
 
       spec "[!1qv12] @action is a Proc object and saves args." do
         class InheritedTest2 < Benry::CmdApp::ActionScope
-          @action.("description", detail: "xxx", postamble: "yyy", important: true, tag: "zzz")
+          @action.("description", detail: "xxx", postamble: "yyy", important: true, tag: "zzz", hidden: false)
         end
         x = InheritedTest2.instance_variable_get('@__action__')
-        ok {x} == ["description", {detail: "xxx", postamble: "yyy", important: true, tag: "zzz"}]
+        ok {x} == ["description", {detail: "xxx", postamble: "yyy", important: true, tag: "zzz", hidden: false}]
       end
 
       spec "[!33ma7] @option is a Proc object and saves args." do

data/test/app_test.rb

@@ -1013,8 +1013,8 @@ END
         class HiddenTest < Benry::CmdApp::ActionScope
           private
           @action.("hidden test")
-          @option.(:_trace, "-T", "enable tracing")
-          def hidden1(_trace: false)
+          @option.(:trace, "-T", "enable tracing", hidden: true)
+          def hidden1(trace: false)
           end
         end
         #

data/test/help_test.rb

@@ -84,7 +84,7 @@ END
 
       spec "[!8b02e] ignores '[<options>]' in 'Usage:' when only hidden options speicified." do
         schema = new_schema(lang: false)
-        schema.add(:_lang, "-l, --lang=<en|fr|it>", "language")
+        schema.add(:lang, "-l, --lang=<en|fr|it>", "language", hidden: true)
         msg = new_metadata(schema).help_message("testapp")
         msg = uncolorize(msg)
         ok {msg} =~ /^  \$ testapp halo1 \[<user>\]\n/
@@ -116,7 +116,7 @@ END
 
       spec "[!hghuj] ignores 'Options:' section when only hidden options speicified." do
         schema = new_schema(lang: false)
-        schema.add(:_lang, "-l, --lang=<en|fr|it>", "language")  # hidden option
+        schema.add(:lang, "-l, --lang=<en|fr|it>", "language", hidden: true)  # hidden option
         msg = new_metadata(schema).help_message("testapp")
         msg = uncolorize(msg)
         ok {msg}.NOT.include?("Options:\n")
@@ -125,7 +125,7 @@ END
       spec "[!vqqq1] hidden option should be shown in weak format." do
         schema = new_schema(lang: false)
         schema.add(:file , "-f, --file=<file>", "filename")
-        schema.add(:_lang, "-l, --lang=<lang>", "language")  # hidden option
+        schema.add(:lang, "-l, --lang=<lang>", "language", hidden: true)  # hidden option
         msg = new_metadata(schema).help_message("testapp", true)
         ok {msg}.end_with?(<<"END")
 \e[34mOptions:\e[0m
@@ -436,7 +436,7 @@ END
         @config.option_debug = false
         app = Benry::CmdApp::Application.new(@config)
         schema = app.instance_variable_get('@schema')
-        schema.add(:_log, "-L", "private option")
+        schema.add(:log, "-L", "private option", hidden: true)
         msg = app.help_message()
         msg = uncolorize(msg)
         ok {msg} !~ /^  -L /
@@ -454,7 +454,7 @@ END
         @config.option_debug = false
         app = Benry::CmdApp::Application.new(@config)
         schema = app.instance_variable_get('@schema')
-        schema.add(:_log, "-L", "private option")
+        schema.add(:log, "-L", "private option", hidden: true)
         msg = app.help_message(true)
         msg = uncolorize(msg)
         ok {msg} =~ /^  -L /
@@ -477,7 +477,7 @@ END
 
       spec "[!p1tu9] prints option in weak format if option is hidden." do
         |app3|
-        app3.schema.add(:_log, "-L", "private option")   # !!!
+        app3.schema.add(:log, "-L", "private option", hidden: true)   # !!!
         msg = app3.help_message(true)
         ok {msg}.include?(<<END)
 \e[34mOptions:\e[0m
@@ -494,7 +494,7 @@ END
         @config.option_debug = false
         app = Benry::CmdApp::Application.new(@config)
         schema = app.instance_variable_get('@schema')
-        schema.add(:_log, "-L", "private option")
+        schema.add(:log, "-L", "private option", hidden: true)
         msg = app.help_message()
         msg = uncolorize(msg)
         ok {msg} !~ /^Options:$/

data/test/util_test.rb

@@ -47,7 +47,7 @@ Oktest.scope do
 
       spec "[!c4ljy] returns true if schema contains only private (hidden) options." do
         sc = Benry::CmdOpt::Schema.new
-        sc.add(:_help, "-h", "help")
+        sc.add(:help, "-h", "help", hidden: true)
         ok {Benry::CmdApp::Util.schema_empty?(sc)} == true
         sc.add(:version, "-V", "version")
         ok {Benry::CmdApp::Util.schema_empty?(sc)} == false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benry-cmdapp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - kwatch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benry-cmdopt
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: oktest
   requirement: !ruby/object:Gem::Requirement