Merge branch 'release/v1.3.0'

Author: EvilLord666

README.md

@@ -6,14 +6,14 @@ A set of a ***high performance string tools*** that helps to build strings from
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/wissance/stringFormatter?style=plastic) 
 ![GitHub issues](https://img.shields.io/github/issues/wissance/stringFormatter?style=plastic)
 ![GitHub Release Date](https://img.shields.io/github/release-date/wissance/stringFormatter) 
-![GitHub release (latest by date)](https://img.shields.io/github/downloads/wissance/stringFormatter/v1.2.2/total?style=plastic)
+![GitHub release (latest by date)](https://img.shields.io/github/downloads/wissance/stringFormatter/v1.3.0/total?style=plastic)
 
-![String Formatter: a convenient string formatting tool](/img/sf_cover.png)
+![String Formatter: a convenient string formatting tool](img/sf_cover.png)
 
 ## 1. Features
 
-1. Text formatting with template using traditional for `C#, Python programmers style` - `{0}`, `{name}` that faster then fmt does:
-![String Formatter: a convenient string formatting tool](/img/benchmarks_adv.png)
+1. Text formatting with template using traditional for `C#, Python programmers style` - `{0}`, `{name}` that faster then `fmt` does:
+![String Formatter: a convenient string formatting tool](img/benchmarks_adv.png)
 2. Additional text utilities:
    - convert ***map to string*** using one of predefined formats (see `text_utils.go`)
 

formatter.go

@@ -7,6 +7,7 @@ import (
 )
 
 const argumentFormatSeparator = ":"
+const bytesPerArgDefault = 20
 
 // Format
 /* Func that makes string formatting from template
@@ -35,7 +36,8 @@ func Format(template string, args ...any) string {
 
 	templateLen := len(template)
 	formattedStr := &strings.Builder{}
-	formattedStr.Grow(templateLen + 22*len(args))
+	argsLen := bytesPerArgDefault * len(args)
+	formattedStr.Grow(templateLen + argsLen + 1)
 	j := -1 //nolint:ineffassign
 
 	nestedBrackets := false
@@ -55,6 +57,13 @@ func Format(template string, args ...any) string {
 				continue
 			}
 			// find end of placeholder
+			// process empty pair - {}
+			if template[i+1] == '}' {
+				i++
+				formattedStr.WriteString("{}")
+				continue
+			}
+			// process non-empty placeholder
 			j = i + 2
 			for {
 				if j >= templateLen {
@@ -117,13 +126,9 @@ func Format(template string, args ...any) string {
 					strVal := getItemAsStr(&args[argNumber], &argFormatOptions)
 					formattedStr.WriteString(strVal)
 				} else {
-					if argNumberStr != "" {
-						formattedStr.WriteByte('{')
-						formattedStr.WriteString(argNumberStr)
-						formattedStr.WriteByte('}')
-					} else {
-						// complicated case when we have brackets in line and open line at the end
-						formattedStr.WriteByte('{')
+					formattedStr.WriteString(template[i:j])
+					if j < templateLen-1 {
+						formattedStr.WriteByte(template[j])
 					}
 				}
 				i = j
@@ -156,7 +161,8 @@ func FormatComplex(template string, args map[string]any) string {
 
 	templateLen := len(template)
 	formattedStr := &strings.Builder{}
-	formattedStr.Grow(templateLen + 22*len(args))
+	argsLen := bytesPerArgDefault * len(args)
+	formattedStr.Grow(templateLen + argsLen + 1)
 	j := -1 //nolint:ineffassign
 	nestedBrackets := false
 	formattedStr.WriteString(template[:start])
@@ -170,10 +176,18 @@ func FormatComplex(template string, args map[string]any) string {
 				break
 			}
 
-			if template[i+1] == '{' { // todo: umv: this not considering {{0}}
+			if template[i+1] == '{' {
 				formattedStr.WriteByte('{')
 				continue
 			}
+			// find end of placeholder
+			// process empty pair - {}
+			if template[i+1] == '}' {
+				i++
+				formattedStr.WriteString("{}")
+				continue
+			}
+			// process non-empty placeholder
 
 			// find end of placeholder
 			j = i + 2
@@ -212,16 +226,20 @@ func FormatComplex(template string, args map[string]any) string {
 				}
 				if ok || (argFormatOptions != "" && !nestedBrackets) {
 					// get number from placeholder
-					strVal := getItemAsStr(&arg, &argFormatOptions)
+					strVal := ""
+					if arg != nil {
+						strVal = getItemAsStr(&arg, &argFormatOptions)
+					} else {
+						formattedStr.WriteString(template[i:j])
+						if j < templateLen-1 {
+							formattedStr.WriteByte(template[j])
+						}
+					}
 					formattedStr.WriteString(strVal)
 				} else {
-					if argNumberStr != "" {
-						formattedStr.WriteByte('{')
-						formattedStr.WriteString(argNumberStr)
-						formattedStr.WriteByte('}')
-					} else {
-						// complicated case when we have brackets in line and open line at the end
-						formattedStr.WriteByte('{')
+					formattedStr.WriteString(template[i:j])
+					if j < templateLen-1 {
+						formattedStr.WriteByte(template[j])
 					}
 				}
 				i = j

formatter_test.go

@@ -129,6 +129,27 @@ func TestFormat(t *testing.T) {
 			args:     []any{},
 			expected: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}) }",
 		},
+
+		"no bracket at the end of line with {} inside": {
+			template: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}) ",
+			args:     []any{},
+			expected: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}) ",
+		},
+		"open bracket at the end of line of go line with multiple {} inside": {
+			template: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}, additionalData interface{}) {",
+			args:     []any{},
+			expected: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}, additionalData interface{}) {",
+		},
+		"commentaries after bracket": {
+			template: "switch app.appConfig.ServerCfg.Schema { //nolint:exhaustive",
+			args:     []any{},
+			expected: "switch app.appConfig.ServerCfg.Schema { //nolint:exhaustive",
+		},
+		"bracket in the middle": {
+			template: "in the middle - { at the end - nothing",
+			args:     []any{},
+			expected: "in the middle - { at the end - nothing",
+		},
 	} {
 		t.Run(name, func(t *testing.T) {
 			assert.Equal(t, test.expected, stringFormatter.Format(test.template, test.args...))
@@ -219,11 +240,22 @@ func TestFormatComplex(t *testing.T) {
 			expected: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}) {",
 		},
 
+		"open bracket at the end of line of go line with multiple {} inside": {
+			template: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}, additionalData interface{}) {",
+			args:     map[string]any{},
+			expected: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}, additionalData interface{}) {",
+		},
+
 		"close bracket at the end of line of go line with {} inside": {
 			template: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}) }",
 			args:     map[string]any{},
 			expected: "func afterHandle(respWriter *http.ResponseWriter, statusCode int, data interface{}) }",
 		},
+		"commentaries after bracket": {
+			template: "switch app.appConfig.ServerCfg.Schema { //nolint:exhaustive",
+			args:     map[string]any{},
+			expected: "switch app.appConfig.ServerCfg.Schema { //nolint:exhaustive",
+		},
 	} {
 		t.Run(name, func(t *testing.T) {
 			assert.Equal(t, test.expected, stringFormatter.FormatComplex(test.template, test.args))