Improving: code generator's template

Author: aopoltorzhicky

cmd/generator/README.md

@@ -17,7 +17,7 @@ generator -n my_contract -c KT1...
 Args:
 
 * `c` - contract address. For example, `KT1WxV6DDSFogKDg9DeAZZZr1HnVvKadpd3S`. Required if `f` is not set.
-* `n` - your contract name. Optional. Default: `contract`.
+* `n` - your contract name. Optional. Default: `my_contract`.
 * `u` - base TzKT API URL. Optional. Default: `https://api.tzkt.io/`.
 * `o` - output directory. Optional. Default: current directory.
 * `f` - path to JSON schema file. Required if `c` is not set.

cmd/generator/generator.go

@@ -1,9 +1,8 @@
 package main
 
 import (
-	"bufio"
+	"embed"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -14,17 +13,18 @@ import (
 	"github.com/iancoleman/strcase"
 )
 
-type typesTemplateContext struct {
-	PackageName string
-}
-
-type contractTemplateContext struct {
+type templateContext struct {
 	PackageName     string
 	TypeName        string
 	EntrypointTypes map[string]types.EntrypointData
 	Contract        string
 }
 
+var (
+	//go:embed template/*.tmpl
+	templates embed.FS
+)
+
 // Generate -
 func Generate(schema api.ContractJSONSchema, name, contract, dest string) error {
 	if dest == "" {
@@ -59,7 +59,7 @@ func Generate(schema api.ContractJSONSchema, name, contract, dest string) error
 
 func generateContractObject(name, contract, dest string, result types.ContractTypeResult) error {
 	className := strcase.ToCamel(name)
-	return generateFromTemplate(result.PackageName, "contract.tmpl", dest, contractTemplateContext{
+	return generateFromTemplate(result.PackageName, "contract", dest, templateContext{
 		PackageName:     result.PackageName,
 		TypeName:        className,
 		Contract:        contract,
@@ -85,29 +85,22 @@ func generateContractTypes(schema api.ContractJSONSchema, packageName, dest stri
 }
 
 func generateDefaultTypes(packageName, dest string) error {
-	return generateFromTemplate(packageName, "types.tmpl", dest, typesTemplateContext{packageName})
+	return generateFromTemplate(packageName, "types", dest, templateContext{PackageName: packageName})
 }
 
 func generateFromTemplate(packageName, templateFileName, dest string, ctx interface{}) error {
-	fileName := fmt.Sprintf("%s.go", strings.TrimSuffix(templateFileName, ".tmpl"))
-	buf, err := ioutil.ReadFile(filepath.Join("./templates", templateFileName))
-	if err != nil {
-		return err
-	}
-	tmpl, err := template.New(packageName).Parse(string(buf))
+	tmpl, err := template.ParseFS(templates, "template/*")
 	if err != nil {
 		return err
 	}
-	targetFile := filepath.Join(dest, fileName)
+	targetFile := filepath.Join(dest, fmt.Sprintf("%s.go", templateFileName))
 	templateFile, err := os.OpenFile(targetFile, os.O_WRONLY|os.O_CREATE, 0755)
 	if err != nil {
 		return err
 	}
-	w := bufio.NewWriter(templateFile)
-	if err := tmpl.Execute(w, ctx); err != nil {
+	if err := tmpl.ExecuteTemplate(templateFile, fmt.Sprintf("%s.tmpl", templateFileName), ctx); err != nil {
 		return err
 	}
-	w.Flush()
 
 	return templateFile.Close()
 }

cmd/generator/main.go

@@ -15,7 +15,7 @@ type args struct {
 	Contract string `validate:"required_with=URL,len=36"`
 	URL      string `validate:"url,required_with=Contract"`
 	Name     string `validate:"omitempty"`
-	Output   string `validate:"dir,omitempty"`
+	Output   string `validate:"omitempty,dir"`
 	File     string `validate:"required_without=URL"`
 }
 
@@ -24,7 +24,7 @@ func main() {
 
 	flag.StringVar(&args.Contract, "c", "", "Contract address `KT1...`")
 	flag.StringVar(&args.URL, "u", "https://api.tzkt.io/", "TzKT base URL")
-	flag.StringVar(&args.Name, "n", "contract", "Contract name")
+	flag.StringVar(&args.Name, "n", "my_contract", "Contract name")
 	flag.StringVar(&args.Output, "o", "", "Output directory")
 	flag.StringVar(&args.File, "f", "", "Path to JSON schema file")
 

cmd/generator/templates/contract.tmpl renamed to cmd/generator/template/contract.tmpl

@@ -13,14 +13,20 @@ import (
 	"github.com/dipdup-net/go-lib/tzkt/events"
 )
 
-
+{{ range $key, $value := .EntrypointTypes }}
+// {{ $value.Type }}Tx - `{{$key}}` transaction entity
+type {{ $value.Type }}Tx struct {
+	*events.Transaction
+	{{ $value.Type }} {{ $value.Type }}
+}
+{{ end }}
 // {{.TypeName}} - struct which implementing contract interaction
 type {{.TypeName}} struct {
 	tzktAPI *api.API
 	tzktEvents *events.TzKT
 
 {{- range $key, $value := .EntrypointTypes }}
-	{{ $value.Var }} chan {{ $value.Type }}
+	{{ $value.Var }} chan {{ $value.Type }}Tx
 {{- end }}
 	wg sync.WaitGroup
 }
@@ -31,7 +37,7 @@ func New(baseURL string) *{{.TypeName}}  {
 		tzktAPI: api.New(baseURL),
 		tzktEvents: events.NewTzKT(fmt.Sprintf("%s/v1/events", baseURL)),
 		{{- range $key, $value := .EntrypointTypes }}
-		{{ $value.Var }}: make(chan {{ $value.Type }}, 1024),
+		{{ $value.Var }}: make(chan {{ $value.Type }}Tx, 1024),
 		{{- end }}
 	}
 }
@@ -64,7 +70,7 @@ func (contract *{{.TypeName}}) Close() error {
 
 {{ range $key, $value := .EntrypointTypes }}
 // {{$value.Type}}Events - listen `{{$key}}` events channel
-func (contract *{{$.TypeName}}) {{$value.Type}}Events() <-chan {{$value.Type}} {
+func (contract *{{$.TypeName}}) {{$value.Type}}Events() <-chan {{ $value.Type }}Tx {
 	return contract.{{$value.Var}}
 }
 {{ end }}
@@ -100,7 +106,9 @@ func (contract *{{.TypeName}}) listen(ctx context.Context) {
 								log.Println(err)
 								continue
 							}
-							contract.{{ $value.Var }} <- data
+							contract.{{ $value.Var }} <- {{ $value.Type }}Tx{
+								tx, data,
+							}
 						{{- end }}
 						}
 					}

cmd/generator/templates/types.tmpl renamed to cmd/generator/template/types.tmpl

@@ -1,6 +1,6 @@
 module github.com/dipdup-net/go-lib
 
-go 1.15
+go 1.16
 
 require (
 	github.com/dave/jennifer v1.4.1