Merge pull request #31 from devimteam/develop

0.5.0

Author: vetcher

Gopkg.lock

@@ -26,4 +26,4 @@
 
 [[constraint]]
   name = "github.com/vetcher/godecl"
-  version = "^0.2.0"
+  version = "^1.0.0"

Gopkg.toml

@@ -8,6 +8,8 @@ The goal is to generate code for service which not fun to write but it should be
 go get -u github.com/devimteam/microgen/cmd/microgen
 ```
 
+Note: If you have problems with building microgen, please, install [dep](https://github.com/golang/dep) and use `dep ensure` command to install correct versions of dependencies ([#29](https://github.com/devimteam/microgen/issues/29)).
+
 ## Usage
 ``` sh
 microgen [OPTIONS]
@@ -33,7 +35,7 @@ Typical syntax is: `// @<tag-name>:`
 
 #### @microgen
 Main tag for microgen tool. Microgen scan file for the first interface which docs contains this tag.  
-To add templates for generation, add their tags, separated by comma after `@microgen:`
+To add templates for generation, add their [tags](#tags), separated by comma after `@microgen:`
 Example:
 ```go
 // @microgen middleware, logging
@@ -82,13 +84,26 @@ type FileService interface {
 }
 ```
 
+#### @logs-len
+This tag is used for logging middleware. It prints length of parameters.
+Example:  
+```go
+// @microgen logging
+type FileService interface {
+    // @logs-ignore data
+    // @logs-len data
+    UploadFile(ctx context.Context, name string, data []byte) (link string, err error)
+}
+```
+
 ### Tags
 All allowed tags for customize generation provided here.
 
 | Tag         | Description                                                                                                                   |
 |:------------|:------------------------------------------------------------------------------------------------------------------------------|
 | middleware  | General application middleware interface. Generates every time.                                                               |
 | logging     | Middleware that writes to logger all request/response information with handled time. Generates every time.                    |
+| recover     | Middleware that recovers panics and writes errors to logger. Generates every time.                                            |
 | grpc-client | Generates client for grpc transport with request/response encoders/decoders. Do not generates again if file exist.            |
 | grpc-server | Generates server for grpc transport with request/response encoders/decoders. Do not generates again if file exist.            |
 | grpc        | Generates client and server for grpc transport with request/response encoders/decoders. Do not generates again if file exist. |
@@ -148,3 +163,22 @@ For correct generation, please, follow rules below.
 * Function names in _protobuf_ should be the same, as in interface.
 * Message names in _protobuf_ should be named `<FunctionName>Request` or `<FunctionName>Response` for request/response message respectively.
 * Field names in _protobuf_ messages should be the same, as in interface methods (_protobuf_ - snake_case, interface - camelCase).
+
+## Dependency
+After generation your service may depend on this packages:
+```
+    "net/http"      // for http purposes
+    "bytes"
+    "encoding/json" // for http purposes
+    "io/ioutil"
+    "strings"
+    "net/url"       // for http purposes
+    "fmt"
+    "context"
+    "time"          // for logging
+
+    "google.golang.org/grpc"                    // for grpc purposes
+    "golang.org/x/net/context"
+    "github.com/go-kit/kit"                     // for grpc purposes
+    "github.com/golang/protobuf/ptypes/empty"   // for grpc purposes
+```

README.md

@@ -12,6 +12,8 @@ import (
 	"github.com/vetcher/godecl/types"
 )
 
+const Version = generator.Version
+
 var (
 	flagFileName  = flag.String("file", "service.go", "Name of file where described interface definition")
 	flagOutputDir = flag.String("out", ".", "Output directory")
@@ -24,6 +26,7 @@ func init() {
 }
 
 func main() {
+	fmt.Println("@microgen", Version)
 	if *flagHelp || *flagFileName == "" {
 		flag.Usage()
 		os.Exit(0)

cmd/microgen/main.go

@@ -6,12 +6,12 @@ import (
 	"github.com/devimteam/microgen/example/svc/entity"
 )
 
-// @microgen middleware, logging, grpc, http
+// @microgen middleware, logging, grpc, http, recover
 // @grpc-addr devim.string.team
 // @protobuf github.com/devimteam/protobuf/stringsvc
 type StringService interface {
 	// @logs-ignore ans, err
-	Uppercase(ctx context.Context, str string) (ans string, err error)
+	Uppercase(ctx context.Context, str ...map[string]interface{}) (ans string, err error)
 	Count(ctx context.Context, text string, symbol string) (count int, positions []int, err error)
 	// @logs-len comments
 	TestCase(ctx context.Context, comments []*entity.Comment) (tree map[string]int, err error)

example/svc/svc.go

@@ -122,6 +122,8 @@ func tagToTemplate(tag string, info *template.GenerationInfo) (tmpls []template.
 			template.NewHttpClientTemplate(info),
 			template.NewHttpConverterTemplate(info),
 		)
+	case "recover":
+		return append(tmpls, template.NewRecoverTemplate(info))
 	}
 	return nil
 }

generator/decide.go

@@ -8,6 +8,8 @@ import (
 	"github.com/devimteam/microgen/generator/write_strategy"
 )
 
+const Version = template.Version
+
 var (
 	EmptyTemplateError = errors.New("empty template")
 	EmptyStrategyError = errors.New("empty strategy")

generator/generator.go

@@ -1,6 +1,8 @@
 package template
 
 import (
+	"strings"
+
 	. "github.com/dave/jennifer/jen"
 	"github.com/devimteam/microgen/util"
 	"github.com/vetcher/godecl/types"
@@ -23,11 +25,13 @@ const (
 	PackagePathStrings            = "strings"
 	PackagePathUrl                = "net/url"
 	PackagePathEmptyProtobuf      = "github.com/golang/protobuf/ptypes/empty"
+	PackagePathFmt                = "fmt"
 
 	TagMark  = "// @"
 	ForceTag = "force"
 
-	FileHeader = `This file was automatically generated by "microgen" utility.`
+	Version    = "0.5.0"
+	FileHeader = `This file was automatically generated by "microgen ` + Version + `" utility.`
 )
 
 type WriteStrategyState int
@@ -76,10 +80,11 @@ func removeContextIfFirst(fields []types.Variable) []types.Variable {
 }
 
 func IsContextFirst(fields []types.Variable) bool {
-	return len(fields) > 0 &&
-		fields[0].Type.Import != nil &&
-		fields[0].Type.Import.Package == PackagePathContext &&
-		fields[0].Type.Name == "Context"
+	name := types.TypeName(fields[0].Type)
+	return name != nil && len(fields) > 0 &&
+		types.TypeImport(fields[0].Type) != nil &&
+		types.TypeImport(fields[0].Type).Package == PackagePathContext &&
+		*name == "Context"
 }
 
 // Remove from function fields error if it is last in slice
@@ -91,9 +96,10 @@ func removeErrorIfLast(fields []types.Variable) []types.Variable {
 }
 
 func IsErrorLast(fields []types.Variable) bool {
-	return len(fields) > 0 &&
-		fields[len(fields)-1].Type.Import == nil &&
-		fields[len(fields)-1].Type.Name == "error"
+	name := types.TypeName(fields[len(fields)-1].Type)
+	return name != nil && len(fields) > 0 &&
+		types.TypeImport(fields[len(fields)-1].Type) == nil &&
+		*name == "error"
 }
 
 // Return name of error, if error is last result, else return `err`
@@ -110,8 +116,11 @@ func nameOfLastResultError(fn *types.Function) string {
 //
 func structField(field *types.Variable) *Statement {
 	s := structFieldName(field)
-	s.Add(fieldType(&field.Type))
+	s.Add(fieldType(field.Type, false))
 	s.Tag(map[string]string{"json": util.ToSnakeCase(field.Name)})
+	if types.IsEllipsis(field.Type) {
+		s.Comment("This field was defined with ellipsis (...).")
+	}
 	return s
 }
 
@@ -123,7 +132,7 @@ func funcDefinitionParams(fields []types.Variable) *Statement {
 	c := &Statement{}
 	c.ListFunc(func(g *Group) {
 		for _, field := range fields {
-			g.Id(util.ToLowerFirst(field.Name)).Add(fieldType(&field.Type))
+			g.Id(util.ToLowerFirst(field.Name)).Add(fieldType(field.Type, true))
 		}
 	})
 	return c
@@ -133,26 +142,52 @@ func funcDefinitionParams(fields []types.Variable) *Statement {
 //
 //  	*repository.Visit
 //
-func fieldType(field *types.Type) *Statement {
+func fieldType(field types.Type, useEllipsis bool) *Statement {
 	c := &Statement{}
-	if field.IsArray {
-		c.Index()
+	for field != nil {
+		switch f := field.(type) {
+		case types.TImport:
+			if f.Import != nil {
+				c.Qual(f.Import.Package, "")
+			}
+			field = f.Next
+		case types.TName:
+			c.Id(f.TypeName)
+			field = nil
+		case types.TArray:
+			if f.IsSlice {
+				c.Index()
+			} else if f.ArrayLen > 0 {
+				c.Index(Lit(f.ArrayLen))
+			}
+			field = f.Next
+		case types.TMap:
+			return c.Map(fieldType(f.Key, false)).Add(fieldType(f.Value, false))
+		case types.TPointer:
+			c.Op(strings.Repeat("*", f.NumberOfPointers))
+			field = f.Next
+		case types.TInterface:
+			mhds := interfaceType(f.Interface)
+			return c.Interface(mhds...)
+		case types.TEllipsis:
+			if useEllipsis {
+				c.Op("...")
+			} else {
+				c.Index()
+			}
+			field = f.Next
+		default:
+			return c
+		}
 	}
+	return c
+}
 
-	if field.IsPointer {
-		c.Op("*")
-	}
-	if field.IsMap {
-		m := field.Map
-		return c.Map(fieldType(&m.Key)).Add(fieldType(&m.Value))
+func interfaceType(p *types.Interface) (code []Code) {
+	for _, x := range p.Methods {
+		code = append(code, functionDefinition(x))
 	}
-	if field.Import != nil {
-		c.Qual(field.Import.Package, field.Name)
-	} else {
-		c.Id(field.Name)
-	}
-
-	return c
+	return
 }
 
 // Renders key/value pairs wrapped in Dict for provided fields.
@@ -175,7 +210,11 @@ func dictByVariables(fields []types.Variable) Dict {
 func paramNames(fields []types.Variable) *Statement {
 	var list []Code
 	for _, field := range fields {
-		list = append(list, Id(util.ToLowerFirst(field.Name)))
+		v := Id(util.ToLowerFirst(field.Name))
+		if types.IsEllipsis(field.Type) {
+			v.Op("...")
+		}
+		list = append(list, v)
 	}
 	return List(list...)
 }
@@ -187,7 +226,15 @@ func paramNames(fields []types.Variable) *Statement {
 func methodDefinition(obj string, signature *types.Function) *Statement {
 	return Func().
 		Params(Id(util.LastUpperOrFirst(obj)).Op("*").Id(obj)).
-		Id(signature.Name).
+		Add(functionDefinition(signature))
+}
+
+// Render full method definition with receiver, method name, args and results.
+//
+//		func Count(ctx context.Context, text string, symbol string) (count int)
+//
+func functionDefinition(signature *types.Function) *Statement {
+	return Id(signature.Name).
 		Params(funcDefinitionParams(signature.Args)).
 		Params(funcDefinitionParams(signature.Results))
 }

generator/template/common.go

@@ -189,7 +189,11 @@ func createEndpointBody(signature *types.Function) *Statement {
 			CallFunc(func(g *Group) {
 				g.Add(Id(firstArgName(signature)))
 				for _, field := range methodParams {
-					g.Add(Id("_req").Dot(util.ToUpperFirst(field.Name)))
+					v := Dot(util.ToUpperFirst(field.Name))
+					if types.IsEllipsis(field.Type) {
+						v.Op("...")
+					}
+					g.Add(Id("_req").Add(v))
 				}
 			}))