stringy

package module
Version: v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 7, 2020 License: MIT Imports: 7 Imported by: 0

README

Golang String manipulation helper package

Build Go Report Card GoDoc

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.

Between Boolean CamelCase
ContainsAll Delimited Get
KebabCase LcFirst Lines
Pad RemoveSpecialCharacter ReplaceFirst
ReplaceLast Reverse Shuffle
Surround SnakeCase Tease
ToLower ToUpper UcFirst
First ToUpper

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.

package main

import (
	"fmt"
	. "github.com/gobeam/Stringy"
    )

func main() {
 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

$ go get -u -v github.com/gobeam/Stringy

or with dep

$ 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.

  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.

  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.

  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.

  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.

  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.

  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.

First(length int) string

First returns first n characters from provided input. It removes all spaces in string before doing so.

  fcn := stringy.New("4111 1111 1111 1111")
  first := fcn.First(4)
  fmt.Println(first) // 4111
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.

  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.

Last(length int) string

Last returns last n characters from provided input. It removes all spaces in string before doing so.

  lcn := stringy.New("4111 1111 1111 1348")
  last := lcn.Last(4)
  fmt.Println(last) // 1348
LcFirst() string

LcFirst simply returns result by lower casing first letter of string and it can be chained on function which return StringManipulation interface

  contains := New("Hello roshan")
  fmt.Println(contains.LcFirst()) // hello roshan
Lines() []string

Lines returns slice of strings by removing white space characters

  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

  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

  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.

  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

  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.

  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.

  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.

  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.

  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.

  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.

  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.

  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.

  contains := New("hello roshan")
  fmt.Println(contains.UcFirst()) // Hello roshan

Running the tests

$ 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.

Documentation

Index

Constants

View Source
const (
	First                = "first"
	Last                 = "last"
	Left                 = "left"
	Right                = "right"
	Both                 = "both"
	OddError             = "odd number rule provided please provide in even count"
	SelectCapital        = "([a-z])([A-Z])"
	ReplaceCapital       = "$1 $2"
	LengthError          = "passed length cannot be greater than input length"
	InvalidLogicalString = "invalid string value to test boolean value"
)

const below are used in packages

Variables

View Source
var False = []string{"off", "no", "0", "false"}

False is slice of array for false logical representation in string

View Source
var True = []string{"on", "yes", "1", "True"}

True is slice of array for true logical representation in string

Functions

This section is empty.

Types

type StringManipulation

type StringManipulation interface {
	Between(start, end string) StringManipulation
	Boolean() bool
	CamelCase(rule ...string) string
	ContainsAll(check ...string) bool
	Delimited(delimiter string, rule ...string) StringManipulation
	First(length int) string
	Get() string
	KebabCase(rule ...string) StringManipulation
	Last(length int) string
	LcFirst() string
	Lines() []string
	Pad(length int, with, padType string) string
	RemoveSpecialCharacter() string
	ReplaceFirst(search, replace string) string
	ReplaceLast(search, replace string) string
	Reverse() string
	Shuffle() string
	Surround(with string) string
	SnakeCase(rule ...string) StringManipulation
	Tease(length int, indicator string) string
	ToLower() string
	ToUpper() string
	UcFirst() string
}

StringManipulation is an interface that holds all abstract methods to manipulate strings

func New

func New(val string) StringManipulation

New func returns pointer to input struct

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL