refactor(tag): modify the tag declaration of a structure (#67)

chenjunbiao · web-flow · commit 6b734dbd0fda · 2021-02-23T14:18:47.000+08:00
`yomo:"0x10"` to `y3:"0x10"`
diff --git a/README_CN.md b/README_CN.md
@@ -78,8 +78,8 @@ Golang implementation of [YoMo Codec](https://github.com/yomorun/yomo-codec)
   
     ```go 
     type Example struct {
-    	Id   int32  `yomo:"0x22"`
-    	Name string `yomo:"0x23"`
+    	Id   int32  `y3:"0x22"`
+    	Name string `y3:"0x23"`
     }
     ```
   
@@ -167,8 +167,8 @@ func main() {
 }
 
 type Example struct {
-	Id   int32  `yomo:"0x22"`
-	Name string `yomo:"0x23"`
+	Id   int32  `y3:"0x22"`
+	Name string `y3:"0x23"`
 }
 ```
 
@@ -218,8 +218,8 @@ func main() {
 }
 
 type Example struct {
-	Id   int32  `yomo:"0x22"`
-	Name string `yomo:"0x23"`
+	Id   int32  `y3:"0x22"`
+	Name string `y3:"0x23"`
 }
 ```
 
diff --git a/codec_test.go b/codec_test.go
@@ -223,16 +223,16 @@ func TestMarshalObjectSlice(t *testing.T) {
 }
 
 type exampleData struct {
-	Name  string      `yomo:"0x10"`
-	Noise float32     `yomo:"0x11"`
-	Therm thermometer `yomo:"0x12"`
+	Name  string      `y3:"0x10"`
+	Noise float32     `y3:"0x11"`
+	Therm thermometer `y3:"0x12"`
 }
 
 type thermometer struct {
-	Temperature float32 `yomo:"0x13"`
-	Humidity    float32 `yomo:"0x14"`
+	Temperature float32 `y3:"0x13"`
+	Humidity    float32 `y3:"0x14"`
 }
 
 type exampleSlice struct {
-	Therms []thermometer `yomo:"0x12"`
+	Therms []thermometer `y3:"0x12"`
 }
diff --git a/examples/example1/main.go b/examples/example1/main.go
@@ -9,14 +9,14 @@ import (
 )
 
 type SourceData struct {
-	Name  string      `yomo:"0x10"`
-	Noise float32     `yomo:"0x11"`
-	Therm Thermometer `yomo:"0x12"`
+	Name  string      `y3:"0x10"`
+	Noise float32     `y3:"0x11"`
+	Therm Thermometer `y3:"0x12"`
 }
 
 type Thermometer struct {
-	Temperature float32 `yomo:"0x13"`
-	Humidity    float32 `yomo:"0x14"`
+	Temperature float32 `y3:"0x13"`
+	Humidity    float32 `y3:"0x14"`
 }
 
 func main() {
diff --git a/explainer.md b/explainer.md
@@ -36,14 +36,14 @@ Core interfaces include:
 
 ```go
 type SourceData struct {
-   Name  string      `yomo:"0x10"`
-   Noise float32     `yomo:"0x11"`
-   Therm Thermometer `yomo:"0x12"`
+   Name  string      `y3:"0x10"`
+   Noise float32     `y3:"0x11"`
+   Therm Thermometer `y3:"0x12"`
 }
 
 type Thermometer struct {
-   Temperature float32 `yomo:"0x13"`
-   Humidity    float32 `yomo:"0x14"`
+   Temperature float32 `y3:"0x13"`
+   Humidity    float32 `y3:"0x14"`
 }
 
 func main() {
diff --git a/explainer_CN.md b/explainer_CN.md
@@ -36,14 +36,14 @@
 
 ```go
 type SourceData struct {
-   Name  string      `yomo:"0x10"`
-   Noise float32     `yomo:"0x11"`
-   Therm Thermometer `yomo:"0x12"`
+   Name  string      `y3:"0x10"`
+   Noise float32     `y3:"0x11"`
+   Therm Thermometer `y3:"0x12"`
 }
 
 type Thermometer struct {
-   Temperature float32 `yomo:"0x13"`
-   Humidity    float32 `yomo:"0x14"`
+   Temperature float32 `y3:"0x13"`
+   Humidity    float32 `y3:"0x14"`
 }
 
 func main() {
diff --git a/internal/tester/data.go b/internal/tester/data.go
@@ -1,84 +1,84 @@
 package tester
 
 type BasicTestData struct {
-	Vstring  string  `yomo:"0x10"`
-	Vint32   int32   `yomo:"0x11"`
-	Vint64   int64   `yomo:"0x12"`
-	Vuint32  uint32  `yomo:"0x13"`
-	Vuint64  uint64  `yomo:"0x14"`
-	Vfloat32 float32 `yomo:"0x15"`
-	Vfloat64 float64 `yomo:"0x16"`
-	Vbool    bool    `yomo:"0x17"`
+	Vstring  string  `y3:"0x10"`
+	Vint32   int32   `y3:"0x11"`
+	Vint64   int64   `y3:"0x12"`
+	Vuint32  uint32  `y3:"0x13"`
+	Vuint64  uint64  `y3:"0x14"`
+	Vfloat32 float32 `y3:"0x15"`
+	Vfloat64 float64 `y3:"0x16"`
+	Vbool    bool    `y3:"0x17"`
 }
 
 type EmbeddedTestData struct {
-	BasicTestData `yomo:"0x1a"`
-	Vaction       string `yomo:"0x1b"`
+	BasicTestData `y3:"0x1a"`
+	Vaction       string `y3:"0x1b"`
 }
 
 type EmbeddedMoreTestData struct {
-	EmbeddedTestData `yomo:"0x1c"`
-	Vanimal          string `yomo:"0x1d"`
+	EmbeddedTestData `y3:"0x1c"`
+	Vanimal          string `y3:"0x1d"`
 }
 
 type NamedTestData struct {
-	Base    BasicTestData `yomo:"0x1e"`
-	Vaction string        `yomo:"0x1f"`
+	Base    BasicTestData `y3:"0x1e"`
+	Vaction string        `y3:"0x1f"`
 }
 
 type NamedMoreTestData struct {
-	MyNest  NamedTestData `yomo:"0x2a"`
-	Vanimal string        `yomo:"0x2b"`
+	MyNest  NamedTestData `y3:"0x2a"`
+	Vanimal string        `y3:"0x2b"`
 }
 
 type ArrayTestData struct {
-	Vfoo          string     `yomo:"0x20"`
-	Vbar          [2]string  `yomo:"0x21"`
-	Vint32Array   [2]int32   `yomo:"0x22"`
-	Vint64Array   [2]int64   `yomo:"0x23"`
-	Vuint32Array  [2]uint32  `yomo:"0x24"`
-	Vuint64Array  [2]uint64  `yomo:"0x25"`
-	Vfloat32Array [2]float32 `yomo:"0x26"`
-	Vfloat64Array [2]float64 `yomo:"0x27"`
+	Vfoo          string     `y3:"0x20"`
+	Vbar          [2]string  `y3:"0x21"`
+	Vint32Array   [2]int32   `y3:"0x22"`
+	Vint64Array   [2]int64   `y3:"0x23"`
+	Vuint32Array  [2]uint32  `y3:"0x24"`
+	Vuint64Array  [2]uint64  `y3:"0x25"`
+	Vfloat32Array [2]float32 `y3:"0x26"`
+	Vfloat64Array [2]float64 `y3:"0x27"`
 }
 
 type SliceTestData struct {
-	Vfoo          string    `yomo:"0x30"`
-	Vbar          []string  `yomo:"0x31"`
-	Vint32Slice   []int32   `yomo:"0x32"`
-	Vint64Slice   []int64   `yomo:"0x33"`
-	Vuint32Slice  []uint32  `yomo:"0x34"`
-	Vuint64Slice  []uint64  `yomo:"0x35"`
-	Vfloat32Slice []float32 `yomo:"0x36"`
-	Vfloat64Slice []float64 `yomo:"0x37"`
+	Vfoo          string    `y3:"0x30"`
+	Vbar          []string  `y3:"0x31"`
+	Vint32Slice   []int32   `y3:"0x32"`
+	Vint64Slice   []int64   `y3:"0x33"`
+	Vuint32Slice  []uint32  `y3:"0x34"`
+	Vuint64Slice  []uint64  `y3:"0x35"`
+	Vfloat32Slice []float32 `y3:"0x36"`
+	Vfloat64Slice []float64 `y3:"0x37"`
 }
 
 type SliceStructTestData struct {
-	Vstring          string                 `yomo:"0x2e"`
-	BaseList         []BasicTestData        `yomo:"0x2f"`
-	NamedMoreList    []NamedMoreTestData    `yomo:"0x3a"`
-	EmbeddedMoreList []EmbeddedMoreTestData `yomo:"0x3b"`
+	Vstring          string                 `y3:"0x2e"`
+	BaseList         []BasicTestData        `y3:"0x2f"`
+	NamedMoreList    []NamedMoreTestData    `y3:"0x3a"`
+	EmbeddedMoreList []EmbeddedMoreTestData `y3:"0x3b"`
 }
 
 type ArrayStructTestData struct {
-	Vstring          string                  `yomo:"0x2e"`
-	BaseList         [2]BasicTestData        `yomo:"0x2f"`
-	NamedMoreList    [2]NamedMoreTestData    `yomo:"0x3a"`
-	EmbeddedMoreList [2]EmbeddedMoreTestData `yomo:"0x3b"`
+	Vstring          string                  `y3:"0x2e"`
+	BaseList         [2]BasicTestData        `y3:"0x2f"`
+	NamedMoreList    [2]NamedMoreTestData    `y3:"0x3a"`
+	EmbeddedMoreList [2]EmbeddedMoreTestData `y3:"0x3b"`
 }
 
 type NestedTestData struct {
-	SubNested Sub1NestedTestData `yomo:"0x3a"`
+	SubNested Sub1NestedTestData `y3:"0x3a"`
 }
 
 type Sub1NestedTestData struct {
-	SubNested Sub2NestedTestData `yomo:"0x3b"`
+	SubNested Sub2NestedTestData `y3:"0x3b"`
 }
 
 type Sub2NestedTestData struct {
-	SubNested Sub3NestedTestData `yomo:"0x3c"`
+	SubNested Sub3NestedTestData `y3:"0x3c"`
 }
 
 type Sub3NestedTestData struct {
-	BasicList []BasicTestData `yomo:"0x3d"`
+	BasicList []BasicTestData `y3:"0x3d"`
 }
diff --git a/structure_decoder.go b/structure_decoder.go
@@ -52,7 +52,7 @@ func newStructDecoder(mold interface{}, options ...func(*structDecoderImpl)) str
 	decoder := &structDecoderImpl{
 		config: &structDecoderConfig{
 			ZeroFields: true,
-			TagName:    "yomo",
+			TagName:    "y3",
 		},
 		result: mold,
 	}
diff --git a/structure_decoder_test.go b/structure_decoder_test.go
@@ -34,7 +34,7 @@ func TestBasic_Struct(t *testing.T) {
 func runDecode(t *testing.T, inputBuf []byte, output interface{}) {
 	_, err := newStructDecoder(output, structDecoderOptionConfig(&structDecoderConfig{
 		ZeroFields: true,
-		TagName:    "yomo",
+		TagName:    "y3",
 	})).Decode(inputBuf)
 	if err != nil {
 		t.Errorf("got an err: %s", err.Error())
diff --git a/structure_encoder.go b/structure_encoder.go
@@ -52,7 +52,7 @@ func newStructEncoder(observe byte, options ...func(*structEncoderImpl)) structE
 	encoder := &structEncoderImpl{
 		config: &structEncoderConfig{
 			ZeroFields: true,
-			TagName:    "yomo",
+			TagName:    "y3",
 		},
 		observe: observe,
 		root:    utils.EmptyKey,
diff --git a/structure_encoder_test.go b/structure_encoder_test.go
@@ -19,7 +19,7 @@ func TestStructEncoderWithSignals(t *testing.T) {
 	encoder := newStructEncoder(0x30, structEncoderOptionRoot(rootToken),
 		structEncoderOptionConfig(&structEncoderConfig{
 			ZeroFields: true,
-			TagName:    "yomo",
+			TagName:    "y3",
 		}))
 	inputBuf, _ := encoder.Encode(input,
 		createSignal(0x02).SetString("a"),

Original file line number	Diff line number	Diff line change
`@@ -78,8 +78,8 @@ Golang implementation of [YoMo Codec](https://github.com/yomorun/yomo-codec)`
`78`	`78`
`79`	`79`	```go
`80`	`80`	`type Example struct {`
`81`		- Id int32 `yomo:"0x22"`
`82`		- Name string `yomo:"0x23"`
	`81`	+ Id int32 `y3:"0x22"`
	`82`	+ Name string `y3:"0x23"`
`83`	`83`	`}`
`84`	`84`	```
`85`	`85`
`@@ -167,8 +167,8 @@ func main() {`
`167`	`167`	`}`
`168`	`168`
`169`	`169`	`type Example struct {`
`170`		- Id int32 `yomo:"0x22"`
`171`		- Name string `yomo:"0x23"`
	`170`	+ Id int32 `y3:"0x22"`
	`171`	+ Name string `y3:"0x23"`
`172`	`172`	`}`
`173`	`173`	```
`174`	`174`
`@@ -218,8 +218,8 @@ func main() {`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`type Example struct {`
`221`		- Id int32 `yomo:"0x22"`
`222`		- Name string `yomo:"0x23"`
	`221`	+ Id int32 `y3:"0x22"`
	`222`	+ Name string `y3:"0x23"`
`223`	`223`	`}`
`224`	`224`	```
`225`	`225`
Original file line number	Diff line number	Diff line change
`@@ -223,16 +223,16 @@ func TestMarshalObjectSlice(t *testing.T) {`
`223`	`223`	`}`
`224`	`224`
`225`	`225`	`type exampleData struct {`
`226`		- Name string `yomo:"0x10"`
`227`		- Noise float32 `yomo:"0x11"`
`228`		- Therm thermometer `yomo:"0x12"`
	`226`	+ Name string `y3:"0x10"`
	`227`	+ Noise float32 `y3:"0x11"`
	`228`	+ Therm thermometer `y3:"0x12"`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`type thermometer struct {`
`232`		- Temperature float32 `yomo:"0x13"`
`233`		- Humidity float32 `yomo:"0x14"`
	`232`	+ Temperature float32 `y3:"0x13"`
	`233`	+ Humidity float32 `y3:"0x14"`
`234`	`234`	`}`
`235`	`235`
`236`	`236`	`type exampleSlice struct {`
`237`		- Therms []thermometer `yomo:"0x12"`
	`237`	+ Therms []thermometer `y3:"0x12"`
`238`	`238`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,14 +9,14 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`type SourceData struct {`
`12`		- Name string `yomo:"0x10"`
`13`		- Noise float32 `yomo:"0x11"`
`14`		- Therm Thermometer `yomo:"0x12"`
	`12`	+ Name string `y3:"0x10"`
	`13`	+ Noise float32 `y3:"0x11"`
	`14`	+ Therm Thermometer `y3:"0x12"`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`type Thermometer struct {`
`18`		- Temperature float32 `yomo:"0x13"`
`19`		- Humidity float32 `yomo:"0x14"`
	`18`	+ Temperature float32 `y3:"0x13"`
	`19`	+ Humidity float32 `y3:"0x14"`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`func main() {`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ func newStructDecoder(mold interface{}, options ...func(*structDecoderImpl)) str`
`52`	`52`	`decoder := &structDecoderImpl{`
`53`	`53`	`config: &structDecoderConfig{`
`54`	`54`	`ZeroFields: true,`
`55`		`- TagName: "yomo",`
	`55`	`+ TagName: "y3",`
`56`	`56`	`},`
`57`	`57`	`result: mold,`
`58`	`58`	`}`