Merge branch 'main' into v2

* feat:(slice add AppendIfAbsent function)

* feat:(slice add TernaryOperator function)

Co-authored-by: george.zheng <george.zheng@ambergroup.io>

README.md

@@ -219,6 +219,7 @@ import queue "github.com/duke-git/lancet/v2/datastructure/queue"
 import set "github.com/duke-git/lancet/v2/datastructure/set"
 import tree "github.com/duke-git/lancet/v2/datastructure/tree"
 import heap "github.com/duke-git/lancet/v2/datastructure/heap"
+import hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
 ```
 #### Function list:
 - [List](https://github.com/duke-git/lancet/blob/main/docs/datastructure/list.md)
@@ -228,6 +229,7 @@ import heap "github.com/duke-git/lancet/v2/datastructure/heap"
 - [Set](https://github.com/duke-git/lancet/blob/main/docs/datastructure/set.md)
 - [Tree](https://github.com/duke-git/lancet/blob/main/docs/datastructure/tree.md)
 - [Heap](https://github.com/duke-git/lancet/blob/main/docs/datastructure/heap.md)
+- [HashMap](https://github.com/duke-git/lancet/blob/main/docs/datastructure/hashmap.md)
 
 
 ### 7. Fileutil package implements some basic functions for file operations.
@@ -491,6 +493,7 @@ import "github.com/duke-git/lancet/v2/validator"
 - [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsStrongPassword)
 - [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsUrl)
 - [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword)
+- [IsZeroValue](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsZeroValue)
 ### 19. xerror package implements helpers for errors.
 
 ```go

README_zh-CN.md

@@ -216,6 +216,7 @@ import queue "github.com/duke-git/lancet/v2/datastructure/queue"
 import set "github.com/duke-git/lancet/v2/datastructure/set"
 import tree "github.com/duke-git/lancet/v2/datastructure/tree"
 import heap "github.com/duke-git/lancet/v2/datastructure/heap"
+import hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap"
 ```
 #### Function list:
 - [List](https://github.com/duke-git/lancet/blob/main/docs/datastructure/list_zh-CN.md)
@@ -225,6 +226,7 @@ import heap "github.com/duke-git/lancet/v2/datastructure/heap"
 - [Set](https://github.com/duke-git/lancet/blob/main/docs/datastructure/set_zh-CN.md)
 - [Tree](https://github.com/duke-git/lancet/blob/main/docs/datastructure/tree_zh-CN.md)
 - [Heap](https://github.com/duke-git/lancet/blob/main/docs/datastructure/heap.md)
+- [HashMap](https://github.com/duke-git/lancet/blob/main/docs/datastructure/hashmap.md)
 
 
 ### 7. fileutil包支持文件基本操作。
@@ -488,6 +490,7 @@ import "github.com/duke-git/lancet/v2/validator"
 - [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsStrongPassword)
 - [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsUrl)
 - [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsWeakPassword)
+- [IsZeroValue](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsZeroValue)
 
 ### 19. xerror包实现一些错误处理函数
 

condition/condition.go

@@ -0,0 +1,14 @@
+// Copyright 2021 dudaodong@gmail.com. All rights reserved.
+// Use of this source code is governed by MIT license
+
+// Package condition contains some functions for conditional judgment. eg. And, Or, TernaryOperator ...
+package condition
+
+// TernaryOperator if true return trueValue else return falseValue
+func TernaryOperator[T any](isTrue bool, trueValue T, falseValue T) T {
+	if isTrue {
+		return trueValue
+	} else {
+		return falseValue
+	}
+}

condition/condition_test.go

@@ -0,0 +1,15 @@
+package condition
+
+import (
+	"testing"
+
+	"github.com/duke-git/lancet/v2/internal"
+)
+
+func TestTernaryOperator(t *testing.T) {
+	assert := internal.NewAssert(t, "TernaryOperator")
+	trueValue := "1"
+	falseValue := "0"
+
+	assert.Equal(trueValue, TernaryOperator(true, trueValue, falseValue))
+}

convertor/convertor.go

@@ -7,6 +7,7 @@ package convertor
 import (
 	"bytes"
 	"encoding/binary"
+	"encoding/gob"
 	"encoding/json"
 	"fmt"
 	"math"
@@ -270,3 +271,21 @@ func ColorRGBToHex(red, green, blue int) string {
 
 	return "#" + r + g + b
 }
+
+// EncodeByte encode data to byte
+func EncodeByte(data any) ([]byte, error) {
+	buffer := bytes.NewBuffer(nil)
+	encoder := gob.NewEncoder(buffer)
+	err := encoder.Encode(data)
+	if err != nil {
+		return nil, err
+	}
+	return buffer.Bytes(), nil
+}
+
+// DecodeByte decode byte data to target object
+func DecodeByte(data []byte, target any) error {
+	buffer := bytes.NewBuffer(data)
+	decoder := gob.NewDecoder(buffer)
+	return decoder.Decode(target)
+}

convertor/convertor_test.go

@@ -238,3 +238,21 @@ func TestToPointer(t *testing.T) {
 
 	assert.Equal(*result, 123)
 }
+
+func TestEncodeByte(t *testing.T) {
+	assert := internal.NewAssert(t, "TestEncodeByte")
+
+	byteData, _ := EncodeByte("abc")
+	expected := []byte{6, 12, 0, 3, 97, 98, 99}
+
+	assert.Equal(expected, byteData)
+}
+
+func TestDecodeByte(t *testing.T) {
+	assert := internal.NewAssert(t, "TestDecodeByte")
+
+	var obj string
+	byteData := []byte{6, 12, 0, 3, 97, 98, 99}
+	DecodeByte(byteData, &obj)
+	assert.Equal("abc", obj)
+}

datastructure/hashmap/hashmap.go

@@ -98,6 +98,8 @@ func (hm *HashMap) resize() {
 
 	tempTable := hm.table
 
+	hm.table = make([]*mapNode, hm.capacity)
+
 	for i := 0; i < len(tempTable); i++ {
 		node := tempTable[i]
 		if node == nil {

datastructure/hashmap/hashmap_test.go

@@ -19,6 +19,18 @@ func TestHashMap_PutAndGet(t *testing.T) {
 	assert.Equal(4, hm.Get("abc"))
 }
 
+func TestHashMap_Resize(t *testing.T) {
+	assert := internal.NewAssert(t, "TestHashMap_Resize")
+
+	hm := NewHashMapWithCapacity(3, 3)
+
+	for i := 0; i < 20; i++ {
+		hm.Put(i, 10)
+	}
+
+	assert.Equal(10, hm.Get(5))
+}
+
 func TestHashMap_Delete(t *testing.T) {
 	assert := internal.NewAssert(t, "TestHashMap_Delete")
 

docs/convertor.md

@@ -34,6 +34,8 @@ import (
 - [ToString](#ToString)
 - [StructToMap](#StructToMap)
 - [MapToSlice](#MapToSlice)
+- [EncodeByte](#EncodeByte)
+- [DecodeByte](#DecodeByte)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -457,4 +459,59 @@ func main() {
 
     fmt.Println(result) //[]string{"a:1", "b:2", "c:3"}
 }
+```
+
+
+### <span id="EncodeByte">EncodeByte</span>
+
+<p>Encode data to byte slice.</p>
+
+<b>Signature:</b>
+
+```go
+func EncodeByte(data any) ([]byte, error)
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/convertor"
+)
+
+func main() {
+    byteData, _ := convertor.EncodeByte("abc")
+    fmt.Println(byteData) //[]byte{6, 12, 0, 3, 97, 98, 99}
+}
+```
+
+
+
+### <span id="DecodeByte">DecodeByte</span>
+
+<p>Decode byte data to target object. target should be a pointer instance.</p>
+
+<b>Signature:</b>
+
+```go
+func DecodeByte(data []byte, target any) error
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/convertor"
+)
+
+func main() {
+    var result string
+	byteData := []byte{6, 12, 0, 3, 97, 98, 99}
+	convertor.DecodeByte(byteData, &result)
+    fmt.Println(result) //"abc"
+}
 ```

docs/convertor_zh-CN.md

@@ -36,6 +36,8 @@ import (
 - [ToString](#ToString)
 - [StructToMap](#StructToMap)
 - [MapToSlice](#MapToSlice)
+- [EncodeByte](#EncodeByte)
+- [DecodeByte](#DecodeByte)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -489,3 +491,59 @@ func main() {
     fmt.Println(result) //[]string{"a:1", "b:2", "c:3"}
 }
 ```
+
+
+
+### <span id="EncodeByte">EncodeByte</span>
+
+<p>将data编码成字节切片</p>
+
+<b>函数签名:</b>
+
+```go
+func EncodeByte(data any) ([]byte, error)
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/convertor"
+)
+
+func main() {
+    byteData, _ := convertor.EncodeByte("abc")
+    fmt.Println(byteData) //[]byte{6, 12, 0, 3, 97, 98, 99}
+}
+```
+
+
+
+### <span id="DecodeByte">DecodeByte</span>
+
+<p>解码字节切片到目标对象，目标对象需要传入一个指针实例子</p>
+
+<b>函数签名:</b>
+
+```go
+func DecodeByte(data []byte, target any) error
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/convertor"
+)
+
+func main() {
+    var result string
+	byteData := []byte{6, 12, 0, 3, 97, 98, 99}
+	convertor.DecodeByte(byteData, &result)
+    fmt.Println(result) //"abc"
+}
+```

docs/datastructure/hashmap.md

@@ -20,6 +20,7 @@ import (
 
 <div STYLE="page-break-after: always;"></div>
 
+
 ## Index
 
 - [NewHashMap](#NewHashMap)
@@ -106,8 +107,8 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	val := hm.Get("a")
+    hm := heap.NewHashMap()
+    val := hm.Get("a")
 
     fmt.Println(val) //nil
 }
@@ -134,10 +135,10 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	hm.Put("a", 1)
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
 
-	val := hm.Get("a")
+    val := hm.Get("a")
     fmt.Println(val) //1
 }
 ```
@@ -165,13 +166,13 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	hm.Put("a", 1)
-	val := hm.Get("a")
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    val := hm.Get("a")
     fmt.Println(val) //1
 
-	hm.Delete("a")
-	val = hm.Get("a")
+    hm.Delete("a")
+    val = hm.Get("a")
     fmt.Println(val) //nil
 }
 ```
@@ -199,8 +200,8 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	hm.Put("a", 1)
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
 
     fmt.Println(hm.Contains("a")) //true
     fmt.Println(hm.Contains("b")) //false

docs/datastructure/hashmap_zh-CN.md

@@ -22,17 +22,13 @@ import (
 
 ## 目录
 
-- [HashMap](#hashmap)
-  - [源码](#源码)
-  - [用法](#用法)
-  - [目录](#目录)
-  - [API 文档](#api-文档)
-    - [<span id="NewHashMap">NewHashMap</span>](#newhashmap)
-    - [<span id="NewHashMapWithCapacity">NewHashMapWithCapacity</span>](#newhashmapwithcapacity)
-    - [<span id="Get">Get</span>](#get)
-    - [<span id="Put">Put</span>](#put)
-    - [<span id="Delete">Delete</span>](#delete)
-    - [<span id="Contains">Contains</span>](#contains)
+- [NewHashMap](#NewHashMap)
+- [NewHashMapWithCapacity](#NewHashMapWithCapacity)
+
+- [Get](#Get)
+- [Put](#Put)
+- [Delete](#Delete)
+- [Contains](#Contains)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -111,8 +107,8 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	val := hm.Get("a")
+    hm := heap.NewHashMap()
+    val := hm.Get("a")
 
     fmt.Println(val) //nil
 }
@@ -139,10 +135,10 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	hm.Put("a", 1)
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
 
-	val := hm.Get("a")
+    val := hm.Get("a")
     fmt.Println(val) //1
 }
 ```
@@ -168,13 +164,13 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	hm.Put("a", 1)
-	val := hm.Get("a")
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
+    val := hm.Get("a")
     fmt.Println(val) //1
 
-	hm.Delete("a")
-	val = hm.Get("a")
+    hm.Delete("a")
+    val = hm.Get("a")
     fmt.Println(val) //nil
 }
 ```
@@ -200,8 +196,8 @@ import (
 )
 
 func main() {
-	hm := heap.NewHashMap()
-	hm.Put("a", 1)
+    hm := heap.NewHashMap()
+    hm.Put("a", 1)
 
     fmt.Println(hm.Contains("a")) //true
     fmt.Println(hm.Contains("b")) //false

docs/validator.md

@@ -47,6 +47,7 @@ import (
 - [IsStrongPassword](#IsStrongPassword)
 - [IsUrl](#IsUrl)
 - [IsWeakPassword](#IsWeakPassword)
+- [IsZeroValue](#IsZeroValue)
   
 
 <div STYLE="page-break-after: always;"></div>
@@ -765,7 +766,7 @@ func main() {
 
 
 ### <span id="IsWeakPassword">IsWeakPassword</span>
-<p>Check if the string is weak password（only letter or only number or letter + number）
+<p>Checks if the string is weak password（only letter or only number or letter + number）
 .</p>
 
 <b>Signature:</b>
@@ -792,6 +793,36 @@ func main() {
 
 
 
+### <span id="IsZeroValue">IsZeroValue</span>
+<p>Checks if passed value is a zero value.</p>
+
+<b>Signature:</b>
+
+```go
+func IsZeroValue(value any) bool
+```
+<b>Example:</b>
+
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+	fmt.Println(validator.IsZeroValue(nil)) //true
+	fmt.Println(validator.IsZeroValue(0)) //true
+	fmt.Println(validator.IsZeroValue("")) //true
+	fmt.Println(validator.IsZeroValue([]int)) //true
+	fmt.Println(validator.IsZeroValue(interface{})) //true
+
+	fmt.Println(validator.IsZeroValue("0")) //false
+	fmt.Println(validator.IsZeroValue("nil")) //false
+}
+```
+
+
+
 
 
 

docs/validator_zh-CN.md

@@ -47,6 +47,7 @@ import (
 - [IsStrongPassword](#IsStrongPassword)
 - [IsUrl](#IsUrl)
 - [IsWeakPassword](#IsWeakPassword)
+- [IsZeroValue](#IsZeroValue)
   
 
 <div STYLE="page-break-after: always;"></div>
@@ -792,8 +793,31 @@ func main() {
 
 
 
+### <span id="IsZeroValue">IsZeroValue</span>
+<p>判断传入的参数值是否为零值</p>
 
+<b>函数签名:</b>
 
+```go
+func IsZeroValue(value any) bool
+```
+<b>例子:</b>
 
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/v2/validator"
+)
 
+func main() {
+	fmt.Println(validator.IsZeroValue(nil)) //true
+	fmt.Println(validator.IsZeroValue(0)) //true
+	fmt.Println(validator.IsZeroValue("")) //true
+	fmt.Println(validator.IsZeroValue([]int)) //true
+	fmt.Println(validator.IsZeroValue(interface{})) //true
+	
+	fmt.Println(validator.IsZeroValue("0")) //false
+	fmt.Println(validator.IsZeroValue("nil")) //false
+}
+```
 

docs/xerror.md

@@ -46,7 +46,7 @@ import (
 )
 
 func main() {
-    _, err := strconv.Atoi("4o2")
+	_, err := strconv.Atoi("4o2")
 	defer func() {
 		v := recover()
 		fmt.Println(err.Error()) // err.Error() == v.(*strconv.NumError).Error()

docs/xerror_zh-CN.md

@@ -46,7 +46,7 @@ import (
 )
 
 func main() {
-    _, err := strconv.Atoi("4o2")
+	_, err := strconv.Atoi("4o2")
 	defer func() {
 		v := recover()
 		fmt.Println(err.Error()) // err.Error() == v.(*strconv.NumError).Error()

validator/validator.go

@@ -8,6 +8,7 @@ import (
 	"encoding/json"
 	"net"
 	"net/url"
+	"reflect"
 	"regexp"
 	"strconv"
 	"strings"
@@ -159,7 +160,7 @@ func IsEmail(email string) bool {
 	return isEmailRegexMatcher.MatchString(email)
 }
 
-var isChineseMobileRegexMatcher *regexp.Regexp = regexp.MustCompile("^((13[0-9])|(14[5,7])|(15[0-3,5-9])|(17[0,3,5-8])|(18[0-9])|166|198|199|(147))\\d{8}$")
+var isChineseMobileRegexMatcher *regexp.Regexp = regexp.MustCompile(`^((13[0-9])|(14[5,7])|(15[0-3,5-9])|(17[0,3,5-8])|(18[0-9])|166|198|199|(147))\\d{8}$`)
 
 // IsChineseMobile check if the string is chinese mobile number.
 func IsChineseMobile(mobileNum string) bool {
@@ -253,3 +254,32 @@ func IsWeakPassword(password string) bool {
 
 	return (num || letter) && !special
 }
+
+// IsZeroValue checks if value is a zero value
+func IsZeroValue(value any) bool {
+	if value == nil {
+		return true
+	}
+
+	rv := reflect.ValueOf(value)
+	if !rv.IsValid() {
+		return true
+	}
+
+	switch rv.Kind() {
+	case reflect.String:
+		return rv.Len() == 0
+	case reflect.Bool:
+		return !rv.Bool()
+	case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
+		return rv.Int() == 0
+	case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
+		return rv.Uint() == 0
+	case reflect.Float32, reflect.Float64:
+		return rv.Float() == 0
+	case reflect.Ptr, reflect.Chan, reflect.Func, reflect.Interface, reflect.Slice, reflect.Map:
+		return rv.IsNil()
+	}
+
+	return reflect.DeepEqual(rv.Interface(), reflect.Zero(rv.Type()).Interface())
+}

validator/validator_test.go

@@ -1,7 +1,9 @@
 package validator
 
 import (
+	"fmt"
 	"testing"
+	"time"
 
 	"github.com/duke-git/lancet/v2/internal"
 )
@@ -279,3 +281,110 @@ func TestIsWeakPassword(t *testing.T) {
 	assert.Equal(true, IsWeakPassword("abcABC123"))
 	assert.Equal(false, IsWeakPassword("abc123@#$"))
 }
+
+func TestIsZeroValue(t *testing.T) {
+	assert := internal.NewAssert(t, "TestIsZeroValue")
+
+	var (
+		zeroPtr   *string
+		zeroSlice []int
+		zeroFunc  func() string
+		zeroMap   map[string]string
+		nilIface  interface{}
+		zeroIface fmt.Formatter
+	)
+	zeroValues := []interface{}{
+		nil,
+		false,
+		0,
+		int8(0),
+		int16(0),
+		int32(0),
+		int64(0),
+		uint(0),
+		uint8(0),
+		uint16(0),
+		uint32(0),
+		uint64(0),
+
+		0.0,
+		float32(0.0),
+		float64(0.0),
+
+		"",
+
+		// func
+		zeroFunc,
+
+		// array / slice
+		[0]int{},
+		zeroSlice,
+
+		// map
+		zeroMap,
+
+		// interface
+		nilIface,
+		zeroIface,
+
+		// pointer
+		zeroPtr,
+
+		// struct
+		time.Time{},
+	}
+
+	for _, value := range zeroValues {
+		assert.Equal(true, IsZeroValue(value))
+	}
+
+	var nonZeroIface fmt.Stringer = time.Now()
+
+	nonZeroValues := []interface{}{
+		// bool
+		true,
+
+		// int
+		1,
+		int8(1),
+		int16(1),
+		int32(1),
+		int64(1),
+		uint8(1),
+		uint16(1),
+		uint32(1),
+		uint64(1),
+
+		// float
+		1.0,
+		float32(1.0),
+		float64(1.0),
+
+		// string
+		"test",
+
+		// func
+		time.Now,
+
+		// array / slice
+		[]int{},
+		[]int{42},
+		[1]int{42},
+
+		// map
+		make(map[string]string, 1),
+
+		// interface
+		nonZeroIface,
+
+		// pointer
+		&nonZeroIface,
+
+		// struct
+		time.Now(),
+	}
+
+	for _, value := range nonZeroValues {
+		assert.Equal(false, IsZeroValue(value))
+	}
+}