documize/core/stringutil/slug.go

// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
//
// This software (Documize Community Edition) is licensed under
// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
//
// You can operate outside the AGPL restrictions by purchasing
// Documize Enterprise Edition and obtaining a commercial license
// by contacting <sales@documize.com>.
//
// https://documize.com

package stringutil

import (
	"strings"
	"unicode"
)

// MakeSlug creates a slug, suitable for use in a URL, from a string
func MakeSlug(str string) string {
	slg := strings.Map(
		func(r rune) rune { // individual mapping of runes into a format suitable for use in a URL
			r = unicode.ToLower(r)
			if unicode.IsLower(r) || unicode.IsDigit(r) {
				return r
			}
			return '-'
		}, str)
	slg = strings.NewReplacer("---", "-", "--", "-").Replace(slg)
	for strings.HasSuffix(slg, "-") {
		slg = strings.TrimSuffix(slg, "-")
	}
	for strings.HasPrefix(slg, "-") {
		slg = strings.TrimPrefix(slg, "-")
	}
	return slg
}