noth/surrealpatch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add functionality to database defined fields

Browse source
This commit is contained in:
Tobie Morgan Hitchcock 2016-07-21 22:48:32 +01:00
parent 8431079025
commit 4af24a5ca0
7 changed files with 512 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
db/define.go
View file

@ -63,13 +63,16 @@ func executeDefineFieldStatement(ast *sql.DefineFieldStatement) (out []interface
doc := data.New()
doc.Set(ast.Name, "name")
doc.Set(ast.Type, "type")
doc.Set(ast.Enum, "enum")
doc.Set(ast.Code, "code")
doc.Set(ast.Min, "min")
doc.Set(ast.Max, "max")
doc.Set(ast.Match, "match")
doc.Set(ast.Default, "default")
doc.Set(ast.Notnull, "notnull")
doc.Set(ast.Readonly, "readonly")
doc.Set(ast.Mandatory, "mandatory")
doc.Set(ast.Validate, "validate")
for _, TB := range ast.What {

16
sql/ast.go
View file

@ -182,8 +182,8 @@ type RemoveTableStatement struct {
// DefineFieldStatement represents an SQL DEFINE INDEX statement.
//
// DEFINE FIELD name ON person TYPE string CODE {}
// DEFINE FIELD name ON person TYPE [0,1,2,3,4,5] DEFAULT 0
// DEFINE FIELD name ON person TYPE [0...100]number MIN 0 MAX 3 DEFAULT 0
// DEFINE FIELD name ON person TYPE number MIN 0 MAX 5 DEFAULT 0
// DEFINE FIELD name ON person TYPE custom ENUM [0,1,2,3,4,5] DEFAULT 0
type DefineFieldStatement struct {
EX bool // Explain
KV string // Bucket
@ -191,15 +191,17 @@ type DefineFieldStatement struct {
DB string // Database
Name Ident // Field name
What []Table // Table names
Type Expr // Field type
Type Ident // Field type
Enum []interface{} // Custom options
Code string // Field code
Min float64 // Minimum value / length
Max float64 // Maximum value / length
Default Expr // Default value
Notnull bool // Notnull?
Readonly bool // Readonly?
Mandatory bool // Mnadatory?
Match string // Regex value
Default interface{} // Default value
Notnull bool // Notnull - can not be NULL?
Readonly bool // Readonly - can not be changed?
Mandatory bool // Mandatory - can not be VOID?
Validate bool // Validate - can not be INCORRECT?
}
// RemoveFieldStatement represents an SQL REMOVE INDEX statement.

14
sql/exprs.go
View file

@ -15,6 +15,7 @@
package sql
import (
"regexp"
"strconv"
"time"
)
@ -228,6 +229,19 @@ func (p *Parser) parseScript() (string, error) {
}
func (p *Parser) parseRegexp() (string, error) {
tok, lit, err := p.shouldBe(REGEX)
if err != nil {
return string(""), &ParseError{Found: lit, Expected: []string{"regular expression"}}
}
val, err := declare(tok, lit)
return val.(*regexp.Regexp).String(), err
}
func (p *Parser) parseBoolean() (bool, error) {
tok, lit, err := p.shouldBe(TRUE, FALSE)

19
sql/field.go
View file

@ -38,7 +38,7 @@ func (p *Parser) parseDefineFieldStatement(explain bool) (stmt *DefineFieldState
for {
tok, _, exi := p.mightBe(MIN, MAX, TYPE, ENUM, CODE, DEFAULT, NOTNULL, READONLY, MANDATORY)
tok, _, exi := p.mightBe(MIN, MAX, TYPE, ENUM, CODE, MATCH, DEFAULT, NOTNULL, READONLY, MANDATORY, VALIDATE)
if !exi {
break
}
@ -73,6 +73,12 @@ func (p *Parser) parseDefineFieldStatement(explain bool) (stmt *DefineFieldState
}
}
if is(tok, MATCH) {
if stmt.Match, err = p.parseRegexp(); err != nil {
return nil, err
}
}
if is(tok, DEFAULT) {
if stmt.Default, err = p.parseDefault(); err != nil {
return nil, err
@ -106,9 +112,18 @@ func (p *Parser) parseDefineFieldStatement(explain bool) (stmt *DefineFieldState
}
}
if is(tok, VALIDATE) {
stmt.Validate = true
if tok, _, exi := p.mightBe(TRUE, FALSE); exi {
if tok == FALSE {
stmt.Validate = false
}
}
}
}
if stmt.Type == nil {
if stmt.Type == "" {
return nil, &ParseError{Found: "", Expected: []string{"TYPE"}}
}

8
sql/type.go
View file

@ -14,17 +14,17 @@
package sql
func (p *Parser) parseType() (exp Expr, err error) {
func (p *Parser) parseType() (exp Ident, err error) {
allowed := []string{"any", "url", "email", "phone", "array", "object", "string", "number", "custom", "boolean", "datetime"}
allowed := []string{"any", "url", "uuid", "color", "email", "phone", "array", "object", "domain", "string", "number", "custom", "boolean", "datetime", "latitude", "longitude"}
tok, lit, err := p.shouldBe(IDENT)
if err != nil {
return nil, err
return Ident(""), err
}
if !contains(lit, allowed) {
return nil, &ParseError{Found: lit, Expected: allowed}
return Ident(""), &ParseError{Found: lit, Expected: allowed}
}
val, err := declare(tok, lit)

155
util/conv/conv.go Normal file
View file

@ -0,0 +1,155 @@
// Copyright © 2016 Abcum Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package conv
import (
"fmt"
"time"
"github.com/asaskevich/govalidator"
)
func ConvertToUrl(obj interface{}) (val string, err error) {
val = govalidator.ToString(obj)
if !govalidator.IsURL(val) {
err = fmt.Errorf("Not a valid url")
}
return
}
func ConvertToUuid(obj interface{}) (val string, err error) {
val = govalidator.ToString(obj)
if !govalidator.IsUUID(val) {
err = fmt.Errorf("Not a valid uuid")
}
return
}
func ConvertToEmail(obj interface{}) (val string, err error) {
val = govalidator.ToString(obj)
if !govalidator.IsEmail(val) {
err = fmt.Errorf("Not a valid email")
}
return govalidator.NormalizeEmail(val)
}
func ConvertToPhone(obj interface{}) (val string, err error) {
val = govalidator.ToString(obj)
if !govalidator.Matches(val, `^[\s\d\+\-\(\)]+$`) {
err = fmt.Errorf("Not a valid phone")
}
return
}
func ConvertToColor(obj interface{}) (val string, err error) {
val = govalidator.ToString(obj)
if !govalidator.IsHexcolor(val) && !govalidator.IsRGBcolor(val) {
err = fmt.Errorf("Not a valid color")
}
return
}
func ConvertToArray(obj interface{}) (val []interface{}, err error) {
if now, ok := obj.([]interface{}); ok {
val = now
} else {
err = fmt.Errorf("Not a valid array")
}
return
}
func ConvertToObject(obj interface{}) (val map[string]interface{}, err error) {
if now, ok := obj.(map[string]interface{}); ok {
val = now
} else {
err = fmt.Errorf("Not a valid object")
}
return
}
func ConvertToDomain(obj interface{}) (val string, err error) {
val = govalidator.ToString(obj)
if !govalidator.IsDNSName(val) {
err = fmt.Errorf("Not a valid domain name")
}
return
}
func ConvertToBase64(obj interface{}) (val string, err error) {
val = govalidator.ToString(obj)
if !govalidator.IsBase64(val) {
err = fmt.Errorf("Not valid base64 data")
}
return
}
func ConvertToString(obj interface{}) (val string, err error) {
if now, ok := obj.(string); ok {
return now, err
}
return govalidator.ToString(obj), err
}
func ConvertToNumber(obj interface{}) (val float64, err error) {
if now, ok := obj.(float64); ok {
return now, err
}
return govalidator.ToFloat(govalidator.ToString(obj))
}
func ConvertToBoolean(obj interface{}) (val bool, err error) {
if now, ok := obj.(bool); ok {
return now, err
}
return govalidator.ToBoolean(govalidator.ToString(obj))
}
func ConvertToDatetime(obj interface{}) (val time.Time, err error) {
if now, ok := obj.(time.Time); ok {
val = now
} else {
err = fmt.Errorf("Not a valid datetime")
}
return
}
func ConvertToLatitude(obj interface{}) (val float64, err error) {
str := govalidator.ToString(obj)
if !govalidator.IsLatitude(str) {
err = fmt.Errorf("Not a valid latitude")
}
return govalidator.ToFloat(str)
}
func ConvertToLongitude(obj interface{}) (val float64, err error) {
str := govalidator.ToString(obj)
if !govalidator.IsLatitude(str) {
err = fmt.Errorf("Not a valid longitude")
}
return govalidator.ToFloat(str)
}
func ConvertToOneOf(obj interface{}, pos ...interface{}) (val interface{}, err error) {
for _, now := range pos {
if num, ok := obj.(int64); ok {
if float64(num) == now {
return obj, nil
}
} else if obj == now {
return obj, nil
}
}
return nil, fmt.Errorf("Not a valid option")
}

319
util/item/item.go
View file

@ -16,6 +16,7 @@ package item
import (
"fmt"
"regexp"
"time"
"github.com/imdario/mergo"
@ -23,6 +24,7 @@ import (
"github.com/abcum/surreal/kvs"
"github.com/abcum/surreal/sql"
"github.com/abcum/surreal/util/conv"
"github.com/abcum/surreal/util/data"
// "github.com/abcum/surreal/util/diff"
"github.com/abcum/surreal/util/keys"
@ -33,12 +35,14 @@ type field struct {
Name string
Code string
Enum []interface{}
Min int64
Max int64
Min float64
Max float64
Match string
Default interface{}
Notnull bool
Readonly bool
Mandatory bool
Validate bool
}
type index struct {
@ -329,15 +333,18 @@ func (this *Doc) getFlds(txn kvs.TX) (out []*field) {
fld := &field{}
fld.Type, _ = inf.Get("type").Data().(string)
fld.Name, _ = inf.Get("name").Data().(string)
fld.Type, _ = inf.Get("type").Data().(string)
fld.Enum, _ = inf.Get("enum").Data().([]interface{})
fld.Code, _ = inf.Get("code").Data().(string)
fld.Min, _ = inf.Get("min").Data().(int64)
fld.Max, _ = inf.Get("max").Data().(int64)
fld.Min, _ = inf.Get("min").Data().(float64)
fld.Max, _ = inf.Get("max").Data().(float64)
fld.Match, _ = inf.Get("match").Data().(string)
fld.Default = inf.Get("default").Data()
fld.Notnull = inf.Get("notnull").Data().(bool)
fld.Readonly = inf.Get("readonly").Data().(bool)
fld.Mandatory = inf.Get("mandatory").Data().(bool)
fld.Validate = inf.Get("validate").Data().(bool)
out = append(out, fld)
@ -379,7 +386,11 @@ func (this *Doc) mrgFld(txn kvs.TX) (err error) {
for _, fld := range this.getFlds(txn) {
initial := this.initial.Get("data", fld.Name).Data()
var exists bool
var initial interface{}
var current interface{}
initial = this.initial.Get("data", fld.Name).Data()
if fld.Readonly && initial != nil {
this.current.Set(initial, "data", fld.Name)
@ -408,8 +419,8 @@ func (this *Doc) mrgFld(txn kvs.TX) (err error) {
}
current := this.current.Get("data", fld.Name).Data()
exists := this.current.Exists("data", fld.Name)
current = this.current.Get("data", fld.Name).Data()
exists = this.current.Exists("data", fld.Name)
if fld.Default != nil && exists == false {
this.current.Set(fld.Default, "data", fld.Name)
@ -423,8 +434,298 @@ func (this *Doc) mrgFld(txn kvs.TX) (err error) {
return fmt.Errorf("Need to set field '%v'", fld.Name)
}
if fld.Type != "" {
if current != nil && fld.Type != "" {
switch fld.Type {
case "url":
if val, err := conv.ConvertToUrl(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a URL", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "uuid":
if val, err := conv.ConvertToUuid(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a UUID", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "color":
if val, err := conv.ConvertToColor(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a HEX or RGB color", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "email":
if val, err := conv.ConvertToEmail(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a email address", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "phone":
if val, err := conv.ConvertToPhone(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a phone number", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "array":
if val, err := conv.ConvertToArray(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a array", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "object":
if val, err := conv.ConvertToObject(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a object", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "domain":
if val, err := conv.ConvertToDomain(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a domain name", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "base64":
if val, err := conv.ConvertToBase64(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be base64 data", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "string":
if val, err := conv.ConvertToString(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a string", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "number":
if val, err := conv.ConvertToNumber(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a number", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "boolean":
if val, err := conv.ConvertToBoolean(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a boolean", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "datetime":
if val, err := conv.ConvertToDatetime(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a datetime", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "latitude":
if val, err := conv.ConvertToLatitude(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a latitude value", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "longitude":
if val, err := conv.ConvertToLongitude(current); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be a longitude value", fld.Name)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case "custom":
if val, err := conv.ConvertToOneOf(current, fld.Enum...); err == nil {
this.current.Set(val, "data", fld.Name)
} else {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be one of %v", fld.Name, fld.Enum)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
}
}
if fld.Match != "" {
if reg, err := regexp.Compile(fld.Match); err != nil {
return fmt.Errorf("Regular expression /%v/ is invalid", fld.Match)
} else {
if !reg.MatchString(fmt.Sprintf("%v", current)) {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to match the regular expression /%v/", fld.Name, fld.Match)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
}
}
if fld.Min != 0 {
if current = this.current.Get("data", fld.Name).Data(); current != nil {
switch now := current.(type) {
case []interface{}:
if len(now) < int(fld.Min) {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be have at least %v items", fld.Name, fld.Min)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case string:
if len(now) < int(fld.Min) {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to at least %v characters", fld.Name, fld.Min)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case float64:
if now < fld.Min {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be >= %v", fld.Name, fld.Min)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
}
}
}
if fld.Max != 0 {
if current = this.current.Get("data", fld.Name).Data(); current != nil {
switch now := current.(type) {
case []interface{}:
if len(now) > int(fld.Max) {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be have %v or fewer items", fld.Name, fld.Max)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case string:
if len(now) > int(fld.Max) {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be %v or fewer characters", fld.Name, fld.Max)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
case float64:
if now > fld.Max {
if fld.Validate {
return fmt.Errorf("Field '%v' needs to be <= %v", fld.Name, fld.Max)
} else {
this.current.Try(initial, "data", fld.Name)
}
}
}
}
}
current = this.current.Get("data", fld.Name).Data()
exists = this.current.Exists("data", fld.Name)
if fld.Default != nil && exists == false {
this.current.Set(fld.Default, "data", fld.Name)
}
if fld.Notnull && exists == true && current == nil {
return fmt.Errorf("Can't be null field '%v'", fld.Name)
}
if fld.Mandatory && exists == false {
return fmt.Errorf("Need to set field '%v'", fld.Name)
}
}