Merge pull request #306 from essentialkaos/develop

Version 12.37.0

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 12.37.0
+
+* `[strutil]` Added helper `Q` for working with default values
+* `[usage]` Added color customization for application name and version
+
 ### 12.36.0
 
 * `[system]` Added CPU architecture bits info to `SystemInfo`

ek.go

@@ -19,7 +19,7 @@ import (
 // ////////////////////////////////////////////////////////////////////////////////// //
 
 // VERSION is current ek package version
-const VERSION = "12.36.0"
+const VERSION = "12.37.0"
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 

strutil/example_test.go

@@ -13,6 +13,16 @@ import (
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
+func ExampleQ() {
+	var defaultValue = "john"
+	var user = ""
+
+	fmt.Println(Q(user, defaultValue))
+
+	// Output:
+	// john
+}
+
 func ExampleConcat() {
 	fmt.Println(Concat("abc", " ", "123", " ", "ABC"))
 

strutil/strutil.go

@@ -24,6 +24,17 @@ var defaultFieldsSeparators = []string{" ", "\t"}
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
+// Q is simple helper for working with default values
+func Q(v ...string) string {
+	for _, k := range v {
+		if k != "" {
+			return k
+		}
+	}
+
+	return ""
+}
+
 // Concat is method for fast string concatenation
 func Concat(s ...string) string {
 	var buffer bytes.Buffer

strutil/strutil_test.go

@@ -25,6 +25,12 @@ var _ = Suite(&StrUtilSuite{})
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
+func (s *StrUtilSuite) TestQ(c *C) {
+	c.Assert(Q(), Equals, "")
+	c.Assert(Q("a"), Equals, "a")
+	c.Assert(Q("", "", "1"), Equals, "1")
+}
+
 func (s *StrUtilSuite) TestConcat(c *C) {
 	s1 := "abcdef"
 	s2 := "123456"

usage/example_test.go

@@ -23,6 +23,9 @@ func ExampleAbout_Render() {
 		Year:    2009,    // Year when company was founded
 		License: "MIT",
 		Owner:   "John Dow <john@domain.com>",
+
+		AppNameColorTag: "{r*}", // Use custom color for application name
+		VersionColorTag: "{r}",  // Use custom color for application version
 	}
 
 	about.Render()

usage/usage.go

@@ -32,6 +32,15 @@ const _BREADCRUMBS_MIN_SIZE = 8
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 
+const (
+	DEFAULT_COMMANDS_COLOR_TAG = "{y}"
+	DEFAULT_OPTIONS_COLOR_TAG  = "{g}"
+	DEFAULT_APP_NAME_COLOR_TAG = "{c*}"
+	DEFAULT_APP_VER_COLOR_TAG  = "{c}"
+)
+
+// ////////////////////////////////////////////////////////////////////////////////// //
+
 // About contains info about application
 type About struct {
 	App        string // App is application name
@@ -44,14 +53,17 @@ type About struct {
 	Owner      string // Owner is name of owner (company/developer)
 	BugTracker string // BugTracker is URL of bug tracker
 
+	AppNameColorTag string // AppNameColorTag contains default app name color tag
+	VersionColorTag string // AppNameColorTag contains default app version color tag
+
 	// Function for checking application updates
 	UpdateChecker UpdateChecker
 }
 
 // Info contains info about commands, options, and examples
 type Info struct {
-	CommandsColorTag string // CommandsColor contains default commands color
-	OptionsColorTag  string // OptionsColor contains default options color
+	CommandsColorTag string // CommandsColor contains default commands color tag
+	OptionsColorTag  string // OptionsColor contains default options color tag
 	Breadcrumbs      bool   // Use bread crumbs for commands and options output
 
 	Name    string
@@ -105,16 +117,14 @@ func NewInfo(args ...string) *Info {
 		args = args[1:]
 	}
 
-	if name == "" {
-		name = filepath.Base(os.Args[0])
-	}
+	name = strutil.Q(name, filepath.Base(os.Args[0]))
 
 	info := &Info{
 		Name: name,
 		Args: args,
 
-		CommandsColorTag: "{y}",
-		OptionsColorTag:  "{g}",
+		CommandsColorTag: DEFAULT_COMMANDS_COLOR_TAG,
+		OptionsColorTag:  DEFAULT_OPTIONS_COLOR_TAG,
 		Breadcrumbs:      true,
 	}
 
@@ -273,16 +283,19 @@ func (i *Info) Render() {
 
 // Render prints version info to console
 func (a *About) Render() {
+	nc := strutil.Q(a.AppNameColorTag, DEFAULT_APP_NAME_COLOR_TAG)
+	vc := strutil.Q(a.VersionColorTag, DEFAULT_APP_VER_COLOR_TAG)
+
 	switch {
 	case a.Build != "":
 		fmtc.Printf(
-			"\n{*c}%s {c}%s{!}{s}%s{!} {s-}(%s){!} - %s\n\n",
+			"\n"+nc+"%s{!} "+vc+"%s{!}{s}%s{!} {s-}(%s){!} - %s\n\n",
 			a.App, a.Version,
 			a.Release, a.Build, a.Desc,
 		)
 	default:
 		fmtc.Printf(
-			"\n{*c}%s {c}%s{!}{s}%s{!} - %s\n\n",
+			"\n"+nc+"%s{!} "+vc+"%s{!}{s}%s{!} - %s\n\n",
 			a.App, a.Version,
 			a.Release, a.Desc,
 		)