-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(validator): create ForMap, ForStruct, ForSlice, ForValue validat…
…ors and respective ...WithContext alternatives
- Loading branch information
1 parent
c56de7a
commit 6ea8c08
Showing
43 changed files
with
3,084 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
indent_style = space | ||
indent_size = 4 | ||
trim_trailing_whitespace = true | ||
|
||
[*.go] | ||
indent_style = tab | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
### Go template | ||
# Binaries for programs and plugins | ||
*.exe | ||
*.exe~ | ||
*.dll | ||
*.so | ||
*.dylib | ||
|
||
# Test binary, built with `go test -c` | ||
*.test | ||
|
||
# Output of the go coverage tool, specifically when used with LiteIDE | ||
*.out | ||
|
||
# Dependency directories (remove the comment below to include it) | ||
# vendor/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,207 @@ | ||
# Go Validator | ||
A Laravel-like data validator for Go. | ||
|
||
[](https://github.com/donatorsky/go-validator/blob/main/LICENSE) | ||
[](https://github.com/donatorsky/go-validator/actions?query=branch%3Amain) | ||
|
||
## Installation | ||
|
||
```shell | ||
go get github.com/donatorsky/go-validator | ||
``` | ||
|
||
The library is still a work in progress. More details soon. | ||
|
||
## Example | ||
|
||
```go | ||
package main | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"fmt" | ||
"time" | ||
|
||
"github.com/donatorsky/go-validator" | ||
"github.com/donatorsky/go-validator/rule" | ||
) | ||
|
||
func main() { | ||
var ( | ||
mapData = map[string]any{ | ||
"int": int(125), | ||
"*int": ptr(int(124)), | ||
"**int": ptr(ptr(int(124))), | ||
"string": "Lorem ipsum", | ||
"boolean": true, | ||
"skip": "123", | ||
"date_string": "2023-03-31", | ||
"array": []any{"Foo", nil, "Bar", "Baz", 123}, | ||
"child": map[string]any{ | ||
"id": 123, | ||
"ancestor": map[string]int{ | ||
"id": 456, | ||
}, | ||
}, | ||
"children": []map[string]any{ | ||
{"id": 123}, | ||
{"id": 456}, | ||
{"id": 789}, | ||
}, | ||
"object": data{ | ||
ID: -1, | ||
Name: "value: Name", | ||
Enabled: true, | ||
Skip: "value: Skip", | ||
NoName: "value: NoName", | ||
}, | ||
} | ||
|
||
intRules = []rule.Rule{ | ||
rule.When(true, | ||
rule.When(true, | ||
rule.Min(101), | ||
//rule.Bail(), | ||
), | ||
rule.Min(150), | ||
//rule.Bail(), | ||
), | ||
rule.Required(), | ||
rule.Integer[int](), | ||
//rule.Bail(), | ||
rule.Min(1240), | ||
rule.Min(float32(125.01)), | ||
rule.Min(float64(125.01)), | ||
rule.When(true, | ||
rule.Min(102), | ||
//rule.Bail(), | ||
rule.When(true, | ||
rule.Min(103), | ||
//rule.Bail(), | ||
), | ||
), | ||
rule.WhenFunc( | ||
func(_ context.Context, value int, _ any) bool { | ||
time.Sleep(time.Millisecond * 100) | ||
|
||
return value%2 == 0 | ||
}, | ||
rule.Min(200), | ||
//rule.Bail(), | ||
rule.When(true, | ||
rule.When(true, | ||
rule.Min(300), | ||
//rule.Bail(), | ||
), | ||
rule.Max(90), | ||
//rule.Bail(), | ||
), | ||
rule.Max(100), | ||
), | ||
rule.Min(400), | ||
rule.Custom(func(_ context.Context, value int, _ any) (int, error) { | ||
switch value % 3 { | ||
case 0: | ||
return value + 1, nil | ||
|
||
case 1: | ||
return value - 1, nil | ||
|
||
default: | ||
return value, errors.New("nie dzielimy przez 3") | ||
} | ||
}), | ||
} | ||
|
||
allRules = RulesMap{ | ||
"int": intRules, | ||
"*int": intRules, | ||
"**int": intRules, | ||
|
||
"child.id": { | ||
rule.Required(), | ||
rule.Integer[int](), | ||
rule.Float[float32](), | ||
//rule.Min(150), | ||
}, | ||
|
||
"child.ancestor.id": { | ||
rule.Required(), | ||
rule.Integer[int](), | ||
rule.Min(500), | ||
}, | ||
|
||
"array.*": { | ||
rule.Required(), | ||
rule.String(), | ||
rule.In([]string{"Foo", "foo"}), | ||
}, | ||
} | ||
) | ||
|
||
fmt.Println("ForMapWithContext") | ||
forMapErrorsBag := validator.ForMapWithContext(context.Background(), mapData, allRules) | ||
fmt.Println(forMapErrorsBag) | ||
|
||
fmt.Println("\nForStruct") | ||
forStructErrorsBag := validator.ForStructWithContext(context.Background(), ptr(data{}), allRules) | ||
fmt.Println(forStructErrorsBag) | ||
|
||
fmt.Println("\nForSlice") | ||
forSliceErrorsBag := validator.ForSliceWithContext(context.Background(), ptr([]int{1, 2, 3}), | ||
rule.Min(150), | ||
) | ||
fmt.Println(forSliceErrorsBag) | ||
|
||
fmt.Println("\nForValue (simple)") | ||
forValueErrors := validator.ForValueWithContext(context.Background(), ptr(ptr(6)), | ||
rule.Required(), | ||
rule.Min(150), | ||
) | ||
fmt.Println(forValueErrors) | ||
} | ||
|
||
type data struct { | ||
ID int `json:"id" validation:"id"` | ||
Name string `json:"name" validation:"name"` | ||
Enabled bool `json:"enabled" validation:"enabled"` | ||
Skip string `json:"-" validation:"-"` | ||
NoName string `json:"-"` | ||
} | ||
|
||
func ptr[T any](v T) *T { | ||
return &v | ||
} | ||
``` | ||
|
||
Produces: | ||
```text | ||
ForMapWithContext | ||
8 field(s) failed: | ||
**int: [9][minRule{Threshold=150} minRule{Threshold=1240} minRule{Threshold=125.01} minRule{Threshold=125.01} minRule{Threshold=200} minRule{Threshold=300} maxRule{Threshold=90} maxRule{Threshold=100} minRule{Threshold=400}] | ||
child.id: [2][minRule{Threshold=500} floatRule{ExpectedType="float32", ActualType="int"}] | ||
array.1: [1][requiredRule{}] | ||
array.2: [1][inRule{Values=[Foo foo]}] | ||
array.3: [1][inRule{Values=[Foo foo]}] | ||
array.4: [2][stringRule{} inRule{Values=[Foo foo]}] | ||
int: [6][minRule{Threshold=150} minRule{Threshold=1240} minRule{Threshold=125.01} minRule{Threshold=125.01} minRule{Threshold=400} customRule{Err="nie dzielimy przez 3"}] | ||
*int: [9][minRule{Threshold=150} minRule{Threshold=1240} minRule{Threshold=125.01} minRule{Threshold=125.01} minRule{Threshold=200} minRule{Threshold=300} maxRule{Threshold=90} maxRule{Threshold=100} minRule{Threshold=400}] | ||
ForStructWithContext | ||
5 field(s) failed: | ||
**int: [1][requiredRule{}] | ||
child.id: [2][requiredRule{} requiredRule{}] | ||
array.*: [1][requiredRule{}] | ||
int: [1][requiredRule{}] | ||
*int: [1][requiredRule{}] | ||
ForSliceWithContext | ||
3 field(s) failed: | ||
0: [1][minRule{Threshold=150}] | ||
1: [1][minRule{Threshold=150}] | ||
2: [1][minRule{Threshold=150}] | ||
ForValueWithContext (simple) | ||
[minRule{Threshold=150}] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
package error | ||
|
||
import "fmt" | ||
|
||
func NewErrorsBag() ErrorsBag { | ||
return make(ErrorsBag) | ||
} | ||
|
||
type ErrorsBag map[string][]ValidationError | ||
|
||
func (b ErrorsBag) Add(field string, message ValidationError) { | ||
if _, exists := b[field]; !exists { | ||
b[field] = []ValidationError{message} | ||
} else { | ||
b[field] = append(b[field], message) | ||
} | ||
} | ||
|
||
func (b ErrorsBag) Any() bool { | ||
return len(b) > 0 | ||
} | ||
|
||
func (b ErrorsBag) All() map[string][]ValidationError { | ||
return b | ||
} | ||
|
||
func (b ErrorsBag) Get(field string) []ValidationError { | ||
if errors, exists := b[field]; exists { | ||
return errors | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func (b ErrorsBag) Error() string { | ||
message := fmt.Sprintf("%d field(s) failed:", len(b)) | ||
|
||
for field, errors := range b { | ||
message += fmt.Sprintf("\n%s: [%d]%s", field, len(errors), errors) | ||
} | ||
|
||
return message | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
package error | ||
|
||
const ( | ||
TypeAfter = "AFTER" | ||
TypeAfterOrEqual = "AFTER_OR_EQUAL" | ||
TypeBefore = "BEFORE" | ||
TypeBeforeOrEqual = "BEFORE_OR_EQUAL" | ||
TypeBoolean = "BOOLEAN" | ||
TypeCustom = "CUSTOM" | ||
TypeDateFormat = "DATE_FORMAT" | ||
TypeDuration = "DURATION" | ||
TypeEmail = "EMAIL" | ||
TypeIn = "IN" | ||
TypeInt = "INT" | ||
TypeLength = "LENGTH" | ||
TypeMax = "MAX" | ||
TypeMin = "MIN" | ||
TypeRequired = "REQUIRED" | ||
TypeSlice = "ARRAY" | ||
TypeSliceOf = "ARRAY_OF" | ||
TypeString = "STRING" | ||
) | ||
|
||
const ( | ||
SubtypeNumber = "NUMBER" | ||
SubtypeString = "STRING" | ||
SubtypeSlice = "ARRAY" | ||
SubtypeMap = "MAP" | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
package error | ||
|
||
type ValidationError interface { | ||
GetRule() string | ||
Error() string | ||
} | ||
|
||
type BasicValidationError struct { | ||
Rule string `json:"rule"` | ||
} | ||
|
||
func (e BasicValidationError) GetRule() string { | ||
return e.Rule | ||
} | ||
|
||
type CompositeValidationError struct { | ||
errors []ValidationError | ||
} | ||
|
||
func (e CompositeValidationError) GetRule() string { | ||
return "" | ||
} | ||
|
||
func (e CompositeValidationError) Error() string { | ||
return "" | ||
} | ||
|
||
func (e *CompositeValidationError) Add(error ValidationError) { | ||
e.errors = append(e.errors, error) | ||
} | ||
|
||
func (e *CompositeValidationError) Errors() []ValidationError { | ||
return e.errors | ||
} | ||
|
||
func (e *CompositeValidationError) Empty() bool { | ||
return len(e.errors) == 0 | ||
} |
Oops, something went wrong.