up: update some comments and add more unit tests

Author: inhere

color_rgb.go

@@ -57,6 +57,7 @@ type RGBColor [4]uint8
 var emptyRGBColor = RGBColor{3: 99}
 
 // RGB color create.
+//
 // Usage:
 // 	c := RGB(30,144,255)
 // 	c := RGB(30,144,255, true)
@@ -106,15 +107,14 @@ func HEX(hex string, isBg ...bool) RGBColor {
 // Hex alias of the HEX()
 func Hex(hex string, isBg ...bool) RGBColor { return HEX(hex, isBg...) }
 
+// RGBFromHEX quick RGBColor from hex string, alias of HEX()
+func RGBFromHEX(hex string, isBg ...bool) RGBColor { return HEX(hex, isBg...) }
+
 // HSL create RGB color from a hsl value.
 // more see HslToRgb()
 func HSL(h, s, l float64, isBg ...bool) RGBColor {
-	if rgb := HslToRgb(h, s, l); len(rgb) > 0 {
-		return RGB(rgb[0], rgb[1], rgb[2], isBg...)
-	}
-
-	// mark is empty
-	return emptyRGBColor
+	rgb := HslToRgb(h, s, l)
+	return RGB(rgb[0], rgb[1], rgb[2], isBg...)
 }
 
 // Hsl alias of the HSL()
@@ -123,12 +123,8 @@ func Hsl(h, s, l float64, isBg ...bool) RGBColor { return HSL(h, s, l, isBg...)
 // HSLInt create RGB color from a hsl int value.
 // more see HslIntToRgb()
 func HSLInt(h, s, l int, isBg ...bool) RGBColor {
-	if rgb := HslIntToRgb(h, s, l); len(rgb) > 0 {
-		return RGB(rgb[0], rgb[1], rgb[2], isBg...)
-	}
-
-	// mark is empty
-	return emptyRGBColor
+	rgb := HslIntToRgb(h, s, l)
+	return RGB(rgb[0], rgb[1], rgb[2], isBg...)
 }
 
 // HslInt alias of the HSLInt()
@@ -140,7 +136,7 @@ func RGBFromSlice(rgb []uint8, isBg ...bool) RGBColor {
 }
 
 // RGBFromString create RGB color from a string.
-// support use color name in the {namedRgbMap}
+// Support use color name in the {namedRgbMap}
 //
 // Usage:
 // 	c := RGBFromString("170,187,204")
@@ -278,13 +274,13 @@ func (c RGBColor) C16() Color { return c.Basic() }
  * RGB Style
  *************************************************************/
 
-// RGBStyle definition.
+// RGBStyle supports set foreground and background color
 //
-// Foreground/Background color
 // All are composed of 4 digits uint8, the first three digits are the color value;
 // The last bit is different from RGBColor, here it indicates whether the value is set.
-// - 1  Has been set
-// - ^1 Not set
+//
+// 	1    Has been set
+// 	^1   Not set
 type RGBStyle struct {
 	// Name of the style
 	Name string
@@ -305,6 +301,7 @@ func NewRGBStyle(fg RGBColor, bg ...RGBColor) *RGBStyle {
 }
 
 // HEXStyle create a RGBStyle from HEX color string.
+//
 // Usage:
 // 	s := HEXStyle("aabbcc", "eee")
 // 	s.Print("message")
@@ -317,11 +314,11 @@ func HEXStyle(fg string, bg ...string) *RGBStyle {
 	if len(fg) > 0 {
 		s.SetFg(HEX(fg))
 	}
-
 	return s
 }
 
 // RGBStyleFromString create a RGBStyle from color value string.
+//
 // Usage:
 // 	s := RGBStyleFromString("170,187,204", "70,87,4")
 // 	s.Print("message")

color_rgb_test.go

@@ -64,6 +64,18 @@ func TestRGBColor(t *testing.T) {
 	is.Equal("\x1b[38;2;204;204;204mmsg\x1b[0m\n", str)
 }
 
+func TestRGBColor_set_reset(t *testing.T) {
+	_, err := Reset()
+	assert.NoError(t, err)
+
+	c := RGBFromHEX("6256CC")
+
+	assert.NoError(t, c.Set())
+	fmt.Println("a message on True color set.")
+	assert.NoError(t, c.Reset())
+	fmt.Println()
+}
+
 func TestRGBFromString(t *testing.T) {
 	forceOpenColorRender()
 	defer resetColorRender()

color_test.go

@@ -342,6 +342,9 @@ func TestColor_convert(t *testing.T) {
 	assert.Equal(t, "106", HiCyan.ToBg().Code())
 	assert.Equal(t, "93", BgHiYellow.ToFg().Code())
 	assert.Equal(t, "105", BgHiMagenta.ToBg().Code())
+
+	assert.Equal(t, "5", OpBlink.ToFg().Code())
+	assert.Equal(t, "5", OpBlink.ToBg().Code())
 }
 
 func TestColor_C256(t *testing.T) {
@@ -536,6 +539,25 @@ func TestColor256_Print(t *testing.T) {
 	buf.Reset()
 }
 
+func TestColor256_conv(t *testing.T) {
+	is := assert.New(t)
+	c := C256(132)
+
+	is.Equal("132", c.C16().Code())
+}
+
+func TestColor256_set_reset(t *testing.T) {
+	_, err := Reset()
+	assert.NoError(t, err)
+
+	c := C256(132)
+
+	assert.NoError(t, c.Set())
+	fmt.Println("a message on color 256 set.")
+	assert.NoError(t, c.Reset())
+	fmt.Println()
+}
+
 func TestColor256_AsBg(t *testing.T) {
 	is := assert.New(t)
 	c := C256(132)

convert.go

@@ -756,11 +756,9 @@ func RgbToHsl(r, g, b uint8) []float64 {
 	min, max := ps[0], ps[2]
 	// max := math.Max(math.Max(pr, pg), pb)
 	// min := math.Min(math.Min(pr, pg), pb)
-
 	mid := (max + min) / 2
 
 	h, s, l := mid, mid, mid
-
 	if max == min {
 		h, s = 0, 0 // achromatic
 	} else {

convert_test.go

@@ -46,5 +46,10 @@ func TestHslToRgb(t *testing.T) {
 	assert.Equal(t, []int{0, 0, 66}, hslVal)
 
 	hslFVal := RgbToHsl(rgbVal[0], rgbVal[1], rgbVal[2])
-	fmt.Println(hslFVal)
+	fmt.Println("rgb:", rgbVal, "=> hsl:", hslFVal)
+	assert.NotEmpty(t, hslFVal)
+
+	hslFVal = RgbToHsl(57, 187, 226)
+	fmt.Println("rgb: 57, 187, 226 => hsl:", hslFVal)
+	assert.NotEmpty(t, hslFVal)
 }

style_test.go

@@ -154,6 +154,10 @@ func TestStyleFunc(t *testing.T) {
 	buf := forceOpenColorRender()
 	defer resetColorRender()
 
+	Infop("color message")
+	assert.Equal(t, "\x1b[0;32mcolor message\x1b[0m", buf.String())
+	buf.Reset()
+
 	Infoln("color message")
 	assert.Equal(t, "\x1b[0;32mcolor message\x1b[0m\n", buf.String())
 	buf.Reset()
@@ -162,6 +166,22 @@ func TestStyleFunc(t *testing.T) {
 	assert.Equal(t, "\x1b[0;32mcolor message\x1b[0m", buf.String())
 	buf.Reset()
 
+	Successp("color message")
+	assert.Equal(t, "\x1b[1;32mcolor message\x1b[0m", buf.String())
+	buf.Reset()
+
+	Successln("color message")
+	assert.Equal(t, "\x1b[1;32mcolor message\x1b[0m\n", buf.String())
+	buf.Reset()
+
+	Successf("color %s", "message")
+	assert.Equal(t, "\x1b[1;32mcolor message\x1b[0m", buf.String())
+	buf.Reset()
+
+	Warnp("color message")
+	assert.Equal(t, "\x1b[1;33mcolor message\x1b[0m", buf.String())
+	buf.Reset()
+
 	Warnln("color message")
 	assert.Equal(t, "\x1b[1;33mcolor message\x1b[0m\n", buf.String())
 	buf.Reset()
@@ -170,6 +190,10 @@ func TestStyleFunc(t *testing.T) {
 	assert.Equal(t, "\x1b[1;33mcolor message\x1b[0m", buf.String())
 	buf.Reset()
 
+	Errorp("color message")
+	assert.Equal(t, "\x1b[97;41mcolor message\x1b[0m", buf.String())
+	buf.Reset()
+
 	Errorln("color message")
 	assert.Equal(t, "\x1b[97;41mcolor message\x1b[0m\n", buf.String())
 	buf.Reset()

utils_test.go

@@ -423,3 +423,9 @@ func TestRgbToAnsi(t *testing.T) {
 		assert.Equal(t, item.want, Rgb2ansi(r, g, b, item.isBg))
 	}
 }
+
+func TestEnv_COLOR_DEBUG_MODE(t *testing.T) {
+	mockEnvValue("COLOR_DEBUG_MODE", "on", func(_ string) {
+		debugf("print debug message")
+	})
+}