doc: update doc for v2.3.1

merge qa branch
Merge branch 'rc' into v2
2026-02-23 13:52:26 +08:00 · 2024-05-14 10:47:27 +08:00 · 2024-05-14 10:11:29 +08:00 · 2024-05-14 10:10:45 +08:00 · 2024-05-14 10:08:56 +08:00 · 2024-05-14 10:02:56 +08:00
8 changed files with 70 additions and 39 deletions
--- a/README.md
+++ b/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.3.0-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.3.1-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)
@@ -901,6 +901,10 @@ import "github.com/duke-git/lancet/v2/maputil"
 -   **<big>HasKey</big>** : checks if map has key or not.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#HasKey)]
    [[play](https://go.dev/play/p/isZZHOsDhFc)]
+-   **<big>ToSortedSlicesDefault</big>** : converts a map to two slices sorted by key: one for the keys and another for the values.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#ToSortedSlicesDefault)]
+-   **<big>ToSortedSlicesWithComparator</big>** : converts a map to two slices sorted by key and using a custom comparison function: one for the keys and another for the values.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#ToSortedSlicesWithComparator)]
 -   **<big>NewConcurrentMap</big>** : creates a ConcurrentMap with specific shard count.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#NewConcurrentMap)]
    [[play](https://go.dev/play/p/3PenTPETJT0)]
@@ -1432,6 +1436,12 @@ import "github.com/duke-git/lancet/v2/slice"
 -   **<big>SetToDefaultIf</big>** : set elements to their default value if they match the given predicate.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/slice.md#SetToDefaultIf)]
    [[play](https://go.dev/play/p/9AXGlPRC0-A)]
+-   **<big>Break</big>** : breaks a list into two parts at the point where the predicate for the first time is true.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/slice.md#Break)]
+-   **<big>RightPadding</big>** : adds padding to the right end of a slice.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/slice.md#RightPadding)]
+-   **<big>LeftPadding</big>** : adds padding to the left begin of a slice.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/slice.md#LeftPadding)]



--- a/README_zh-CN.md
+++ b/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.3.0-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.3.1-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)
@@ -903,6 +903,10 @@ import "github.com/duke-git/lancet/v2/maputil"
 -   **<big>HasKey</big>** : 检查 map 是否包含某个 key。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#HasKey)]
    [[play](https://go.dev/play/p/isZZHOsDhFc)]
+-   **<big>ToSortedSlicesDefault</big>** : 将map的key和value转化成两个根据key的值从小到大排序的切片，value切片中元素的位置与key对应。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#ToSortedSlicesDefault)]
+-   **<big>ToSortedSlicesWithComparator</big>** : 将map的key和value转化成两个使用比较器函数根据key的值自定义排序规则的切片，value切片中元素的位置与key对应。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#ToSortedSlicesWithComparator)]
 -   **<big>NewConcurrentMap</big>** : ConcurrentMap 协程安全的 map 结构。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#NewConcurrentMap)]
    [[play](https://go.dev/play/p/3PenTPETJT0)]
@@ -1431,7 +1435,12 @@ import "github.com/duke-git/lancet/v2/slice"
 -   **<big>SetToDefaultIf</big>** : 根据给定给定的predicate判定函数来修改切片中的元素。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/slice.md#SetToDefaultIf)]
    [[play](https://go.dev/play/p/9AXGlPRC0-A)]
-
+-   **<big>Break</big>** : 根据判断函数将切片分成两部分。它开始附加到与函数匹配的第一个元素之后的第二个切片。第一个匹配之后的所有元素都包含在第二个切片中，无论它们是否与函数匹配。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/slice.md#Break)]
+-   **<big>RightPadding</big>** : 在切片的右部添加元素。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/slice.md#RightPadding)]
+-   **<big>LeftPadding</big>** : 在切片的左部添加元素。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/slice.md#LeftPadding)]


 <h3 id="stream"> 19. stream 流，该包仅验证简单的 stream 实现，功能有限。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>
@@ -1521,6 +1530,7 @@ import "github.com/duke-git/lancet/v2/stream"
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/stream.md#ToSlice)]
    [[play](https://go.dev/play/p/jI6_iZZuVFE)]

+
 <h3 id="structs"> 20. structs 提供操作 struct, tag, field 的相关函数。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>

 ```go
--- a/maputil/map.go
+++ b/maputil/map.go
@@ -6,9 +6,11 @@ package maputil

 import (
 	"fmt"
-	"golang.org/x/exp/constraints"
 	"reflect"
 	"sort"
+	"strings"
+
+	"golang.org/x/exp/constraints"

 	"github.com/duke-git/lancet/v2/slice"
 )
@@ -377,8 +379,7 @@ func getFieldNameByJsonTag(structObj any, jsonTag string) string {
 	for i := 0; i < s.NumField(); i++ {
 		field := s.Field(i)
 		tag := field.Tag
-		name := tag.Get("json")
-
+		name, _, _ := strings.Cut(tag.Get("json"), ",")
 		if name == jsonTag {
 			return field.Name
 		}
--- a/maputil/map_test.go
+++ b/maputil/map_test.go
@@ -485,7 +485,7 @@ func TestMapToStruct(t *testing.T) {
 			Name  string   `json:"name"`
 			Age   int      `json:"age"`
 			Phone string   `json:"phone"`
-			Addr  *Address `json:"address"`
+			Addr  *Address `json:"address,omitempty"`
 		}

 		Address struct {
--- a/netutil/http_test.go
+++ b/netutil/http_test.go
@@ -5,7 +5,6 @@ import (
 	"encoding/json"
 	"io"
 	"io/ioutil"
-	"log"
 	"net/http"
 	"net/http/httptest"
 	"net/url"
@@ -24,7 +23,8 @@ func TestHttpGet(t *testing.T) {

 	resp, err := HttpGet(url, header)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: " + err.Error())
+		return
 	}

 	body, _ := io.ReadAll(resp.Body)
@@ -45,8 +45,10 @@ func TestHttpPost(t *testing.T) {

 	resp, err := HttpPost(url, header, nil, bodyParams)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: " + err.Error())
+		return
 	}
+
 	body, _ := io.ReadAll(resp.Body)
 	t.Log("response: ", resp.StatusCode, string(body))
 }
@@ -55,21 +57,18 @@ func TestHttpPostFormData(t *testing.T) {
 	apiUrl := "https://jsonplaceholder.typicode.com/todos"
 	header := map[string]string{
 		"Content-Type": "application/x-www-form-urlencoded",
-		// "Content-Type": "multipart/form-data",
 	}

 	postData := url.Values{}
 	postData.Add("userId", "1")
 	postData.Add("title", "TestToDo")

-	// postData := make(map[string]string)
-	// postData["userId"] = "1"
-	// postData["title"] = "title"
-
 	resp, err := HttpPost(apiUrl, header, nil, postData)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: " + err.Error())
+		return
 	}
+
 	body, _ := io.ReadAll(resp.Body)
 	t.Log("response: ", resp.StatusCode, string(body))
 }
@@ -89,8 +88,10 @@ func TestHttpPut(t *testing.T) {

 	resp, err := HttpPut(url, header, nil, bodyParams)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}
+
 	body, _ := io.ReadAll(resp.Body)
 	t.Log("response: ", resp.StatusCode, string(body))
 }
@@ -110,8 +111,10 @@ func TestHttpPatch(t *testing.T) {

 	resp, err := HttpPatch(url, header, nil, bodyParams)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}
+
 	body, _ := io.ReadAll(resp.Body)
 	t.Log("response: ", resp.StatusCode, string(body))
 }
@@ -120,8 +123,10 @@ func TestHttpDelete(t *testing.T) {
 	url := "https://jsonplaceholder.typicode.com/todos/1"
 	resp, err := HttpDelete(url)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}
+
 	body, _ := io.ReadAll(resp.Body)
 	t.Log("response: ", resp.StatusCode, string(body))
 }
@@ -148,7 +153,8 @@ func TestParseResponse(t *testing.T) {

 	resp, err := HttpGet(url, header)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}

 	type Todo struct {
@@ -161,8 +167,10 @@ func TestParseResponse(t *testing.T) {
 	toDoResp := &Todo{}
 	err = ParseHttpResponse(resp, toDoResp)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}
+
 	t.Log("response: ", toDoResp)
 }

@@ -179,7 +187,8 @@ func TestHttpClient_Get(t *testing.T) {
 	httpClient := NewHttpClient()
 	resp, err := httpClient.SendRequest(request)
 	if err != nil || resp.StatusCode != 200 {
-		log.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}

 	type Todo struct {
@@ -216,7 +225,8 @@ func TestHttpClent_Post(t *testing.T) {
 	httpClient := NewHttpClient()
 	resp, err := httpClient.SendRequest(request)
 	if err != nil {
-		log.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}

 	body, _ := io.ReadAll(resp.Body)
@@ -376,8 +386,10 @@ func TestProxy(t *testing.T) {
 	httpClient := NewHttpClientWithConfig(config)
 	resp, err := httpClient.Get("https://www.ipplus360.com/getLocation")
 	if err != nil {
-		t.Fatal(err)
+		t.Log("net error: ", err.Error())
+		return
 	}
+
 	if resp.StatusCode != http.StatusOK {
 		t.Fatalf("expected %d, got %d", http.StatusOK, resp.StatusCode)
 	}
--- a/slice/slice.go
+++ b/slice/slice.go
@@ -772,21 +772,14 @@ func UpdateAt[T any](slice []T, index int, value T) []T {
 // Play: https://go.dev/play/p/AXw0R3ZTE6a
 func Unique[T comparable](slice []T) []T {
 	result := []T{}
-
-	for i := 0; i < len(slice); i++ {
-		v := slice[i]
-		skip := true
-		for j := range result {
-			if v == result[j] {
-				skip = false
-				break
-			}
-		}
-		if skip {
-			result = append(result, v)
+	exists := map[T]bool{}
+	for _, t := range slice {
+		if exists[t] {
+			continue
 		}
+		exists[t] = true
+		result = append(result, t)
 	}
-
 	return result
 }

--- a/validator/validator.go
+++ b/validator/validator.go
@@ -8,6 +8,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net"
+	"net/mail"
 	"net/url"
 	"reflect"
 	"regexp"
@@ -24,7 +25,7 @@ var (
 	intStrMatcher          *regexp.Regexp = regexp.MustCompile(`^[\+-]?\d+$`)
 	urlMatcher             *regexp.Regexp = regexp.MustCompile(`^((ftp|http|https?):\/\/)?(\S+(:\S*)?@)?((([1-9]\d?|1\d\d|2[01]\d|22[0-3])(\.(1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.([0-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(([a-zA-Z0-9]+([-\.][a-zA-Z0-9]+)*)|((www\.)?))?(([a-z\x{00a1}-\x{ffff}0-9]+-?-?)*[a-z\x{00a1}-\x{ffff}0-9]+)(?:\.([a-z\x{00a1}-\x{ffff}]{2,}))?))(:(\d{1,5}))?((\/|\?|#)[^\s]*)?$`)
 	dnsMatcher             *regexp.Regexp = regexp.MustCompile(`^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$`)
-	emailMatcher           *regexp.Regexp = regexp.MustCompile(`\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*`)
+	emailMatcher           *regexp.Regexp = regexp.MustCompile(`^[a-z0-9._%+\-]+@[a-z0-9.\-]+\.[a-z]{2,4}$`)
 	chineseMobileMatcher   *regexp.Regexp = regexp.MustCompile(`^1(?:3\d|4[4-9]|5[0-35-9]|6[67]|7[013-8]|8\d|9\d)\d{8}$`)
 	chineseIdMatcher       *regexp.Regexp = regexp.MustCompile(`^(\d{17})([0-9]|X|x)$`)
 	chineseMatcher         *regexp.Regexp = regexp.MustCompile("[\u4e00-\u9fa5]")
@@ -264,7 +265,10 @@ func IsDns(dns string) bool {
 // IsEmail check if the string is a email address.
 // Play: https://go.dev/play/p/Os9VaFlT33G
 func IsEmail(email string) bool {
-	return emailMatcher.MatchString(email)
+	_, err := mail.ParseAddress(email)
+	return err == nil
+
+	// return emailMatcher.MatchString(email)
 }

 // IsChineseMobile check if the string is chinese mobile number.
--- a/validator/validator_test.go
+++ b/validator/validator_test.go
@@ -285,6 +285,7 @@ func TestIsEmail(t *testing.T) {
 	assert := internal.NewAssert(t, "TestIsEmail")

 	assert.Equal(true, IsEmail("abc@xyz.com"))
+	assert.Equal(false, IsEmail("@abc@xyz.com"))
 	assert.Equal(false, IsEmail("a.b@@com"))
 }
Author	SHA1	Message	Date
dudaodong	967e6a3493	doc: update doc for v2.3.1	2024-05-14 10:47:27 +08:00
dudaodong	5b24801e49	merge qa branch	2024-05-14 10:11:29 +08:00
dudaodong	974ba525a6	Merge branch 'rc' into v2	2024-05-14 10:10:45 +08:00
chentong	f0235c40b6	fix: json tag omitempty convert error (#218 )	2024-05-14 10:08:56 +08:00
dudaodong	712a215ea6	reset	2024-05-14 10:02:56 +08:00
dudaodong	7893f828d3	fix: fix get tag failed	2024-05-13 17:49:34 +08:00
Yang Li	53fa210f09	refactor slice.Unique() (#215 )	2024-05-09 10:43:59 +08:00
dudaodong	de9ee08be4	test: update net error handle	2024-04-18 14:23:36 +08:00
dudaodong	5381450bea	feat: fix email validation failed	2024-04-18 14:18:33 +08:00