release v2.2.2

README.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.2.1-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.2.2-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -38,7 +38,7 @@ English | [简体中文](./README_zh-CN.md)
 go get github.com/duke-git/lancet/v2 // will install latest version of v2.x.x
 ```
 
-2. <b>For users who use version below go1.18, you should install v1.x.x. The latest of v1.x.x is v1.3.9. </b>
+2. <b>For users who use version below go1.18, you should install v1.x.x. The latest of v1.x.x is v1.4.0. </b>
 
 ```go
 go get github.com/duke-git/lancet // below go1.18, install latest version of v1.x.x
@@ -282,6 +282,10 @@ import "github.com/duke-git/lancet/v2/convertor"
 -   **<big>ToInterface</big>** : converts reflect value to its interface type.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToInterface)]
     [[play](https://go.dev/play/p/syqw0-WG7Xd)]
+-   **<big>Utf8ToGbk</big>** : converts utf8 encoding data to GBK encoding data
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#Utf8ToGbk)]
+-   **<big>GbkToUtf8</big>** : converts GBK encoding data to utf8 encoding data.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#GbkToUtf8)]
 
 ### 6. Cryptor package is for data encryption and decryption.
 
@@ -581,9 +585,11 @@ import "github.com/duke-git/lancet/v2/fileutil"
 -   **<big>ReadFileByLine</big>** : read file line by line, return string slice of file content.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileByLine)]
     [[play](https://go.dev/play/p/svJP_7ZrBrD)]
--   **<big>Zip</big>** : create zip file.
+-   **<big>Zip</big>** : create a zip file of fpath, fpath could be a file or a directory.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip)]
     [[play](https://go.dev/play/p/j-3sWBp8ik_P)]
+-   **<big>ZipAppendEntry</big>** : append a single file or directory by fpath to an existing zip file.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ZipAppendEntry)]
 -   **<big>UnZip</big>** : unzip the zip file and save it to dest path.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip)]
     [[play](https://go.dev/play/p/g0w34kS7B8m)]
@@ -605,6 +611,8 @@ import "github.com/duke-git/lancet/v2/fileutil"
 -   **<big>ReadCsvFile</big>** : read file content into slice.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadCsvFile)]
     [[play](https://go.dev/play/p/OExTkhGEd3_u)]
+-   **<big>WriteCsvFile</big>** : write content to target csv file.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#WriteCsvFile)]
 -   **<big>WriteBytesToFile</big>** : write bytes to target file.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#WriteBytesToFile)]
     [[play](https://go.dev/play/p/s7QlDxMj3P8)]
@@ -825,7 +833,10 @@ import "github.com/duke-git/lancet/v2/mathutil"
 -   **<big>Sin</big>** : return the sine of the radian argument.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Sin)]
     [[play](https://go.dev/play/p/TWMQlMywDsP)]
-
+-   **<big>Log</big>** : returns the logarithm of base n.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Log)]
+-   **<big>Sum</big>** : return sum of passed numbers.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Sum)]
 
 ### 14. Netutil package contains functions to get net information and send http request.
 
@@ -932,6 +943,8 @@ import "github.com/duke-git/lancet/v2/random"
 -   **<big>UUIdV4</big>** : generate a random UUID of version 4 according to RFC 4122.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4)]
     [[play](https://go.dev/play/p/_Z9SFmr28ft)]
+-   **<big>RandUniqueIntSlice</big>** : generate a slice of random int of length n that do not repeat.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandUniqueIntSlice)]
 
 ### 16. Retry package is for executing a function repeatedly until it was successful or canceled by the context.
 
@@ -1405,7 +1418,8 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>HideString</big>** : Hide some chars in source string with param `replaceChar`.
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#HideString)]
     [[play](https://go.dev/play/p/pzbaIVCTreZ)]
-
+-   **<big>RemoveWhiteSpace</big>** : remove whitespace characters from a string.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#RemoveWhiteSpace)]
 
 ### 21. System package contain some functions about os, runtime, shell command.
 

README_zh-CN.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.2.1-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.2.2-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -25,7 +25,7 @@
 -   👏 全面、高效、可复用。
 -   💪 500+常用 go 工具函数，支持 string、slice、datetime、net、crypt...
 -   💅 只依赖 go 标准库和 golang.org/x。
--   🌍 所有导出函数单元测试覆盖率100%。
+-   🌍 所有导出函数单元测试覆盖率 100%。
 
 ## 安装
 
@@ -37,7 +37,7 @@
 go get github.com/duke-git/lancet/v2 //安装v2最新版本v2.x.x
 ```
 
-2. <b>使用 go1.18 以下版本的用户，必须安装 v1.x.x。目前最新的 v1 版本是 v1.3.9。</b>
+2. <b>使用 go1.18 以下版本的用户，必须安装 v1.x.x。目前最新的 v1 版本是 v1.4.0。</b>
 
 ```go
 go get github.com/duke-git/lancet// 使用go1.18以下版本, 必须安装v1.x.x版本
@@ -281,6 +281,10 @@ import "github.com/duke-git/lancet/v2/convertor"
 -   **<big>ToInterface</big>** : 将反射值转换成对应的 interface 类型。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToInterface)]
     [[play](https://go.dev/play/p/syqw0-WG7Xd)]
+-   **<big>Utf8ToGbk</big>** : utf8 编码转 GBK 编码。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#Utf8ToGbk)]
+-   **<big>GbkToUtf8</big>** : GBK 编码转 utf8 编码。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#GbkToUtf8)]
 
 ### 6. cryptor 加密包支持数据加密和解密，获取 md5，hash 值。支持 base64, md5, hmac, aes, des, rsa。
 
@@ -503,7 +507,6 @@ import "github.com/duke-git/lancet/v2/datetime"
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#IsWeekend)]
     [[play](https://go.dev/play/p/cupRM5aZOIY)]
 
-
 ### 8. datastructure 包含一些普通的数据结构实现。例如：list, linklist, stack, queue, set, tree, graph.
 
 ```go
@@ -586,6 +589,8 @@ import "github.com/duke-git/lancet/v2/fileutil"
 -   **<big>Zip</big>** : zip 压缩文件, 参数可以是文件或目录。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip)]
     [[play](https://go.dev/play/p/j-3sWBp8ik_P)]
+-   **<big>ZipAppendEntry</big>** : 通过将单个文件或目录追加到现有的 zip 文件。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ZipAppendEntry)]
 -   **<big>UnZip</big>** : zip 解压缩文件并保存在目录中。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip)]
     [[play](https://go.dev/play/p/g0w34kS7B8m)]
@@ -607,14 +612,14 @@ import "github.com/duke-git/lancet/v2/fileutil"
 -   **<big>ReadCsvFile</big>** : 读取 csv 文件内容到切片。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadCsvFile)]
     [[play](https://go.dev/play/p/OExTkhGEd3_u)]
--   **<big>WriteBytesToFile</big>** : 将bytes写入文件。
+-   **<big>WriteCsvFile</big>** : 向 csv 文件写入内容。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#WriteCsvFile)]
+-   **<big>WriteBytesToFile</big>** : 将 bytes 写入文件。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#WriteBytesToFile)]
     [[play](https://go.dev/play/p/s7QlDxMj3P8)]
 -   **<big>WriteStringToFile</big>** : 将字符串写入文件。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#WriteStringToFile)]
     [[play](https://go.dev/play/p/GhLS6d8lH_g)]
-    
-
 
 ### 10. formatter 格式化器包含一些数据格式化处理方法。
 
@@ -828,7 +833,10 @@ import "github.com/duke-git/lancet/v2/mathutil"
 -   **<big>Sin</big>** : 计算弧度的正弦值。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Sin)]
     [[play](https://go.dev/play/p/TWMQlMywDsP)]
-
+-   **<big>Log</big>** : 计算以 base 为底 n 的对数。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Log)]
+-   **<big>Sum</big>** : 求传入参数之和。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Sum)]
 
 ### 14. netutil 网络包支持获取 ip 地址，发送 http 请求。
 
@@ -935,6 +943,8 @@ import "github.com/duke-git/lancet/v2/random"
 -   **<big>UUIdV4</big>** : 生成 UUID v4 字符串。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#UUIdV4)]
     [[play](https://go.dev/play/p/_Z9SFmr28ft)]
+-   **<big>RandUniqueIntSlice</big>** : 生成一个不重复的长度为n的随机int切片。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandUniqueIntSlice)]
 
 ### 16. retry 重试执行函数直到函数运行成功或被 context cancel。
 
@@ -1411,7 +1421,8 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>HideString</big>** : 隐藏源字符串中的一些字符。
     [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#HideString)]
     [[play](https://go.dev/play/p/pzbaIVCTreZ)]
-
+-   **<big>RemoveWhiteSpace</big>** : 删除字符串中的空格。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#RemoveWhiteSpace)]
 
 ### 21. system 包含 os, runtime, shell command 的相关函数。
 

docs/convertor_zh-CN.md

@@ -41,6 +41,8 @@ import (
 -   [DeepClone](#DeepClone)
 -   [CopyProperties](#CopyProperties)
 -   [ToInterface](#ToInterface)
+-   [Utf8ToGbk](#Utf8ToGbk)
+-   [GbkToUtf8](#GbkToUtf8)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -838,7 +840,7 @@ func main() {
 
     // Output:
     // true
-    // true   
+    // true
 }
 ```
 
@@ -871,6 +873,6 @@ func main() {
 
     // Output:
     // true
-    // hello   
+    // hello
 }
-```
+```

docs/fileutil.md

@@ -37,6 +37,7 @@ import (
 -   [ReadFileToString](#ReadFileToString)
 -   [ReadFileByLine](#ReadFileByLine)
 -   [Zip](#Zip)
+-   [ZipAppendEntry](#ZipAppendEntry)
 -   [UnZip](#UnZip)
 -   [IsZipFile](#IsZipFile)
 -   [FileSize](#FileSize)
@@ -476,6 +477,34 @@ func main() {
 }
 ```
 
+### <span id="ZipAppendEntry">ZipAppendEntry</span>
+
+<p>Append a single file or directory by fpath to an existing zip file.</p>
+
+<b>Signature:</b>
+
+```go
+func ZipAppendEntry(fpath string, destPath string) error 
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/fileutil"
+)
+
+func main() {
+    err := fileutil.ZipAppendEntry("./test.txt", "./test.zip")
+    if err != nil {
+        fmt.Println(err)
+    }
+}
+```
+
 ### <span id="UnZip">UnZip</span>
 
 <p>Unzip the file and save it to dest path.</p>

docs/fileutil_zh-CN.md

@@ -37,6 +37,7 @@ import (
 -   [ReadFileToString](#ReadFileToString)
 -   [ReadFileByLine](#ReadFileByLine)
 -   [Zip](#Zip)
+-   [ZipAppendEntry](#ZipAppendEntry)
 -   [UnZip](#UnZip)
 -   [IsZipFile](#IsZipFile)
 -   [FileSize](#FileSize)
@@ -476,6 +477,34 @@ func main() {
 }
 ```
 
+### <span id="ZipAppendEntry">ZipAppendEntry</span>
+
+<p>通过将单个文件或目录追加到现有的zip文件</p>
+
+<b>函数签名:</b>
+
+```go
+func ZipAppendEntry(fpath string, destPath string) error
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/fileutil"
+)
+
+func main() {
+    err := fileutil.ZipAppendEntry("./test.txt", "./test.zip")
+    if err != nil {
+        fmt.Println(err)
+    }
+}
+```
+
 ### <span id="UnZip">UnZip</span>
 
 <p>zip解压缩文件并保存在目录中</p>
@@ -701,7 +730,6 @@ func main() {
 }
 ```
 
-
 ### <span id="WriteBytesToFile">WriteBytesToFile</span>
 
 <p>将bytes写入文件。</p>
@@ -751,7 +779,6 @@ func main() {
 }
 ```
 
-
 ### <span id="WriteStringToFile">WriteStringToFile</span>
 
 <p>将字符串写入文件。</p>

fileutil/file.go

@@ -208,7 +208,11 @@ func Zip(fpath string, destPath string) error {
 	archive := zip.NewWriter(zipFile)
 	defer archive.Close()
 
-	err = filepath.Walk(fpath, func(path string, info os.FileInfo, err error) error {
+	return addFileToArchive(fpath, archive)
+}
+
+func addFileToArchive(fpath string, archive *zip.Writer) error {
+	err := filepath.Walk(fpath, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
 		}
@@ -224,32 +228,22 @@ func Zip(fpath string, destPath string) error {
 			header.Name += "/"
 		} else {
 			header.Method = zip.Deflate
-		}
-
-		writer, err := archive.CreateHeader(header)
-		if err != nil {
-			return err
-		}
-
-		if !info.IsDir() {
+			writer, err := archive.CreateHeader(header)
+			if err != nil {
+				return err
+			}
 			file, err := os.Open(path)
 			if err != nil {
 				return err
 			}
 			defer file.Close()
-			_, err = io.Copy(writer, file)
-			if err != nil {
+			if _, err := io.Copy(writer, file); err != nil {
 				return err
 			}
 		}
 		return nil
 	})
-
-	if err != nil {
-		return err
-	}
-
-	return nil
+	return err
 }
 
 // UnZip unzip the file and save it to destPath.
@@ -302,6 +296,64 @@ func UnZip(zipFile string, destPath string) error {
 	return nil
 }
 
+// ZipAppendEntry append a single file or directory by fpath to an existing zip file.
+// Play: https://go.dev/play/p/cxvaT8TRNQp
+func ZipAppendEntry(fpath string, destPath string) error {
+	tempFile, err := os.CreateTemp("", "temp.zip")
+	if err != nil {
+		return err
+	}
+	defer os.Remove(tempFile.Name())
+
+	zipReader, err := zip.OpenReader(destPath)
+	if err != nil {
+		return err
+	}
+
+	archive := zip.NewWriter(tempFile)
+
+	for _, zipItem := range zipReader.File {
+		zipItemReader, err := zipItem.Open()
+		if err != nil {
+			return err
+		}
+		header, err := zip.FileInfoHeader(zipItem.FileInfo())
+		if err != nil {
+			return err
+		}
+		header.Name = zipItem.Name
+		targetItem, err := archive.CreateHeader(header)
+		if err != nil {
+			return err
+		}
+		_, err = io.Copy(targetItem, zipItemReader)
+		if err != nil {
+			return err
+		}
+	}
+
+	err = addFileToArchive(fpath, archive)
+
+	if err != nil {
+		return err
+	}
+
+	err = zipReader.Close()
+	if err != nil {
+		return err
+	}
+	err = archive.Close()
+	if err != nil {
+		return err
+	}
+	err = tempFile.Close()
+	if err != nil {
+		return err
+	}
+
+	return CopyFile(tempFile.Name(), destPath)
+}
+
 func safeFilepathJoin(path1, path2 string) (string, error) {
 	relPath, err := filepath.Rel(".", path2)
 	if err != nil || strings.HasPrefix(relPath, "..") {

fileutil/file_example_test.go

@@ -175,11 +175,11 @@ func ExampleReadFileByLine() {
 }
 
 func ExampleListFileNames() {
-	fileList, _ := ListFileNames("./")
+	fileList, _ := ListFileNames("../internal")
 	fmt.Println(fileList)
 
 	// Output:
-	// [file.go file_example_test.go file_test.go]
+	// [assert.go assert_test.go error_join.go]
 }
 
 func ExampleZip() {
@@ -224,6 +224,28 @@ func ExampleUnZip() {
 	// application/octet-stream
 }
 
+func ExampleZipAppendEntry() {
+	zipFile := "./test.zip"
+	CopyFile("./testdata/file.go.zip", zipFile)
+
+	ZipAppendEntry("./testdata", zipFile)
+
+	unZipPath := "./unzip"
+	UnZip(zipFile, unZipPath)
+
+	fmt.Println(IsExist("./unzip/file.go"))
+	fmt.Println(IsExist("./unzip/testdata/file.go.zip"))
+	fmt.Println(IsExist("./unzip/testdata/test.txt"))
+
+	os.Remove(zipFile)
+	os.RemoveAll(unZipPath)
+
+	// Output:
+	// true
+	// true
+	// true
+}
+
 func ExampleIsZipFile() {
 	result1 := IsZipFile("./file.go")
 	result2 := IsZipFile("./testdata/file.go.zip")

fileutil/file_test.go

@@ -191,6 +191,44 @@ func TestZipAndUnZip(t *testing.T) {
 	os.RemoveAll(unZipPath)
 }
 
+func TestZipAppendEntry(t *testing.T) {
+	assert := internal.NewAssert(t, "TestZipAppendEntry")
+
+	zipFile := "./text.zip"
+	err := CopyFile("./testdata/file.go.zip", zipFile)
+	assert.IsNil(err)
+
+	srcFile := "./text.txt"
+	CreateFile(srcFile)
+
+	file, _ := os.OpenFile(srcFile, os.O_WRONLY|os.O_TRUNC, os.ModePerm)
+
+	_, err = file.WriteString("hello\nworld")
+	if err != nil {
+		t.Fail()
+	}
+	file.Close()
+
+	err = ZipAppendEntry(srcFile, zipFile)
+	assert.IsNil(err)
+
+	err = ZipAppendEntry("./testdata", zipFile)
+	assert.IsNil(err)
+
+	unZipPath := "./unzip"
+	err = UnZip(zipFile, unZipPath)
+	assert.IsNil(err)
+
+	assert.Equal(true, IsExist("./unzip/text.txt"))
+	assert.Equal(true, IsExist("./unzip/file.go"))
+	assert.Equal(true, IsExist("./unzip/testdata/file.go.zip"))
+	assert.Equal(true, IsExist("./unzip/testdata/test.txt"))
+
+	os.Remove(srcFile)
+	os.Remove(zipFile)
+	os.RemoveAll(unZipPath)
+}
+
 func TestFileMode(t *testing.T) {
 	assert := internal.NewAssert(t, "TestFileMode")
 
@@ -235,10 +273,10 @@ func TestMiMeType(t *testing.T) {
 func TestListFileNames(t *testing.T) {
 	assert := internal.NewAssert(t, "TestListFileNames")
 
-	filesInPath, err := ListFileNames("./")
+	filesInPath, err := ListFileNames("../internal")
 	assert.IsNil(err)
 
-	expected := []string{"file.go", "file_example_test.go", "file_test.go"}
+	expected := []string{"assert.go", "assert_test.go", "error_join.go"}
 	assert.Equal(expected, filesInPath)
 }