changes Delimiter to a string, updates README

Author: chanced

README.md

@@ -44,27 +44,27 @@ import (
     "github.com/chanced/caps"
 )
 func main() {
-    c := caps.New()
-    fmt.Println(c.ToCamel("http request"))
+    fmt.Println(caps.ToCamel("http request"))
     // Output:
     // HTTPRequest
-    fmt.Println(c.ToCamel("http request"))
+    fmt.Println(caps.ToCamel("http request"))
     // Output:
     // HTTPRequest
-    fmt.Println(c.ToLowerCamel("some_id"))
+    fmt.Println(caps.ToLowerCamel("some_id"))
     // Output:
     // someID
-    fmt.Println(c.ToLowerCamel("SomeID", caps.WithReplaceStyleCamel()))
+    fmt.Println(caps.ToLowerCamel("SomeID", caps.WithReplaceStyleCamel()))
     // Output:
     // someId
 
     // Alternatively:
-
-    fmt.Println(caps.ToCamel("http request"))
+    capsJS := caps.New(caps.CapsOpts{
+        AllowedSymbols: "$",
+        ReplaceStyle: caps.ReplaceStyleCamel
+    })
+    fmt.Println(capsJS.ToCamel("SomeID"))
     // Output:
-    // HTTPRequest
-
-
+    // someId
 }
 ```
 
@@ -154,6 +154,30 @@ options. See below.
 
 ## Customizing the `Converter`
 
+### Using caps.Caps
+
+This is likely your best option. You can create and utilize an instance of
+`caps.Caps` which as all of the conversions as methods:
+
+```go
+    package main
+    import (
+        "fmt"
+        "github.com/chanced/caps"
+        "github.com/chanced/caps/token"
+    )
+
+    c := caps.New(caps.CapsOpts{
+        Replacements: []caps.Replacement{
+            {"Ex", "EX" },
+            // ... your replacements
+        },
+    })
+    c.ToLower("some ex")
+    // Output:
+    // SomeEX
+```
+
 ### Creating isolated `caps.StdConverter` instances
 
 You can pass a new instance of `caps.StdConverter` with a new set of
@@ -278,50 +302,57 @@ func main() {
 
 input: `"Example Uuid Test Case."`
 
+```
+goos: darwin
+goarch: arm64
+pkg: github.com/chanced/caps
+BenchmarkToTitle
+```
+
 Using a `caps.Caps` instance:
 
 ```
 BenchmarkCapsToTitle
-BenchmarkCapsToTitle-10                        1000000          1007 ns/op         288 B/op          19 allocs/op
+BenchmarkCapsToTitle-10                   	 1000000	      1005 ns/op	     288 B/op	      19 allocs/op
 BenchmarkCapsToCamel
-BenchmarkCapsToCamel-10                        1217474           984.5 ns/op         288 B/op          19 allocs/op
+BenchmarkCapsToCamel-10                   	 1214407	       995.0 ns/op	     288 B/op	      19 allocs/op
 BenchmarkCapsToLowerCamel
-BenchmarkCapsToLowerCamel-10                   1223340           979.1 ns/op         288 B/op          19 allocs/op
+BenchmarkCapsToLowerCamel-10              	 1219000	       980.1 ns/op	     288 B/op	      19 allocs/op
 BenchmarkCapsToSnake
-BenchmarkCapsToSnake-10                        1205770           996.5 ns/op         288 B/op          20 allocs/op
+BenchmarkCapsToSnake-10                   	 1212786	       989.1 ns/op	     288 B/op	      19 allocs/op
 BenchmarkCapsToScreamingSnake
-BenchmarkCapsToScreamingSnake-10               1000000          1037 ns/op         336 B/op          21 allocs/op
+BenchmarkCapsToScreamingSnake-10          	 1000000	      1027 ns/op	     336 B/op	      20 allocs/op
 BenchmarkCapsToKebab
-BenchmarkCapsToKebab-10                        1000000          1021 ns/op         336 B/op          21 allocs/op
+BenchmarkCapsToKebab-10                   	 1000000	      1007 ns/op	     336 B/op	      20 allocs/op
 BenchmarkCapsToScreamingKebab
-BenchmarkCapsToScreamingKebab-10               1000000          1052 ns/op         336 B/op          21 allocs/op
+BenchmarkCapsToScreamingKebab-10          	 1000000	      1018 ns/op	     336 B/op	      20 allocs/op
 BenchmarkCapsToDotNotation
-BenchmarkCapsToDotNotation-10                  1000000          1019 ns/op         336 B/op          21 allocs/op
+BenchmarkCapsToDotNotation-10             	 1000000	      1017 ns/op	     336 B/op	      20 allocs/op
 BenchmarkCapsToScreamingDotNotation
-BenchmarkCapsToScreamingDotNotation-10         1000000          1032 ns/op         336 B/op          21 allocs/op
+BenchmarkCapsToScreamingDotNotation-10    	 1000000	      1042 ns/op	     336 B/op	      20 allocs/op
 ```
 
 Using top-level functions:
 
 ```
 BenchmarkToTitle
-BenchmarkToTitle-10                            1128897          1051 ns/op         336 B/op          20 allocs/op
+BenchmarkToTitle-10                       	 1138011	      1046 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToCamel
-BenchmarkToCamel-10                            1000000          1030 ns/op         336 B/op          20 allocs/op
+BenchmarkToCamel-10                       	 1000000	      1023 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToLowerCamel
-BenchmarkToLowerCamel-10                       1000000          1014 ns/op         336 B/op          20 allocs/op
+BenchmarkToLowerCamel-10                  	 1000000	      1020 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToSnake
-BenchmarkToSnake-10                            1000000          1026 ns/op         336 B/op          21 allocs/op
+BenchmarkToSnake-10                       	 1000000	      1024 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToScreamingSnake
-BenchmarkToScreamingSnake-10                   1000000          1042 ns/op         336 B/op          21 allocs/op
+BenchmarkToScreamingSnake-10              	 1000000	      1040 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToKebab
-BenchmarkToKebab-10                            1000000          1021 ns/op         336 B/op          21 allocs/op
+BenchmarkToKebab-10                       	 1000000	      1024 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToScreamingKebab
-BenchmarkToScreamingKebab-10                   1000000          1032 ns/op         336 B/op          21 allocs/op
+BenchmarkToScreamingKebab-10              	 1000000	      1032 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToDotNotation
-BenchmarkToDotNotation-10                      1000000          1020 ns/op         336 B/op          21 allocs/op
+BenchmarkToDotNotation-10                 	 1000000	      1020 ns/op	     336 B/op	      20 allocs/op
 BenchmarkToScreamingDotNotation
-BenchmarkToScreamingDotNotation-10             1000000          1033 ns/op         336 B/op          21 allocs/op
+BenchmarkToScreamingDotNotation-10        	 1000000	      1028 ns/op	     336 B/op	      20 allocs/op
 ```
 
 ## License

caps.go

@@ -21,7 +21,7 @@ type Caps struct {
 type CapsOpts struct {
 	// Any characters within this string will be allowed in the output.
 	//
-	// This does not affect delimiters (e.g. '_', '-', '.') as they are added
+	// This does not affect delimiters (e.g. "_", "-", ".") as they are added
 	// post-tokenization.
 	//
 	// Default:
@@ -30,7 +30,7 @@ type CapsOpts struct {
 	// The Converter to use.
 	//
 	// Default:
-	// 	DefaultConverter
+	// 	A StdConverter with the Replacements, Caser, and Tokenizer.
 	Converter Converter
 
 	// If not set, this will be DefaultReplacements.
@@ -59,7 +59,7 @@ type CapsOpts struct {
 	// functions)
 	Caser token.Caser
 
-	// If not set, uses DefaultTokenizer
+	// If not set, uses StdTokenizer with the provided delimiters and token.Caser.
 	Tokenizer Tokenizer
 }
 
@@ -154,7 +154,7 @@ func (c Caps) LowerFirst(str string) string {
 
 // Without numbers returns the string with all numeric runes removed.
 //
-// It does not currently use any logic to determine if a rune (e.g. '.')
+// It does not currently use any logic to determine if a rune (e.g. ".")
 // is part of a number. This may change in the future.
 func (c Caps) WithoutNumbers(s string) string {
 	return strings.Map(func(r rune) rune {
@@ -211,7 +211,7 @@ func (c Caps) ToLowerCamel(str string) string {
 //
 //	caps.ToSnake("This is [an] {example}${id32}.") // this_is_an_example_id_32
 func (c Caps) ToSnake(str string) string {
-	return c.ToDelimited(str, '_', true)
+	return c.ToDelimited(str, "_", true)
 }
 
 // ToScreamingSnake transforms the case of str into Screaming Snake Case (e.g.
@@ -220,15 +220,15 @@ func (c Caps) ToSnake(str string) string {
 //
 //	caps.ToScreamingSnake("This is [an] {example}${id32}.") // THIS_IS_AN_EXAMPLE_ID_32
 func (c Caps) ToScreamingSnake(str string) string {
-	return ToDelimited(str, '_', false)
+	return ToDelimited(str, "_", false)
 }
 
 // ToKebab transforms the case of str into Lower Kebab Case (e.g. an-example-string) using
 // either the provided Converter or the DefaultConverter otherwise.
 //
 //	caps.ToKebab("This is [an] {example}${id32}.") // this-is-an-example-id-32
 func (c Caps) ToKebab(str string) string {
-	return ToDelimited(str, '-', true)
+	return ToDelimited(str, "-", true)
 }
 
 // ToScreamingKebab transforms the case of str into Screaming Kebab Snake (e.g.
@@ -237,15 +237,15 @@ func (c Caps) ToKebab(str string) string {
 //
 //	caps.ToScreamingKebab("This is [an] {example}${id32}.") // THIS-IS-AN-EXAMPLE-ID-32
 func (c Caps) ToScreamingKebab(str string) string {
-	return ToDelimited(str, '-', false)
+	return ToDelimited(str, "-", false)
 }
 
 // ToDotNotation transforms the case of str into Lower Dot Notation Case (e.g. an.example.string) using
 // either the provided Converter or the DefaultConverter otherwise.
 //
 //	caps.ToDotNotation("This is [an] {example}${id32}.") // this.is.an.example.id.32
 func (c Caps) ToDotNotation(str string) string {
-	return ToDelimited(str, '.', true)
+	return ToDelimited(str, ".", true)
 }
 
 // ToScreamingDotNotation transforms the case of str into Screaming Kebab Case (e.g.
@@ -254,7 +254,7 @@ func (c Caps) ToDotNotation(str string) string {
 //
 //	caps.ToScreamingDotNotation("This is [an] {example}${id32}.") // THIS.IS.AN.EXAMPLE.ID.32
 func (c Caps) ToScreamingDotNotation(str string) string {
-	return ToDelimited(str, '.', false)
+	return ToDelimited(str, ".", false)
 }
 
 // ToTitle transforms the case of str into Title Case (e.g. An Example String) using
@@ -281,10 +281,10 @@ func (c Caps) ToTitle(str string) string {
 //
 // # Example
 //
-//	caps.ToDelimited("This is [an] {example}${id}.#32", '.', true) // this.is.an.example.id.32
-//	caps.ToDelimited("This is [an] {example}${id}.break32", '.', false) // THIS.IS.AN.EXAMPLE.ID.BREAK.32
-//	caps.ToDelimited("This is [an] {example}${id}.v32", '.', true, caps.Opts{AllowedSymbols: "$"}) // this.is.an.example.$.id.v32
-func (c Caps) ToDelimited(str string, delimiter rune, lowercase bool) string {
+//	caps.ToDelimited("This is [an] {example}${id}.#32", ".", true) // this.is.an.example.id.32
+//	caps.ToDelimited("This is [an] {example}${id}.break32", ".", false) // THIS.IS.AN.EXAMPLE.ID.BREAK.32
+//	caps.ToDelimited("This is [an] {example}${id}.v32", ".", true, caps.Opts{AllowedSymbols: "$"}) // this.is.an.example.$.id.v32
+func (c Caps) ToDelimited(str string, delimiter string, lowercase bool) string {
 	var style Style
 	var replacementStyle ReplaceStyle
 	if lowercase {
@@ -298,7 +298,7 @@ func (c Caps) ToDelimited(str string, delimiter rune, lowercase bool) string {
 		Style:          style,
 		ReplaceStyle:   replacementStyle,
 		Input:          str,
-		Join:           string(delimiter),
+		Join:           delimiter,
 		AllowedSymbols: c.allowedSymbols,
 		NumberRules:    c.numberRules,
 	})

conversions.go

@@ -93,7 +93,7 @@ func ToLowerCamel[T ~string](str T, options ...Opts) T {
 //
 //	caps.ToSnake("This is [an] {example}${id32}.") // this_is_an_example_id_32
 func ToSnake[T ~string](str T, options ...Opts) T {
-	return ToDelimited(str, '_', true, options...)
+	return ToDelimited(str, "_", true, options...)
 }
 
 // ToScreamingSnake transforms the case of str into Screaming Snake Case (e.g.
@@ -102,15 +102,15 @@ func ToSnake[T ~string](str T, options ...Opts) T {
 //
 //	caps.ToScreamingSnake("This is [an] {example}${id32}.") // THIS_IS_AN_EXAMPLE_ID_32
 func ToScreamingSnake[T ~string](str T, options ...Opts) T {
-	return ToDelimited(str, '_', false, options...)
+	return ToDelimited(str, "_", false, options...)
 }
 
 // ToKebab transforms the case of str into Lower Kebab Case (e.g. an-example-string) using
 // either the provided Converter or the DefaultConverter otherwise.
 //
 //	caps.ToKebab("This is [an] {example}${id32}.") // this-is-an-example-id-32
 func ToKebab[T ~string](str T, options ...Opts) T {
-	return ToDelimited(str, '-', true, options...)
+	return ToDelimited(str, "-", true, options...)
 }
 
 // ToScreamingKebab transforms the case of str into Screaming Kebab Snake (e.g.
@@ -119,15 +119,15 @@ func ToKebab[T ~string](str T, options ...Opts) T {
 //
 //	caps.ToScreamingKebab("This is [an] {example}${id32}.") // THIS-IS-AN-EXAMPLE-ID-32
 func ToScreamingKebab[T ~string](str T, options ...Opts) T {
-	return ToDelimited(str, '-', false, options...)
+	return ToDelimited(str, "-", false, options...)
 }
 
 // ToDotNotation transforms the case of str into Lower Dot Notation Case (e.g. an.example.string) using
 // either the provided Converter or the DefaultConverter otherwise.
 //
 //	caps.ToDotNotation("This is [an] {example}${id32}.") // this.is.an.example.id.32
 func ToDotNotation[T ~string](str T, options ...Opts) T {
-	return ToDelimited(str, '.', true, options...)
+	return ToDelimited(str, ".", true, options...)
 }
 
 // ToScreamingDotNotation transforms the case of str into Screaming Kebab Case (e.g.
@@ -136,7 +136,7 @@ func ToDotNotation[T ~string](str T, options ...Opts) T {
 //
 //	caps.ToScreamingDotNotation("This is [an] {example}${id32}.") // THIS.IS.AN.EXAMPLE.ID.32
 func ToScreamingDotNotation[T ~string](str T, options ...Opts) T {
-	return ToDelimited(str, '.', false, options...)
+	return ToDelimited(str, ".", false, options...)
 }
 
 // ToTitle transforms the case of str into Title Case (e.g. An Example String) using
@@ -164,10 +164,10 @@ func ToTitle[T ~string](str T, options ...Opts) T {
 //
 // # Example
 //
-//	caps.ToDelimited("This is [an] {example}${id}.#32", '.', true) // this.is.an.example.id.32
-//	caps.ToDelimited("This is [an] {example}${id}.break32", '.', false) // THIS.IS.AN.EXAMPLE.ID.BREAK.32
-//	caps.ToDelimited("This is [an] {example}${id}.v32", '.', true, caps.Opts{AllowedSymbols: "$"}) // this.is.an.example.$.id.v32
-func ToDelimited[T ~string](str T, delimiter rune, lowercase bool, options ...Opts) T {
+//	caps.ToDelimited("This is [an] {example}${id}.#32", ".", true) // this.is.an.example.id.32
+//	caps.ToDelimited("This is [an] {example}${id}.break32", ".", false) // THIS.IS.AN.EXAMPLE.ID.BREAK.32
+//	caps.ToDelimited("This is [an] {example}${id}.v32", ".", true, caps.Opts{AllowedSymbols: "$"}) // this.is.an.example.$.id.v32
+func ToDelimited[T ~string](str T, delimiter string, lowercase bool, options ...Opts) T {
 	opts := loadOpts(options)
 	var style Style
 	var replacementStyle ReplaceStyle

examples_test.go

@@ -63,9 +63,9 @@ func ExampleToScreamingDotNotation() {
 }
 
 func ExampleToDelimited() {
-	fmt.Println(caps.ToDelimited("This is [an] {example}${id}.#32", '.', true))
-	fmt.Println(caps.ToDelimited("This is [an] {example}${id}.break32", '.', false))
-	fmt.Println(caps.ToDelimited("This is [an] {example}${id}.v32", '.', true, caps.Opts{AllowedSymbols: "$"}))
+	fmt.Println(caps.ToDelimited("This is [an] {example}${id}.#32", ".", true))
+	fmt.Println(caps.ToDelimited("This is [an] {example}${id}.break32", ".", false))
+	fmt.Println(caps.ToDelimited("This is [an] {example}${id}.v32", ".", true, caps.Opts{AllowedSymbols: "$"}))
 
 	// Output:
 	// this.is.an.example.id.32

text/text.go

@@ -112,7 +112,7 @@ func (t Text) ToTitle(opts ...caps.Opts) Text {
 // using either the provided Converter or the DefaultConverter otherwise.
 //
 // If lowercase is false, the output will be all uppercase.
-func (t Text) ToDelimited(delimiter rune, lowercase bool, opts ...caps.Opts) Text {
+func (t Text) ToDelimited(delimiter string, lowercase bool, opts ...caps.Opts) Text {
 	return caps.ToDelimited(t, delimiter, lowercase, opts...)
 }