name.go

package userbus

import (
	"fmt"
	"regexp"
)

// Name represents a name in the system.
type Name struct {
	name string
}

// String returns the value of the name.
func (n Name) String() string {
	return n.name
}

// Equal provides support for the go-cmp package and testing.
func (n Name) Equal(n2 Name) bool {
	return n.name == n2.name
}

// =============================================================================

var nameRegEx = regexp.MustCompile("^[a-zA-Z0-9' -]{3,20}$")

// ParseName parses the string value and returns a name if the value complies
// with the rules for a name.
func ParseName(value string) (Name, error) {
	if !nameRegEx.MatchString(value) {
		return Name{}, fmt.Errorf("invalid name %q", value)
	}

	return Name{value}, nil
}

// MustParseName parses the string value and returns a name if the value
// complies with the rules for a name. If an error occurs the function panics.
func MustParseName(value string) Name {
	name, err := ParseName(value)
	if err != nil {
		panic(err)
	}

	return name
}