feat: add ReplaceWithMap, Trim, SplitAndTrim, HideString

docs/strutil.md

@@ -51,6 +51,10 @@ import (
 -   [HasPrefixAny](#HasPrefixAny)
 -   [HasSuffixAny](#HasSuffixAny)
 -   [IndexOffset](#IndexOffset)
+-   [ReplaceWithMap](#ReplaceWithMap)
+-   [Trim](#Trim)
+-   [SplitAndTrim](#SplitAndTrim)
+-   [HideString](#HideString)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -1021,4 +1025,146 @@ func main() {
 	// -1
 	// -1
 }
-```
+```
+
+### <span id="ReplaceWithMap">ReplaceWithMap</span>
+
+<p>Returns a copy of `str`, which is replaced by a map in unordered way, case-sensitively.</p>
+
+<b>Signature:</b>
+
+```go
+func ReplaceWithMap(str string, replaces map[string]string) string
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := "ac ab ab ac"
+	replaces := map[string]string{
+		"a": "1",
+		"b": "2",
+	}
+
+	result := strutil.ReplaceWithMap(str, replaces)
+
+	fmt.Println(result)
+	// Output:
+	// 1c 12 12 1c
+}
+```
+
+### <span id="Trim">Trim</span>
+
+<p>Strips whitespace (or other characters) from the beginning and end of a string. The optional parameter `characterMask` specifies the additional stripped characters.</p>
+
+<b>Signature:</b>
+
+```go
+func Trim(str string, characterMask ...string) string
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    result1 := strutil.Trim("\nabcd")
+
+	str := "$ ab	cd $ "
+
+	result2 := strutil.Trim(str)
+	result3 := strutil.Trim(str, "$")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// abcd
+	// $ ab	cd $
+	// ab	cd
+}
+```
+
+### <span id="SplitAndTrim">SplitAndTrim</span>
+
+<p>Splits string `str` by a string `delimiter` to a slice, and calls Trim to every element of slice. It ignores the elements which are empty after Trim.</p>
+
+<b>Signature:</b>
+
+```go
+func SplitAndTrim(str, delimiter string, characterMask ...string) []string
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := " a,b, c,d,$1 "
+
+	result1 := strutil.SplitAndTrim(str, ",")
+	result2 := strutil.SplitAndTrim(str, ",", "$")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+
+	// Output:
+	// [a b c d $1]
+	// [a b c d 1]
+}
+```
+
+### <span id="HideString">HideString</span>
+
+<p>HideString hide some chars in source string with param `replaceChar`. replace range is origin[start : end]. [start, end).</p>
+
+<b>Signature:</b>
+
+```go
+func HideString(origin string, start, end int, replaceChar string) string
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := "13242658976"
+
+	result1 := strutil.HideString(str, 3, 3, "*")
+	result2 := strutil.HideString(str, 3, 4, "*")
+	result3 := strutil.HideString(str, 3, 7, "*")
+	result4 := strutil.HideString(str, 7, 11, "*")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// 13242658976
+	// 132*2658976
+	// 132****8976
+	// 1324265****
+}
+```

docs/strutil_zh-CN.md

@@ -51,6 +51,10 @@ import (
 -   [HasPrefixAny](#HasPrefixAny)
 -   [HasSuffixAny](#HasSuffixAny)
 -   [IndexOffset](#IndexOffset)
+-   [ReplaceWithMap](#ReplaceWithMap)
+-   [Trim](#Trim)
+-   [SplitAndTrim](#SplitAndTrim)
+-   [HideString](#HideString)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -832,7 +836,6 @@ func main() {
 }
 ```
 
-
 ### <span id="RemoveNonPrintable">RemoveNonPrintable</span>
 
 <p>删除字符串中不可打印的字符。</p>
@@ -1053,4 +1056,148 @@ func main() {
 	// -1
 	// -1
 }
-```
+```
+
+### <span id="ReplaceWithMap">ReplaceWithMap</span>
+
+<p>返回`str`的副本，以无序的方式被map替换，区分大小写。</p>
+
+<b>函数签名:</b>
+
+```go
+func ReplaceWithMap(str string, replaces map[string]string) string
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := "ac ab ab ac"
+	replaces := map[string]string{
+		"a": "1",
+		"b": "2",
+	}
+
+	result := strutil.ReplaceWithMap(str, replaces)
+
+	fmt.Println(result)
+	// Output:
+	// 1c 12 12 1c
+}
+```
+
+### <span id="Trim">Trim</span>
+
+<p>从字符串的开头和结尾去除空格（或其他字符）。 可选参数 characterMask 指定额外的剥离字符。</p>
+
+<b>函数签名:</b>
+
+```go
+func Trim(str string, characterMask ...string) string
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    result1 := strutil.Trim("\nabcd")
+
+	str := "$ ab	cd $ "
+
+	result2 := strutil.Trim(str)
+	result3 := strutil.Trim(str, "$")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// abcd
+	// $ ab	cd $
+	// ab	cd
+}
+```
+
+
+### <span id="SplitAndTrim">SplitAndTrim</span>
+
+<p>将字符串str按字符串delimiter拆分为一个切片，并对该数组的每个元素调用Trim。忽略Trim后为空的元素。</p>
+
+<b>函数签名:</b>
+
+```go
+func SplitAndTrim(str, delimiter string, characterMask ...string) []string
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := " a,b, c,d,$1 "
+
+	result1 := strutil.SplitAndTrim(str, ",")
+	result2 := strutil.SplitAndTrim(str, ",", "$")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+
+	// Output:
+	// [a b c d $1]
+	// [a b c d 1]
+}
+```
+
+
+### <span id="HideString">HideString</span>
+
+<p>使用参数`replaceChar`隐藏源字符串中的一些字符。替换范围是 origin[start : end]。</p>
+
+<b>函数签名:</b>
+
+```go
+func HideString(origin string, start, end int, replaceChar string) string
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := "13242658976"
+
+	result1 := strutil.HideString(str, 3, 3, "*")
+	result2 := strutil.HideString(str, 3, 4, "*")
+	result3 := strutil.HideString(str, 3, 7, "*")
+	result4 := strutil.HideString(str, 7, 11, "*")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// 13242658976
+	// 132*2658976
+	// 132****8976
+	// 1324265****
+}
+```

strutil/string.go

@@ -403,3 +403,81 @@ func IndexOffset(str string, substr string, idxFrom int) int {
 
 	return strings.Index(str[idxFrom:], substr) + idxFrom
 }
+
+// ReplaceWithMap returns a copy of `str`, which is replaced by a map in unordered way, case-sensitively.
+func ReplaceWithMap(str string, replaces map[string]string) string {
+	for k, v := range replaces {
+		str = strings.ReplaceAll(str, k, v)
+	}
+
+	return str
+}
+
+// SplitAndTrim splits string `str` by a string `delimiter` to a slice,
+// and calls Trim to every element of this slice. It ignores the elements
+// which are empty after Trim.
+func SplitAndTrim(str, delimiter string, characterMask ...string) []string {
+	result := make([]string, 0)
+
+	for _, v := range strings.Split(str, delimiter) {
+		v = Trim(v, characterMask...)
+		if v != "" {
+			result = append(result, v)
+		}
+	}
+
+	return result
+}
+
+var (
+	// DefaultTrimChars are the characters which are stripped by Trim* functions in default.
+	DefaultTrimChars = string([]byte{
+		'\t', // Tab.
+		'\v', // Vertical tab.
+		'\n', // New line (line feed).
+		'\r', // Carriage return.
+		'\f', // New page.
+		' ',  // Ordinary space.
+		0x00, // NUL-byte.
+		0x85, // Delete.
+		0xA0, // Non-breaking space.
+	})
+)
+
+// Trim strips whitespace (or other characters) from the beginning and end of a string.
+// The optional parameter `characterMask` specifies the additional stripped characters.
+func Trim(str string, characterMask ...string) string {
+	trimChars := DefaultTrimChars
+
+	if len(characterMask) > 0 {
+		trimChars += characterMask[0]
+	}
+
+	return strings.Trim(str, trimChars)
+}
+
+// HideString hide some chars in source string with param `replaceChar`.
+// replace range is origin[start : end]. [start, end)
+func HideString(origin string, start, end int, replaceChar string) string {
+	size := len(origin)
+
+	if start > size-1 || start < 0 || end < 0 || start > end {
+		return origin
+	}
+
+	if end > size {
+		end = size
+	}
+
+	if replaceChar == "" {
+		return origin
+	}
+
+	startStr := origin[0:start]
+	endStr := origin[end:size]
+
+	replaceSize := end - start
+	replaceStr := strings.Repeat(replaceChar, replaceSize)
+
+	return startStr + replaceStr + endStr
+}

strutil/string_test.go

@@ -386,3 +386,56 @@ func TestIndexOffset(t *testing.T) {
 	assert.Equal(IndexOffset(str, "d", len(str)), -1)
 	assert.Equal(IndexOffset(str, "f", -1), -1)
 }
+
+func TestReplaceWithMap(t *testing.T) {
+	assert := internal.NewAssert(t, "TestReplaceWithMap")
+
+	str := "ac ab ab ac"
+	replaces := map[string]string{
+		"a": "1",
+		"b": "2",
+	}
+
+	assert.Equal(str, "ac ab ab ac")
+	assert.Equal(ReplaceWithMap(str, replaces), "1c 12 12 1c")
+}
+
+func TestTrim(t *testing.T) {
+	assert := internal.NewAssert(t, "TestTrim")
+
+	str1 := "$ ab	cd $ "
+
+	assert.Equal("$ ab	cd $", Trim(str1))
+	assert.Equal("ab	cd", Trim(str1, "$"))
+	assert.Equal("abcd", Trim("\nabcd"))
+}
+
+func TestSplitAndTrim(t *testing.T) {
+	assert := internal.NewAssert(t, "TestTrim")
+
+	str := " a,b, c,d,$1 "
+
+	result1 := SplitAndTrim(str, ",")
+	result2 := SplitAndTrim(str, ",", "$")
+
+	assert.Equal([]string{"a", "b", "c", "d", "$1"}, result1)
+	assert.Equal([]string{"a", "b", "c", "d", "1"}, result2)
+}
+
+func TestHideString(t *testing.T) {
+	assert := internal.NewAssert(t, "TestTrim")
+
+	str := "13242658976"
+
+	assert.Equal("13242658976", HideString(str, 0, -1, "*"))
+	assert.Equal("13242658976", HideString(str, 0, 0, "*"))
+	assert.Equal("****2658976", HideString(str, 0, 4, "*"))
+
+	assert.Equal("13242658976", HideString(str, 3, 3, "*"))
+	assert.Equal("132*2658976", HideString(str, 3, 4, "*"))
+	assert.Equal("132****8976", HideString(str, 3, 7, "*"))
+	assert.Equal("1324265****", HideString(str, 7, 11, "*"))
+
+	assert.Equal("1324265****", HideString(str, 7, 100, "*"))
+	assert.Equal("13242658976", HideString(str, 100, 100, "*"))
+}