benry-cmdapp 0.2.0 → 1.0.0

data/test/metadata_test.rb

@@ -0,0 +1,191 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+
+require_relative 'shared'
+
+
+Oktest.scope do
+
+
+  topic Benry::CmdApp::BaseMetadata do
+
+  end
+
+
+  topic Benry::CmdApp::ActionMetadata do
+
+    topic '#hidden?()' do
+
+      spec "[!stied] returns true/false if `hidden:` kwarg provided." do
+        args = ["hello", "Hello", nil, MyAction, :hello]
+        md = Benry::CmdApp::ActionMetadata.new(*args, hidden: true)
+        ok {md.hidden?} == true
+        md = Benry::CmdApp::ActionMetadata.new(*args, hidden: false)
+        ok {md.hidden?} == false
+      end
+
+      spec "[!eumhz] returns true/false if method is private or not." do
+        args = ["hello", "Hello", nil, MyAction, :hello]
+        md = Benry::CmdApp::ActionMetadata.new(*args)
+        ok {md.hidden?} == false
+        MyAction.class_eval { private :hello }
+        at_end { MyAction.class_eval { public :hello } }
+        ok {md.hidden?} == true
+      end
+
+    end
+
+
+    topic '#option_empty?()' do
+
+      spec "[!14xgg] returns true if the action has no options." do
+        schema = Benry::CmdApp::ACTION_OPTION_SCHEMA_CLASS.new
+        args = ["hello", "Hello", schema, MyAction, :hello]
+        md = Benry::CmdApp::ActionMetadata.new(*args)
+        ok {md.option_empty?} == true
+      end
+
+      spec "[!dbtht] returns false if the action has at least one option." do
+        schema = Benry::CmdApp::ACTION_OPTION_SCHEMA_CLASS.new
+        schema.add(:verbose, "-v", "verbose")
+        args = ["hello", "Hello", schema, MyAction, :hello]
+        md = Benry::CmdApp::ActionMetadata.new(*args)
+        ok {md.option_empty?} == false
+      end
+
+      spec "[!wa315] considers hidden options if `all: true` passed." do
+        schema = Benry::CmdApp::ACTION_OPTION_SCHEMA_CLASS.new
+        schema.add(:debug, "-D", "debug", hidden: true)
+        args = ["hello", "Hello", schema, MyAction, :hello]
+        md = Benry::CmdApp::ActionMetadata.new(*args)
+        ok {md.option_empty?(all: false)} == true
+        ok {md.option_empty?(all: true)} == false
+      end
+
+    end
+
+
+    topic '#option_help()' do
+
+      before do
+        schema = Benry::CmdApp::ACTION_OPTION_SCHEMA_CLASS.new
+        schema.add(:lang, "-l <lang>", "language")
+        schema.add(:color, "--color[=<on|off>]", "color mode", type: TrueClass)
+        schema.add(:debug, "--debug", "debug mode", hidden: true)
+        args = ["hello", "Hello", schema, MyAction, :hello]
+        @metadata = Benry::CmdApp::ActionMetadata.new(*args)
+      end
+
+      spec "[!bpkwn] returns help message string of the action." do
+        ok {@metadata.option_help("  %-15s : %s")} == <<"END"
+  -l <lang>       : language
+  --color[=<on|off>] : color mode
+END
+      end
+
+      spec "[!76hni] includes hidden options in help message if `all:` is truthy." do
+        ok {@metadata.option_help("  %-15s : %s", all: true)} == <<"END"
+  -l <lang>       : language
+  --color[=<on|off>] : color mode
+  --debug         : debug mode
+END
+      end
+
+    end
+
+
+    topic '#parse_options()' do
+
+      before do
+        schema = Benry::CmdApp::ACTION_OPTION_SCHEMA_CLASS.new
+        schema.add(:lang, "-l <lang>", "language")
+        schema.add(:color, "--color[=<on|off>]", "color mode", type: TrueClass)
+        schema.add(:debug, "--debug", "debug mode", hidden: true)
+        args = ["hello", "Hello", schema, MyAction, :hello]
+        @metadata = Benry::CmdApp::ActionMetadata.new(*args)
+      end
+
+      spec "[!gilca] returns parsed options." do
+        args = ["-len", "--color=on", "Alice"]
+        opts = @metadata.parse_options(args)
+        ok {opts} == {:lang=>"en", :color=>true}
+        ok {args} == ["Alice"]
+      end
+
+      spec "[!v34yk] raises OptionError if option has error." do
+        args = ["--lang=en", "--color=on", "Alice"]
+        pr = proc { @metadata.parse_options(args) }
+        ok {pr}.raise?(Benry::CmdApp::OptionError,
+                       "--lang=en: Unknown long option.")
+      end
+
+    end
+
+
+    topic '#alias?()' do
+
+      spec "[!c1eq3] returns false which means that this is not an alias metadata." do
+        schema = Benry::CmdApp::ACTION_OPTION_SCHEMA_CLASS.new
+        args = ["hello", "Hello", schema, MyAction, :hello]
+        metadata = Benry::CmdApp::ActionMetadata.new(*args)
+        ok {metadata.alias?} == false
+      end
+
+    end
+
+
+  end
+
+
+  topic Benry::CmdApp::AliasMetadata do
+
+
+    topic '#initialize()' do
+
+      spec "[!qtb61] sets description string automatically." do
+        metadata = Benry::CmdApp::AliasMetadata.new("a9344", "hello", nil)
+        ok {metadata.desc} == "alias for 'hello'"
+      end
+
+      spec "[!kgic6] includes args value into description if provided." do
+        metadata = Benry::CmdApp::AliasMetadata.new("a1312", "hello", ["aa", "bb"])
+        ok {metadata.desc} == "alias for 'hello aa bb'"
+      end
+
+    end
+
+
+    topic '#alias?()' do
+
+      spec "[!c798o] returns true which means that this is an alias metadata." do
+        metadata = Benry::CmdApp::AliasMetadata.new("a2041", "hello", nil)
+        ok {metadata.alias?} == true
+      end
+
+    end
+
+
+    topic '#name_with_args()' do
+
+      spec "[!6kjuv] returns alias name if no args." do
+        metadata = Benry::CmdApp::AliasMetadata.new("a1549", "hello", nil)
+        ok {metadata.name_with_args} == "a1549"
+        metadata = Benry::CmdApp::AliasMetadata.new("a1549", "hello", [])
+        ok {metadata.name_with_args} == "a1549"
+      end
+
+      spec "[!d4xrb] returns alias name and args as combined." do
+        metadata = Benry::CmdApp::AliasMetadata.new("a1549", "hello", ["x"])
+        ok {metadata.name_with_args} == "a1549 (with 'x')"
+        metadata = Benry::CmdApp::AliasMetadata.new("a1549", "hello", ["x", "y"])
+        ok {metadata.name_with_args} == "a1549 (with 'x y')"
+      end
+
+    end
+
+
+  end
+
+
+end

data/test/misc_test.rb

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+
+require_relative 'shared'
+
+
+Oktest.scope do
+
+
+  topic Benry::CmdApp::BaseError do
+
+
+    topic '#should_report_backtrace?()' do
+
+      spec "[!oj9x3] returns true in base exception class to report backtrace." do
+        exc = Benry::CmdApp::BaseError.new("")
+        ok {exc.should_report_backtrace?()} == true
+      end
+
+    end
+
+
+  end
+
+
+  topic Benry::CmdApp::OptionError do
+
+
+    topic '#should_report_backtrace?()' do
+
+      spec "[!6qvnc] returns false in OptionError class because no need to report backtrace." do
+        exc = Benry::CmdApp::OptionError.new("")
+        ok {exc.should_report_backtrace?()} == false
+      end
+
+    end
+
+
+  end
+
+
+  topic Benry::CmdApp::CommandError do
+
+
+    topic '#should_report_backtrace?()' do
+
+      spec "[!o9xu2] returns false in ComamndError class because no need to report backtrace." do
+        exc = Benry::CmdApp::CommandError.new("")
+        ok {exc.should_report_backtrace?()} == false
+      end
+
+    end
+
+
+  end
+
+
+  topic Benry::CmdApp::ActionOptionSchema do
+
+
+    topic '#initialize()' do
+
+    end
+
+  end
+
+
+  topic Benry::CmdApp::OptionParser do
+
+
+    topic '#parse()' do
+
+      spec "[!iaawe] raises OptionError if option error found." do
+        schema = Benry::CmdApp::ActionOptionSchema.new()
+        schema.add(:help, "-h, --help", "help message")
+        parser = Benry::CmdApp::OptionParser.new(schema)
+        pr = proc { parser.parse(["-x", "foo"]) }
+        ok {pr}.raise?(Benry::CmdApp::OptionError,
+                       "-x: Unknown option.")
+      end
+
+    end
+
+  end
+
+
+  topic Benry::CmdApp::OptionSet do
+
+    before do
+      @optset = Benry::CmdApp::OptionSet.new
+      @schema = Benry::CmdApp::OptionSchema.new
+      @schema.add(:user , "-u, --user=<user>"  , "user name")
+      @schema.add(:email, "-e, --email=<email>", "email address")
+      @schema.add(:port , "-p, --port=<number>", "port number", type: Integer)
+    end
+
+
+    topic '#copy_from()' do
+
+      spec "[!d9udc] copy option items from schema." do
+        items = []
+        @schema.each {|item| items << item }
+        #
+        @optset.copy_from(@schema)
+        new_items = @optset.instance_variable_get(:@items)
+        ok {new_items}.length(3)
+        ok {new_items[0]} == items[0]
+        ok {new_items[1]} == items[1]
+        ok {new_items[2]} == items[2]
+      end
+
+      spec "[!v1ok3] returns self." do
+        ok {@optset.copy_from(@schema)}.same?(@optset)
+      end
+
+    end
+
+
+    topic '#copy_into()' do
+
+      spec "[!n00r1] copy option items into schema." do
+        @optset.copy_from(@schema)
+        new_schema = Benry::CmdApp::OptionSchema.new
+        @optset.copy_into(new_schema)
+        new_items = []
+        new_schema.each {|item| new_items << item }
+        items = @optset.instance_variable_get(:@items)
+        ok {new_items}.length(3)
+        ok {new_items[0]} == items[0]
+        ok {new_items[1]} == items[1]
+        ok {new_items[2]} == items[2]
+      end
+
+      spec "[!ynn1m] returns self." do
+        @optset.copy_from(@schema)
+        new_schema = Benry::CmdApp::OptionSchema.new
+        ok {@optset.copy_into(new_schema)}.same?(@optset)
+      end
+
+    end
+
+
+    topic '#select()' do
+
+      spec "[!mqkzf] creates new OptionSet object with filtered options." do
+        @optset.copy_from(@schema)
+        newone = @optset.select(:user, :email)
+        ok {newone}.is_a?(Benry::CmdApp::OptionSet)
+        items = newone.instance_variable_get(:@items)
+        ok {items}.length(2)
+        ok {items.collect(&:key).sort} == [:email, :user]
+      end
+
+    end
+
+
+    topic '#exclude()' do
+
+      spec "[!oey0q] creates new OptionSet object with remained options." do
+        @optset.copy_from(@schema)
+        newone = @optset.exclude(:user, :email)
+        ok {newone}.is_a?(Benry::CmdApp::OptionSet)
+        items = newone.instance_variable_get(:@items)
+        ok {items}.length(1)
+        ok {items.collect(&:key).sort} == [:port]
+      end
+
+    end
+
+
+  end
+
+
+end