forked from cohesivestack/valgo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
validator_string.go
343 lines (305 loc) · 9.9 KB
/
validator_string.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
package valgo
import (
"regexp"
"strings"
)
func isStringEqualTo[T ~string](v0 T, v1 T) bool {
return v0 == v1
}
func isStringGreaterThan[T ~string](v0 T, v1 T) bool {
return v0 > v1
}
func isStringGreaterOrEqualTo[T ~string](v0 T, v1 T) bool {
return v0 >= v1
}
func isStringLessThan[T ~string](v0 T, v1 T) bool {
return v0 < v1
}
func isStringLessOrEqualTo[T ~string](v0 T, v1 T) bool {
return v0 <= v1
}
func isStringBetween[T ~string](v T, min T, max T) bool {
return v >= min && v <= max
}
func isStringEmpty[T ~string](v T) bool {
return len(v) == 0
}
func isStringBlank[T ~string](v T) bool {
return len(strings.TrimSpace(string(v))) == 0
}
func isStringInSlice[T ~string](v T, slice []T) bool {
for _, _v := range slice {
if v == _v {
return true
}
}
return false
}
func isStringMatchingTo[T ~string](v T, regex *regexp.Regexp) bool {
return regex.MatchString(string(v))
}
func isStringMaxLength[T ~string](v T, length int) bool {
return len(v) <= length
}
func isStringMinLength[T ~string](v T, length int) bool {
return len(v) >= length
}
func isStringLength[T ~string](v T, length int) bool {
return len(v) == length
}
func isStringLengthBetween[T ~string](v T, min int, max int) bool {
return len(v) >= min && len(v) <= max
}
// The `ValidatorString` provides functions for setting validation rules for
// a string value type, or a custom type based on a string.
type ValidatorString[T ~string] struct {
context *ValidatorContext
}
// Receive a string value to validate.
//
// The value can also be a custom string type such as type Status string;.
//
// Optionally, the function can receive a name and title, in that order, to be
// displayed in the error messages. A value_%N` pattern is used as a name in the
// error messages if a name and title are not supplied; for example: value_0.
// When the name is provided but not the title, then the name is humanized to be
// used as the title as well; for example the name phone_number will be
// humanized as Phone Number.
func String[T ~string](value T, nameAndTitle ...string) *ValidatorString[T] {
return &ValidatorString[T]{context: NewContext(value, nameAndTitle...)}
}
// Return the context of the validator. The context is useful to create a custom
// validator by extending this validator.
func (validator *ValidatorString[T]) Context() *ValidatorContext {
return validator.context
}
// Invert the boolean value associated with the next validator function.
// For example:
//
// // It will return false because Not() inverts the boolean value associated with the Blank() function
// Is(v.String("").Not().Blank()).Valid()
func (validator *ValidatorString[T]) Not() *ValidatorString[T] {
validator.context.Not()
return validator
}
// Validate if a string value is equal to another. This function internally uses
// the golang `==` operator.
// For example:
//
// status := "running"
// Is(v.String(status).Equal("running"))
func (validator *ValidatorString[T]) EqualTo(value T, template ...string) *ValidatorString[T] {
validator.context.AddWithValue(
func() bool {
return isStringEqualTo(validator.context.Value().(T), value)
},
ErrorKeyEqualTo, value, template...)
return validator
}
// Validate if a string value is greater than another. This function internally
// uses the golang `>` operator.
// For example:
//
// section := "bb"
// Is(v.String(section).GreaterThan("ba"))
func (validator *ValidatorString[T]) GreaterThan(value T, template ...string) *ValidatorString[T] {
validator.context.AddWithValue(
func() bool {
return isStringGreaterThan(validator.context.Value().(T), value)
},
ErrorKeyGreaterThan, value, template...)
return validator
}
// Validate if a string value is greater than or equal to another. This function
// internally uses the golang `>=` operator.
// For example:
//
// section := "bc"
// Is(v.String(section).GreaterOrEqualTo("bc"))
func (validator *ValidatorString[T]) GreaterOrEqualTo(value T, template ...string) *ValidatorString[T] {
validator.context.AddWithValue(
func() bool {
return isStringGreaterOrEqualTo(validator.context.Value().(T), value)
},
ErrorKeyGreaterOrEqualTo, value, template...)
return validator
}
// Validate if a string value is less than another. This function internally
// uses the golang `<` operator.
// For example:
//
// section := "bb"
// Is(v.String(section).LessThan("bc"))
func (validator *ValidatorString[T]) LessThan(value T, template ...string) *ValidatorString[T] {
validator.context.AddWithValue(
func() bool {
return isStringLessThan(validator.context.Value().(T), value)
},
ErrorKeyLessThan, value, template...)
return validator
}
// Validate if a string value is less than or equal to another. This function
// internally uses the golang `<=` operator to compare two strings.
// For example:
//
// section := "bc"
// Is(v.String(section).LessOrEqualTo("bc"))
func (validator *ValidatorString[T]) LessOrEqualTo(value T, template ...string) *ValidatorString[T] {
validator.context.AddWithValue(
func() bool {
return isStringLessOrEqualTo(validator.context.Value().(T), value)
},
ErrorKeyLessOrEqualTo, value, template...)
return validator
}
// Validate if a string value is empty. Return false if the length of the string
// is greater than zero, even if the string has only spaces.
//
// For checking if the string has only spaces, use the function `Blank()`
// instead.
// For example:
//
// Is(v.String("").Empty()) // Will be true
// Is(v.String(" ").Empty()) // Will be false
func (validator *ValidatorString[T]) Empty(template ...string) *ValidatorString[T] {
validator.context.Add(
func() bool {
return isStringEmpty(validator.context.Value().(T))
},
ErrorKeyEmpty, template...)
return validator
}
// Validate if a string value is blank. Blank will be true if the length
// of the string is zero or if the string only has spaces.
// For example:
//
// Is(v.String("").Empty()) // Will be true
// Is(v.String(" ").Empty()) // Will be true
func (validator *ValidatorString[T]) Blank(template ...string) *ValidatorString[T] {
validator.context.Add(
func() bool {
return isStringBlank(validator.context.Value().(T))
},
ErrorKeyBlank, template...)
return validator
}
// Validate if a string value passes a custom function.
// For example:
//
// status := ""
// Is(v.String(status).Passing((v string) bool {
// return v == getNewStatus()
// })
func (validator *ValidatorString[T]) Passing(function func(v0 T) bool, template ...string) *ValidatorString[T] {
validator.context.Add(
func() bool {
return function(validator.context.Value().(T))
},
ErrorKeyPassing, template...)
return validator
}
// Validate if a string is present in a string slice.
// For example:
//
// status := "idle"
// validStatus := []string{"idle", "paused", "stopped"}
// Is(v.String(status).InSlice(validStatus))
func (validator *ValidatorString[T]) InSlice(slice []T, template ...string) *ValidatorString[T] {
validator.context.AddWithValue(
func() bool {
return isStringInSlice(validator.context.Value().(T), slice)
},
ErrorKeyInSlice, validator.context.Value(), template...)
return validator
}
// Validate if a string matches a regular expression.
// For example:
//
// status := "pre-approved"
// regex, _ := regexp.Compile("pre-.+")
// Is(v.String(status).MatchingTo(regex))
func (validator *ValidatorString[T]) MatchingTo(regex *regexp.Regexp, template ...string) *ValidatorString[T] {
validator.context.AddWithParams(
func() bool {
return isStringMatchingTo(validator.context.Value().(T), regex)
},
ErrorKeyMatchingTo,
map[string]any{"title": validator.context.title, "regexp": regex},
template...)
return validator
}
// Validate the maximum length of a string.
// For example:
//
// slug := "myname"
// Is(v.String(slug).MaxLength(6))
func (validator *ValidatorString[T]) MaxLength(length int, template ...string) *ValidatorString[T] {
validator.context.AddWithParams(
func() bool {
return isStringMaxLength(validator.context.Value().(T), length)
},
ErrorKeyMaxLength,
map[string]any{"title": validator.context.title, "length": length},
template...)
return validator
}
// Validate the minimum length of a string.
// For example:
//
// slug := "myname"
// Is(v.String(slug).MinLength(6))
func (validator *ValidatorString[T]) MinLength(length int, template ...string) *ValidatorString[T] {
validator.context.AddWithParams(
func() bool {
return isStringMinLength(validator.context.Value().(T), length)
},
ErrorKeyMinLength,
map[string]any{"title": validator.context.title, "length": length},
template...)
return validator
}
// Validate the length of a string.
// For example:
//
// slug := "myname"
// Is(v.String(slug).OfLength(6))
func (validator *ValidatorString[T]) OfLength(length int, template ...string) *ValidatorString[T] {
validator.context.AddWithParams(
func() bool {
return isStringLength(validator.context.Value().(T), length)
},
ErrorKeyLength,
map[string]any{"title": validator.context.title, "length": length},
template...)
return validator
}
// Validate if the length of a string is within a range (inclusive).
// For example:
//
// slug := "myname"
// Is(v.String(slug).OfLengthBetween(2,6))
func (validator *ValidatorString[T]) OfLengthBetween(min int, max int, template ...string) *ValidatorString[T] {
validator.context.AddWithParams(
func() bool {
return isStringLengthBetween(validator.context.Value().(T), min, max)
},
ErrorKeyLengthBetween,
map[string]any{"title": validator.context.title, "min": min, "max": max},
template...)
return validator
}
// Validate if the value of a string is within a range (inclusive).
// For example:
//
// slug := "ab"
// Is(v.String(slug).Between("ab","ac"))
func (validator *ValidatorString[T]) Between(min T, max T, template ...string) *ValidatorString[T] {
validator.context.AddWithParams(
func() bool {
return isStringBetween(validator.context.Value().(T), min, max)
},
ErrorKeyBetween,
map[string]any{"title": validator.context.title, "min": min, "max": max},
template...)
return validator
}