New mask types and error with masked value

Author: nikitaksv

README.md

@@ -20,22 +20,38 @@ import (
 )
 
 func main() {
-	maskedValue, _ := strmask.Apply("LLL-000-0", "ABC1234")
-	fmt.Println(maskedValue) // out: ABC-123-4
-
-	maskedValue, _ = strmask.Apply("LLL-000-0", "ABC-123-4")
-	fmt.Println(maskedValue) // out: ABC-123-4
-
-	maskedValue, _ = strmask.Apply("LLL-000-0", "ABC1234XYZ")
-	fmt.Println(maskedValue) // out: ABC-123-4
+	// Ex. phone number
+	maskedValue, _ := strmask.Apply("+0 (000) 000-00-00", "12345678900")
+	fmt.Println(maskedValue) // out: +1 (234) 567-89-00
+
+	// Ex. phone number with err
+	maskedValue, err := strmask.Apply("+0 (000) 000-00-00", "12345")
+	if err != nil {
+		fmt.Println(err) // out: invalid value
+	}
+	fmt.Println(maskedValue) // but maskedValue out: +1 (234) 5
+
+	// Ex. ID
+	maskedValue, _ = strmask.Apply("####-####-####-####", "1234qwerasdfzxcv")
+	fmt.Println(maskedValue) // out: 1234-qwer-asdf-zxcv
+
+	// Ex. Passport
+	maskedValue, _ = strmask.Apply("00 0000000", "123456789")
+	fmt.Println(maskedValue) // out: 12 3456789
+	
+	// Ex. code
+	maskedValue, _ = strmask.Apply("G-UUUUUU", "q1w2e3")
+	fmt.Println(maskedValue) // out: G-Q1W2E3
 }
-
 ```
 
 
 ## Mask Symbols
 Symbol | Meaning
 --- | ---
-`0` | Requires a decimal digit at this position
-`L` | Requires a unicode letter and digit at this position
-`l` | Requires a unicode letter at this position
+`#` | Requires a unicode letter or digit at this position
+`0` | Requires a digit at this position
+`L` | Requires a unicode letter (will be lower) or digit at this position
+`l` | Requires a unicode letter (will be lower) at this position
+`U` | Requires a unicode letter (will be upper) or digit at this position
+`u` | Requires a unicode letter (will be upper) at this position

strmask.go

@@ -6,58 +6,80 @@ import (
 )
 
 const (
-	Letter      = 'l'
-	LetterDigit = 'L'
+	LetterDigit = '#'
 	Digit       = '0'
+
+	LowerLetterDigit = 'L'
+	LowerLetter      = 'l'
+
+	UpperLetterDigit = 'U'
+	UpperLetter      = 'u'
 )
 
 var ErrValue = errors.New("invalid value")
 
 func Apply(mask, value string) (string, error) {
-	var err error
-	runes := make([]rune, len(mask))
+	valueRunes := []rune(value)
+	runes := make([]rune, 0, len(mask))
 	cursor := 0
-	for i, mT := range mask {
-		runes[i], err = getRune(mT, value, &cursor)
-		if err != nil {
-			return "", err
+
+	var r rune
+	for _, mT := range mask {
+		if isMaskType(mT) {
+			r = getRune(mT, valueRunes, &cursor)
+			if r == -1 {
+				return string(runes), ErrValue
+			}
+		} else {
+			r = mT
 		}
+		runes = append(runes, r)
 	}
 
-	str := string(runes)
-	return str, nil
+	return string(runes), nil
 }
 
-func getRune(maskType rune, value string, cursor *int) (rune, error) {
+func getRune(maskType rune, value []rune, cursor *int) rune {
 	if (*cursor) > len(value)-1 {
-		return 0, ErrValue
+		return -1
 	}
 
-	r := rune(value[*cursor])
-
-	if maskType == r {
-		*cursor++
-		return maskType, nil
-	} else if isMaskType(maskType) {
-		*cursor++
-		if (maskType == LetterDigit && isLetterDigit(r)) ||
-			(maskType == Letter && unicode.IsLetter(r)) ||
-			(maskType == Digit && unicode.IsDigit(r)) {
-			return r, nil
-		}
-		return getRune(maskType, value, cursor)
-	} else {
-		return maskType, nil
+	r := value[*cursor]
+	*cursor++
+
+	// # - Requires a unicode letter or digit at this position
+	// 0 - Requires a digit at this position
+	if (maskType == LetterDigit && isLetterOrDigit(r)) || (maskType == Digit && unicode.IsDigit(r)) {
+		return r
 	}
+
+	// L - Requires a unicode letter (will be lower) or digit at this position
+	// l - Requires a unicode letter (will be lower) at this position
+	if (maskType == LowerLetterDigit && isLetterOrDigit(r)) || (maskType == LowerLetter && unicode.IsLetter(r)) {
+		return unicode.ToLower(r)
+	}
+
+	// U - Requires a unicode letter (will be upper) or digit at this position
+	// u - Requires a unicode letter (will be upper) at this position
+	if (maskType == UpperLetterDigit && isLetterOrDigit(r)) || (maskType == UpperLetter && unicode.IsLetter(r)) {
+		return unicode.ToUpper(r)
+	}
+
+	return getRune(maskType, value, cursor)
 }
 
-func isLetterDigit(r rune) bool {
+func isLetterOrDigit(r rune) bool {
 	return unicode.IsLetter(r) || unicode.IsDigit(r)
 }
 
 func isMaskType(r rune) bool {
 	switch r {
-	case LetterDigit, Letter, Digit:
+	case LetterDigit,
+		Digit,
+		LowerLetterDigit,
+		LowerLetter,
+		UpperLetterDigit,
+		UpperLetter:
 		return true
 	default:
 		return false

strmask_test.go

@@ -16,43 +16,69 @@ func TestApply(t *testing.T) {
 		wantErr bool
 	}{
 		{
-			name: "success",
+			name: "mask-# (any letter or digit)",
 			args: args{
-				mask:  "LLL-LLL-LLL",
-				value: "A23456ABC",
+				mask:  "####-####-####-####",
+				value: "qwer TYUI 0123-4567",
 			},
-			want: "A23-456-ABC",
+			want: "qwer-TYUI-0123-4567",
 		},
 		{
-			name: "success",
+			name: "mask-0 (only digit)",
 			args: args{
-				mask:  "0000-000-0",
-				value: "123456789",
+				mask:  "+0 (000) 000-00-00",
+				value: "A12345678900",
 			},
-			want: "1234-567-8",
+			want: "+1 (234) 567-89-00",
 		},
 		{
-			name: "success",
+			name: "mask-L (lower letter or digit)",
 			args: args{
-				mask:  "0000-000-0",
-				value: "9999-123-4",
+				mask:  "LLLL-LLLL",
+				value: "QWER 1234",
 			},
-			want: "9999-123-4",
+			want: "qwer-1234",
 		},
 		{
-			name: "error",
+			name: "mask-l (lower letter)",
 			args: args{
-				mask:  "0000-000-0",
-				value: "9999-123-",
+				mask:  "llll-llll",
+				value: "QWER 1234 zxCV",
 			},
+			want: "qwer-zxcv",
+		},
+		{
+			name: "mask-U (upper letter or digit)",
+			args: args{
+				mask:  "UUUU-UUUU",
+				value: "qwer 1234",
+			},
+			want: "QWER-1234",
+		},
+		{
+			name: "mask-u (upper letter)",
+			args: args{
+				mask:  "uuuu-uuuu",
+				value: "qwer 1234 ASDV",
+			},
+			want: "QWER-ASDV",
+		},
+		{
+			name: "error mask",
+			args: args{
+				mask:  "uuuu-uuuu",
+				value: "123345",
+			},
+			want:    "",
 			wantErr: true,
 		},
 		{
-			name: "error",
+			name: "error mask with value",
 			args: args{
-				mask:  "0000-000-0",
-				value: "asdasdasdas",
+				mask:  "uuuu-uuuu",
+				value: "qwer",
 			},
+			want:    "QWER-",
 			wantErr: true,
 		},
 	}