add new interact method: select

Author: inhere

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 inhere
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

_examples/cliapp.go

@@ -13,22 +13,27 @@ import (
 func main() {
 	runtime.GOMAXPROCS(runtime.NumCPU())
 
-	app := cliapp.NewApp()
+	app := cliapp.NewApp(func(a *cliapp.Application) {
+		a.Hooks[cliapp.EvtInit] = func(a *cliapp.Application, data interface{}) {
+			// do something...
+			// fmt.Println("init app")
+		}
+	})
 	app.Version = "1.0.6"
 	app.Description = "this is my cli application"
 
 	// app.SetVerbose(cliapp.VerbDebug)
 	// app.DefaultCommand("example")
-	app.Hooks[cliapp.EvtInit] = func(app *cliapp.Application, data interface{}) {
-		// do something...
-	}
 
 	app.Add(cmd.ExampleCommand())
 	app.Add(cmd.EnvInfoCommand())
 	app.Add(cmd.GitCommand())
 	app.Add(cmd.ColorCommand())
+	app.Add(cmd.ShowDemoCommand(), cmd.InteractDemoCommand())
+
 	app.Add(filewatcher.FileWatcher(nil))
 	app.Add(reverseproxy.ReverseProxyCommand())
+
 	app.Add(&cliapp.Command{
 		Name:        "test",
 		Aliases:     []string{"ts"},

_examples/cmd/example.go

@@ -64,16 +64,18 @@ func ExampleCommand() *cliapp.Command {
 func exampleExecute(c *cliapp.Command, args []string) int {
 	fmt.Print("hello, in example command\n")
 
-	color.Magentaln("All options:")
+	magentaln := color.Magenta.Println
+
+	magentaln("All options:")
 	fmt.Printf("%+v\n", exampleOpts)
-	color.Magentaln("Raw args:")
+	magentaln("Raw args:")
 	fmt.Printf("%v\n", args)
 
-	color.Magentaln("Get arg by name:")
+	magentaln("Get arg by name:")
 	arr := c.Arg("arrArg")
 	fmt.Printf("named array arg '%s', value: %v\n", arr.Name, arr.Value)
 
-	color.Magentaln("All named args:")
+	magentaln("All named args:")
 	for _, arg := range c.Args() {
 		fmt.Printf("named arg '%s': %+v\n", arg.Name, *arg)
 	}

_examples/cmd/interact_demo.go

@@ -0,0 +1,74 @@
+package cmd
+
+import (
+	"github.com/gookit/cliapp"
+	"github.com/gookit/cliapp/interact"
+	"github.com/gookit/color"
+)
+
+// InteractDemoCommand create
+func InteractDemoCommand() *cliapp.Command {
+	c := &cliapp.Command{
+		Name: "interact",
+		Func: interactDemo,
+		// Aliases: []string{"im"}
+		Description: "the command will show some interactive methods",
+		Examples: `{$fullCmd} confirm
+  {$fullCmd} select
+`,
+		Help: `Supported interactive methods:
+answerIsYes 	check user answer is Yes
+confirm 		confirm message
+select			select one from multi options
+`,
+	}
+
+	c.AddArg("name", "want running interact method name", true)
+	return c
+}
+
+var funcMap = map[string]func(c *cliapp.Command){
+	"select":      demoSelect,
+	"confirm":     demoConfirm,
+	"answerIsYes": demoAnswerIsYes,
+}
+
+func interactDemo(c *cliapp.Command, _ []string) int {
+	name := c.Arg("name").String()
+	if handler, ok := funcMap[name]; ok {
+		handler(c)
+	} else {
+		return c.Errorf("want run unknown demo method: %s", name)
+	}
+
+	return 0
+}
+
+func demoSelect(_ *cliapp.Command) {
+	// s := interact.NewSelect("Your city", []string{"chengdu", "beijing", "shanghai"})
+	// s.DefOpt = "2"
+	// val := s.Run()
+	// color.Comment.Println("your select is: ", val.String())
+
+	ans := interact.QuickSelect(
+		"Your city name(use array)?",
+		[]string{"chengdu", "beijing", "shanghai"},
+		"",
+	)
+	color.Comment.Println("your select is: ", ans)
+
+	ans = interact.QuickSelect(
+		"Your city name(use map)?",
+		map[string]string{"a":"chengdu", "b":"beijing", "c":"shanghai"},
+		"a",
+	)
+	color.Comment.Println("your select is: ", ans)
+}
+
+func demoConfirm(_ *cliapp.Command) {
+
+}
+
+func demoAnswerIsYes(_ *cliapp.Command) {
+
+}

_examples/cmd/show_demo.go

@@ -0,0 +1,20 @@
+package cmd
+
+import "github.com/gookit/cliapp"
+
+// ShowDemoCommand create
+func ShowDemoCommand() *cliapp.Command {
+	c := &cliapp.Command{
+		Name: "show",
+		Func: runShow,
+		//
+		Description: "the command will show some data format methods",
+	}
+
+	return c
+}
+
+func runShow(c *cliapp.Command, _ []string) int {
+
+	return 0
+}

_examples/servermanager/commands.go

@@ -6,7 +6,6 @@ import (
 	"os/exec"
 	"github.com/gookit/color"
 	"fmt"
-	"os"
 )
 
 type Config struct {
@@ -76,7 +75,7 @@ func stopServer() int {
 	command := exec.Command("kill", string(bs))
 	command.Start()
 
-	color.Successln("server stopped")
+	color.Success.Println("server stopped")
 	return 0
 }
 

app.go

@@ -34,11 +34,12 @@ const (
 	EvtError  = "error"
 )
 
-// OK success code
-const OK = 0
-
-// ERR error code
-const ERR = 2
+const (
+	// OK success exit code
+	OK = 0
+	// ERR error exit code
+	ERR = 2
+)
 
 // Logo app logo, ASCII logo
 type Logo struct {
@@ -118,36 +119,33 @@ func Verbose() uint {
 }
 
 // NewApp create new app.
-// The settings (name, version, description)
 // eg:
-// 	cliapp.NewApp("cli app", "1.0.1", "The is is my cil application")
-func NewApp(settings ...string) *Application {
+// 	cliapp.NewApp()
+// 	cliapp.NewApp(func(a *Application) {
+//		// do something before init ....
+// 		a.Hooks[cliapp.EvtInit] = func () {}
+// 	})
+func NewApp(fn ...func(a *Application)) *Application {
 	app = &Application{
-		Name: "My CLI Application",
-		Logo: Logo{Style: "info"},
+		Name:  "My CLI Application",
+		Logo:  Logo{Style: "info"},
+		Hooks: make(map[string]appHookFunc, 0),
 		// set a default version
 		Version: "1.0.0",
 	}
 
-	for k, v := range settings {
-		switch k {
-		case 0:
-			app.Name = v
-		case 1:
-			app.Version = v
-		case 2:
-			app.Description = v
-		}
+	if len(fn) > 0 {
+		fn[0](app)
 	}
 
 	// init
-	app.initialize()
+	app.Initialize()
 
 	return app
 }
 
 // initialize application
-func (app *Application) initialize() {
+func (app *Application) Initialize() {
 	app.pid = os.Getpid()
 	app.names = make(map[string]int)
 
@@ -158,7 +156,6 @@ func (app *Application) initialize() {
 		"binName": binName,
 	}
 
-	app.Hooks = make(map[string]appHookFunc, 0)
 	app.callHook(EvtInit, nil)
 }
 
@@ -232,8 +229,8 @@ func (app *Application) callHook(event string, data interface{}) {
 	}
 }
 
-// AddHook handler for a hook event
-func (app *Application) AddHook(name string, handler func(*Application, interface{})) {
+// On add hook handler for a hook event
+func (app *Application) On(name string, handler func(a *Application, data interface{})) {
 	app.Hooks[name] = handler
 }
 

app_help.go

@@ -29,7 +29,7 @@ Use "<cyan>{$binName} {command} -h</>" for more information about a command
 func (app *Application) showVersionInfo() {
 	fmt.Printf(
 		"%s\n\nVersion: %s\n",
-		utils.UpperFirst(app.Description),
+		utils.UcFirst(app.Description),
 		color.ApplyTag("cyan", app.Version),
 	)
 	Exit(OK)
@@ -38,17 +38,17 @@ func (app *Application) showVersionInfo() {
 // display app commands help
 func (app *Application) showCommandsHelp() {
 	commandsHelp = color.ReplaceTag(commandsHelp)
+	// render help text template
 	str := utils.RenderTemplate(commandsHelp, map[string]interface{}{
 		"Cs": commands,
 		// app version
 		"Version": app.Version,
 		// always upper first char
-		"Description": utils.UpperFirst(app.Description),
+		"Description": utils.UcFirst(app.Description),
 	}, false)
 
-	// parse help vars
-	str = replaceVars(str, app.vars)
-	fmt.Print(color.RenderStr(str))
+	// parse help vars and render color tags
+	fmt.Print(color.RenderStr(replaceVars(str, app.vars)))
 	Exit(OK)
 }
 

builtin/filewatcher/file_watcher.go

@@ -54,7 +54,7 @@ func FileWatcher(handler func(event fsnotify.Event)) *cliapp.Command {
 // test run:
 // go run ./_examples/cliapp.go watch -e .git -e .idea -d ./_examples
 func watch(c *cliapp.Command, _ []string) int {
-	color.Infoln("Work directory: ", c.WorkDir())
+	color.Info.Println("Work directory: ", c.WorkDir())
 
 	if opts.Dir == "" && len(opts.Files) == 0 {
 		return c.Errorf("watched directory or files cannot be empty")

builtin/gen_auto_complete.go

@@ -66,7 +66,7 @@ func GenAutoCompleteScript() *cliapp.Command {
 	return &c
 }
 
-func doGen(_ *cliapp.Command, _ []string) int {
+func doGen(c *cliapp.Command, _ []string) int {
 	if len(genOpts.binName) == 0 {
 		genOpts.binName = cliapp.BinName()
 	}
@@ -103,22 +103,21 @@ func doGen(_ *cliapp.Command, _ []string) int {
 
 	str := utils.RenderTemplate(shellTpls[genOpts.shell], &data)
 
-	color.Infoln("Now, will write content to file ", genOpts.output)
-	color.Normal("Continue?")
+	color.Info.Println("Now, will write content to file ", genOpts.output)
+	color.Normal.Print("Continue?")
 
 	if !interact.AnswerIsYes(true) {
-		color.Info("\nBye :)\n")
+		color.Info.Print("\nBye :)\n")
 		return 0
 	}
 
 	// 以读写方式打开文件，如果不存在，则创建
 	err := ioutil.WriteFile(genOpts.output, []byte(str), 0664)
 	if err != nil {
-		color.Errorln("Write file error: ", err.Error())
-		return -2
+		return c.Errorf("Write file error: %s", err.Error())
 	}
 
-	color.Sucln("\nOK, auto-complete file generate successful")
+	color.Success.Println("\nOK, auto-complete file generate successful")
 	return 0
 }
 

builtin/tcpproxy/tcp_proxy.go

@@ -7,6 +7,7 @@ import (
 
 // ref links:
 // https://www.jianshu.com/p/53e219fbf3c5
+// https://github.com/yangxikun/gsproxy
 type TCPProxy struct {
 	lock sync.Mutex
 }

cmd.go

@@ -103,7 +103,7 @@ func (c *Command) Runnable() bool {
 // Init command
 func (c *Command) Init() *Command {
 	if len(c.Description) > 0 {
-		c.Description = utils.UpperFirst(c.Description)
+		c.Description = utils.UcFirst(c.Description)
 
 		// contains help var "{$cmd}". replace on here is for 'app help'
 		if strings.Contains(c.Description, "{$cmd}") {
@@ -112,7 +112,8 @@ func (c *Command) Init() *Command {
 	}
 
 	// set help vars
-	c.Vars = c.app.vars
+	// c.Vars = c.app.vars // Error: var is map, map is ref addr
+	c.AddVars(c.app.vars)
 	c.AddVars(map[string]string{
 		"cmd": c.Name,
 		// full command
@@ -218,6 +219,11 @@ func (c *Command) Copy() *Command {
 	return &nc
 }
 
+// On add hook handler for a hook event
+func (c *Command) On(name string, handler func(c *Command, data interface{})) {
+	c.Hooks[name] = handler
+}
+
 /*************************************************************
  * alone running
  *************************************************************/