release v2.1.0

.gitignore

@@ -6,4 +6,5 @@ fileutil/*.txt
 fileutil/*.zip
 fileutil/*.link
 fileutil/unzip/*
+slice/testdata/*
 cryptor/*.pem

README.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-%3E%3D1.16<recommend>-9cf)
-[![Release](https://img.shields.io/badge/release-2.0.8-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.0-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)
@@ -35,9 +35,9 @@ 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. now latest v1 is v1.2.9. </b>
+2. <b>For users who use version below go1.18, you should install v1.x.x. now latest v1 is v1.3.0. </b>
 ```go
-go get github.com/duke-git/lancet@v1.2.9 // below go1.18, install latest version of v1.x.x
+go get github.com/duke-git/lancet@v1.3.0 // below go1.18, install latest version of v1.x.x
 ```
 
 ## Usage
@@ -233,6 +233,7 @@ import "github.com/duke-git/lancet/v2/fileutil"
 
 - [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ClearFile)
 - [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateFile)
+- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateDir)
 - [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CopyFile)
 - [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileMode)
 - [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MiMeType)
@@ -370,6 +371,8 @@ import "github.com/duke-git/lancet/v2/slice"
 - [DifferenceWith](https://github.com/duke-git/lancet/blob/main/docs/slice.md#DifferenceWith)
 - [DeleteAt](https://github.com/duke-git/lancet/blob/main/docs/slice.md#DeleteAt)
 - [Drop](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Drop)
+- [Equal](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Equal)
+- [EqualWith](https://github.com/duke-git/lancet/blob/main/docs/slice.md#EqualWith)
 - [Every](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Every)
 - [Filter](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Filter)
 - [Find](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Find)
@@ -393,6 +396,7 @@ import "github.com/duke-git/lancet/v2/slice"
 - [StringSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#StringSlice)
 - [SymmetricDifference](https://github.com/duke-git/lancet/blob/main/docs/slice.md#SymmetricDifference)
 - [Unique](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Unique)
+- [UniqueBy](https://github.com/duke-git/lancet/blob/main/docs/slice.md#UniqueBy)
 - [Union](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Union)
 - [UpdateAt](https://github.com/duke-git/lancet/blob/main/docs/slice.md#UpdateAt)
 - [Without](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Without)

README_zh-CN.md

@@ -4,7 +4,7 @@
 <br/>
 
 ![Go version](https://img.shields.io/badge/go-%3E%3D1.16<recommend>-9cf)
-[![Release](https://img.shields.io/badge/release-2.0.8-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.0-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)
@@ -35,9 +35,9 @@
 go get github.com/duke-git/lancet/v2 //安装v2最新版本v2.x.x
 ```
 
-2. <b>使用go1.18以下版本的用户，必须安装v1.x.x。目前最新的v1版本是v1.2.9。</b>
+2. <b>使用go1.18以下版本的用户，必须安装v1.x.x。目前最新的v1版本是v1.3.0。</b>
 ```go
-go get github.com/duke-git/lancet@v1.2.9 // 使用go1.18以下版本, 必须安装v1.x.x版本
+go get github.com/duke-git/lancet@v1.3.0 // 使用go1.18以下版本, 必须安装v1.x.x版本
 ```
 
 ## 用法
@@ -231,6 +231,7 @@ import "github.com/duke-git/lancet/v2/fileutil"
 
 - [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ClearFile)
 - [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateFile)
+- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateDir)
 - [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CopyFile)
 - [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#FileMode)
 - [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#MiMeType)
@@ -390,6 +391,7 @@ import "github.com/duke-git/lancet/v2/slice"
 - [StringSlice](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#StringSlice)
 - [SymmetricDifference](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#SymmetricDifference)
 - [Unique](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Unique)
+- [UniqueBy](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#UniqueBy)
 - [Union](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Union)
 - [UpdateAt](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#UpdateAt)
 - [Without](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Without)

datastructure/queue/arrayqueue.go

@@ -33,7 +33,7 @@ func (q *ArrayQueue[T]) Data() []T {
 	return items
 }
 
-// Size return length of queue data
+// Size return number of elements in queue
 func (q *ArrayQueue[T]) Size() int {
 	return q.size
 }

datastructure/queue/circularqueue.go

@@ -9,10 +9,10 @@ import (
 // CircularQueue implements circular queue with slice,
 // last index of CircularQueue don't contain value, so acturl capacity is capacity - 1
 type CircularQueue[T any] struct {
-	data  []T
+	data     []T
-	front int
+	front    int
-	rear  int
+	rear     int
-	capacity  int
+	capacity int
 }
 
 // NewCircularQueue return a empty CircularQueue pointer

datastructure/queue/linkedqueue.go

@@ -42,7 +42,6 @@ func (q *LinkedQueue[T]) IsEmpty() bool {
 	return q.length == 0
 }
 
-
 // Enqueue put element into queue
 func (q *LinkedQueue[T]) Enqueue(value T) {
 	newNode := datastructure.NewQueueNode(value)

docs/fileutil.md

@@ -21,18 +21,20 @@ import (
 ## Index
 - [ClearFile](#ClearFile)
 - [CreateFile](#CreateFile)
+- [CreateDir](#CreateDir)
 - [CopyFile](#CopyFile)
 - [FileMode](#FileMode)
 - [MiMeType](#MiMeType)
 - [IsExist](#IsExist)
 - [IsLink](#IsLink)
 - [IsDir](#IsDir)
+
 - [ListFileNames](#ListFileNames)
 - [RemoveFile](#RemoveFile)
 - [ReadFileToString](#ReadFileToString)
 - [ReadFileByLine](#ReadFileByLine)
 - [Zip](#Zip)
-
+- [UnZip](#UnZip)
 - [UnZip](#UnZip)
 
 <div STYLE="page-break-after: always;"></div>
@@ -92,6 +94,32 @@ func main() {
 ```
 
 
+
+### <span id="CreateDir">CreateDir</span>
+<p>Create directory in absolute path. param `absPath` like /a/, /a/b/.</p>
+
+<b>Signature:</b>
+
+```go
+func CreateDir(absPath string) error
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/fileutil"
+)
+
+func main() {
+    err := fileutil.CreateDir("/a/")
+    fmt.Println(err)
+}
+```
+
+
 ### <span id="CopyFile">CopyFile</span>
 <p>Copy src file to dest file. If dest file exist will overwrite it.</p>
 

docs/fileutil_zh-CN.md

@@ -21,6 +21,7 @@ import (
 ## 目录
 - [ClearFile](#ClearFile)
 - [CreateFile](#CreateFile)
+- [CreateDir](#CreateDir)
 - [CopyFile](#CopyFile)
 - [FileMode](#FileMode)
 - [MiMeType](#MiMeType)
@@ -92,6 +93,32 @@ func main() {
 ```
 
 
+### <span id="CreateDir">CreateDir</span>
+<p>使用绝对路径创建嵌套目录，例如/a/, /a/b/</p>
+
+<b>函数签名:</b>
+
+```go
+func CreateDir(absPath string) error
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/fileutil"
+)
+
+func main() {
+    err := fileutil.CreateDir("/a/")
+    fmt.Println(err)
+}
+```
+
+
+
 ### <span id="CopyFile">CopyFile</span>
 <p>拷贝文件，会覆盖原有的拷贝文件</p>
 

docs/slice.md

@@ -31,6 +31,8 @@ import (
 - [DifferenceWith](#DifferenceWith)
 - [DeleteAt](#DeleteAt)
 - [Drop](#Drop)
+- [Equal](#Equal)
+- [EqualWith](#EqualWith)
 - [Every](#Every)
 - [Filter](#Filter)
 - [Find](#Find)
@@ -55,6 +57,7 @@ import (
 - [StringSlice](#StringSlice)
 - [SymmetricDifference](#SymmetricDifference)
 - [Unique](#Unique)
+- [UniqueBy](#UniqueBy)
 - [Union](#Union)
 - [UpdateAt](#UpdateAt)
 - [Without](#Without)
@@ -360,6 +363,68 @@ func main() {
 
 
 
+### <span id="Equal">Equal</span>
+<p>Check if two slices are equal: the same length and all elements' order and value are equal.</p>
+
+<b>Signature:</b>
+
+```go
+func Equal[T comparable](slice1, slice2 []T) bool
+```
+<b>Example:</b>
+
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/v2/slice"
+)
+
+func main() {
+	slice1 := []int{1, 2, 3}
+	slice2 := []int{1, 2, 3}
+	slice3 := []int{3, 2, 1}
+
+	res1 := slice.Equal(slice1, slice2)
+	res2 := slice.Equal(slice1, slice3)
+
+	fmt.Println(res1) //true
+	fmt.Println(res2) //false
+}
+```
+
+
+
+### <span id="EqualWith">EqualWith</span>
+<p>Check if two slices are equal with comparator func.</p>
+
+<b>Signature:</b>
+
+```go
+func EqualWith[T, U any](slice1 []T, slice2 []U, comparator func(T, U) bool) bool
+```
+<b>Example:</b>
+
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/v2/slice"
+)
+
+func main() {
+	slice1 := []int{1, 2, 3}
+	slice2 := []int{2, 4, 6}
+
+	isDouble := func(a, b int) bool {
+		return b == a*2
+	}
+
+	res := slice.EqualWith(slice1, slice2, isDouble)
+
+	fmt.Println(res) //true
+}
+```
+
+
 
 ### <span id="Every">Every</span>
 <p>Return true if all of the values in the slice pass the predicate function.</p>
@@ -1022,7 +1087,33 @@ func main() {
 
 
 
-### <span id="Union">Unique</span>
+### <span id="UniqueBy">UniqueBy</span>
+<p>Call iteratee func with every item of slice, then remove duplicated.</p>
+
+<b>Signature:</b>
+
+```go
+func UniqueBy[T any](slice []T, iteratee func(item T) T) []T
+```
+<b>Example:</b>
+
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/slice"
+)
+
+func main() {
+	res := slice.UniqueBy([]int{1, 2, 3, 4, 5, 6}, func(val int) int {
+		return val % 4
+	})
+	fmt.Println(res) //[]int{1, 2, 3, 0}
+}
+```
+
+
+
+### <span id="Union">Union</span>
 <p>Creates a slice of unique values, in order, from all given slices. using == for equality comparisons.</p>
 
 <b>Signature:</b>

docs/slice_zh-CN.md

@@ -32,6 +32,8 @@ import (
 - [DeleteAt](#DeleteAt)
 - [Drop](#Drop)
 - [Every](#Every)
+- [Equal](#Equal)
+- [EqualWith](#EqualWith)
 - [Filter](#Filter)
 - [Find](#Find)
 - [FindLast](#FindLast)
@@ -55,6 +57,7 @@ import (
 - [StringSlice](#StringSlice)
 - [SymmetricDifference](#SymmetricDifference)
 - [Unique](#Unique)
+- [UniqueBy](#UniqueBy)
 - [Union](#Union)
 - [UpdateAt](#UpdateAt)
 - [Without](#Without)
@@ -393,6 +396,69 @@ func main() {
 
 
 
+### <span id="Equal">Equal</span>
+<p>检查两个切片是否相等，相等条件：切片长度相同，元素顺序和值都相同</p>
+
+<b>函数签名:</b>
+
+```go
+func Equal[T comparable](slice1, slice2 []T) bool
+```
+<b>例子:</b>
+
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/v2/slice"
+)
+
+func main() {
+	slice1 := []int{1, 2, 3}
+	slice2 := []int{1, 2, 3}
+	slice3 := []int{3, 2, 1}
+
+	res1 := slice.Equal(slice1, slice2)
+	res2 := slice.Equal(slice1, slice3)
+
+	fmt.Println(res1) //true
+	fmt.Println(res2) //false
+}
+```
+
+
+
+### <span id="EqualWith">EqualWith</span>
+<p>检查两个切片是否相等，相等条件：对两个切片的元素调用比较函数comparator，返回true</p>
+
+<b>函数签名:</b>
+
+```go
+func EqualWith[T, U any](slice1 []T, slice2 []U, comparator func(T, U) bool) bool
+```
+<b>例子:</b>
+
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/v2/slice"
+)
+
+func main() {
+	slice1 := []int{1, 2, 3}
+	slice2 := []int{2, 4, 6}
+
+	isDouble := func(a, b int) bool {
+		return b == a*2
+	}
+
+	res := slice.EqualWith(slice1, slice2, isDouble)
+
+	fmt.Println(res) //true
+}
+```
+
+
+
 ### <span id="Filter">Filter</span>
 <p>返回切片中通过predicate函数真值测试的所有元素</p>
 
@@ -1020,7 +1086,33 @@ func main() {
 
 
 
-### <span id="Union">Unique</span>
+### <span id="UniqueBy">UniqueBy</span>
+<p>对切片的每个元素调用iteratee函数，然后删除重复元素</p>
+
+<b>函数签名:</b>
+
+```go
+func UniqueBy[T any](slice []T, iteratee func(item T) T) []T
+```
+<b>例子:</b>
+
+```go
+import (
+	"fmt"
+	"github.com/duke-git/lancet/slice"
+)
+
+func main() {
+	res := slice.UniqueBy([]int{1, 2, 3, 4, 5, 6}, func(val int) int {
+		return val % 4
+	})
+	fmt.Println(res) //[]int{1, 2, 3, 0}
+}
+```
+
+
+
+### <span id="Union">Union</span>
 <p>从所有给定的切片按顺序创建一个唯一值切片，使用==进行相等比较</p>
 
 <b>函数签名:</b>

fileutil/file.go

@@ -13,6 +13,7 @@ import (
 	"io/ioutil"
 	"net/http"
 	"os"
+	"path"
 	"path/filepath"
 	"strings"
 )
@@ -40,6 +41,11 @@ func CreateFile(path string) bool {
 	return true
 }
 
+// CreateDir create directory in absolute path. param `absPath` like /a/, /a/b/
+func CreateDir(absPath string) error {
+	return os.MkdirAll(path.Dir(absPath), os.ModePerm)
+}
+
 // IsDir checks if the path is directory or not
 func IsDir(path string) bool {
 	file, err := os.Stat(path)

fileutil/file_test.go

@@ -33,6 +33,27 @@ func TestCreateFile(t *testing.T) {
 	os.Remove(f)
 }
 
+func TestCreateDir(t *testing.T) {
+	assert := internal.NewAssert(t, "TestCreateDir")
+
+	pwd, err := os.Getwd()
+	if err != nil {
+		t.Error(err)
+		t.FailNow()
+	}
+
+	dirPath := pwd + "/a/"
+	err = CreateDir(dirPath)
+	if err != nil {
+		t.Error(err)
+		t.FailNow()
+	}
+
+	assert.Equal(true, IsExist(dirPath))
+	os.Remove(dirPath)
+	assert.Equal(false, IsExist(dirPath))
+}
+
 func TestIsDir(t *testing.T) {
 	assert := internal.NewAssert(t, "TestIsDir")
 

slice/slice.go

@@ -147,6 +147,37 @@ func DifferenceWith[T any](slice []T, comparedSlice []T, comparator func(value,
 	return res
 }
 
+// Equal checks if two slices are equal: the same length and all elements' order and value are equal
+func Equal[T comparable](slice1, slice2 []T) bool {
+	if len(slice1) != len(slice2) {
+		return false
+	}
+
+	for i := range slice1 {
+		if slice1[i] != slice2[i] {
+			return false
+		}
+	}
+
+	return true
+}
+
+// EqualWith checks if two slices are equal with comparator func
+func EqualWith[T, U any](slice1 []T, slice2 []U, comparator func(T, U) bool) bool {
+	if len(slice1) != len(slice2) {
+		return false
+	}
+
+	for i, v1 := range slice1 {
+		v2 := slice2[i]
+		if !comparator(v1, v2) {
+			return false
+		}
+	}
+
+	return true
+}
+
 // Every return true if all of the values in the slice pass the predicate function.
 func Every[T any](slice []T, predicate func(index int, item T) bool) bool {
 	if predicate == nil {
@@ -551,6 +582,21 @@ func Unique[T any](slice []T) []T {
 	return res
 }
 
+// UniqueBy call iteratee func with every item of slice, then remove duplicated.
+func UniqueBy[T any](slice []T, iteratee func(item T) T) []T {
+	if len(slice) == 0 {
+		return []T{}
+	}
+
+	var res []T
+	for _, v := range slice {
+		val := iteratee(v)
+		res = append(res, val)
+	}
+
+	return Unique(res)
+}
+
 // Union creates a slice of unique values, in order, from all given slices. using == for equality comparisons.
 func Union[T any](slices ...[]T) []T {
 	if len(slices) == 0 {

slice/slice_test.go

@@ -61,11 +61,39 @@ func TestCompact(t *testing.T) {
 func TestConcat(t *testing.T) {
 	assert := internal.NewAssert(t, "Concat")
 
-	// assert.Equal([]int{0}, Concat([]int{}, 0))
-	// assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, 4, 5))
 	assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, []int{4, 5}))
 	assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, []int{4}, []int{5}))
-	// assert.Equal([]int{1, 2, 3, 4, 5}, Concat([]int{1, 2, 3}, []int{4}, 5))
+}
+
+func TestEqual(t *testing.T) {
+	assert := internal.NewAssert(t, "TestEqual")
+
+	slice1 := []int{1, 2, 3}
+	slice2 := []int{1, 2, 3}
+	slice3 := []int{3, 2, 1}
+
+	assert.Equal(true, Equal(slice1, slice2))
+	assert.Equal(false, Equal(slice1, slice3))
+}
+
+// go test -fuzz=Fuzz -fuzztime=10s .
+func FuzzEqual(f *testing.F) {
+	f.Fuzz(func(t *testing.T, a, b []byte) {
+		Equal(a, b)
+	})
+}
+
+func TestEqualWith(t *testing.T) {
+	assert := internal.NewAssert(t, "TestEqualWith")
+
+	slice1 := []int{1, 2, 3}
+	slice2 := []int{2, 4, 6}
+
+	isDouble := func(a, b int) bool {
+		return b == a*2
+	}
+
+	assert.Equal(true, EqualWith(slice1, slice2, isDouble))
 }
 
 func TestEvery(t *testing.T) {
@@ -371,6 +399,15 @@ func TestUnique(t *testing.T) {
 	assert.Equal([]string{"a", "b", "c"}, Unique([]string{"a", "a", "b", "c"}))
 }
 
+func TestUniqueBy(t *testing.T) {
+	assert := internal.NewAssert(t, "TestUniqueBy")
+
+	actual := UniqueBy([]int{1, 2, 3, 4, 5, 6}, func(val int) int {
+		return val % 4
+	})
+	assert.Equal([]int{1, 2, 3, 0}, actual)
+}
+
 func TestUnion(t *testing.T) {
 	assert := internal.NewAssert(t, "TestUnion")