Move tag parser related codes as a standalone sub package (#1547)

Fix sliceEq

fix tests

Move tag parser related codes as a standalone sub package

Reviewed-on: https://gitea.com/xorm/xorm/pulls/1547

Author: lunny

.drone.yml

@@ -22,8 +22,8 @@ steps:
   commands:
   - make test-sqlite
   - TEST_CACHE_ENABLE=true make test-sqlite
-  - go test ./caches/... ./core/... ./dialects/... ./internal/... \
-    ./log/... ./migrate/... ./names/... ./schemas/...
+  - go test ./caches/... ./convert/... ./core/... ./dialects/... \
+    ./log/... ./migrate/... ./names/... ./schemas/... ./tags/...
   when:
     event:
     - push

convert.go

@@ -346,10 +346,3 @@ func asBool(bs []byte) (bool, error) {
 	}
 	return strconv.ParseBool(string(bs))
 }
-
-// Conversion is an interface. A type implements Conversion will according
-// the custom method to fill into database and retrieve from database.
-type Conversion interface {
-	FromDB([]byte) error
-	ToDB() ([]byte, error)
-}

convert/conversion.go

@@ -0,0 +1,12 @@
+// Copyright 2017 The Xorm Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package convert
+
+// Conversion is an interface. A type implements Conversion will according
+// the custom method to fill into database and retrieve from database.
+type Conversion interface {
+	FromDB([]byte) error
+	ToDB() ([]byte, error)
+}

engine.go

@@ -28,6 +28,7 @@ import (
 	"xorm.io/xorm/log"
 	"xorm.io/xorm/names"
 	"xorm.io/xorm/schemas"
+	"xorm.io/xorm/tags"
 )
 
 // Engine is the major struct of xorm, it means a database manager.
@@ -36,10 +37,7 @@ type Engine struct {
 	db      *core.DB
 	dialect dialects.Dialect
 
-	ColumnMapper  names.Mapper
-	TableMapper   names.Mapper
-	TagIdentifier string
-	Tables        map[reflect.Type]*schemas.Table
+	Tables map[reflect.Type]*schemas.Table
 
 	mutex *sync.RWMutex
 
@@ -50,12 +48,12 @@ type Engine struct {
 	TZLocation *time.Location // The timezone of the application
 	DatabaseTZ *time.Location // The timezone of the database
 
-	tagHandlers map[string]tagHandler
-
 	engineGroup *EngineGroup
-	cacherMgr   *caches.Manager
 
 	defaultContext context.Context
+
+	tagParser *tags.Parser
+	cacherMgr *caches.Manager
 }
 
 func (engine *Engine) SetCacher(tableName string, cacher caches.Cacher) {
@@ -151,12 +149,12 @@ func (engine *Engine) SetMapper(mapper names.Mapper) {
 
 // SetTableMapper set the table name mapping rule
 func (engine *Engine) SetTableMapper(mapper names.Mapper) {
-	engine.TableMapper = mapper
+	engine.tagParser.TableMapper = mapper
 }
 
 // SetColumnMapper set the column name mapping rule
 func (engine *Engine) SetColumnMapper(mapper names.Mapper) {
-	engine.ColumnMapper = mapper
+	engine.tagParser.ColumnMapper = mapper
 }
 
 // SupportInsertMany If engine's database support batch insert records like
@@ -769,7 +767,7 @@ func (engine *Engine) autoMapType(v reflect.Value) (*schemas.Table, error) {
 	table, ok := engine.Tables[t]
 	if !ok {
 		var err error
-		table, err = engine.mapType(v)
+		table, err = engine.tagParser.MapType(v)
 		if err != nil {
 			return nil, err
 		}
@@ -813,215 +811,6 @@ func (engine *Engine) TableInfo(bean interface{}) *Table {
 	return &Table{tb, engine.TableName(bean)}
 }
 
-func addIndex(indexName string, table *schemas.Table, col *schemas.Column, indexType int) {
-	if index, ok := table.Indexes[indexName]; ok {
-		index.AddColumn(col.Name)
-		col.Indexes[index.Name] = indexType
-	} else {
-		index := schemas.NewIndex(indexName, indexType)
-		index.AddColumn(col.Name)
-		table.AddIndex(index)
-		col.Indexes[index.Name] = indexType
-	}
-}
-
-// TableName table name interface to define customerize table name
-type TableName interface {
-	TableName() string
-}
-
-var (
-	tpTableName = reflect.TypeOf((*TableName)(nil)).Elem()
-)
-
-func (engine *Engine) mapType(v reflect.Value) (*schemas.Table, error) {
-	t := v.Type()
-	table := schemas.NewEmptyTable()
-	table.Type = t
-	table.Name = names.GetTableName(engine.TableMapper, v)
-
-	var idFieldColName string
-	var hasCacheTag, hasNoCacheTag bool
-
-	for i := 0; i < t.NumField(); i++ {
-		tag := t.Field(i).Tag
-
-		ormTagStr := tag.Get(engine.TagIdentifier)
-		var col *schemas.Column
-		fieldValue := v.Field(i)
-		fieldType := fieldValue.Type()
-
-		if ormTagStr != "" {
-			col = &schemas.Column{
-				FieldName:       t.Field(i).Name,
-				Nullable:        true,
-				IsPrimaryKey:    false,
-				IsAutoIncrement: false,
-				MapType:         schemas.TWOSIDES,
-				Indexes:         make(map[string]int),
-				DefaultIsEmpty:  true,
-			}
-			tags := splitTag(ormTagStr)
-
-			if len(tags) > 0 {
-				if tags[0] == "-" {
-					continue
-				}
-
-				var ctx = tagContext{
-					table:      table,
-					col:        col,
-					fieldValue: fieldValue,
-					indexNames: make(map[string]int),
-					engine:     engine,
-				}
-
-				if strings.HasPrefix(strings.ToUpper(tags[0]), "EXTENDS") {
-					pStart := strings.Index(tags[0], "(")
-					if pStart > -1 && strings.HasSuffix(tags[0], ")") {
-						var tagPrefix = strings.TrimFunc(tags[0][pStart+1:len(tags[0])-1], func(r rune) bool {
-							return r == '\'' || r == '"'
-						})
-
-						ctx.params = []string{tagPrefix}
-					}
-
-					if err := ExtendsTagHandler(&ctx); err != nil {
-						return nil, err
-					}
-					continue
-				}
-
-				for j, key := range tags {
-					if ctx.ignoreNext {
-						ctx.ignoreNext = false
-						continue
-					}
-
-					k := strings.ToUpper(key)
-					ctx.tagName = k
-					ctx.params = []string{}
-
-					pStart := strings.Index(k, "(")
-					if pStart == 0 {
-						return nil, errors.New("( could not be the first character")
-					}
-					if pStart > -1 {
-						if !strings.HasSuffix(k, ")") {
-							return nil, fmt.Errorf("field %s tag %s cannot match ) character", col.FieldName, key)
-						}
-
-						ctx.tagName = k[:pStart]
-						ctx.params = strings.Split(key[pStart+1:len(k)-1], ",")
-					}
-
-					if j > 0 {
-						ctx.preTag = strings.ToUpper(tags[j-1])
-					}
-					if j < len(tags)-1 {
-						ctx.nextTag = tags[j+1]
-					} else {
-						ctx.nextTag = ""
-					}
-
-					if h, ok := engine.tagHandlers[ctx.tagName]; ok {
-						if err := h(&ctx); err != nil {
-							return nil, err
-						}
-					} else {
-						if strings.HasPrefix(key, "'") && strings.HasSuffix(key, "'") {
-							col.Name = key[1 : len(key)-1]
-						} else {
-							col.Name = key
-						}
-					}
-
-					if ctx.hasCacheTag {
-						hasCacheTag = true
-					}
-					if ctx.hasNoCacheTag {
-						hasNoCacheTag = true
-					}
-				}
-
-				if col.SQLType.Name == "" {
-					col.SQLType = schemas.Type2SQLType(fieldType)
-				}
-				engine.dialect.SQLType(col)
-				if col.Length == 0 {
-					col.Length = col.SQLType.DefaultLength
-				}
-				if col.Length2 == 0 {
-					col.Length2 = col.SQLType.DefaultLength2
-				}
-				if col.Name == "" {
-					col.Name = engine.ColumnMapper.Obj2Table(t.Field(i).Name)
-				}
-
-				if ctx.isUnique {
-					ctx.indexNames[col.Name] = schemas.UniqueType
-				} else if ctx.isIndex {
-					ctx.indexNames[col.Name] = schemas.IndexType
-				}
-
-				for indexName, indexType := range ctx.indexNames {
-					addIndex(indexName, table, col, indexType)
-				}
-			}
-		} else {
-			var sqlType schemas.SQLType
-			if fieldValue.CanAddr() {
-				if _, ok := fieldValue.Addr().Interface().(Conversion); ok {
-					sqlType = schemas.SQLType{Name: schemas.Text}
-				}
-			}
-			if _, ok := fieldValue.Interface().(Conversion); ok {
-				sqlType = schemas.SQLType{Name: schemas.Text}
-			} else {
-				sqlType = schemas.Type2SQLType(fieldType)
-			}
-			col = schemas.NewColumn(engine.ColumnMapper.Obj2Table(t.Field(i).Name),
-				t.Field(i).Name, sqlType, sqlType.DefaultLength,
-				sqlType.DefaultLength2, true)
-
-			if fieldType.Kind() == reflect.Int64 && (strings.ToUpper(col.FieldName) == "ID" || strings.HasSuffix(strings.ToUpper(col.FieldName), ".ID")) {
-				idFieldColName = col.Name
-			}
-		}
-		if col.IsAutoIncrement {
-			col.Nullable = false
-		}
-
-		table.AddColumn(col)
-
-	} // end for
-
-	if idFieldColName != "" && len(table.PrimaryKeys) == 0 {
-		col := table.GetColumn(idFieldColName)
-		col.IsPrimaryKey = true
-		col.IsAutoIncrement = true
-		col.Nullable = false
-		table.PrimaryKeys = append(table.PrimaryKeys, col.Name)
-		table.AutoIncrement = col.Name
-	}
-
-	if hasCacheTag {
-		if engine.GetDefaultCacher() != nil { // !nash! use engine's cacher if provided
-			engine.logger.Info("enable cache on table:", table.Name)
-			engine.SetCacher(table.Name, engine.GetDefaultCacher())
-		} else {
-			engine.logger.Info("enable LRU cache on table:", table.Name)
-			engine.SetCacher(table.Name, caches.NewLRUCacher2(caches.NewMemoryStore(), time.Hour, 10000))
-		}
-	}
-	if hasNoCacheTag {
-		engine.logger.Info("disable cache on table:", table.Name)
-		engine.SetCacher(table.Name, nil)
-	}
-
-	return table, nil
-}
-
 // IsTableEmpty if a table has any reocrd
 func (engine *Engine) IsTableEmpty(bean interface{}) (bool, error) {
 	session := engine.NewSession()
@@ -1542,12 +1331,12 @@ func (engine *Engine) formatTime(sqlTypeName string, t time.Time) (v interface{}
 
 // GetColumnMapper returns the column name mapper
 func (engine *Engine) GetColumnMapper() names.Mapper {
-	return engine.ColumnMapper
+	return engine.tagParser.ColumnMapper
 }
 
 // GetTableMapper returns the table name mapper
 func (engine *Engine) GetTableMapper() names.Mapper {
-	return engine.TableMapper
+	return engine.tagParser.TableMapper
 }
 
 // GetTZLocation returns time zone of the application

engine_cond.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"xorm.io/builder"
+	"xorm.io/xorm/convert"
 	"xorm.io/xorm/internal/utils"
 	"xorm.io/xorm/schemas"
 )
@@ -137,7 +138,7 @@ func (engine *Engine) buildConds(table *schemas.Table, bean interface{},
 					continue
 				}
 				val = engine.formatColTime(col, t)
-			} else if _, ok := reflect.New(fieldType).Interface().(Conversion); ok {
+			} else if _, ok := reflect.New(fieldType).Interface().(convert.Conversion); ok {
 				continue
 			} else if valNul, ok := fieldValue.Interface().(driver.Valuer); ok {
 				val, _ = valNul.Value()

engine_group.go

@@ -112,9 +112,9 @@ func (eg *EngineGroup) Ping() error {
 
 // SetColumnMapper set the column name mapping rule
 func (eg *EngineGroup) SetColumnMapper(mapper names.Mapper) {
-	eg.Engine.ColumnMapper = mapper
+	eg.Engine.SetColumnMapper(mapper)
 	for i := 0; i < len(eg.slaves); i++ {
-		eg.slaves[i].ColumnMapper = mapper
+		eg.slaves[i].SetColumnMapper(mapper)
 	}
 }
 
@@ -182,9 +182,9 @@ func (eg *EngineGroup) SetPolicy(policy GroupPolicy) *EngineGroup {
 
 // SetTableMapper set the table name mapping rule
 func (eg *EngineGroup) SetTableMapper(mapper names.Mapper) {
-	eg.Engine.TableMapper = mapper
+	eg.Engine.SetTableMapper(mapper)
 	for i := 0; i < len(eg.slaves); i++ {
-		eg.slaves[i].TableMapper = mapper
+		eg.slaves[i].SetTableMapper(mapper)
 	}
 }