Files
gf/util/gvalid/internal/builtin/builtin_enums.go

84 lines
1.9 KiB
Go

// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package builtin
import (
"errors"
"fmt"
"reflect"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/internal/json"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/v2/util/gconv"
"github.com/gogf/gf/v2/util/gtag"
)
// RuleEnums implements `enums` rule:
// Value should be in enums of its constant type.
//
// Format: enums
type RuleEnums struct{}
func init() {
Register(RuleEnums{})
}
func (r RuleEnums) Name() string {
return "enums"
}
func (r RuleEnums) Message() string {
return "The {field} value `{value}` should be in enums of: {enums}"
}
func (r RuleEnums) Run(in RunInput) error {
if in.ValueType == nil {
return gerror.NewCode(
gcode.CodeInvalidParameter,
`value type cannot be empty to use validation rule "enums"`,
)
}
var (
pkgPath = in.ValueType.PkgPath()
typeName = in.ValueType.Name()
)
if in.ValueType.Kind() == reflect.Slice {
pkgPath = in.ValueType.Elem().PkgPath()
typeName = in.ValueType.Elem().Name()
}
if pkgPath == "" {
return gerror.NewCodef(
gcode.CodeInvalidOperation,
`no pkg path found for type "%s"`,
in.ValueType.String(),
)
}
var (
typeId = fmt.Sprintf(`%s.%s`, pkgPath, typeName)
tagEnums = gtag.GetEnumsByType(typeId)
)
if tagEnums == "" {
return gerror.NewCodef(
gcode.CodeInvalidOperation,
`no enums found for type "%s", missing using command "gf gen enums"?`,
typeId,
)
}
var enumsValues = make([]interface{}, 0)
if err := json.Unmarshal([]byte(tagEnums), &enumsValues); err != nil {
return err
}
if !gstr.InArray(gconv.Strings(enumsValues), in.Value.String()) {
return errors.New(gstr.Replace(
in.Message, `{enums}`, tagEnums,
))
}
return nil
}