aperture147/stringformatter

A set of tools to manipulate text, i.e. making text from templates in C#/Python way is faster than fmt.Sprintf

StringFormatter

A set of a high performance string tools that helps to build strings from templates and process text that faster than fmt!!!.

1. Features

1. Text formatting with template using traditional for C#, Python programmers style - {0}, {name} that faster then fmt does:
2. Additional text utilities:
   • convert map to string using one of predefined formats (see text_utils.go)

1. Text formatting from templates

1.1 Description

This is a GO module for template text formatting in syntax like in C# or/and Python using:

• {n} , n here is a number to notes order of argument list to use i.e. {0}, {1}
• {name} to notes arguments by name i.e. {name}, {last_name}, {address} and so on ...

1.2 Examples

1.2.1 Format by arg order

i.e. you have following template: "Hello {0}, we are greeting you here: {1}!"

if you call Format with args "manager" and "salesApp" :

formattedStr := Format("Hello {0}, we are greeting you here: {1}!", "manager", "salesApp")

you get string "Hello manager, we are greeting you here: salesApp!"

1.2.2 Format by arg key

i.e. you have following template: "Hello {user} what are you doing here {app} ?"

if you call FormatComplex with args "vpupkin" and "mn_console" FormatComplex("Hello {user} what are you doing here {app} ?", map[string]interface{}{"user":"vpupkin", "app":"mn_console"})

you get string "Hello vpupkin what are you doing here mn_console ?"

another example is:

    strFormatResult = FormatComplex("Current app settings are: ipAddr: {ipaddr}, port: {port}, use ssl: {ssl}.", 
                                    map[string]interface{}{"ipaddr":"127.0.0.1", "port":5432, "ssl":false})

a result will be: `"Current app settings are: ipAddr: 127.0.0.1, port: 5432, use ssl: false."``

1.2.3 Benchmarks of the Format and FormatComplex functions

benchmark could be running using following commands from command line:

• to see Format result - go test -bench=Format -benchmem -cpu 1
• to see fmt result - go test -bench=Fmt -benchmem -cpu 1

2. Text utilities

2.1 Map to string utility

Map to string function allow to convert map to string using one of predefined line format:

• key => value
• key : value
• value

For example see code from test (text_utils_test.go):

options := map[string]interface{}{
		"connectTimeout": 1000,
		"useSsl":         true,
		"login":          "sa",
		"password":       "sa",
	}

	str := MapToString(&options, KeyValueWithSemicolonSepFormat, ", ")
	assert.True(t, len(str) > 0)
	assert.Equal(t, "connectTimeout : 1000, useSsl : true, login : sa, password : sa", str)

2.2 Benchmarks of the MapToStr function

• to see MapToStr result - go test -bench=MapToStr -benchmem -cpu 1

3. Contributors