benry-cmdapp 0.1.0

data/test/index_test.rb

@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+
+require 'oktest'
+
+require 'benry/cmdapp'
+require_relative './shared'
+
+
+Oktest.scope do
+
+
+  topic Benry::CmdApp::ActionIndex do
+    include CommonTestingHelper
+
+    class IndexTestAction < Benry::CmdApp::ActionScope
+      @action.("lookup test #1")
+      @option.(:repeat, "-r <N>", "repeat", type: Integer)
+      def lookup1(user="world", repeat: nil); end
+      #
+      @action.("lookup test #2")
+      def lookup2(); end
+      #
+      private
+      @action.("lookup test #3")   # hidden
+      def lookup3(); end
+    end
+
+    Benry::CmdApp.action_alias("findxx", "lookup2")
+
+
+    topic '.lookup_action()' do
+
+      spec "[!vivoa] returns action metadata object." do
+        x = Benry::CmdApp::INDEX.lookup_action("lookup1")
+        ok {x} != nil
+        ok {x}.is_a?(Benry::CmdApp::ActionMetadata)
+        ok {x.name} == "lookup1"
+        ok {x.klass} == IndexTestAction
+        ok {x.method} == :lookup1
+      end
+
+      spec "[!tnwq0] supports alias name." do
+        x = Benry::CmdApp::INDEX.lookup_action("findxx")
+        ok {x} != nil
+        ok {x}.is_a?(Benry::CmdApp::ActionMetadata)
+        ok {x.name} == "lookup2"
+        ok {x.klass} == IndexTestAction
+        ok {x.method} == :lookup2
+      end
+
+      spec "[!z15vu] returns ActionWithArgs object if alias has args and/or kwargs." do
+        Benry::CmdApp.action_alias("findyy1", "lookup1", "Alice", "-r3")
+        x = Benry::CmdApp::INDEX.lookup_action("findyy1")
+        ok {x} != nil
+        ok {x}.is_a?(Benry::CmdApp::ActionWithArgs)
+        ok {x.args} == ["Alice"]
+        ok {x.kwargs} == {repeat: 3}
+        ok {x.name} == "lookup1"
+        ok {x.klass} == IndexTestAction
+        ok {x.method} == :lookup1
+      end
+
+    end
+
+
+    topic '.each_action_name_and_desc()' do
+
+      before do
+        clear_index_except(IndexTestAction)
+      end
+
+      after do
+        restore_index()
+      end
+
+      spec "[!5lahm] yields action name, description, and important flag." do
+        arr = []
+        Benry::CmdApp::INDEX.each_action_name_and_desc(false) {|a| arr << a }
+        ok {arr} == [
+          ["lookup1", "lookup test #1", nil],
+          ["lookup2", "lookup test #2", nil],
+        ]
+        #
+        with_important("lookup1"=>true, "lookup2"=>false) do
+          arr = []
+          Benry::CmdApp::INDEX.each_action_name_and_desc(false) {|a| arr << a }
+          ok {arr} == [
+            ["lookup1", "lookup test #1", true],
+            ["lookup2", "lookup test #2", false],
+          ]
+        end
+      end
+
+      spec "[!27j8b] includes alias names when the first arg is true." do
+        arr = []
+        Benry::CmdApp::INDEX.each_action_name_and_desc(true) {|a| arr << a }
+        ok {arr} == [
+          ["findxx", "alias of 'lookup2' action", nil],
+          ["findyy1", "alias of 'lookup1 Alice -r3'", nil],
+          ["lookup1", "lookup test #1", nil],
+          ["lookup2", "lookup test #2", nil],
+        ]
+      end
+
+      spec "[!8xt8s] rejects hidden actions if 'all: false' kwarg specified." do
+        arr = []
+        Benry::CmdApp::INDEX.each_action_name_and_desc(false, all: false) {|a| arr << a }
+        ok {arr} == [
+          ["lookup1", "lookup test #1", nil],
+          ["lookup2", "lookup test #2", nil],
+        ]
+      end
+
+      spec "[!5h7s5] includes hidden actions if 'all: true' kwarg specified." do
+        arr = []
+        Benry::CmdApp::INDEX.each_action_name_and_desc(false, all: true) {|a| arr << a }
+        ok {arr} == [
+          ["lookup1", "lookup test #1", nil],
+          ["lookup2", "lookup test #2", nil],
+          ["lookup3", "lookup test #3", false],   # hidden action
+        ]
+      end
+
+      spec "[!arcia] action names are sorted." do
+        arr = []
+        Benry::CmdApp::INDEX.each_action_name_and_desc(true) {|a| arr << a }
+        ok {arr} == arr.sort_by(&:first)
+      end
+
+    end
+
+
+    topic '#delete_action()' do
+
+      spec "[!08e1s] unregisters action." do
+        class DeleteActionTest < Benry::CmdApp::ActionScope
+          @action.("test")
+          def delaction1(); end
+        end
+        name = "delaction1"
+        ok {Benry::CmdApp::INDEX.action_exist?(name)} == true
+        Benry::CmdApp::INDEX.delete_action(name)
+        ok {Benry::CmdApp::INDEX.action_exist?(name)} == false
+      end
+
+      spec "[!zjpq0] raises error if action not registered." do
+        name = "delaction99"
+        ok {Benry::CmdApp::INDEX.action_exist?(name)} == false
+        pr = proc { Benry::CmdApp::INDEX.delete_action(name) }
+        ok {pr}.raise?(Benry::CmdApp::ActionNotFoundError,
+                       "delete_action(\"delaction99\"): Action not found.")
+      end
+
+    end
+
+
+    topic '#delete_alias()' do
+
+      spec "[!8ls45] unregisters alias." do
+        class DeleteAliasTest < Benry::CmdApp::ActionScope
+          @action.("test")
+          def delalias1(); end
+        end
+        Benry::CmdApp.action_alias("delali1", "delalias1")
+        name = "delali1"
+        ok {Benry::CmdApp::INDEX.alias_exist?(name)} == true
+        Benry::CmdApp::INDEX.delete_alias(name)
+        ok {Benry::CmdApp::INDEX.alias_exist?(name)} == false
+      end
+
+      spec "[!fdfyq] raises error if alias not registered." do
+        name = "delalias99"
+        ok {Benry::CmdApp::INDEX.alias_exist?(name)} == false
+        pr = proc { Benry::CmdApp::INDEX.delete_alias(name) }
+        ok {pr}.raise?(Benry::CmdApp::ActionNotFoundError,
+                       "delete_alias(\"delalias99\"): Alias not found.")
+      end
+
+    end
+
+
+  end
+
+
+end

data/test/run_all.rb

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+
+Dir.glob(File.dirname(__FILE__) + '/*.rb').each do |filename|
+#$stderr.puts "\033[0;31m*** debug: filename=#{filename.inspect}\033[0m"
+  require_relative File.basename(filename)
+end

data/test/shared.rb

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+
+
+module CommonTestingHelper
+
+  def uncolorize(str)
+    return str.gsub(/\e\[.*?m/, '')
+  end
+
+  def without_tty(&block)
+    result = nil
+    capture_sio(tty: false) { result = yield }
+    return result
+  end
+
+  def with_tty(&block)
+    result = nil
+    capture_sio(tty: true) { result = yield }
+    return result
+  end
+
+  def with_important(keyval={}, &block)
+    bkup = {}
+    keyval.each do |name, val|
+      action = Benry::CmdApp::INDEX.get_action(name)
+      bkup[name] = action.important
+      action.instance_variable_set('@important', val)
+    end
+    begin
+      yield
+    ensure
+      bkup.each do |name, val|
+        action = Benry::CmdApp::INDEX.get_action(name)
+        action.instance_variable_set('@important', val)
+      end
+    end
+  end
+
+  module_function
+
+  def clear_index_except(klass)
+    actions = Benry::CmdApp::INDEX.instance_variable_get('@actions')
+    aliases = Benry::CmdApp::INDEX.instance_variable_get('@aliases')
+    @_bkup_actions = actions.dup()
+    actions.delete_if {|_, x| x.klass != klass }
+    anames = actions.keys()
+    @_bkup_aliases = aliases.dup()
+    aliases.delete_if {|_, x| ! anames.include?(x.action_name) }
+  end
+
+  def restore_index()
+    actions = Benry::CmdApp::INDEX.instance_variable_get('@actions')
+    aliases = Benry::CmdApp::INDEX.instance_variable_get('@aliases')
+    actions.update(@_bkup_actions)
+    aliases.update(@_bkup_aliases)
+  end
+
+end
+
+
+module ActionMetadataTestingHelper
+  include CommonTestingHelper
+
+  def new_schema(lang: true)
+    schema = Benry::Cmdopt::Schema.new
+    schema.add(:lang, "-l, --lang=<en|fr|it>", "language") if lang
+    return schema
+  end
+
+  def new_metadata(schema, meth=:halo1, **kwargs)
+    metadata = Benry::CmdApp::ActionMetadata.new(meth.to_s, MetadataTestAction, meth, "greeting", schema, **kwargs)
+    return metadata
+  end
+
+end

data/test/util_test.rb

@@ -0,0 +1,189 @@
+# -*- coding: utf-8 -*-
+
+require 'oktest'
+
+require 'benry/cmdapp'
+require_relative './shared'
+
+
+Oktest.scope do
+
+
+  topic Benry::CmdApp::Util do
+
+
+    topic '.hidden_name?()' do
+
+      spec "[!fcfic] returns true if name is '_foo'." do
+        ok {Benry::CmdApp::Util.hidden_name?("_foo")} == true
+      end
+
+      spec "[!po5co] returns true if name is '_foo:bar'." do
+        ok {Benry::CmdApp::Util.hidden_name?("_foo:bar")} == true
+      end
+
+      spec "[!9iqz3] returns true if name is 'foo:_bar'." do
+        ok {Benry::CmdApp::Util.hidden_name?("foo:_bar")} == true
+      end
+
+      spec "[!mjjbg] returns false if else." do
+        ok {Benry::CmdApp::Util.hidden_name?("foo")} == false
+        ok {Benry::CmdApp::Util.hidden_name?("foo_")} == false
+        ok {Benry::CmdApp::Util.hidden_name?("foo_:bar")} == false
+        ok {Benry::CmdApp::Util.hidden_name?("foo:bar_")} == false
+      end
+
+    end
+
+
+    topic '.schema_empty?()' do
+
+      spec "[!8t5ju] returns true if schema empty." do
+        sc = Benry::CmdOpt::Schema.new
+        ok {Benry::CmdApp::Util.schema_empty?(sc)} == true
+        sc.add(:help, "-h", "help")
+        ok {Benry::CmdApp::Util.schema_empty?(sc)} == false
+      end
+
+      spec "[!c4ljy] returns true if schema contains only private (hidden) options." do
+        sc = Benry::CmdOpt::Schema.new
+        sc.add(:_help, "-h", "help")
+        ok {Benry::CmdApp::Util.schema_empty?(sc)} == true
+        sc.add(:version, "-V", "version")
+        ok {Benry::CmdApp::Util.schema_empty?(sc)} == false
+      end
+
+    end
+
+
+    topic '.method2action()' do
+
+      spec "[!801f9] converts action name 'aa_bb_cc_' into 'aa_bb_cc'." do
+        ok {Benry::CmdApp::Util.method2action("aa_")} == "aa"
+        ok {Benry::CmdApp::Util.method2action("_aa_")} == "_aa"
+      end
+
+      spec "[!9pahu] converts action name 'aa__bb__cc' into 'aa:bb:cc'." do
+        ok {Benry::CmdApp::Util.method2action("aa__bb__cc")} == "aa:bb:cc"
+      end
+
+      spec "[!7a1s7] converts action name 'aa_bb:_cc_dd' into 'aa-bb:_cc-dd'." do
+        ok {Benry::CmdApp::Util.method2action("aa_bb:cc_dd")} == "aa-bb:cc-dd"
+        ok {Benry::CmdApp::Util.method2action("aa_bb:_cc_dd")} == "aa-bb:_cc-dd"
+        ok {Benry::CmdApp::Util.method2action("aa___bb")} == "aa:_bb"
+      end
+
+    end
+
+
+    topic '.colorize?()' do
+
+      spec "[!801y1] returns $COLOR_MODE value if it is not nil." do
+        bkup = $COLOR_MODE
+        begin
+          $COLOR_MODE = true
+          ok {Benry::CmdApp::Util.colorize?()} == true
+          $COLOR_MODE = false
+          ok {Benry::CmdApp::Util.colorize?()} == false
+        ensure
+          $COLOR_MODE = bkup
+        end
+      end
+
+      spec "[!0harg] returns true if stdout is a tty." do
+        capture_sio(tty: true) {
+          ok {Benry::CmdApp::Util.colorize?()} == true
+        }
+      end
+
+      spec "[!u1j1x] returns false if stdout is not a tty." do
+        capture_sio(tty: false) {
+          ok {Benry::CmdApp::Util.colorize?()} == false
+        }
+      end
+
+    end
+
+
+    topic '.del_escape_seq()' do
+
+      spec "[!wgp2b] deletes escape sequence." do
+        s = "  \e[1m%-18s\e[0m : %s"
+        ok {Benry::CmdApp::Util.del_escape_seq(s)} == "  %-18s : %s"
+      end
+
+    end
+
+
+    topic '._important?()' do
+
+      spec "[!0yz2h] returns nil if tag == nil." do
+        ok {Benry::CmdApp::Util._important?(nil)} == nil
+      end
+
+      spec "[!h5pid] returns true if tag == :important." do
+        ok {Benry::CmdApp::Util._important?(:important)} == true
+        ok {Benry::CmdApp::Util._important?("important")} == true
+      end
+
+      spec "[!7zval] returns false if tag == :unimportant." do
+        ok {Benry::CmdApp::Util._important?(:unimportant)} == false
+        ok {Benry::CmdApp::Util._important?("unimportant")} == false
+      end
+
+      spec "[!z1ygi] supports nested tag." do
+        ok {Benry::CmdApp::Util._important?([:important, :foo])} == true
+        ok {Benry::CmdApp::Util._important?([:bar, :unimportant])} == false
+      end
+
+    end
+
+
+    topic '.format_help_line()' do
+
+      fixture :format do
+        "  [[%-10s]] : %s"
+      end
+
+      spec "[!xx1vj] if `important == nil` then format help line with no decoration." do
+        |format|
+        s = Benry::CmdApp::Util.format_help_line(format, "<action>", "<desc>", nil)
+        ok {s} == "  [[<action>  ]] : <desc>"
+      end
+
+      spec "[!oaxp1] if `important == true` then format help line with strong decoration." do
+        |format|
+        s = Benry::CmdApp::Util.format_help_line(format, "<action>", "<desc>", true)
+        ok {s} == "  [[\e[4m<action>\e[0m  ]] : <desc>"
+      end
+
+      spec "[!bdhh6] if `important == false` then format help line with weak decoration." do
+        |format|
+        s = Benry::CmdApp::Util.format_help_line(format, "<action>", "<desc>", false)
+        ok {s} == "  [[\e[2m<action>\e[0m  ]] : <desc>"
+      end
+
+    end
+
+
+    topic '.fill_with_decoration()' do
+
+      spec "[!udrbj] returns decorated string with padding by white spaces." do
+        format = "  [[%-10s]] : %s"
+        s = Benry::CmdApp::Util.fill_with_decoration(format, "<action>") {|s| "\e[1m#{s}\e[0m" }
+        ok {s} == "\e[1m<action>\e[0m  "
+      end
+
+      spec "[!7bl2b] considers minus sign in format." do
+        format = "  [[%10s]] : %s"
+        s = Benry::CmdApp::Util.fill_with_decoration(format, "<action>") {|s| "\e[1m#{s}\e[0m" }
+        ok {s} == "  \e[1m<action>\e[0m"
+      end
+
+    end
+
+
+  end
+
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: benry-cmdapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kwatch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benry-cmdopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: oktest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: |
+  Benry-CmdApp is a framework to create command-line application
+  like `git`, `docker`, or `npm` commands.
+
+  If you want create a command-line application which takes sub-commands,
+  Benry-CmdApp is the solution.
+
+  See https://kwatch.github.io/benry-ruby/benry-cmdapp.html for details.
+email: kwatch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGES.md
+- MIT-LICENSE
+- README.md
+- benry-cmdapp.gemspec
+- doc/benry-cmdapp.html
+- doc/css/style.css
+- lib/benry/cmdapp.rb
+- test/action_test.rb
+- test/app_test.rb
+- test/func_test.rb
+- test/help_test.rb
+- test/index_test.rb
+- test/run_all.rb
+- test/shared.rb
+- test/util_test.rb
+homepage: https://kwatch.github.io/benry-ruby/benry-cmdapp.html
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Command-line application framework`
+test_files:
+- test/action_test.rb
+- test/app_test.rb
+- test/func_test.rb
+- test/help_test.rb
+- test/index_test.rb
+- test/util_test.rb