Merge pull request #339 from hairyhenderson/add-slug-336

Add strings.Slug function

docs/content/functions/strings.md

@@ -241,6 +241,27 @@ $ gomplate -i '{{ "172.21.1.42" | strings.ReplaceAll "." "-" }}'
 172-21-1-42
 ```
 
+## `strings.Slug`
+
+Creates a a "slug" from a given string - supports unicode correctly. This wraps the [github.com/gosimple/slug](https://github.com/gosimple/slug) package. See [the github.com/gosimple/slug docs](https://godoc.org/github.com/gosimple/slug) for more information.
+
+### Usage
+```go
+strings.Slug input
+```
+```go
+input | strings.Slug
+```
+
+### Examples
+```console
+$ gomplate -i '{{ "Hello, world!" | strings.Slug }}'
+hello-world
+
+$ echo 'Rock & Roll @ Cafe Wha?' | gomplate -d in=stdin: -i '{{ strings.Slug (include "in") }}'
+rock-and-roll-at-cafe-wha
+```
+
 ## `strings.Title`
 
 **Alias:** `title`

funcs/strings.go

@@ -15,6 +15,7 @@ import (
 
 	"strings"
 
+	"github.com/gosimple/slug"
 	gompstrings "github.com/hairyhenderson/gomplate/strings"
 )
 
@@ -185,3 +186,8 @@ func (f *StringFuncs) Indent(args ...interface{}) string {
 	}
 	return gompstrings.Indent(width, indent, input)
 }
+
+// Slug -
+func (f *StringFuncs) Slug(in interface{}) string {
+	return slug.Make(conv.ToString(in))
+}

funcs/strings_test.go

@@ -58,3 +58,30 @@ func TestAbbrev(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, "...baz...", s)
 }
+
+func TestSlug(t *testing.T) {
+	sf := &StringFuncs{}
+	s := sf.Slug(nil)
+	assert.Equal(t, "nil", s)
+
+	s = sf.Slug(0)
+	assert.Equal(t, "0", s)
+
+	s = sf.Slug(1.85e-5)
+	assert.Equal(t, "1-85e-05", s)
+
+	s = sf.Slug("Hello, World!")
+	assert.Equal(t, "hello-world", s)
+
+	s = sf.Slug("foo@example.com")
+	assert.Equal(t, "fooatexample-com", s)
+
+	s = sf.Slug("rock & roll!")
+	assert.Equal(t, "rock-and-roll", s)
+
+	s = sf.Slug("foo@example.com")
+	assert.Equal(t, "fooatexample-com", s)
+
+	s = sf.Slug(`100%`)
+	assert.Equal(t, "100", s)
+}

test/integration/strings_test.go

@@ -43,3 +43,9 @@ func (s *StringsSuite) TestRepeat(c *C) {
 		`ba{{ strings.Repeat -1 "na" }}`)
 	result.Assert(c, icmd.Expected{ExitCode: 1, Out: `negative count`})
 }
+
+func (s *StringsSuite) TestSlug(c *C) {
+	result := icmd.RunCommand(GomplateBin, "-i",
+		`{{ strings.Slug "Hellö, Wôrld! Free @ last..." }}`)
+	result.Assert(c, icmd.Expected{ExitCode: 0, Out: `hello-world-free-at-last`})
+}