Added support for kebab-case, snake.case with custom delimiters and the screaming variants of all 3tags/v0.1.0
@@ -1,6 +1,7 @@ | |||||
The MIT License (MIT) | The MIT License (MIT) | ||||
Copyright (c) 2015 Ian Coleman | Copyright (c) 2015 Ian Coleman | ||||
Copyright (c) 2018 Ma_124, <github.com/Ma124> | |||||
Permission is hereby granted, free of charge, to any person obtaining a copy | Permission is hereby granted, free of charge, to any person obtaining a copy | ||||
of this software and associated documentation files (the "Software"), to deal | of this software and associated documentation files (the "Software"), to deal | ||||
@@ -1,12 +1,23 @@ | |||||
strcase [![Build Status](https://travis-ci.org/iancoleman/strcase.svg)](https://travis-ci.org/iancoleman/strcase) [![Coverage](http://gocover.io/_badge/github.com/iancoleman/strcase?0)](http://gocover.io/github.com/iancoleman/strcase) | |||||
======= | |||||
# strcase | |||||
[![Godoc Reference](https://godoc.org/github.com/iancoleman/strcase?status.svg)](http://godoc.org/github.com/iancoleman/strcase) | |||||
[![Build Status](https://travis-ci.org/iancoleman/strcase.svg)](https://travis-ci.org/iancoleman/strcase) | |||||
[![Coverage](http://gocover.io/_badge/github.com/iancoleman/strcase?0)](http://gocover.io/github.com/iancoleman/strcase) | |||||
strcase is a go package for converting string case to [snake case](https://en.wikipedia.org/wiki/Snake_case) or [camel case](https://en.wikipedia.org/wiki/CamelCase). | strcase is a go package for converting string case to [snake case](https://en.wikipedia.org/wiki/Snake_case) or [camel case](https://en.wikipedia.org/wiki/CamelCase). | ||||
# Example | |||||
## Example | |||||
```go | |||||
s := "AnyKind of_string" | |||||
``` | ``` | ||||
x := "AnyKind of_string" | |||||
xSnake := strcase.ToSnake(x) // any_kind_of_string | |||||
xCamel := strcase.ToCamel(x) // AnyKindOfString | |||||
``` | |||||
| Function | Result | | |||||
|-----------------------------------|----------------------| | |||||
| `ToSnake(s)` | `any_kind_of_string` | | |||||
| `ToScreamingSnake(s)` | `ANY_KIND_OF_STRING` | | |||||
| `ToKebab(s)` | `any-kind-of-string` | | |||||
| `ToScreamingKebab(s)` | `ANY-KIND-OF-STRING` | | |||||
| `ToDelimited(s, '.')` | `any.kind.of.string` | | |||||
| `ToScreamingDelimited(s, '.')` | `ANY.KIND.OF.STRING` | | |||||
| `ToCamel(s)` | `AnyKindOfString` | | |||||
| `ToLowerCamel(s)` | `anyKindOfString` | |
@@ -1,3 +1,28 @@ | |||||
/* | |||||
* The MIT License (MIT) | |||||
* | |||||
* Copyright (c) 2015 Ian Coleman | |||||
* Copyright (c) 2018 Ma_124, <github.com/Ma124> | |||||
* | |||||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||||
* of this software and associated documentation files (the "Software"), to deal | |||||
* in the Software without restriction, including without limitation the rights | |||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||||
* copies of the Software, and to permit persons to whom the Software is | |||||
* furnished to do so, Subject to the following conditions: | |||||
* | |||||
* The above copyright notice and this permission notice shall be included in all | |||||
* copies or Substantial portions of the Software. | |||||
* | |||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||||
* SOFTWARE. | |||||
*/ | |||||
package strcase | package strcase | ||||
import ( | import ( | ||||
@@ -33,10 +58,12 @@ func toCamelInitCase(s string, initCase bool) string { | |||||
return n | return n | ||||
} | } | ||||
// Converts a string to CamelCase | |||||
func ToCamel(s string) string { | func ToCamel(s string) string { | ||||
return toCamelInitCase(s, true) | return toCamelInitCase(s, true) | ||||
} | } | ||||
// Converts a string to lowerCamelCase | |||||
func ToLowerCamel(s string) string { | func ToLowerCamel(s string) string { | ||||
if s == "" { | if s == "" { | ||||
return s | return s | ||||
@@ -1,3 +1,27 @@ | |||||
/* | |||||
* The MIT License (MIT) | |||||
* | |||||
* Copyright (c) 2015 Ian Coleman | |||||
* | |||||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||||
* of this software and associated documentation files (the "Software"), to deal | |||||
* in the Software without restriction, including without limitation the rights | |||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||||
* copies of the Software, and to permit persons to whom the Software is | |||||
* furnished to do so, Subject to the following conditions: | |||||
* | |||||
* The above copyright notice and this permission notice shall be included in all | |||||
* copies or Substantial portions of the Software. | |||||
* | |||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||||
* SOFTWARE. | |||||
*/ | |||||
package strcase | package strcase | ||||
import ( | import ( | ||||
@@ -1,3 +1,27 @@ | |||||
/* | |||||
* The MIT License (MIT) | |||||
* | |||||
* Copyright (c) 2015 Ian Coleman | |||||
* | |||||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||||
* of this software and associated documentation files (the "Software"), to deal | |||||
* in the Software without restriction, including without limitation the rights | |||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||||
* copies of the Software, and to permit persons to whom the Software is | |||||
* furnished to do so, Subject to the following conditions: | |||||
* | |||||
* The above copyright notice and this permission notice shall be included in all | |||||
* copies or Substantial portions of the Software. | |||||
* | |||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||||
* SOFTWARE. | |||||
*/ | |||||
package strcase | package strcase | ||||
import ( | import ( | ||||
@@ -1,3 +1,28 @@ | |||||
/* | |||||
* The MIT License (MIT) | |||||
* | |||||
* Copyright (c) 2015 Ian Coleman | |||||
* Copyright (c) 2018 Ma_124, <github.com/Ma124> | |||||
* | |||||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||||
* of this software and associated documentation files (the "Software"), to deal | |||||
* in the Software without restriction, including without limitation the rights | |||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||||
* copies of the Software, and to permit persons to whom the Software is | |||||
* furnished to do so, Subject to the following conditions: | |||||
* | |||||
* The above copyright notice and this permission notice shall be included in all | |||||
* copies or Substantial portions of the Software. | |||||
* | |||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||||
* SOFTWARE. | |||||
*/ | |||||
// Package strcase converts strings to snake_case or CamelCase | // Package strcase converts strings to snake_case or CamelCase | ||||
package strcase | package strcase | ||||
@@ -7,6 +32,31 @@ import ( | |||||
// Converts a string to snake_case | // Converts a string to snake_case | ||||
func ToSnake(s string) string { | func ToSnake(s string) string { | ||||
return ToDelimited(s, '_') | |||||
} | |||||
// Converts a string to SCREAMING_SNAKE_CASE | |||||
func ToScreamingSnake(s string) string { | |||||
return ToScreamingDelimited(s, '_', true) | |||||
} | |||||
// Converts a string to kebab-case | |||||
func ToKebab(s string) string { | |||||
return ToDelimited(s, '-') | |||||
} | |||||
// Converts a string to SCREAMING-KEBAB-CASE | |||||
func ToScreamingKebab(s string) string { | |||||
return ToScreamingDelimited(s, '-', true) | |||||
} | |||||
// Converts a string to delimited.snake.case (in this case `del = '.'`) | |||||
func ToDelimited(s string, del uint8) string { | |||||
return ToScreamingDelimited(s, del, false) | |||||
} | |||||
// Converts a string to SCREAMING.DELIMITED.SNAKE.CASE (in this case `del = '.'; screaming = true`) or delimited.snake.case (in this case `del = '.'; screaming = false`) | |||||
func ToScreamingDelimited(s string, del uint8, screaming bool) string { | |||||
s = addWordBoundariesToNumbers(s) | s = addWordBoundariesToNumbers(s) | ||||
s = strings.Trim(s, " ") | s = strings.Trim(s, " ") | ||||
n := "" | n := "" | ||||
@@ -20,20 +70,25 @@ func ToSnake(s string) string { | |||||
} | } | ||||
} | } | ||||
if i > 0 && n[len(n)-1] != '_' && nextCaseIsChanged { | |||||
if i > 0 && n[len(n)-1] != del && nextCaseIsChanged { | |||||
// add underscore if next letter case type is changed | // add underscore if next letter case type is changed | ||||
if v >= 'A' && v <= 'Z' { | if v >= 'A' && v <= 'Z' { | ||||
n += "_" + string(v) | |||||
n += string(del) + string(v) | |||||
} else if v >= 'a' && v <= 'z' { | } else if v >= 'a' && v <= 'z' { | ||||
n += string(v) + "_" | |||||
n += string(v) + string(del) | |||||
} | } | ||||
} else if v == ' ' { | |||||
// replace spaces with underscores | |||||
n += "_" | |||||
} else if v == ' ' || v == '_' || v == '-' { | |||||
// replace spaces/underscores with delimiters | |||||
n += string(del) | |||||
} else { | } else { | ||||
n = n + string(v) | n = n + string(v) | ||||
} | } | ||||
} | } | ||||
n = strings.ToLower(n) | |||||
if screaming { | |||||
n = strings.ToUpper(n) | |||||
} else { | |||||
n = strings.ToLower(n) | |||||
} | |||||
return n | return n | ||||
} | } |
@@ -1,3 +1,28 @@ | |||||
/* | |||||
* The MIT License (MIT) | |||||
* | |||||
* Copyright (c) 2015 Ian Coleman | |||||
* Copyright (c) 2018 Ma_124, <github.com/Ma124> | |||||
* | |||||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||||
* of this software and associated documentation files (the "Software"), to deal | |||||
* in the Software without restriction, including without limitation the rights | |||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||||
* copies of the Software, and to permit persons to whom the Software is | |||||
* furnished to do so, Subject to the following conditions: | |||||
* | |||||
* The above copyright notice and this permission notice shall be included in all | |||||
* copies or Substantial portions of the Software. | |||||
* | |||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||||
* SOFTWARE. | |||||
*/ | |||||
package strcase | package strcase | ||||
import ( | import ( | ||||
@@ -29,7 +54,38 @@ func TestToSnake(t *testing.T) { | |||||
out := i[1] | out := i[1] | ||||
result := ToSnake(in) | result := ToSnake(in) | ||||
if result != out { | if result != out { | ||||
t.Error("'" + result + "' != '" + out + "'") | |||||
t.Error("'" + in + "'('" + result + "' != '" + out + "')") | |||||
} | |||||
} | |||||
} | |||||
func TestToDelimited(t *testing.T) { | |||||
cases := [][]string{ | |||||
[]string{"testCase", "test@case"}, | |||||
[]string{"TestCase", "test@case"}, | |||||
[]string{"Test Case", "test@case"}, | |||||
[]string{" Test Case", "test@case"}, | |||||
[]string{"Test Case ", "test@case"}, | |||||
[]string{" Test Case ", "test@case"}, | |||||
[]string{"test", "test"}, | |||||
[]string{"test_case", "test@case"}, | |||||
[]string{"Test", "test"}, | |||||
[]string{"", ""}, | |||||
[]string{"ManyManyWords", "many@many@words"}, | |||||
[]string{"manyManyWords", "many@many@words"}, | |||||
[]string{"AnyKind of_string", "any@kind@of@string"}, | |||||
[]string{"numbers2and55with000", "numbers@2@and@55@with@000"}, | |||||
[]string{"JSONData", "json@data"}, | |||||
[]string{"userID", "user@id"}, | |||||
[]string{"AAAbbb", "aa@abbb"}, | |||||
[]string{"test-case", "test@case"}, | |||||
} | |||||
for _, i := range cases { | |||||
in := i[0] | |||||
out := i[1] | |||||
result := ToDelimited(in, '@') | |||||
if result != out { | |||||
t.Error("'" + in + "' ('" + result + "' != '" + out + "')") | |||||
} | } | ||||
} | } | ||||
} | } |