cliapp 0.1.0

data/test/module_test.rb

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+
+require_relative './init'
+
+
+Oktest.scope do
+
+
+  topic CLIApp do
+
+
+    topic '.new()' do
+
+      fixture :app do
+        CLIApp.new("Sample", "Sample App", command: "sample", version: "1.2.3")
+      end
+
+      spec "[!gpvqe] creates new Config object internally." do
+        |app|
+        ok {app.config.name}    == "Sample"
+        ok {app.config.desc}    == "Sample App"
+        ok {app.config.command} == "sample"
+        ok {app.config.version} == "1.2.3"
+      end
+
+      spec "[!qyunk] creates new Application object with config object created." do
+        |app|
+        ok {app}.is_a?(CLIApp::Application)
+        ok {app.config}.is_a?(CLIApp::Config)
+      end
+
+    end
+
+
+    topic '.skeleton()' do
+
+      GLOBAL_HELP = <<'END'
+Sample (1.0.0) --- Sample Application
+
+Usage:
+  $ tmp.sample [<options>] <action> [<arguments>...]
+
+Options:
+  -h, --help             print help message
+      --version          print version number
+  -l, --list             list action names
+
+Actions:
+  clean                  delete garbage files (& product files too if '-a')
+  hello                  greeting message
+END
+
+      HELLO_HELP = <<'END'
+tmp.sample hello --- greeting message
+
+Usage:
+  $ tmp.sample hello [<options>] [<name>]
+
+Options:
+  -l, --lang=<en|fr|it>  language
+END
+
+      spec "[!zls9g] returns example code." do
+        str = CLIApp.skeleton()
+        ok {str}.is_a?(String)
+        filename = "tmp.sample"
+        dummy_file(filename, str)
+        #
+        sout, serr = capture_command "ruby #{filename} --help"
+        ok {serr} == ""
+        ok {sout} == GLOBAL_HELP
+        #
+        sout, serr = capture_command "ruby #{filename} hello --help"
+        ok {serr} == ""
+        ok {sout} == HELLO_HELP
+        #
+        sout, serr = capture_command "ruby #{filename} hello"
+        ok {serr} == ""
+        ok {sout} == "Hello, world!\n"
+        sout, serr = capture_command "ruby #{filename} hello Alice --lang=fr"
+        ok {serr} == ""
+        ok {sout} == "Bonjour, Alice!\n"
+      end
+
+    end
+
+  end
+
+
+end

data/test/util_test.rb

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+
+require_relative './init'
+
+
+Oktest.scope do
+
+
+  topic CLIApp::Util do
+
+
+    topic '#arity_of_proc()' do
+
+      spec "[!get6i] returns min and max arity of proc object." do
+        pr1 = proc {|a, b, c=nil, d=nil, x: nil, y: nil| nil }
+        ok {CLIApp::Util.arity_of_proc(pr1)} == [2, 4]
+        pr2 = proc {|a=nil, b=nil| nil }
+        ok {CLIApp::Util.arity_of_proc(pr2)} == [0, 2]
+        pr3 = proc { nil }
+        ok {CLIApp::Util.arity_of_proc(pr3)} == [0, 0]
+      end
+
+      spec "[!ghrxo] returns nil as max arity if proc has variable param." do
+        pr1 = proc {|a, b, c=nil, d=nil, *e, x: nil, y: nil| nil }
+        ok {CLIApp::Util.arity_of_proc(pr1)} == [2, nil]
+        pr2 = proc {|a=nil, b=nil, *c| nil }
+        ok {CLIApp::Util.arity_of_proc(pr2)} == [0, nil]
+      end
+
+    end
+
+
+    topic '#argstr_of_proc()' do
+
+      spec "[!gbk7b] generates argument string of proc object." do
+        pr1 = proc {|aa, bb, cc=nil, dd=nil, x: nil, y: nil| nil }
+        ok {CLIApp::Util.argstr_of_proc(pr1)} == " <aa> <bb> [<cc> [<dd>]]"
+      end
+
+      spec "[!b6gzp] required param should be '<param>'." do
+        pr1 = proc {|aa, bb| nil }
+        ok {CLIApp::Util.argstr_of_proc(pr1)} == " <aa> <bb>"
+      end
+
+      spec "[!q1030] optional param should be '[<param>]'." do
+        pr1 = proc {|aa=nil, bb=nil| nil }
+        ok {CLIApp::Util.argstr_of_proc(pr1)} == " [<aa> [<bb>]]"
+      end
+
+      spec "[!osxwq] variable param should be '[<param>...]'." do
+        pr1 = proc {|aa, bb=nil, *cc| nil }
+        ok {CLIApp::Util.argstr_of_proc(pr1)} == " <aa> [<bb> [<cc>...]]"
+      end
+
+    end
+
+
+    topic '#param2argname()' do
+
+      spec "[!52dzl] converts 'yes_or_no' to 'yes|no'." do
+        ok {CLIApp::Util.param2argname("yes_or_no")} == "yes|no"
+      end
+
+      spec "[!6qkk6] converts 'file__html' to 'file.html'." do
+        ok {CLIApp::Util.param2argname("file__html")} == "file.html"
+      end
+
+      spec "[!2kbhe] converts 'aa_bb_cc' to 'aa-bb-cc'." do
+        ok {CLIApp::Util.param2argname("aa_bb_cc")} == "aa-bb-cc"
+      end
+
+    end
+
+
+  end
+
+
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: cliapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kwatch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oktest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 'A small framework for CLI Applications such as Git, Docker, NPM, etc.
+
+  '
+email: kwatch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile.rb
+- cliapp.gemspec
+- lib/cliapp.rb
+- task/common-task.rb
+- task/release-task.rb
+- test/action_test.rb
+- test/application_test.rb
+- test/init.rb
+- test/module_test.rb
+- test/util_test.rb
+homepage: https://github.com/kwatch/cliapp-ruby
+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.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: CLI Application Framework
+test_files:
+- test/module_test.rb
+- test/util_test.rb
+- test/action_test.rb
+- test/application_test.rb