update readme. some bug fixed

Author: inhere

README.md

@@ -9,7 +9,7 @@ The package is a generic Go data validate library.
 
 > **[中文说明](README_cn.md)**
 
-- Support validate Map, Struct, Request(Form, JSON, url.Values) data
+- Support validate Map, Struct, Request(Form, JSON, url.Values, UploadedFile) data
 - Support filter/sanitize data before validate
 - Support add custom filter/validator func
 - Support scene settings, verify different fields in different scenes
@@ -285,15 +285,15 @@ validator/aliases | description
 `dnsName/DNSName/isDNSName` | Check value is DNSName string.
 `dataURI/isDataURI` | Check value is DataURI string.
 `empty/isEmpty` | Check value is Empty string.
-`hexColor/isHexColor` | Check value is HexColor string.
+`hexColor/isHexColor` | Check value is Hex color string.
 `hexadecimal/isHexadecimal` | Check value is Hexadecimal string.
 `json/JSON/isJSON` | Check value is JSON string.
 `lat/latitude/isLatitude` | Check value is Latitude string.
 `lon/longitude/isLongitude` | Check value is Longitude string.
 `mac/isMAC` | Check value is MAC string.
 `num/number/isNumber` | Check value is number string. `>= 0`
 `printableASCII/isPrintableASCII` | Check value is PrintableASCII string.
-`rgbColor/RGBColor/isRGBColor` | Check value is RGBColor string.
+`rgbColor/RGBColor/isRGBColor` | Check value is RGB color string.
 `url/isURL` | Check value is URL string.
 `ip/isIP`  |  Check value is IP(v4 or v6) string.
 `ipv4/isIPv4`  |  Check value is IPv4 string.

README_cn.md

@@ -7,13 +7,15 @@
 
 Go通用的数据验证与过滤库，使用简单，内置大部分常用验证器、过滤器，支持自定义消息、字段翻译。
 
-- 支持验证Map，Struct，Request（Form，JSON，url.Values）数据
+> **[EN README](README.md)**
+
+- 支持验证Map，Struct，Request（Form，JSON，url.Values, UploadedFile）数据
 - 简单方便，支持前置验证检查, 支持添加自定义验证器
 - 支持将规则按场景进行分组设置。不同场景验证不同的字段
-- 支持自定义每个验证的错误消息，字段翻译，消息翻译(内置`en` `zh-CN`)
 - 支持在进行验证前对值使用过滤器进行净化过滤，查看 [内置过滤器](#built-in-filters)
-- 方便的获取错误信息，验证后的安全数据获取(只会收集有规则检查过的数据)
 - 已经内置了超多（> 60 个）常用的验证器，查看 [内置验证器](#built-in-validators)
+- 方便的获取错误信息，验证后的安全数据获取(只会收集有规则检查过的数据)
+- 支持自定义每个验证的错误消息，字段翻译，消息翻译(内置`en` `zh-CN`)
 - 完善的单元测试，覆盖率 > 85%
 
 > 受到这些项目的启发 [albrow/forms](https://github.com/albrow/forms) 和 [asaskevich/govalidator](https://github.com/asaskevich/govalidator). 非常感谢它们
@@ -270,58 +272,57 @@ v := d.Validation()
 `range/between`  |  检查值是否为数字且在给定范围内
 `max/lte`  |  检查输入值小于或等于给定值
 `min/gte`  |  检查输入值大于或等于给定值(for `intX` `uintX` `floatX`)
-`intStr/intString/isIntString`  |  Check value is an int string.
 `eq/equal/isEqual`  |  检查输入值是否等于给定值
 `ne/notEq/notEqual`  |  检查输入值是否不等于给定值
-`lt/lessThan`  |  Check value is less than the given size(use for `intX` `uintX` `floatX`)
-`gt/greaterThan`  |  Check value is greater than the given size(use for `intX` `uintX` `floatX`)
-`email/isEmail`  |   Check value is email address string.
-`intEq/intEqual`  |  Check value is int and equals to the given value.
-`len/length`  |  Check value length is equals to the given size(use for `string` `array` `slice` `map`).
-`regex/regexp`  |  Check if the value can pass the regular verification
-`arr/array/isArray`  |   Check value is array type
-`map/isMap`  |  Check value is a MAP type
-`strings/isStrings`  |  Check value is string slice type(only allow `[]string`).
-`ints/isInts`  |  Check value is int slice type(only allow `[]int`).
-`minLen/minLength`  |  Check the minimum length of the value is the given size
-`maxLen/maxLength`  |  Check the maximum length of the value is the given size
-`eqField`  |  Check that the field value is equals to the value of another field
-`neField`  |  Check that the field value is not equals to the value of another field
-`gteField`  |  Check that the field value is greater than or equal to the value of another field
-`gtField`  |  Check that the field value is greater than the value of another field
-`lteField`  |  Check if the field value is less than or equal to the value of another field
-`ltField`  |  Check that the field value is less than the value of another field
+`lt/lessThan`  |  检查值小于给定大小(use for `intX` `uintX` `floatX`)
+`gt/greaterThan`  |  检查值大于给定大小(use for `intX` `uintX` `floatX`)
+`intEq/intEqual`  |  检查值为int且等于给定值
+`len/length`  |  检查值长度等于给定大小(use for `string` `array` `slice` `map`).
+`minLen/minLength`  |  检查值的最小长度是给定大小
+`maxLen/maxLength`  |  检查值的最大长度是给定大小
+`email/isEmail`  |   检查值是Email地址字符串
+`regex/regexp`  |  检查该值是否可以通过正则验证
+`arr/array/isArray`  |  检查值是数组`array`类型
+`map/isMap`  |  检查值是MAP类型
+`strings/isStrings`  |  检查值是字符串切片类型(`[]string`).
+`ints/isInts`  |  检查值是int slice类型(only allow `[]int`).
+`eqField`  |  检查字段值是否等于另一个字段的值
+`neField`  |  检查字段值是否不等于另一个字段的值
+`gtField`  |  检查字段值是否大于另一个字段的值
+`gteField`  | 检查字段值是否大于或等于另一个字段的值
+`ltField`  |  检查字段值是否小于另一个字段的值
+`lteField`  |  检查字段值是否小于或等于另一个字段的值
 `file/isFile`  |  验证是否是上传的文件
 `image/isImage`  |  验证是否是上传的图片文件，支持后缀检查
 `mime/mimeType/inMimeTypes`  |  验证是否是上传的文件，并且在指定的MIME类型中
-`date/isDate` | Check the field value is date string. eg `2018-10-25`
-`gtDate/afterDate` | Check that the input value is greater than the given date string.
-`ltDate/beforeDate` | Check that the input value is less than the given date string
-`gteDate/afterOrEqualDate` | Check that the input value is greater than or equal to the given date string.
-`lteDate/beforeOrEqualDate` | Check that the input value is less than or equal to the given date string.
-`hasWhitespace` | Check value string has Whitespace.
-`ascii/ASCII/isASCII` | Check value is ASCII string.
+`date/isDate` | 检查字段值是否为日期字符串。（只支持几种常用的格式） eg `2018-10-25`
+`gtDate/afterDate` | 检查输入值是否大于给定的日期字符串
+`ltDate/beforeDate` | 检查输入值是否小于给定的日期字符串
+`gteDate/afterOrEqualDate` | 检查输入值是否大于或等于给定的日期字符串
+`lteDate/beforeOrEqualDate` | 检查输入值是否小于或等于给定的日期字符串
+`hasWhitespace` | 检查字符串值是否有空格
+`ascii/ASCII/isASCII` | 检查值是ASCII字符串
 `alpha/isAlpha` | 验证值是否仅包含字母字符
 `alphaNum/isAlphaNum` | 验证是否仅包含字母、数字
 `alphaDash/isAlphaDash` | 验证是否仅包含字母、数字、破折号（ - ）以及下划线（ _ ）
 `multiByte/isMultiByte` | Check value is MultiByte string.
-`base64/isBase64` | Check value is Base64 string.
-`dnsName/DNSName/isDNSName` | Check value is DNSName string.
+`base64/isBase64` | 检查值是Base64字符串
+`dnsName/DNSName/isDNSName` | 检查值是DNS名称字符串
 `dataURI/isDataURI` | Check value is DataURI string.
 `empty/isEmpty` | Check value is Empty string.
-`hexColor/isHexColor` | Check value is HexColor string.
-`hexadecimal/isHexadecimal` | Check value is Hexadecimal string.
-`json/JSON/isJSON` | Check value is JSON string.
-`lat/latitude/isLatitude` | Check value is Latitude string.
-`lon/longitude/isLongitude` | Check value is Longitude string.
-`mac/isMAC` | Check value is MAC string.
-`num/number/isNumber` | Check value is number string. `>= 0`
+`hexColor/isHexColor` | 检查值是16进制的颜色字符串
+`hexadecimal/isHexadecimal` | 检查值是十六进制字符串
+`json/JSON/isJSON` | 检查值是JSON字符串。
+`lat/latitude/isLatitude` | 检查值是纬度坐标
+`lon/longitude/isLongitude` | 检查值是经度坐标
+`mac/isMAC` | 检查值是MAC字符串
+`num/number/isNumber` | 检查值是数字字符串. `>= 0`
 `printableASCII/isPrintableASCII` | Check value is PrintableASCII string.
-`rgbColor/RGBColor/isRGBColor` | Check value is RGBColor string.
-`url/isURL` | Check value is URL string.
-`ip/isIP`  |  Check value is IP(v4 or v6) string.
-`ipv4/isIPv4`  |  Check value is IPv4 string.
-`ipv6/isIPv6`  |  Check value is IPv6 string.
+`rgbColor/RGBColor/isRGBColor` | 检查值是RGB颜色字符串
+`url/isURL` | 检查值是URL字符串
+`ip/isIP`  |  检查值是IP（v4或v6）字符串
+`ipv4/isIPv4`  |  检查值是IPv4字符串
+`ipv6/isIPv6`  |  检查值是IPv6字符串
 `CIDR/isCIDR` | Check value is CIDR string.
 `CIDRv4/isCIDRv4` | Check value is CIDRv4 string.
 `CIDRv6/isCIDRv6` | Check value is CIDRv6 string.

data_source.go

@@ -414,10 +414,16 @@ func (d *FormData) Set(field string, val interface{}) error {
 
 // Get value by key
 func (d FormData) Get(key string) (interface{}, bool) {
+	// get form value
 	if vs, ok := d.Form[key]; ok && len(vs) > 0 {
 		return vs[0], true
 	}
 
+	// get uploaded file
+	if fh, ok := d.Files[key]; ok {
+		return fh, true
+	}
+
 	return nil, false
 }
 

generic_test.go

@@ -25,6 +25,8 @@ func TestValueLen(t *testing.T) {
 	for _, sample := range tests {
 		is.Equal(3, ValueLen(reflect.ValueOf(sample)))
 	}
+
+	is.Equal(-1, ValueLen(reflect.ValueOf(nil)))
 }
 
 func TestCallByValue(t *testing.T) {
@@ -296,12 +298,13 @@ func TestRule(t *testing.T) {
 	v.AddRule("key0", "inRule").SetCheckFunc(func(s string) bool {
 		return s == "val0"
 	})
+	v.AddRule("name", "gtField", "key0")
 
 	// validate. will skip validate field "name"
 	v.Validate()
 	is.True(v.IsOK())
 	is.Equal("val0", v.SafeVal("key0"))
-	is.Equal(nil, v.SafeVal("name"))
+	is.Equal(nil, v.SafeVal("not-exist"))
 
 	// validate on "test". will validate field "name"
 	v.ResetResult()

helper.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"github.com/gookit/filter"
 	"reflect"
-	"runtime"
 	"strconv"
 	"strings"
 	"unicode"
@@ -135,7 +134,7 @@ func CalcLength(val interface{}) int {
 }
 
 // value compare. use for compare int, string.
-func valueCompare(srcVal, dstVal interface{}, op string) bool {
+func valueCompare(srcVal, dstVal interface{}, op string) (ok bool) {
 	var err error
 	var srcInt, dstInt int64
 
@@ -162,21 +161,21 @@ func valueCompare(srcVal, dstVal interface{}, op string) bool {
 
 	switch op {
 	case "lt":
-		return srcInt < dstInt
+		ok = srcInt < dstInt
 	case "lte":
-		return srcInt <= dstInt
+		ok = srcInt <= dstInt
 	case "gt":
-		return srcInt > dstInt
+		ok = srcInt > dstInt
 	case "gte":
-		return srcInt >= dstInt
+		ok = srcInt >= dstInt
 	}
 
-	return false
+	return
 }
 
-func nameOfFunc(fv reflect.Value) string {
-	return runtime.FuncForPC(fv.Pointer()).Name()
-}
+// func nameOfFunc(fv reflect.Value) string {
+// 	return runtime.FuncForPC(fv.Pointer()).Name()
+// }
 
 func parseArgString(argStr string) (ss []string) {
 	if argStr == "" { // no arg

validate.go

@@ -37,6 +37,8 @@ type Rule struct {
 	fields []string
 	// is optional, only validate on value is not empty. sometimes
 	optional bool
+	// skip validate not exist field/empty value
+	skipEmpty bool
 	// default value setting
 	defValue interface{}
 	// error message
@@ -76,6 +78,16 @@ func (r *Rule) SetScene(scene string) *Rule {
 	return r
 }
 
+// SetOptional only validate on value is not empty.
+func (r *Rule) SetOptional(optional bool) {
+	r.optional = optional
+}
+
+// SetSkipEmpty skip validate not exist field/empty value
+func (r *Rule) SetSkipEmpty(skipEmpty bool) {
+	r.skipEmpty = skipEmpty
+}
+
 // SetCheckFunc set custom validate func.
 func (r *Rule) SetCheckFunc(checkFunc interface{}) *Rule {
 	var name string
@@ -101,11 +113,6 @@ func (r *Rule) SetBeforeFunc(fn func(field string, v *Validation) bool) {
 	r.beforeFunc = fn
 }
 
-// SetOptional only validate on value is not empty.
-func (r *Rule) SetOptional(optional bool) {
-	r.optional = optional
-}
-
 // SetMessage set error message.
 // Usage:
 // 	v.AddRule("name", "required").SetMessage("error message")
@@ -161,7 +168,6 @@ func (r *Rule) Apply(v *Validation) (stop bool) {
 			continue
 		}
 
-		// field value check:
 		// get field value.
 		val, exist := v.Get(field)
 		if !exist && r.optional { // not exist AND r.optional=true. skip check.
@@ -194,6 +200,45 @@ func (r *Rule) Apply(v *Validation) (stop bool) {
 	return false
 }
 
+func (r *Rule) fileValidate(field, name string, v *Validation) (ok bool) {
+	// beforeFunc return false, skip validate
+	if r.beforeFunc != nil && !r.beforeFunc(field, v) {
+		return false
+	}
+
+	fd, ok := v.data.(*FormData)
+	if !ok {
+		return
+	}
+
+	// skip on empty AND field not exist
+	if v.SkipOnEmpty && !fd.HasFile(field) {
+		return true
+	}
+
+	var ss []string
+	for _, item := range r.arguments {
+		ss = append(ss, item.(string))
+	}
+
+	switch name {
+	case "isFile":
+		ok = v.IsFile(fd, field)
+	case "isImage":
+		ok = v.IsImage(fd, field, ss...)
+	case "inMimeTypes":
+		if ln := len(ss); ln == 0 {
+			return false
+		} else if ln == 1 {
+			ok = v.InMimeTypes(fd, field, ss[0])
+		} else {
+			ok = v.InMimeTypes(fd, field, ss[0], ss[1:]...)
+		}
+	}
+
+	return
+}
+
 // validate the field value
 func (r *Rule) valueValidate(field, name string, val interface{}, v *Validation) (ok bool) {
 	// "-" OR "safe" mark field value always is safe.
@@ -251,45 +296,6 @@ func (r *Rule) valueValidate(field, name string, val interface{}, v *Validation)
 	return
 }
 
-func (r *Rule) fileValidate(field, name string, v *Validation) (ok bool) {
-	// beforeFunc return false, skip validate
-	if r.beforeFunc != nil && !r.beforeFunc(field, v) {
-		return false
-	}
-
-	fd, ok := v.data.(*FormData)
-	if !ok {
-		return
-	}
-
-	// skip on empty AND field not exist
-	if v.SkipOnEmpty && !fd.HasFile(field) {
-		return true
-	}
-
-	var ss []string
-	for _, item := range r.arguments {
-		ss = append(ss, item.(string))
-	}
-
-	switch name {
-	case "isFile":
-		ok = v.IsFile(fd, field)
-	case "isImage":
-		ok = v.IsImage(fd, field, ss...)
-	case "inMimeTypes":
-		if ln := len(ss); ln == 0 {
-			return false
-		} else if ln == 1 {
-			ok = v.InMimeTypes(fd, field, ss[0])
-		} else {
-			ok = v.InMimeTypes(fd, field, ss[0], ss[1:]...)
-		}
-	}
-
-	return
-}
-
 func (r *Rule) errorMessage(field, validator string, v *Validation) (msg string) {
 	if r.messages != nil {
 		var ok bool

validation_test.go

@@ -29,6 +29,7 @@ var mpSample = M{
 	"oldSt": 1,
 	"newSt": 2,
 	"email": "[email protected]",
+	"items": []string{"a"},
 }
 
 func TestMap(t *testing.T) {
@@ -114,6 +115,10 @@ func TestErrorMessages(t *testing.T) {
 	is.False(v.Validate())
 	is.Equal("oldSt's err msg", v.Errors.Get("oldSt"))
 	is.Equal("newSt's err msg", v.Errors.Get("newSt"))
+
+	is.False(v.GtField([]int{2}, "age"))
+	is.False(v.GtField(2, "items"))
+	is.False(v.GtField("a", "items"))
 }
 
 // UserForm struct
@@ -256,6 +261,9 @@ func TestFromQuery(t *testing.T) {
 		"age":  "required|int|min:10",
 	})
 
+	val, ok := v.Raw("name")
+	is.True(ok)
+	is.Equal("inhere", val)
 	is.False(v.Validate())
 	is.Equal("name min length is 7", v.Errors.Field("name")[0])
 	is.Empty(v.SafeData())