benry-cmdapp 0.2.0 → 1.0.0

data/test/func_test.rb

@@ -1,9 +1,8 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
-require 'oktest'
 
-require 'benry/cmdapp'
-require_relative './shared'
+require_relative "shared"
 
 
 Oktest.scope do
@@ -12,125 +11,346 @@ Oktest.scope do
   topic Benry::CmdApp do
 
 
-    topic '.delete_action()' do
+    topic '.define_alias()' do
 
-      spec "[!era7d] deletes action." do
-        class DeleteAction2Test < Benry::CmdApp::ActionScope
-          @action.("test")
-          def delaction2(); end
-        end
+      spec "[!zawcd] action arg can be a string or an array of string." do
+        pr = proc { Benry::CmdApp.define_alias("a4983-1", "hello") }
+        ok {pr}.NOT.raise?(Exception)
+        pr = proc { Benry::CmdApp.define_alias("a4983-2", ["hello", "-l", "it"]) }
+        ok {pr}.NOT.raise?(Exception)
+        md = Benry::CmdApp.define_alias("a4983-3", ["hello", "-l", "it"])
+        ok {md.name}   == "a4983-3"
+        ok {md.action} == "hello"
+        ok {md.args}   == ["-l", "it"]
+      end
+
+      spec "[!hqc27] raises DefinitionError if something error exists in alias or action." do
+        pr = proc { Benry::CmdApp.define_alias("hello2", "hello1") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q=define_alias("hello2", "hello1"): Action 'hello1' not found.=)
+      end
+
+      spec "[!oo91b] registers new metadata of alias." do
+        metadata = Benry::CmdApp::REGISTRY.metadata_get("tmphello1")
+        ok {metadata} == nil
+        Benry::CmdApp.define_alias("tmphello1", "hello")
+        metadata = Benry::CmdApp::REGISTRY.metadata_get("tmphello1")
+        ok {metadata} != nil
+        ok {metadata}.is_a?(Benry::CmdApp::AliasMetadata)
+        ok {metadata.name} == "tmphello1"
+        ok {metadata.action} == "hello"
+        ok {metadata.args} == []
         #
-        pr = proc {
-          class DeleteAction2Test
-            @action.("test")
-            def delaction2(); end
-          end
+        Benry::CmdApp.define_alias("tmphello2", ["hello", "aa", "bb", "cc"])
+        metadata = Benry::CmdApp::REGISTRY.metadata_get("tmphello2")
+        ok {metadata.args} == ["aa", "bb", "cc"]
+      end
+
+      spec "[!wfbqu] returns alias metadata." do
+        ret = Benry::CmdApp.define_alias("tmphello3", "hello")
+        ok {ret}.is_a?(Benry::CmdApp::AliasMetadata)
+        ok {ret.name} == "tmphello3"
+        ok {ret.action} == "hello"
+      end
+
+    end
+
+
+    topic '.__validate_alias_and_action()' do
+
+      spec "[!2x1ew] returns error message if alias name is not a string." do
+        pr = proc { Benry::CmdApp.define_alias(:a4869, "hello") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|define_alias(:a4869, "hello"): Alias name should be a string, but got Symbol object.|)
+      end
+
+      spec "[!galce] returns error message if action name is not a string." do
+        pr = proc { Benry::CmdApp.define_alias("a8680", :hello) }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|define_alias("a8680", :hello): Action name should be a string, but got Symbol object.|)
+      end
+
+      spec "[!zh0a9] returns error message if other alias already exists." do
+        pr = proc { Benry::CmdApp.define_alias("tmphello4", "hello") }
+        ok {pr}.NOT.raise?(Exception)
+        pr = proc { Benry::CmdApp.define_alias("tmphello4", "hello") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|define_alias("tmphello4", "hello"): Alias 'tmphello4' already defined.|)
+      end
+
+      spec "[!ohow0] returns error message if other action exists with the same name as alias." do
+        pr = proc { Benry::CmdApp.define_alias("testerr1", "hello") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|define_alias("testerr1", "hello"): Can't define new alias 'testerr1' because already defined as an action.|)
+      end
+
+      spec "[!r24qn] returns error message if action doesn't exist." do
+        pr = proc { Benry::CmdApp.define_alias("tmphello6", "hello99") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|define_alias("tmphello6", "hello99"): Action 'hello99' not found.|)
+      end
+
+      spec "[!lxolh] returns error message if action is an alias name." do
+        Benry::CmdApp.define_alias("tmphello6x", "hello")
+        pr = proc { Benry::CmdApp.define_alias("tmphello6y", "tmphello6x") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|define_alias("tmphello6y", "tmphello6x"): 'tmphello6x' should be an action, but is an alias.|)
+      end
+
+      spec "[!b6my2] returns nil if no errors found." do
+        x = Benry::CmdApp.class_eval {
+          __validate_alias_and_action("tmphello7", "hello")
         }
-        ok {pr}.raise?(Benry::CmdApp::ActionDefError,
-                       "def delaction2(): Action 'delaction2' already exist.")
+        ok {x} == nil
         #
-        Benry::CmdApp.delete_action("delaction2")
+        pr = proc { Benry::CmdApp.define_alias("tmphello7", "hello") }
         ok {pr}.NOT.raise?(Exception)
       end
 
-      spec "[!ifaj1] raises error if action not exist." do
-        pr = proc { Benry::CmdApp.delete_action("delaction91") }
-        ok {pr}.raise?(Benry::CmdApp::ActionNotFoundError,
-                      "delete_action(\"delaction91\"): Action not found.")
+    end
+
+
+    topic '.undef_alias()' do
+
+      spec "[!pk3ya] raises DefinitionError if alias name is not a string." do
+        pr = proc { Benry::CmdApp.undef_alias(:hello) }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|`:hello`: Alias name should be a string, but got Symbol object.|)
+      end
+
+      spec "[!krdkt] raises DefinitionError if alias not exist." do
+        pr = proc { Benry::CmdApp.undef_alias("tmphello8") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|undef_alias("tmphello8"): Alias not exist.|)
+      end
+
+      spec "[!juykx] raises DefinitionError if action specified instead of alias." do
+        pr = proc { Benry::CmdApp.undef_alias("hello") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       %q|undef_alias("hello"): Alias expected but action name specified.|)
+      end
+
+      spec "[!ocyso] deletes existing alias." do
+        Benry::CmdApp.define_alias("tmphello9", "hello")
+        Benry::CmdApp.undef_alias("tmphello9")
       end
 
     end
 
 
-    topic '.delete_alias()' do
+    topic '.undef_action()' do
+
+      spec "[!bcyn3] raises DefinitionError if action name is not a string." do
+        pr = proc { Benry::CmdApp.undef_action(:hello) }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       "`:hello`: Action name should be a string, but got Symbol object.")
+      end
+
+      spec "[!bvu95] raises error if action not exist." do
+        pr = proc { Benry::CmdApp.undef_action("hello99") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       "undef_action(\"hello99\"): Action not exist.")
+      end
+
+      spec "[!717fw] raises error if alias specified instead of action." do
+        Benry::CmdApp.define_alias("tmphello21", "hello")
+        pr = proc { Benry::CmdApp.undef_action("tmphello21") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                       "undef_action(\"tmphello21\"): Action expected but alias name specified.")
+      end
 
-      spec "[!9g0x9] deletes alias." do
-        class DeleteAlias2Test < Benry::CmdApp::ActionScope
-          @action.("test")
-          def delalias2(); end
+      spec "[!01sx1] deletes existing action." do
+        MyAction.class_eval do
+          @action.("dummy")
+          def dummy2049()
+          end
         end
-        Benry::CmdApp.action_alias("delali2", "delalias2")
-        #
-        pr = proc {
-          Benry::CmdApp.action_alias("delali2", "delalias2")
-        }
-        ok {pr}.raise?(Benry::CmdApp::AliasDefError,
-                       "action_alias(\"delali2\", \"delalias2\"): Alias name duplicated.")
-        #
-        Benry::CmdApp.delete_alias("delali2")
-        ok {pr}.NOT.raise?(Exception)
+        ok {Benry::CmdApp::REGISTRY.metadata_get("dummy2049")} != nil
+        Benry::CmdApp.undef_action("dummy2049")
+        ok {Benry::CmdApp::REGISTRY.metadata_get("dummy2049")} == nil
       end
 
-      spec "[!r49vi] raises error if alias not exist." do
-        pr = proc { Benry::CmdApp.delete_alias("delalias91") }
-        ok {pr}.raise?(Benry::CmdApp::ActionNotFoundError,
-                      "delete_alias(\"delalias91\"): Alias not found.")
+      spec "[!op8z5] deletes action method from action class." do
+        MyAction.class_eval do
+          @action.("dummy")
+          def dummy4290()
+          end
+        end
+        ok {MyAction.method_defined?(:dummy4290)} == true
+        Benry::CmdApp.undef_action("dummy4290")
+        ok {MyAction.method_defined?(:dummy4290)} == false
+        #
+        MyAction.class_eval do
+          private
+          category "p8902:" do
+            @action.("dummy")
+            def dummy9024()
+            end
+          end
+        end
+        ok {MyAction.private_method_defined?(:p8902__dummy9024)} == true
+        Benry::CmdApp.undef_action("p8902:dummy9024")
+        ok {MyAction.private_method_defined?(:p8902__dummy9024)} == false
       end
 
     end
 
 
-    topic '.action_alias()' do
+    topic '.define_abbrev()' do
+
+      spec "[!e1fob] raises DefinitionError if error found." do
+        pr = proc { Benry::CmdApp.define_abbrev(:foo, "git:") }
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError,
+                      ":foo: Abbreviation should be a string, but got Symbol object.")
+      end
+
+      spec "[!ed6hr] registers abbrev with prefix." do
+        ok { Benry::CmdApp::REGISTRY.abbrev_exist?("g99:") } == false
+        Benry::CmdApp.define_abbrev("g99:", "git:")
+        ok { Benry::CmdApp::REGISTRY.abbrev_exist?("g99:") } == true
+        ok { Benry::CmdApp::REGISTRY.abbrev_get_prefix("g99:") } == "git:"
+      end
+
+      def _perform(abbrev, prefix)
+        pr = proc { Benry::CmdApp.define_abbrev(abbrev, prefix) }
+        errmsg = nil
+        ok {pr}.raise?(Benry::CmdApp::DefinitionError) do |exc|
+          errmsg = exc.message
+        end
+        return errmsg
+      end
+
+      spec "[!qfzbp] abbrev should be a string." do
+        ok {_perform(:g11, "git:")} == ":g11: Abbreviation should be a string, but got Symbol object."
+      end
+
+      spec "[!f5isx] abbrev should end with ':'." do
+        ok {_perform("g12", "git:")} == "'g12': Abbreviation should end with ':'."
+      end
+
+      spec "[!r673p] abbrev should not contain unexpected symbol." do
+        ok {_perform("g13@:", "git:")} == "'g13@:': Invalid abbreviation."
+      end
+
+      spec "[!dckvt] abbrev should not exist." do
+        Benry::CmdApp.define_abbrev("g14:", "git:")
+        ok {_perform("g14:", "git:")} == "'g14:': Abbreviation is already defined."
+      end
+
+      spec "[!5djjt] abbrev should not be the same name with existing prefix." do
+        ok {_perform("git:", "git:")} == "'git:': Abbreviation is not available because a prefix with the same name already exists."
+      end
+
+      spec "[!mq4ki] prefix should be a string." do
+        ok {_perform("g15:", :"git:")} == ":\"git:\": Prefix should be a string, but got Symbol object."
+      end
 
-      class Alias1Test < Benry::CmdApp::ActionScope
-        prefix "alias1"
-        @action.("alias test")
-        def a1(); end
-        @action.("alias test")
-        def a2(); end
+      spec "[!a82z3] prefix should end with ':'." do
+        ok {_perform("g16:", "git")} == "'git': Prefix should end with ':'."
       end
 
-      spec "[!vzlrb] registers alias name with action name." do
-        Benry::CmdApp.action_alias("a4", "alias1:a1")
-        ok {Benry::CmdApp::INDEX.alias_exist?("a4")} == true
-        ok {Benry::CmdApp::INDEX.get_alias("a4").alias_name} == "a4"
-        ok {Benry::CmdApp::INDEX.get_alias("a4").action_name} == "alias1:a1"
+      spec "[!eq5iu] prefix should exist." do
+        ok {_perform("g17:", "gittt:")} == "'gittt:': No such prefix."
       end
 
-      spec "[!0cq6o] supports args." do
-        Benry::CmdApp.action_alias("a8", "alias1:a1", "Alice", "-l", "it")
-        ok {Benry::CmdApp::INDEX.alias_exist?("a8")} == true
-        ok {Benry::CmdApp::INDEX.get_alias("a8").alias_name} == "a8"
-        ok {Benry::CmdApp::INDEX.get_alias("a8").action_name} == "alias1:a1"
-        ok {Benry::CmdApp::INDEX.get_alias("a8").args} == ["Alice", "-l", "it"]
+      spec "[!jzkhc] returns nil if no error found." do
+        ok {Benry::CmdApp.define_abbrev("g18:", "git:")} == nil
       end
 
-      spec "[!4wtxj] supports 'tag:' keyword arg." do
-        Benry::CmdApp.action_alias("a7", "alias1:a1", tag: :important)
-        ok {Benry::CmdApp::INDEX.alias_exist?("a7")} == true
-        ok {Benry::CmdApp::INDEX.get_alias("a7").action_name} == "alias1:a1"
-        ok {Benry::CmdApp::INDEX.get_alias("a7").tag} == :important
+    end
+
+
+    topic '.current_app()' do
+
+      spec "[!xdjce] returns current application." do
+        app = Benry::CmdApp::Application.new(Benry::CmdApp::Config.new(""))
+        Benry::CmdApp._set_current_app(app)
+        ok {Benry::CmdApp.current_app()}.same?(app)
       end
 
-      spec "[!5immb] convers both alias name and action name into string." do
-        Benry::CmdApp.action_alias(:a5, :'alias1:a2')
-        ok {Benry::CmdApp::INDEX.alias_exist?("a5")} == true
-        ok {Benry::CmdApp::INDEX.get_alias("a5").alias_name} == "a5"
-        ok {Benry::CmdApp::INDEX.get_alias("a5").action_name} == "alias1:a2"
+    end
+
+
+    topic '._set_current_app()' do
+
+      spec "[!1yqwl] sets current application." do
+        app = Benry::CmdApp::Application.new(Benry::CmdApp::Config.new(""))
+        Benry::CmdApp._set_current_app(app)
+        ok {Benry::CmdApp.current_app()}.same?(app)
+        Benry::CmdApp._set_current_app(nil)
+        ok {Benry::CmdApp.current_app()} == nil
       end
 
-      spec "[!nrz3d] error if action not found." do
-        pr = proc { Benry::CmdApp.action_alias(:a5, :'alias1:a5') }
-        ok {pr}.raise?(Benry::CmdApp::AliasDefError,
-                       "action_alias(:a5, :\"alias1:a5\"): Action not found.")
+    end
+
+
+    topic '.main()' do
+
+      spec "[!6mfxt] accepts the same arguments as 'Config#initialize()'." do
+        ARGV.clear()
+        ARGV.push("-h", "-a")
+        at_end { ARGV.clear() }
+        sout, serr = capture_sio do
+          Benry::CmdApp.main("Sample App", "1.2.0", app_command: "sampleapp", option_verbose: true)
+        end
+        ok {serr} == ""
+        ok {sout}.start_with?(<<END)
+sampleapp (1.2.0) --- Sample App
+END
+        ok {sout} =~ /^      --debug        : debug mode$/
       end
 
-      spec "[!vvmwd] error when action with same name as alias exists." do
-        pr = proc { Benry::CmdApp.action_alias(:'alias1:a2', :'alias1:a1') }
-        ok {pr}.raise?(Benry::CmdApp::AliasDefError,
-                       "action_alias(:\"alias1:a2\", :\"alias1:a1\"): Not allowed to define same name alias as existing action.")
+      spec "[!scpwa] runs application." do
+        ARGV.clear()
+        ARGV.push("-h", "-a")
+        at_end { ARGV.clear() }
+        sout, serr = capture_sio do
+          Benry::CmdApp.main("Sample App", "1.2.0", app_command: "sampleapp", option_verbose: true)
+        end
+        ok {serr} == ""
+        ok {sout}.start_with?(<<END)
+sampleapp (1.2.0) --- Sample App
+
+Usage:
+  $ sampleapp [<options>] <action> [<arguments>...]
+
+Options:
+  -h, --help         : print help message (of action if specified)
+  -V, --version      : print version
+  -l, --list         : list actions and aliases
+  -L <topic>         : topic list (actions|aliases|categories|abbrevs)
+  -a, --all          : list hidden actions/options, too
+  -v, --verbose      : verbose mode
+      --debug        : debug mode
+
+Actions:
+END
       end
 
-      spec "[!i9726] error if alias already defined." do
-        pr1 = proc { Benry::CmdApp.action_alias(:'a6', :'alias1:a1') }
-        pr2 = proc { Benry::CmdApp.action_alias(:'a6', :'alias1:a2') }
-        ok {pr1}.NOT.raise?(Exception)
-        ok {pr2}.raise?(Benry::CmdApp::AliasDefError,
-                        "action_alias(:a6, :\"alias1:a2\"): Alias name duplicated.")
+      spec "[!jbv9z] returns the status code." do
+        ARGV.clear()
+        ARGV.push("-h", "-a")
+        at_end { ARGV.clear() }
+        status_code = nil
+        #
+        sout, serr = capture_sio do
+          status_code = Benry::CmdApp.main("Sample App", "1.2.0")
+        end
+        ok {serr} == ""
+        ok {status_code} == 0
+        #
+        ARGV.clear()
+        ARGV.push("--blabla")
+        sout, serr = capture_sio do
+          status_code = Benry::CmdApp.main("Sample App", "1.2.0")
+        end
+        ok {serr} == "[ERROR] --blabla: Unknown long option.\n"
+        ok {status_code} == 1
       end
 
     end
 
+
   end