Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leebenson/conform

Trims, sanitizes & scrubs data based on struct tags (go, golang)
https://github.com/leebenson/conform

Last synced: 3 days ago
JSON representation

Trims, sanitizes & scrubs data based on struct tags (go, golang)

Awesome Lists containing this project

README 

        
# Conform- keep user input in check (go, golang)



Trim, sanitize, and modify struct string fields in place, based on tags.



**Now also works with embedded structs**



Turns this...



``` go

type Person struct {

	FirstName string `conform:"name"`

	LastName  string `conform:"ucfirst,trim"`

	Email     string `conform:"email"`

	CamelCase string `conform:"camel"`

	UserName  string `conform:"snake"`

	Slug      string `conform:"slug"`

	Blurb     string `conform:"title"`

	Left      string `conform:"ltrim"`

	Right     string `conform:"rtrim"`



 	Skills   []string          `conform:"upper"`

	Examples map[string]string `conform:"!html"`

}



p1 := Person{

	" LEE ",

	"     Benson",

	"   [email protected]  ",

	"I love new york city",

	"lee benson",

	"LeeBensonWasHere",

	"this is a little bit about me...",

	"    Left trim   ",

	"    Right trim  ",

	[]string{"HtmL", "Yaml"},

	map[string]string{"":"
I know this & that.
"},

}



```



Into this...



``` go

p2 := p1 // <-- copy the Person struct into a new one, to see the difference

conform.Strings(&p2) // <-- this does the work



/*

	p1 (left) vs. p2 (right)



	FirstName: ' LEE ' -> 'Lee'

	LastName: '     Benson' -> 'Benson'

	Email: '   [email protected]  ' -> '[email protected]'

	CamelCase: 'I love new york city' -> 'ILoveNewYorkCity'

	UserName: 'lee benson' -> 'lee_benson'

	Slug: 'LeeBensonWasHere' -> 'lee-benson-was-here'

	Blurb: 'this is a little bit about me...' -> 'This Is A Little Bit About Me...'

	Left: '    Left trim   ' -> 'Left trim   '

	Right: '    Right trim  ' -> '    Right trim',

	Skills: { 'HtmL', 'Yaml' } -> { 'HTML', 'YAML' },

	Examples: { '': '
I know this & that.
' } -> { '': '<body><p>I know this & that.</p></body>' }

*/

```

**Note: No map keys are changed.**



## Why?



Conform helps you fix and format user strings quickly, without writing functions.



If you do form processing with [Gorilla Schema](http://www.gorillatoolkit.org/pkg/schema) or similar, you probably shuttle user data into structs using tags. Adding a `conform` tag to your string field gives you "first pass" clean up against user input.



Use it for names, e-mail addresses, URL slugs, or any other form field where formatting matters.



Conform doesn't attempt any kind of validation on your fields. Check out [govalidator](https://github.com/asaskevich/govalidator) for a slew of common validation funcs, or [validator](https://github.com/go-playground/validator) which is an uber-flexible Swiss Army knife for validating pretty much any kind of data you can imagine. Both have struct tag syntax and can be used with conform.



## How to use



Grab the package from the command line with:



`go get github.com/leebenson/conform`



And import in the usual way in your Go app:



`import "github.com/leebenson/conform"`



Add a `conform` tag to your structs, for all of the string fields that you want Conform to transform. Add the name of the transform (known as the "tag") in double quotes, and separate multiple tags with commas. Example: `conform:"trim,lowercase"`



To format in place, pass your struct pointer to `conform.Strings`.



**Note: your struct will be edited _in place_. This will OVERWRITE any data that is already stored in your string fields.**



Here's an example that formats e-mail addresses:



``` go

package main



import (

		"fmt"

		"github.com/leebenson/conform"

)



type UserForm struct {

	Email string `conform:"email"`

}



func main() {

	input := UserForm{

		Email: "   [email protected]  ",

	}

	conform.Strings(&input) // <-- pass in a pointer to your struct

	fmt.Println(input.Email) // prints "[email protected]"

}



```



## Using with Gorilla Schema



Just add a `conform` tag along with your Gorilla `schema` tags:



``` go

// ...



import (

	"net/http"



	"github.com/gorilla/schema"

	"github.com/leebenson/conform"

)



// the struct that will be filled from the post request...

type newUserForm struct {

	FirstName string    `schema:"firstName" conform:"name"`

	Email     string    `schema:"emailAddress" conform:"email"`

	Password  string    `schema:"password"`    // <-- no tag? no change

	Dob       time.Time `schema:"dateOfBirth"` // <-- non-strings ignored by conform

}



// ProcessNewUser attempts to register a new user

func ProcessNewUser(r *http.Request) error {

	form := new(newUserForm)

	schema.NewDecoder().Decode(form, r.PostForm) // <-- Gorilla Schema

	conform.Strings(form)                       // <-- Conform.  Pass in the same pointer that Schema used

	// ...

}



// HTTP handlers, etc...



```



## Godoc

See the [public API / exported methods on Godoc](https://godoc.org/github.com/leebenson/conform).



## Tags



You can use multiple tags in the format of `conform:"tag1,tag2"`



### trim

---------------------------------------

Trims leading and trailing spaces. Example: `"   string   "` -> `"string"`



### ltrim

---------------------------------------

Trims leading spaces only. Example: `"   string   "` -> `"string   "`



### rtrim

---------------------------------------

Trims trailing spaces only. Example: `"   string   "` -> `"   string"`



### lower

---------------------------------------

Converts string to lowercase. Example: `"STRING"` -> `"string"`



### upper

---------------------------------------

Converts string to uppercase. Example: `"string"` -> `"STRING"`



### title

---------------------------------------

Converts string to Title Case, e.g. `"this is a sentence"` -> `"This Is A Sentence"`



### camel

---------------------------------------

Converts to camel case via [stringUp](https://github.com/etgryphon/stringUp), Example provided by library: `this is it => thisIsIt, this\_is\_it => thisIsIt, this-is-it => thisIsIt`



### snake

---------------------------------------

Converts to snake_case. Example: `"CamelCase"` -> `"camel_case"`, `"regular string"` -> `"regular_string"`

Special thanks to [snaker](https://github.com/serenize/snaker/) for inspiration (credited in license)



### slug

---------------------------------------

Turns strings into slugs.  Example: `"CamelCase"` -> `"camel-case"`, `"blog title here"` -> `"blog-title-here"`



### ucfirst

---------------------------------------

Uppercases first character.  Example: `"all lower"` -> `"All lower"`



### name

---------------------------------------

Trims, strips numbers and special characters (except dashes and spaces separating names), converts multiple spaces and dashes to single characters, title cases multiple names. Example: `"3493€848Jo-s$%£@Ann   "` -> `"Jo-Ann"`, `"  ~~  The       Dude ~~"` -> `"The Dude"`, `"**susan**"` -> `"Susan"`, `"    hugh fearnley-whittingstall"` -> `"Hugh Fearnley-Whittingstall"`



### email

---------------------------------------

Trims and lowercases the domain portion of the string.  Example: `"[email protected] "` -> `"[email protected]"`



### num

---------------------------------------

Removes all non-numeric characters. Example: `"the price is €30,38"` -> `"3038"`



_Note: The struct field will remain a string. No type conversion takes place._



### !num

---------------------------------------

Removes all numbers. Example `"39472349D34a34v69e8932747"` -> `"Dave"`



### alpha

---------------------------------------

Removes non-alpha unicode characters. Example: `"!@£$%^&'()Hello 1234567890 World+[];\"` -> `"HelloWorld"`



### !alpha

---------------------------------------

Removes alpha unicode characters. Example: `"Everything's here but the letters!"` -> `"'    !"`



### !html

---------------------------------------



Escapes HTML so that it is safe for display. Characters are substituted by their respective HTML codes. Internally uses _template.HTMLEscapeString_.

Example: `"' " & < > \000"` -> `"' " & < > \uFFFD"`



### !js

---------------------------------------



Escapes JavaScript. Internally uses _template.JSEscapeString_. Example: `"\ ' " < > & ="` -> `"\\ \' \u003C \u003E \u0026 \u003D"`



### LICENSE

[MIT](https://github.com/leebenson/conform/blob/master/LICENSE)