feat: add WriteMapsToCsv

docs/strutil.md

@@ -58,6 +58,7 @@ import (
 -   [SplitAndTrim](#SplitAndTrim)
 -   [HideString](#HideString)
 -   [RemoveWhiteSpace](#RemoveWhiteSpace)
+-   [SubInBetween](#SubInBetween)
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -1274,3 +1275,36 @@ func main() {
     // hello world
 }
 ```
+
+### <span id="SubInBetween">SubInBetween</span>
+
+<p>Return substring between the start and end position(excluded) of source string.</p>
+
+<b>Signature:</b>
+
+```go
+func SubInBetween(str string, start string, end string) string
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := "abcde"
+
+    result1 := strutil.SubInBetween(str, "", "de")
+    result2 := strutil.SubInBetween(str, "a", "d")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // abc
+    // bc
+}
+```

docs/strutil_zh-CN.md

@@ -58,6 +58,7 @@ import (
 -   [SplitAndTrim](#SplitAndTrim)
 -   [HideString](#HideString)
 -   [RemoveWhiteSpace](#RemoveWhiteSpace)
+-   [SubInBetween](#SubInBetween)
 
 
 <div STYLE="page-break-after: always;"></div>
@@ -1307,3 +1308,36 @@ func main() {
     // hello world
 }
 ```
+
+### <span id="SubInBetween">SubInBetween</span>
+
+<p>获取字符串中指定的起始字符串start和终止字符串end直接的子字符串。</p>
+
+<b>函数签名:</b>
+
+```go
+func SubInBetween(str string, start string, end string) string
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/strutil"
+)
+
+func main() {
+    str := "abcde"
+
+    result1 := strutil.SubInBetween(str, "", "de")
+    result2 := strutil.SubInBetween(str, "a", "d")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+
+    // Output:
+    // abc
+    // bc
+}
+```

fileutil/file.go

@@ -21,6 +21,7 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
+	"sort"
 	"strings"
 
 	"github.com/duke-git/lancet/validator"
@@ -524,15 +525,19 @@ func Sha(filepath string, shaType ...int) (string, error) {
 }
 
 // ReadCsvFile read file content into slice.
-func ReadCsvFile(filepath string) ([][]string, error) {
+func ReadCsvFile(filepath string, delimiter ...rune) ([][]string, error) {
 	f, err := os.Open(filepath)
 	if err != nil {
 		return nil, err
 	}
 	defer f.Close()
 
-	csvReader := csv.NewReader(f)
-	records, err := csvReader.ReadAll()
+	reader := csv.NewReader(f)
+	if len(delimiter) > 0 {
+		reader.Comma = delimiter[0]
+	}
+
+	records, err := reader.ReadAll()
 	if err != nil {
 		return nil, err
 	}
@@ -541,7 +546,7 @@ func ReadCsvFile(filepath string) ([][]string, error) {
 }
 
 // WriteCsvFile write content to target csv file.
-func WriteCsvFile(filepath string, records [][]string, append bool) error {
+func WriteCsvFile(filepath string, records [][]string, append bool, delimiter ...rune) error {
 	flag := os.O_RDWR | os.O_CREATE
 
 	if append {
@@ -556,11 +561,91 @@ func WriteCsvFile(filepath string, records [][]string, append bool) error {
 	defer f.Close()
 
 	writer := csv.NewWriter(f)
-	writer.Comma = ','
+	// 设置默认分隔符为逗号，除非另外指定
+	if len(delimiter) > 0 {
+		writer.Comma = delimiter[0]
+	} else {
+		writer.Comma = ','
+	}
+
+	// 遍历所有记录并处理包含分隔符或双引号的单元格
+	for i := range records {
+		for j := range records[i] {
+			records[i][j] = escapeCSVField(records[i][j], writer.Comma)
+		}
+	}
 
 	return writer.WriteAll(records)
 }
 
+// escapeCSVField 处理单元格内容，如果包含分隔符，则用双引号包裹
+func escapeCSVField(field string, delimiter rune) string {
+	// 替换所有的双引号为两个双引号
+	escapedField := strings.ReplaceAll(field, "\"", "\"\"")
+
+	// 如果字段包含分隔符、双引号或换行符，用双引号包裹整个字段
+	if strings.ContainsAny(escapedField, string(delimiter)+"\"\n") {
+		escapedField = fmt.Sprintf("\"%s\"", escapedField)
+	}
+
+	return escapedField
+}
+
+// WriteMapsToCsv write slice of map to csv file.
+// Play: https://go.dev/play/p/umAIomZFV1c
+// filepath: Path to the CSV file.
+// records: Slice of maps to be written. the value of map should be basic type.
+// the maps will be sorted by key in alphabeta order, then be written into csv file.
+// appendToExistingFile: If true, data will be appended to the file if it exists.
+// delimiter: Delimiter to use in the CSV file.
+// headers: order of the csv column headers, needs to be consistent with the key of the map.
+func WriteMapsToCsv(filepath string, records []map[string]interface{}, appendToExistingFile bool, delimiter rune,
+	headers ...[]string) error {
+	for _, record := range records {
+		for _, value := range record {
+			if !isCsvSupportedType(value) {
+				return errors.New("unsupported value type detected; only basic types are supported: \nbool, rune, string, int, int64, float32, float64, uint, byte, complex128, complex64, uintptr")
+			}
+		}
+	}
+
+	var columnHeaders []string
+	if len(headers) > 0 {
+		columnHeaders = headers[0]
+	} else {
+		for key := range records[0] {
+			columnHeaders = append(columnHeaders, key)
+		}
+		// sort keys in alphabeta order
+		sort.Strings(columnHeaders)
+	}
+
+	var datasToWrite [][]string
+	if !appendToExistingFile {
+		datasToWrite = append(datasToWrite, columnHeaders)
+	}
+
+	for _, record := range records {
+		var row []string
+		for _, h := range columnHeaders {
+			row = append(row, fmt.Sprintf("%v", record[h]))
+		}
+		datasToWrite = append(datasToWrite, row)
+	}
+
+	return WriteCsvFile(filepath, datasToWrite, appendToExistingFile, delimiter)
+}
+
+// check if the value of map which to be written into csv is basic type.
+func isCsvSupportedType(v interface{}) bool {
+	switch v.(type) {
+	case bool, rune, string, int, int64, float32, float64, uint, byte, complex128, complex64, uintptr:
+		return true
+	default:
+		return false
+	}
+}
+
 // WriteStringToFile write string to target file.
 func WriteStringToFile(filepath string, content string, append bool) error {
 	flag := os.O_RDWR | os.O_CREATE

fileutil/file_test.go

@@ -342,6 +342,31 @@ func TestWriteCsvFile(t *testing.T) {
 	assert.Equal("Lili", content[0][0])
 }
 
+func TestWriteMapsToCsv(t *testing.T) {
+	assert := internal.NewAssert(t, "TestWriteMapsToCSV")
+
+	csvFilePath := "./testdata/test4.csv"
+	records := []map[string]interface{}{
+		{"Name": "Lili", "Age": "22", "Gender": "female"},
+		{"Name": "Jim", "Age": "21", "Gender": "male"},
+	}
+
+	headers := []string{"Name", "Age", "Gender"}
+	err := WriteMapsToCsv(csvFilePath, records, false, ';', headers)
+
+	assert.IsNil(err)
+
+	content, err := ReadCsvFile(csvFilePath, ';')
+
+	assert.IsNil(err)
+
+	assert.Equal(3, len(content))
+	assert.Equal(3, len(content[0]))
+	assert.Equal("Lili", content[1][0])
+	assert.Equal("22", content[1][1])
+	assert.Equal("female", content[1][2])
+}
+
 func TestWriteStringToFile(t *testing.T) {
 	assert := internal.NewAssert(t, "TestWriteStringToFile")
 

fileutil/testdata/test4.csv

@@ -0,0 +1,3 @@
+Name;Age;Gender
+Lili;22;female
+Jim;21;male

formatter/formatter.go

@@ -8,41 +8,36 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"math"
+	"strconv"
+	"strings"
+	"unicode"
 
 	"github.com/duke-git/lancet/convertor"
-	"github.com/duke-git/lancet/strutil"
-	"github.com/duke-git/lancet/validator"
 )
 
 // Comma add comma to a number value by every 3 numbers from right. ahead by symbol char.
 // if value is invalid number string eg "aa", return empty string
 // Comma("12345", "$") => "$12,345", Comma(12345, "$") => "$12,345"
 func Comma(value interface{}, symbol string) string {
-	if validator.IsInt(value) {
-		v, err := convertor.ToInt(value)
-		if err != nil {
-			return ""
-		}
-		return symbol + commaInt(v)
-	}
+	numString := convertor.ToString(value)
 
-	if validator.IsFloat(value) {
-		v, err := convertor.ToFloat(value)
-		if err != nil {
-			return ""
-		}
-		return symbol + commaFloat(v)
-	}
-
-	if strutil.IsString(value) {
-		v := fmt.Sprintf("%v", value)
-		if validator.IsNumberStr(v) {
-			return symbol + commaStr(v)
-		}
+	_, err := strconv.ParseFloat(numString, 64)
+	if err != nil {
 		return ""
 	}
 
-	return ""
+	index := strings.Index(numString, ".")
+	if index == -1 {
+		index = len(numString)
+	}
+
+	for index > 3 {
+		index = index - 3
+		numString = numString[:index] + "," + numString[index:]
+	}
+
+	return symbol + numString
 }
 
 // Pretty data to JSON string.
@@ -177,3 +172,50 @@ func ParseDecimalBytes(size string) (uint64, error) {
 func ParseBinaryBytes(size string) (uint64, error) {
 	return parseBytes(size, "binary")
 }
+
+// see https://github.com/dustin/go-humanize/blob/master/bytes.go
+func parseBytes(s string, kind string) (uint64, error) {
+	lastDigit := 0
+	hasComma := false
+	for _, r := range s {
+		if !(unicode.IsDigit(r) || r == '.' || r == ',') {
+			break
+		}
+		if r == ',' {
+			hasComma = true
+		}
+		lastDigit++
+	}
+
+	num := s[:lastDigit]
+	if hasComma {
+		num = strings.Replace(num, ",", "", -1)
+	}
+
+	f, err := strconv.ParseFloat(num, 64)
+	if err != nil {
+		return 0, err
+	}
+
+	extra := strings.ToLower(strings.TrimSpace(s[lastDigit:]))
+
+	if kind == "decimal" {
+		if m, ok := decimalByteMap[extra]; ok {
+			f *= float64(m)
+			if f >= math.MaxUint64 {
+				return 0, fmt.Errorf("too large: %v", s)
+			}
+			return uint64(f), nil
+		}
+	} else {
+		if m, ok := binaryByteMap[extra]; ok {
+			f *= float64(m)
+			if f >= math.MaxUint64 {
+				return 0, fmt.Errorf("too large: %v", s)
+			}
+			return uint64(f), nil
+		}
+	}
+
+	return 0, fmt.Errorf("unhandled size name: %v", extra)
+}

formatter/formatter_internal.go

@@ -1,134 +0,0 @@
-package formatter
-
-import (
-	"bytes"
-	"fmt"
-	"math"
-	"strconv"
-	"strings"
-	"unicode"
-)
-
-// see https://github.com/dustin/go-humanize/blob/master/comma.go
-func commaInt(v int64) string {
-	sign := ""
-
-	// Min int64 can't be negated to a usable value, so it has to be special cased.
-	if v == math.MinInt64 {
-		return "-9,223,372,036,854,775,808"
-	}
-
-	if v < 0 {
-		sign = "-"
-		v = 0 - v
-	}
-
-	parts := []string{"", "", "", "", "", "", ""}
-	j := len(parts) - 1
-
-	for v > 999 {
-		parts[j] = strconv.FormatInt(v%1000, 10)
-		switch len(parts[j]) {
-		case 2:
-			parts[j] = "0" + parts[j]
-		case 1:
-			parts[j] = "00" + parts[j]
-		}
-		v = v / 1000
-		j--
-	}
-	parts[j] = strconv.Itoa(int(v))
-	return sign + strings.Join(parts[j:], ",")
-}
-
-func commaFloat(v float64) string {
-	buf := &bytes.Buffer{}
-	if v < 0 {
-		buf.Write([]byte{'-'})
-		v = 0 - v
-	}
-
-	comma := []byte{','}
-
-	parts := strings.Split(strconv.FormatFloat(v, 'f', -1, 64), ".")
-	pos := 0
-	if len(parts[0])%3 != 0 {
-		pos += len(parts[0]) % 3
-		buf.WriteString(parts[0][:pos])
-		buf.Write(comma)
-	}
-	for ; pos < len(parts[0]); pos += 3 {
-		buf.WriteString(parts[0][pos : pos+3])
-		buf.Write(comma)
-	}
-	buf.Truncate(buf.Len() - 1)
-
-	if len(parts) > 1 {
-		buf.Write([]byte{'.'})
-		buf.WriteString(parts[1])
-	}
-	return buf.String()
-}
-
-func commaStr(s string) string {
-	dotIndex := strings.Index(s, ".")
-	if dotIndex != -1 {
-		return commaStrRecursive(s[:dotIndex]) + s[dotIndex:]
-	}
-
-	return commaStrRecursive(s)
-}
-
-func commaStrRecursive(s string) string {
-	if len(s) <= 3 {
-		return s
-	}
-	return commaStrRecursive(s[:len(s)-3]) + "," + commaStrRecursive(s[len(s)-3:])
-}
-
-// see https://github.com/dustin/go-humanize/blob/master/bytes.go
-func parseBytes(s string, kind string) (uint64, error) {
-	lastDigit := 0
-	hasComma := false
-	for _, r := range s {
-		if !(unicode.IsDigit(r) || r == '.' || r == ',') {
-			break
-		}
-		if r == ',' {
-			hasComma = true
-		}
-		lastDigit++
-	}
-
-	num := s[:lastDigit]
-	if hasComma {
-		num = strings.Replace(num, ",", "", -1)
-	}
-
-	f, err := strconv.ParseFloat(num, 64)
-	if err != nil {
-		return 0, err
-	}
-
-	extra := strings.ToLower(strings.TrimSpace(s[lastDigit:]))
-
-	if kind == "decimal" {
-		if m, ok := decimalByteMap[extra]; ok {
-			f *= float64(m)
-			if f >= math.MaxUint64 {
-				return 0, fmt.Errorf("too large: %v", s)
-			}
-			return uint64(f), nil
-		}
-	} else {
-		if m, ok := binaryByteMap[extra]; ok {
-			f *= float64(m)
-			if f >= math.MaxUint64 {
-				return 0, fmt.Errorf("too large: %v", s)
-			}
-			return uint64(f), nil
-		}
-	}
-
-	return 0, fmt.Errorf("unhandled size name: %v", extra)
-}

strutil/string.go

@@ -5,7 +5,6 @@
 package strutil
 
 import (
-	"reflect"
 	"regexp"
 	"strings"
 	"unicode"
@@ -121,37 +120,45 @@ func UpperSnakeCase(s string) string {
 
 // Before create substring in source string before position when char first appear
 func Before(s, char string) string {
-	if s == "" || char == "" {
+	i := strings.Index(s, char)
+
+	if s == "" || char == "" || i == -1 {
 		return s
 	}
-	i := strings.Index(s, char)
+
 	return s[0:i]
 }
 
 // BeforeLast create substring in source string before position when char last appear
 func BeforeLast(s, char string) string {
-	if s == "" || char == "" {
+	i := strings.LastIndex(s, char)
+
+	if s == "" || char == "" || i == -1 {
 		return s
 	}
-	i := strings.LastIndex(s, char)
+
 	return s[0:i]
 }
 
 // After create substring in source string after position when char first appear
 func After(s, char string) string {
-	if s == "" || char == "" {
+	i := strings.Index(s, char)
+
+	if s == "" || char == "" || i == -1 {
 		return s
 	}
-	i := strings.Index(s, char)
+
 	return s[i+len(char):]
 }
 
 // AfterLast create substring in source string after position when char last appear
 func AfterLast(s, char string) string {
-	if s == "" || char == "" {
+	i := strings.LastIndex(s, char)
+
+	if s == "" || char == "" || i == -1 {
 		return s
 	}
-	i := strings.LastIndex(s, char)
+
 	return s[i+len(char):]
 }
 
@@ -342,10 +349,7 @@ func RemoveNonPrintable(str string) string {
 
 // StringToBytes converts a string to byte slice without a memory allocation.
 func StringToBytes(str string) (b []byte) {
-	sh := *(*reflect.StringHeader)(unsafe.Pointer(&str))
-	bh := (*reflect.SliceHeader)(unsafe.Pointer(&b))
-	bh.Data, bh.Len, bh.Cap = sh.Data, sh.Len, sh.Len
-	return b
+	return *(*[]byte)(unsafe.Pointer(&str))
 }
 
 // BytesToString converts a byte slice to string without a memory allocation.
@@ -522,3 +526,14 @@ func RemoveWhiteSpace(str string, repalceAll bool) string {
 
 	return strings.TrimSpace(str)
 }
+
+// SubInBetween return substring between the start and end position(excluded) of source string.
+func SubInBetween(str string, start string, end string) string {
+	if _, after, ok := strings.Cut(str, start); ok {
+		if before, _, ok := strings.Cut(after, end); ok {
+			return before
+		}
+	}
+
+	return ""
+}

strutil/string_test.go

@@ -207,6 +207,7 @@ func TestBefore(t *testing.T) {
 	assert := internal.NewAssert(t, "TestBefore")
 
 	assert.Equal("lancet", Before("lancet", ""))
+	assert.Equal("lancet", Before("lancet", "abcdef"))
 	assert.Equal("github.com", Before("github.com/test/lancet", "/"))
 	assert.Equal("github.com/", Before("github.com/test/lancet", "test"))
 }
@@ -215,6 +216,8 @@ func TestBeforeLast(t *testing.T) {
 	assert := internal.NewAssert(t, "TestBeforeLast")
 
 	assert.Equal("lancet", BeforeLast("lancet", ""))
+
+	assert.Equal("lancet", BeforeLast("lancet", "abcdef"))
 	assert.Equal("github.com/test", BeforeLast("github.com/test/lancet", "/"))
 	assert.Equal("github.com/test/", BeforeLast("github.com/test/test/lancet", "test"))
 
@@ -225,6 +228,7 @@ func TestAfter(t *testing.T) {
 	assert := internal.NewAssert(t, "TestAfter")
 
 	assert.Equal("lancet", After("lancet", ""))
+	assert.Equal("lancet", After("lancet", "abcdef"))
 	assert.Equal("test/lancet", After("github.com/test/lancet", "/"))
 	assert.Equal("/lancet", After("github.com/test/lancet", "test"))
 }
@@ -233,6 +237,7 @@ func TestAfterLast(t *testing.T) {
 	assert := internal.NewAssert(t, "TestAfterLast")
 
 	assert.Equal("lancet", AfterLast("lancet", ""))
+	assert.Equal("lancet", AfterLast("lancet", "abcdef"))
 	assert.Equal("lancet", AfterLast("github.com/test/lancet", "/"))
 	assert.Equal("/lancet", AfterLast("github.com/test/lancet", "test"))
 	assert.Equal("/lancet", AfterLast("github.com/test/test/lancet", "test"))
@@ -465,3 +470,15 @@ func TestRemoveWhiteSpace(t *testing.T) {
 	assert.Equal("helloworld", RemoveWhiteSpace(str, true))
 	assert.Equal("hello world", RemoveWhiteSpace(str, false))
 }
+
+func TestSubInBetween(t *testing.T) {
+	assert := internal.NewAssert(t, "TestSubInBetween")
+
+	str := "abcde"
+
+	assert.Equal("", SubInBetween(str, "", ""))
+	assert.Equal("ab", SubInBetween(str, "", "c"))
+	assert.Equal("bc", SubInBetween(str, "a", "d"))
+	assert.Equal("", SubInBetween(str, "a", ""))
+	assert.Equal("", SubInBetween(str, "a", "f"))
+}