feat: add Trim and SplitAndTrim

strutil/string.go

@@ -445,3 +445,57 @@ 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.
+// Play: todo
+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 an array,
+// and calls Trim to every element of this array. 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)
+}

strutil/string_example_test.go

@@ -525,3 +525,49 @@ func ExampleIndexOffset() {
 	// -1
 	// -1
 }
+
+func ExampleReplaceWithMap() {
+	str := "ac ab ab ac"
+	replaces := map[string]string{
+		"a": "1",
+		"b": "2",
+	}
+
+	result := ReplaceWithMap(str, replaces)
+
+	fmt.Println(result)
+	// Output:
+	// 1c 12 12 1c
+}
+
+func ExampleTrim() {
+	result1 := Trim("\nabcd")
+
+	str := "$ ab	cd $ "
+
+	result2 := Trim(str)
+	result3 := Trim(str, "$")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+
+	// Output:
+	// abcd
+	// $ ab	cd $
+	// ab	cd
+}
+
+func ExampleSplitAndTrim() {
+	str := " a,b, c,d,$1 "
+
+	result1 := SplitAndTrim(str, ",")
+	result2 := SplitAndTrim(str, ",", "$")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+
+	// Output:
+	// [a b c d $1]
+	// [a b c d 1]
+}

strutil/string_test.go

@@ -397,3 +397,38 @@ 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)
+}