README.md added

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020
+
+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.

README.md

@@ -0,0 +1,314 @@
+# Golang Stringy
+A Golang string manipulation utility which have many useful functionality like camelcase, snakecase, kebabcase or slugify, custom delimiter, between, and able to uppercase or lowercase them as needed. You can convert camelcase to snakecase or kebabcase, or snakecase to camelcase and kebabcase and vice versa. This package was inspired from PHP [danielstjules/Stringy](https://github.com/danielstjules/Stringy).
+
+* [Why?](#why)
+* [Installation](#installation)
+* [Functions](#functions)
+* [Running the tests](#running-the-tests)
+* [Contributing](#contributing)
+* [License](#license)
+
+<table>
+    <tr>
+        <td><a href="#betweenstart-end-string-stringmanipulation">Between</a></td>
+        <td><a href="#boolean-bool">Boolean</a></td>
+        <td><a href="#camelcaserule-string-string">CamelCase</a></td>
+    </tr>
+    <tr>
+        <td><a href="#containsallcheck-string-bool">ContainsAll</a></td>
+        <td><a href="#delimiteddelimiter-string-rule-string-stringmanipulation">Delimited</a></td>
+        <td><a href="#get-string">Get</a></td>
+    </tr>
+    <tr>
+        <td><a href="#kebabcaserule-string-stringmanipulation">KebabCase</a></td>
+        <td><a href="#lcfirst-string">LcFirst</a></td>
+        <td><a href="#lines-string">Lines</a></td>
+    </tr>
+    <tr>
+        <td><a href="#padlength-int-with-padtype-string-string">Pad</a></td>
+        <td><a href="#removespecialcharacter-string">RemoveSpecialCharacter</a></td>
+        <td><a href="#replacefirstsearch-replace-string-string">ReplaceFirst</a></td>
+    </tr>
+    <tr>
+        <td><a href="#replacelastsearch-replace-string-string">ReplaceLast</a></td>
+        <td><a href="#reverse-string">Reverse</a></td>
+        <td><a href="#shuffle-string">Shuffle</a></td>
+    </tr>
+    <tr>
+        <td><a href="#surroundwith-string-string">Surround</a></td>
+        <td><a href="#snakecaserule-string-stringmanipulation">SnakeCase</a></td>
+        <td><a href="#teaselength-int-indicator-string-string">Tease</a></td>
+    </tr>
+    <tr>
+        <td><a href="#tolower-string">ToLower</a></td>
+        <td><a href="#toupper-string">ToUpper</a></td>
+        <td><a href="#ucfirst-string">UcFirst</a></td>
+    </tr>
+</table>
+
+
+## Why?
+
+Golang has very rich strings core package but some extra helper function and not available and this stringy package is here to fill that void. Plus there are other some packages in golang, that have same functionality but for some extreme cases they fail to provide correct output. This package cross flexibility is it's main advantage. You can convert to camelcase  to snakecase or kebabcase or vice versa. 
+
+```go
+        str := New("hello__man how-Are you??")
+	result := str.CamelCase("?","")
+	fmt.Println(result) // HelloManHowAreYou
+
+	snakeStr := str.SnakeCase("?","")
+	fmt.Println(snakeStr.ToLower()) // hello_man_how_are_you
+
+	kebabStr := str.KebabCase("?","")
+	fmt.Println(kebabStr.ToUpper()) // HELLO-MAN-HOW-ARE-YOU
+```
+
+## Installation
+
+``` bash
+$ go get -u -v github.com/gobeam/Stringy
+```
+
+or with dep
+
+``` bash
+$ dep ensure -add github.com/gobeam/Stringy
+```
+
+
+## Functions
+
+##### Between(start, end string) StringManipulation
+
+Between takes two string params start and end which and returns value which is in middle of start and end part of input. You can chain to upper which with make result all uppercase or ToLower which will make result all lower case or Get which will return result as it is.
+
+```go
+        strBetween := New("HelloMyName")
+	fmt.Println(strBetween.Between("hello", "name").ToUpper()) // MY
+```
+
+##### Boolean() bool
+
+Boolean func returns boolean value of string value like on, off, 0, 1, yes, no returns boolean value of string input. You can chain this function on other function which returns implemented StringManipulation interface.
+
+```go
+        boolString := New("off")
+        fmt.Println(boolString.Boolean()) // false
+```
+
+##### CamelCase(rule ...string) string
+
+CamelCase is variadic function which takes one Param rule i.e slice of strings and it returns input type string in camel case form and rule helps to omit character you want to omit from string. By default special characters like "_", "-","."," " are treated like word separator and treated accordingly by default and you dont have to worry about it.
+
+```go
+        camelCase := New("ThisIsOne___messed up string. Can we Really camel-case It ?##")
+        fmt.Println(camelCase.CamelCase("?", "", "#", "")) // ThisIsOneMessedUpStringCanWeReallyCamelCaseIt
+```
+look how it omitted ?## from string. If you dont want to omit anything and since it returns plain strings and you cant actually cap all or lower case all camelcase string its not required.
+
+```go
+        camelCase := New("ThisIsOne___messed up string. Can we Really camel-case It ?##")
+        fmt.Println(camelCase.CamelCase()) // ThisIsOneMessedUpStringCanWeReallyCamelCaseIt?##
+```
+
+##### ContainsAll(check ...string) bool
+
+ContainsAll is variadic function which takes slice of strings as param and checks if they are present in input and returns boolean value accordingly.
+
+```go
+        contains := New("hello mam how are you??")
+        fmt.Println(contains.ContainsAll("mam", "?")) // true
+```
+
+##### Delimited(delimiter string, rule ...string) StringManipulation
+
+Delimited is variadic function that takes two params delimiter and slice of strings named rule. It joins the string by passed delimeter. Rule param helps to omit character you want to omit from string. By default special characters like "_", "-","."," " are treated like word separator and treated accordingly by default and you dont have to worry about it. If you don't want to omit any character pass empty string.
+
+```go
+        delimiterString := New("ThisIsOne___messed up string. Can we Really delimeter-case It?")
+        fmt.Println(delimiterString.Delimited("?").Get())
+```
+You can chain to upper which with make result all uppercase or ToLower which will make result all lower case or Get which will return result as it is.
+
+
+##### Get() string
+
+Get simply returns result and can be chained on function which returns StringManipulation interface view above examples
+
+
+##### KebabCase(rule ...string) StringManipulation
+
+KebabCase/slugify is variadic function that takes one Param slice of strings named rule and it returns passed string in kebab case or slugify form. Rule param helps to omit character you want to omit from string. By default special characters like "_", "-","."," " are treated like word separator and treated accordingly by default and you don't have to worry about it. If you don't want to omit any character pass nothing.
+
+```go
+        str := New("hello__man how-Are you??")
+        kebabStr := str.KebabCase("?","")
+        fmt.Println(kebabStr.ToUpper()) // HELLO-MAN-HOW-ARE-YOU
+        fmt.Println(kebabStr.Get()) // hello-man-how-Are-you
+```
+You can chain to upper which with make result all uppercase or ToLower which will make result all lower case or Get which will return result as it is.
+
+
+##### LcFirst() string
+
+LcFirst simply returns result by lower casing first letter of string and it can be chained on function which return StringManipulation interface
+
+```go
+        contains := New("Hello roshan")
+        fmt.Println(contains.LcFirst()) // hello roshan
+```
+
+
+##### Lines() []string
+
+Lines returns slice of strings by removing white space characters
+
+```go
+        lines := New("fòô\r\nbàř\nyolo123")
+        fmt.Println(lines.Lines()) // [fòô bàř yolo123]
+```
+
+
+##### Pad(length int, with, padType string) string
+
+Pad takes three param length i.e total length to be after padding, with i.e  what to pad with and pad type which can be ("both" or "left" or "right") it return string after padding upto length by with param and on padType type it can be chained on function which return StringManipulation interface
+
+```go
+        pad := New("Roshan")
+        fmt.Println(pad.Pad(0, "0", "both"))  // 00Roshan00
+        fmt.Println(pad.Pad(0, "0", "left"))  // 0000Roshan
+        fmt.Println(pad.Pad(0, "0", "right")) // Roshan0000
+```
+
+
+##### RemoveSpecialCharacter() string
+
+RemoveSpecialCharacter removes all special characters and returns the string nit can be chained on function which return StringManipulation interface
+
+```go
+        cleanString := New("special@#remove%%%%")
+        fmt.Println(cleanString.RemoveSpecialCharacter()) // specialremove
+```
+
+
+##### ReplaceFirst(search, replace string) string
+
+ReplaceFirst takes two param search and replace. It returns string by searching search sub string and replacing it with replace substring on first occurrence it can be chained on function which return StringManipulation interface.
+
+```go
+        replaceFirst := New("Hello My name is Roshan and his name is Alis.")
+        fmt.Println(replaceFirst.ReplaceFirst("name", "nombre")) // Hello My nombre is Roshan and his name is Alis.
+```
+
+
+##### ReplaceLast(search, replace string) string
+
+ReplaceLast takes two param search and replace it return string by searching search sub string and replacing it with replace substring on last occurrence it can be chained on function which return StringManipulation interface
+
+```go
+        replaceLast := New("Hello My name is Roshan and his name is Alis.")
+        fmt.Println(replaceLast.ReplaceLast("name", "nombre")) // Hello My name is Roshan and his nombre is Alis.
+```
+
+
+##### Reverse() string
+
+Reverse function reverses the passed strings it can be chained on function which return StringManipulation interface.
+
+```go
+        reverse := New("This is only test")
+        fmt.Println(reverse.Reverse()) // tset ylno si sihT
+```
+
+
+##### Shuffle() string
+
+Shuffle shuffles the given string randomly it can be chained on function which return StringManipulation interface.
+
+```go
+        shuffleString := New("roshan")
+        fmt.Println(shuffleString.Shuffle()) // nhasro
+```
+
+
+##### Surround(with string) string
+
+Surround takes one param with which is used to surround user input and it can be chained on function which return StringManipulation interface.
+
+```go
+        surroundStr := New("__")
+        fmt.Println(surroundStr.Surround("-")) // -__-
+```
+
+
+##### SnakeCase(rule ...string) StringManipulation
+
+SnakeCase is variadic function that takes one Param slice of strings named rule and it returns passed string in snake case form. Rule param helps to omit character you want to omit from string. By default special characters like "_", "-","."," " are treated like word separator and treated accordingly by default and you don't have to worry about it. If you don't want to omit any character pass nothing.
+
+```go
+        snakeCase := New("ThisIsOne___messed up string. Can we Really Snake Case It?")
+        fmt.Println(snakeCase.SnakeCase("?", "").Get()) // This_Is_One_messed_up_string_Can_we_Really_Snake_Case_It
+        fmt.Println(snakeCase.SnakeCase("?", "").ToUpper()) // THIS_IS_ONE_MESSED_UP_STRING_CAN_WE_REALLY_SNAKE_CASE_IT
+```
+You can chain to upper which with make result all uppercase or ToLower which will make result all lower case or Get which will return result as it is.
+
+
+##### Tease(length int, indicator string) string
+
+Tease takes two params length and indicator and it shortens given string on passed length and adds indicator on end it can be chained on function which return StringManipulation interface.
+
+```go
+        teaseString := New("Hello My name is Roshan. I am full stack developer")
+        fmt.Println(teaseString.Tease(20, "...")) // Hello My name is Ros...
+```
+
+
+##### ToLower() string
+
+ToLower makes all string of user input to lowercase and it can be chained on function which return StringManipulation interface.
+
+```go
+        snakeCase := New("ThisIsOne___messed up string. Can we Really Snake Case It?")
+        fmt.Println(snakeCase.SnakeCase("?", "").ToLower()) // this_is_one_messed_up_string_can_we_really_snake_case_it
+```
+
+
+##### ToUpper() string
+
+ToUpper makes all string of user input to uppercase and it can be chained on function which return StringManipulation interface.
+
+```go
+        snakeCase := New("ThisIsOne___messed up string. Can we Really Snake Case It?")
+        fmt.Println(snakeCase.SnakeCase("?", "").ToUpper()) // THIS_IS_ONE_MESSED_UP_STRING_CAN_WE_REALLY_SNAKE_CASE_IT
+```
+
+
+##### UcFirst() string
+
+LcFirst simply returns result by lower casing first letter of string and it can be chained on function which return StringManipulation interface.
+
+```go
+        contains := New("hello roshan")
+        fmt.Println(contains.UcFirst()) // Hello roshan
+```
+
+
+## Running the tests
+
+``` bash
+$ go test
+```
+
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+
+## License
+
+Released under the MIT License - see `LICENSE.txt` for details.
+
+
+

example/main.go

@@ -11,7 +11,7 @@ func main() {
 	fmt.Println(strBetween.Between("hello", "name").ToUpper())
 
 	teaseString := New("Hello My name is Roshan. I am full stack developer")
-	fmt.Println(teaseString.Tease(100, "..."))
+	fmt.Println(teaseString.Tease(20, "..."))
 
 	replaceFirst := New("Hello My name is Roshan and his name is Alis.")
 	fmt.Println(replaceFirst.ReplaceFirst("name", "nombre"))
@@ -21,6 +21,8 @@ func main() {
 
 	snakeCase := New("ThisIsOne___messed up string. Can we Really Snake Case It?")
 	fmt.Println(snakeCase.SnakeCase("?", "").Get())
+	fmt.Println(snakeCase.SnakeCase("?", "").ToUpper())
+	fmt.Println(snakeCase.SnakeCase("?", "").ToLower())
 
 	camelCase := New("ThisIsOne___messed up string. Can we Really camel-case It ?##")
 	fmt.Println(camelCase.CamelCase("?", "", "#", ""))
@@ -38,9 +40,9 @@ func main() {
 	fmt.Println(reverse.Reverse())
 
 	pad := New("Roshan")
-	fmt.Println(pad.Pad(0, "0", "both"))
+	fmt.Println(pad.Pad(10, "0", "both"))
-	fmt.Println(pad.Pad(0, "0", "left"))
+	fmt.Println(pad.Pad(10, "0", "left"))
-	fmt.Println(pad.Pad(0, "0", "right"))
+	fmt.Println(pad.Pad(10, "0", "right"))
 
 	shuffleString := New("roshan")
 	fmt.Println(shuffleString.Shuffle())
@@ -51,4 +53,17 @@ func main() {
 	boolString := New("off")
 	fmt.Println(boolString.Boolean())
 
+	surroundStr := New("__")
+	fmt.Println(surroundStr.Surround("-"))
+
+	str := New("hello__man how-Are you??")
+	result := str.CamelCase("?", "")
+	fmt.Println(result) // HelloManHowAreYou
+
+	snakeStr := str.SnakeCase("?", "")
+	fmt.Println(snakeStr.ToLower()) // hello_man_how_are_you
+
+	kebabStr := str.KebabCase("?", "")
+	fmt.Println(kebabStr.ToUpper()) // HELLO-MAN-HOW-ARE-YOU
+
 }

stringy.go

@@ -46,8 +46,10 @@ func New(val string) StringManipulation {
 	return &input{Input: val}
 }
 
-// Between takes two param start and end which are string
+// Between takes two string params start and end which and returns
-// return value after omitting start and end part of input
+// value which is in middle of start and end part of input. You can
+// chain to upper which with make result all upercase or ToLower which
+// will make result all lower case or Get which will return result as it is
 func (i *input) Between(start, end string) StringManipulation {
 	if start == "" && end == "" || i.Input == "" {
 		return i
@@ -70,8 +72,9 @@ func (i *input) Between(start, end string) StringManipulation {
 	return i
 }
 
-// Boolean func return boolean value of string value like on, off, 0, 1, yes, no
+// Boolean func returns boolean value of string value like on, off, 0, 1, yes, no
-// returns boolean value of string input
+// returns boolean value of string input. You can chain this function on other function
+// which returns implemented StringManipulation interface
 func (i *input) Boolean() bool {
 	input := getInput(*i)
 	inputLower := strings.ToLower(input)
@@ -86,8 +89,10 @@ func (i *input) Boolean() bool {
 	panic(errors.New("invalid string value to test boolean value"))
 }
 
-// CamelCase takes one Param rule and it returns passed string in
+// CamelCase is variadic function which takes one Param rule i.e slice of strings and it returns
-// camel case form and rule helps to omit character you want from string
+// input type string in camel case form and rule helps to omit character you want to omit from string.
+// By default special characters like "_", "-","."," " are l\treated like word separator and treated
+// accordingly by default and you dont have to worry about it
 // Example input: hello user
 // Result : HelloUser
 func (i *input) CamelCase(rule ...string) string {
@@ -100,8 +105,8 @@ func (i *input) CamelCase(rule ...string) string {
 	return strings.Join(wordArray, "")
 }
 
-// ContainsAll function takes multiple string param and
+// ContainsAll is variadic function which takes slice of strings as param and checks if they are present
-// checks if they are present in input
+// in input and returns boolean value accordingly
 func (i *input) ContainsAll(check ...string) bool {
 	input := getInput(*i)
 	for _, item := range check {
@@ -112,7 +117,10 @@ func (i *input) ContainsAll(check ...string) bool {
 	return true
 }
 
-// Delimited function joins the string by passed delimeter
+// Delimited is variadic function that takes two params delimiter and slice of strings i.e rule. It joins
+// the string by passed delimeter. Rule param helps to omit character you want to omit from string. By
+// default special characters like "_", "-","."," " are l\treated like word separator and treated accordingly
+// by default and you dont have to worry about it.
 func (i *input) Delimited(delimiter string, rule ...string) StringManipulation {
 	input := getInput(*i)
 	if strings.TrimSpace(delimiter) == "" {
@@ -129,8 +137,10 @@ func (i *input) Get() string {
 	return getInput(*i)
 }
 
-// KebabCase takes one Param rule and it returns passed string in
+// KebabCase is variadic function that takes one Param slice of strings named rule and it returns passed string
-// kebab case form and rule helps to omit character you want from string
+// in kebab case form. Rule param helps to omit character you want to omit from string. By default special characters
+// like "_", "-","."," " are l\treated like word separator and treated accordingly by default and you dont have to worry
+// about it. If you don't want to omit any character pass nothing.
 // Example input: hello user
 // Result : hello-user
 func (i *input) KebabCase(rule ...string) StringManipulation {
@@ -140,8 +150,8 @@ func (i *input) KebabCase(rule ...string) StringManipulation {
 	return i
 }
 
-// LcFirst simply returns result by lowercasing first letter of string and
+// LcFirst simply returns result by lower casing first letter of string and it can be chained on
-// it can be chained on function which return StringManipulation interface
+// function which return StringManipulation interface
 func (i *input) LcFirst() string {
 	input := getInput(*i)
 	for i, v := range input {
@@ -158,10 +168,10 @@ func (i *input) Lines() []string {
 	return strings.Fields(strings.TrimSpace(result))
 }
 
-// Pad takes three param length i.e total length to be after padding,
+// Pad takes three param length i.e total length to be after padding, with i.e  what to pad
-// with i.e  what to pad with and pad type which can be (both or left or right)
+// with and pad type which can be ("both" or "left" or "right") it return string after padding
-// it return string after padding upto length by with param and on padType type
+// upto length by with param and on padType type it can be chained on function which return
-// it can be chained on function which return StringManipulation interface
+// StringManipulation interface
 func (i *input) Pad(length int, with, padType string) string {
 	input := getInput(*i)
 	inputLength := len(input)
@@ -204,10 +214,9 @@ func (i *input) RemoveSpecialCharacter() string {
 	return result.String()
 }
 
-// ReplaceFirst takes two param search and replace
+// ReplaceFirst takes two param search and replace. It returns string by searching search
-// it return string by searching search sub string and replacing it
+// sub string and replacing it with replace substring on first occurrence it can be chained
-// with replace substring on first occurrence
+// on function which return StringManipulation interface.
-// it can be chained on function which return StringManipulation interface
 func (i *input) ReplaceFirst(search, replace string) string {
 	input := getInput(*i)
 	return replaceStr(input, search, replace, First)
@@ -246,11 +255,11 @@ func (i *input) Shuffle() string {
 	return string(inRune)
 }
 
-// SnakeCase is variadic function that takes one param rule
+// SnakeCase is variadic function that takes one Param slice of strings named rule
-// it returns passed string in snake case form and rule helps to
+// and it returns passed string in snake case form. Rule param helps to omit character
-// omit character you want from string
+// you want to omit from string. By default special characters like "_", "-","."," " are treated
-// Example input: hello user
+// like word separator and treated accordingly by default and you don't have to worry about it.
-// Result : hello_user
+// If you don't want to omit any character pass nothing.
 func (i *input) SnakeCase(rule ...string) StringManipulation {
 	input := getInput(*i)
 	wordArray := caseHelper(input, false, rule...)
@@ -258,8 +267,8 @@ func (i *input) SnakeCase(rule ...string) StringManipulation {
 	return i
 }
 
-// Surround takes one param with which is used to surround user input
+// Surround takes one param with which is used to surround user input and it
-// it can be chained on function which return StringManipulation interface
+// can be chained on function which return StringManipulation interface.
 func (i *input) Surround(with string) string {
 	input := getInput(*i)
 	return with + input + with
@@ -276,7 +285,7 @@ func (i *input) Tease(length int, indicator string) string {
 	return input[:length] + indicator
 }
 
-// ToLowerr makes all string of user input to lowercase
+// ToLower makes all string of user input to lowercase
 // it can be chained on function which return StringManipulation interface
 func (i *input) ToLower() (result string) {
 	input := getInput(*i)