refactor: split field label and field name map

Author: inhere

data_source.go

@@ -147,7 +147,7 @@ type ConfigValidationFace interface {
 //
 // 	func (u *User) Translates() map[string]string {
 // 		return MS{
-// 			"Name": "User name",
+// 			"Name": "Username",
 // 		}
 // 	}
 type FieldTranslatorFace interface {
@@ -316,20 +316,16 @@ func (d *StructData) parseRulesFromTag(v *Validation) {
 			if fName == "" && gOpt.FieldTag != "" {
 				fName = fv.Tag.Get(gOpt.FieldTag)
 			}
+
 			// add pre field display name to fName
 			if fName != "" {
 				if preStrName != "" {
 					if preFName, ok := fMap[preStrName]; ok {
 						fName = preFName + "." + fName
 					}
 				}
-				fMap[name] = fName
-			}
 
-			// Load the outgofmt info to output the error message whether to use the native field of GO
-			tagInfo := fv.Tag.Get(gOpt.OutGoFmt)
-			if tagInfo != "" {
-				fMap[gOpt.OutGoFmt] = tagInfo
+				fMap[name] = fName
 			}
 
 			// load custom error messages.

data_source_test.go

@@ -203,24 +203,3 @@ func TestStructData_Create(t *testing.T) {
 	is.True(ok)
 	is.Equal("inhere", str)
 }
-
-
-func TestIssue_103(t *testing.T) {
-	type Example struct {
-		SomeID string `json:"some_id" validate:"required" outgofmt:"1"`
-	}
-	o := Example{}
-	v := Struct(o)
-	v.Validate()
-	m:=v.Errors.All() // here we get something like {"SomeID": { /* ... */ }}
-	assert.Contains(t, m, "SomeID")
-
-	type Example2 struct {
-		SomeID string `json:"some_id" validate:"required" `
-	}
-	e2 := Example2{}
-	v2 := Struct(e2)
-	v2.Validate()
-	err2 :=v2.Errors.String()
-	assert.Contains(t, err2, "some_id")
-}

issues_test.go

@@ -497,6 +497,32 @@ func TestIssue_92(t *testing.T) {
 	assert.True(t, ok)
 }
 
+// https://github.com/gookit/validate/issues/103
+func TestIssue_103(t *testing.T) {
+	type Example struct {
+		SomeID string `validate:"required"`
+	}
+
+	o := Example{}
+	v := validate.Struct(o)
+	v.Validate()
+	// here we get something like {"SomeID": { /* ... */ }}
+	m := v.Errors.All()
+	// dump.Println(m)
+	assert.Contains(t, m, "SomeID")
+
+	type Example2 struct {
+		SomeID string `json:"some_id" validate:"required" `
+	}
+
+	e2 := Example2{}
+	v2 := validate.Struct(e2)
+	v2.Validate()
+	err2 := v2.Errors.String() // here we get something like {"some_id": { /* ... */ }}
+	dump.Println(v2.Errors)
+	assert.Contains(t, err2, "some_id")
+}
+
 type Issue104A struct {
 	ID int `json:"id" gorm:"primarykey" form:"id" validate:"int|required"`
 }

messages.go

@@ -253,10 +253,15 @@ func BuiltinMessages() map[string]string {
 
 // Translator definition
 type Translator struct {
-	// language string TODO
-	// field map {"field name": "display name"}
+	// field name for output as Errors key.
+	// format: {"field": "output name"}
 	fieldMap map[string]string
-	// message data map
+	// the field translate name in message.
+	// format: {"field": "translate name"}
+	labelMap map[string]string
+	// the error message data map.
+	// key allow:
+	// TODO
 	messages map[string]string
 }
 
@@ -275,6 +280,7 @@ func (t *Translator) Reset() {
 	}
 
 	t.messages = newMessages
+	t.labelMap = make(map[string]string)
 	t.fieldMap = make(map[string]string)
 }
 
@@ -283,6 +289,11 @@ func (t *Translator) FieldMap() map[string]string {
 	return t.fieldMap
 }
 
+// LabelMap data get
+func (t *Translator) LabelMap() map[string]string {
+	return t.labelMap
+}
+
 // AddMessages data to translator
 func (t *Translator) AddMessages(data map[string]string) {
 	for n, m := range data {
@@ -292,9 +303,15 @@ func (t *Translator) AddMessages(data map[string]string) {
 
 // AddFieldMap config field data.
 // If you want to display in the field with the original field is not the same
-func (t *Translator) AddFieldMap(fieldMap map[string]string) {
+func (t *Translator) AddFieldMap(labels map[string]string) {
+	t.AddLabelMap(labels)
+}
+
+// AddLabelMap config field translate data map.
+// If you want to display in the field with the original field is not the same
+func (t *Translator) AddLabelMap(fieldMap map[string]string) {
 	for name, showName := range fieldMap {
-		t.fieldMap[name] = showName
+		t.labelMap[name] = showName
 	}
 }
 
@@ -303,12 +320,26 @@ func (t *Translator) AddMessage(key, msg string) {
 	t.messages[key] = msg
 }
 
-// HasField name in the t.fieldMap
+// HasField name in the t.labelMap.
+// Deprecated
 func (t *Translator) HasField(field string) bool {
-	_, ok := t.fieldMap[field]
+	return t.HasLabel(field)
+}
+
+// HasLabel name in the t.labelMap
+func (t *Translator) HasLabel(field string) bool {
+	_, ok := t.labelMap[field]
 	return ok
 }
 
+// LabelName get in the t.labelMap
+func (t *Translator) LabelName(field string) string {
+	if label, ok := t.labelMap[field]; ok {
+		field = label
+	}
+	return field
+}
+
 // FieldName get in the t.fieldMap
 func (t *Translator) FieldName(field string) string {
 	if trName, ok := t.fieldMap[field]; ok {
@@ -335,7 +366,7 @@ func (t *Translator) Message(validator, field string, args ...interface{}) (msg
 
 		// not found, fallback - use default error message
 		if errMsg == "" {
-			return t.FieldName(field) + defaultErrMsg
+			return t.LabelName(field) + defaultErrMsg
 		}
 	}
 
@@ -349,7 +380,7 @@ func (t *Translator) format(errMsg, field string, args []interface{}) string {
 	// fix: #111 argN maybe is a field name
 	for i, arg := range args {
 		if name, ok := arg.(string); ok {
-			if trName, ok := t.fieldMap[name]; ok {
+			if trName, ok := t.labelMap[name]; ok {
 				args[i] = trName
 			}
 		}
@@ -365,10 +396,8 @@ func (t *Translator) format(errMsg, field string, args []interface{}) string {
 	}
 
 	// get field display name.
-	if _, ok := t.fieldMap[outgofmt]; !ok {
-		if trName, ok := t.fieldMap[field]; ok {
-			field = trName
-		}
+	if trName, ok := t.labelMap[field]; ok {
+		field = trName
 	}
 
 	if argLen > 0 {

messages_test.go

@@ -52,6 +52,7 @@ func TestTranslatorBasic(t *testing.T) {
 
 	assert.True(t, tr.HasMessage("min"))
 	assert.False(t, tr.HasMessage("not-exists"))
+	assert.False(t, tr.HasLabel("FIELD1"))
 	assert.False(t, tr.HasField("FIELD1"))
 
 	tr.AddMessage("FIELD1.min", "{field} message1")

validate.go

@@ -53,9 +53,11 @@ type GlobalOption struct {
 	FilterTag string
 	// ValidateTag in the struct tags.
 	ValidateTag string
-	// FieldTag name in the struct tags. for define field translate. default: json
+	// FieldTag name in the struct tags.
+	// use for define output field name/translate fallback. default: json
 	FieldTag string
-	// LabelTag display name in the struct tags. for define field translate. default: label
+	// LabelTag display name in the struct tags.
+	// use for define field translate. default: label
 	LabelTag string
 	// MessageTag define error message for the field.
 	MessageTag string
@@ -69,8 +71,12 @@ type GlobalOption struct {
 	CheckDefault bool
 	// CheckZero Whether validate the default zero value. (intX,uintX: 0, string: "")
 	CheckZero bool
-	// OutGoFmt Whether to output the native fields of go.
-	OutGoFmt string
+	// ErrKeyFmt
+	//
+	// allow:
+	// - 0 use struct field name as key. (for compatible)
+	// - 1 use FieldTag defined name as key.
+	ErrKeyFmt int8
 }
 
 // global options
@@ -104,7 +110,6 @@ func newGlobalOption() *GlobalOption {
 		MessageTag: messageTag,
 		// tag name in struct tags
 		ValidateTag: validateTag,
-		OutGoFmt:    outgofmt,
 	}
 }
 

validation.go

@@ -17,7 +17,6 @@ const (
 	filterError   = "_filter"
 	validateError = "_validate"
 
-	outgofmt = "outgofmt"
 	// sniff Length, use for detect file mime type
 	sniffLen = 512
 	// 32 MB
@@ -332,6 +331,7 @@ func (v *Validation) AddError(field, validator, msg string) {
 		v.hasError = true
 	}
 
+	field = v.trans.FieldName(field)
 	v.Errors.Add(field, validator, msg)
 }
 

validation_test.go

@@ -190,7 +190,7 @@ func (f UserForm) Messages() map[string]string {
 	}
 }
 
-// Translates you can custom field translates.
+// Translates you can be custom field translates.
 func (f UserForm) Translates() map[string]string {
 	return MS{
 		"Name":  "User Name",
@@ -207,12 +207,15 @@ func TestStruct(t *testing.T) {
 
 	// check trans data
 	is.True(v.Trans().HasField("Name"))
-	is.True(v.Trans().HasField("Safe"))
+	is.True(v.Trans().HasLabel("Safe"))
 	is.True(v.Trans().HasMessage("Name.required"))
+
 	// test trans
 	v.Trans().AddMessage("custom", "message0")
 	is.True(v.Trans().HasMessage("custom"))
 	is.Contains(v.Trans().FieldMap(), "Name")
+	is.Contains(v.Trans().LabelMap(), "Name")
+	is.Equal("Name", v.Trans().LabelName("Name"))
 
 	// validate
 	v.StopOnError = false