add fiber web framework support

README.md

@@ -4,7 +4,7 @@
 [![GoDoc](https://godoc.org/github.com/alimy/mir?status.svg)](https://pkg.go.dev/github.com/alimy/mir/v2)
 [![sourcegraph](https://img.shields.io/badge/view%20on-Sourcegraph-brightgreen.svg?logo=sourcegraph)](https://sourcegraph.com/github.com/alimy/mir)
 
-Mir is used for register handler to http router(eg: [Gin](https://github.com/gin-gonic/gin), [Chi](https://github.com/go-chi/chi), [Echo](https://github.com/labstack/echo), [Iris](https://github.com/kataras/iris), [Macaron](https://github.com/go-macaron/macaron), [Mux](https://github.com/gorilla/mux), [httprouter](https://github.com/julienschmidt/httprouter))
+Mir is used for register handler to http router(eg: [Gin](https://github.com/gin-gonic/gin), [Chi](https://github.com/go-chi/chi), [Echo](https://github.com/labstack/echo), [Iris](https://github.com/kataras/iris), [Fiber](https://github.com/gofiber/fiber), [Macaron](https://github.com/go-macaron/macaron), [Mux](https://github.com/gorilla/mux), [httprouter](https://github.com/julienschmidt/httprouter))
  depends on struct tag string info that defined in logic object's struct type field.
 
  ### Usage
@@ -13,7 +13,7 @@ Mir is used for register handler to http router(eg: [Gin](https://github.com/gin
 
  ```
 % go get github.com/alimy/mir/mirc/v2@latest
-% mirc new -d mir-examples
+% mirc new -d mir-examples -t gin
 % tree mir-examples
 mir-examples
 ├── Makefile

core/core.go

@@ -22,6 +22,7 @@ const (
 	GeneratorMux        = "mux"
 	GeneratorEcho       = "echo"
 	GeneratorIris       = "iris"
+	GeneratorFiber      = "fiber"
 	GeneratorMacaron    = "macaron"
 	GeneratorHttpRouter = "httprouter"
 
@@ -50,12 +51,14 @@ type InitOpts struct {
 	ParserName    string
 	SinkPath      string
 	DefaultTag    string
+	NoneQuery     bool
 	Cleanup       bool
 }
 
 // ParserOpts used for initial parser
 type ParserOpts struct {
 	DefaultTag string
+	NoneQuery  bool
 }
 
 // GeneratorOpts used for initial generator
@@ -85,6 +88,7 @@ func (opts Options) InitOpts() *InitOpts {
 func (opts *InitOpts) ParserOpts() *ParserOpts {
 	return &ParserOpts{
 		DefaultTag: opts.DefaultTag,
+		NoneQuery:  opts.NoneQuery,
 	}
 }
 
@@ -183,6 +187,13 @@ func Cleanup(enable bool) Option {
 	})
 }
 
+// NoneQuery set parser whether parse query
+func NoneQuery(enable bool) Option {
+	return optFunc(func(opts *InitOpts) {
+		opts.NoneQuery = enable
+	})
+}
+
 // DefaultTag set parser's default struct field tag string key
 func DefaultTag(tag string) Option {
 	return optFunc(func(opts *InitOpts) {

internal/generator/generator.go

@@ -27,6 +27,7 @@ func init() {
 		&mirGenerator{name: core.GeneratorMux},
 		&mirGenerator{name: core.GeneratorEcho},
 		&mirGenerator{name: core.GeneratorIris},
+		&mirGenerator{name: core.GeneratorFiber},
 		&mirGenerator{name: core.GeneratorMacaron},
 		&mirGenerator{name: core.GeneratorHttpRouter},
 	)

internal/generator/templates.go

@@ -15,6 +15,7 @@ var tmplFiles = map[string]string{
 	core.GeneratorMux:        "mux_iface.tmpl",
 	core.GeneratorEcho:       "echo_iface.tmpl",
 	core.GeneratorIris:       "iris_iface.tmpl",
+	core.GeneratorFiber:      "fiber_iface.tmpl",
 	core.GeneratorMacaron:    "macaron_iface.tmpl",
 	core.GeneratorHttpRouter: "httprouter_iface.tmpl",
 }

internal/generator/templates/fiber_iface.tmpl

@@ -0,0 +1,28 @@
+// Code generated by go-mir. DO NOT EDIT.
+
+package {{ .PkgName }}
+
+import (
+    "github.com/gofiber/fiber"
+)
+
+{{if notEmptyStr .Comment }}// {{.Comment}}{{end}}
+type {{.TypeName}} interface {
+{{if notEmptyStr .Chain }}// Chain provide handlers chain for fiber
+    {{.Chain}}() []func(*Ctx)
+{{end}}
+{{range .Fields}}{{if notEmptyStr .Comment }}    // {{.Comment}}
+    {{.MethodName}}(c *fiber.Ctx){{else}}    {{.MethodName}}(c *fiber.Ctx){{end}}
+{{end}}
+}
+
+// Register{{.TypeName}}Servant register {{.TypeName}} servant to fiber
+func Register{{.TypeName}}Servant(app *fiber.App, s {{.TypeName}}) {
+{{if notEmptyStr .Group }}    router := app.Group("{{.Group}}"){{else}}    router := app{{end}}
+{{if notEmptyStr .Chain }}    // use chain for router
+    middlewares := s.{{.Chain}}()
+    router.Use(middlewares...)
+{{end}}
+    // register routes info to router
+{{range .Fields}}{{if eq .HttpMethod "GET" }}    router.Get("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "POST"}}    router.Post("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "PUT"}}    router.Put("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "DELETE"}}    router.Delete("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "HEAD"}}    router.Head("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "OPTIONS"}}    router.Options("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "TRACE"}}    router.Trace("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "PATCH"}}    router.Patch("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "CONNECT"}}    router.Connect("{{.Path}}", s.{{.MethodName}}){{else if eq .HttpMethod "ANY" }}    router.All("{{.Path}}", s.{{.MethodName}}){{end}}
+{{end}}}

internal/parser/fields.go

@@ -112,9 +112,10 @@ func (r *reflex) tagInfoFrom(field reflect.StructField) (*tagInfo, error) {
 	if len(tag) == 0 && !info.isGroup {
 		return nil, errNoPathInfo
 	}
-	i = 0
-	for i < len(tag) && tag[i] != '?' && tag[i] != '#' {
-		i++
+	for i = 0; i < len(tag) && tag[i] != '#'; i++ {
+		if !r.noneQuery && tag[i] == '?' {
+			break
+		}
 	}
 	info.Path = tag[0:i]
 	tag = tag[i:]

internal/parser/parser.go

@@ -10,7 +10,6 @@ import (
 
 	"github.com/alimy/mir/v2/core"
 	"github.com/alimy/mir/v2/internal/container"
-	"github.com/alimy/mir/v2/internal/naming"
 )
 
 func init() {
@@ -19,7 +18,8 @@ func init() {
 
 // mirParser parse for struct tag
 type mirParser struct {
-	tagName string
+	tagName   string
+	noneQuery bool
 }
 
 // Name name of parser
@@ -32,7 +32,7 @@ func (p *mirParser) Init(opts *core.ParserOpts) error {
 	if opts == nil {
 		return errors.New("init opts is nil")
 	}
-	p.tagName = opts.DefaultTag
+	p.tagName, p.noneQuery = opts.DefaultTag, opts.NoneQuery
 	if p.tagName == "" {
 		p.tagName = defaultTag
 	}
@@ -44,7 +44,7 @@ func (p *mirParser) Parse(entries []interface{}) (core.Descriptors, error) {
 	if len(entries) == 0 {
 		return nil, errors.New("entries is empty")
 	}
-	r := &reflex{tagName: p.tagName, ns: naming.NewSnakeNamingStrategy()}
+	r := newReflex(p.tagName, p.noneQuery)
 	return r.parse(entries)
 }
 
@@ -56,10 +56,10 @@ func (p *mirParser) ParseContext(ctx core.MirCtx, entries []interface{}) {
 	wg := &sync.WaitGroup{}
 	for _, entry := range entries {
 		wg.Add(1)
-		go func(ctx core.MirCtx, wg *sync.WaitGroup, ifaceSink chan<- *core.IfaceDescriptor, tagName string, entry interface{}) {
+		go func(ctx core.MirCtx, wg *sync.WaitGroup, ifaceSink chan<- *core.IfaceDescriptor, entry interface{}) {
 			defer wg.Done()
 
-			r := &reflex{tagName: tagName}
+			r := newReflex(p.tagName, p.noneQuery)
 			iface, err := r.ifaceFrom(entry)
 			if err != nil {
 				ctx.Cancel(err)
@@ -72,7 +72,7 @@ func (p *mirParser) ParseContext(ctx core.MirCtx, entries []interface{}) {
 			}
 			ifaceSink <- iface
 			core.Logus("delivered iface: %s.%s", iface.PkgName, iface.TypeName)
-		}(ctx, wg, ifaceSink, p.tagName, entry)
+		}(ctx, wg, ifaceSink, entry)
 	}
 	wg.Wait()
 

internal/parser/reflex.go

@@ -14,8 +14,9 @@ import (
 
 // reflex real parser
 type reflex struct {
-	ns      naming.NamingStrategy
-	tagName string
+	ns        naming.NamingStrategy
+	tagName   string
+	noneQuery bool
 }
 
 // reflex get Descriptors from parse entries
@@ -134,3 +135,11 @@ func (r *reflex) fieldFrom(t *tagInfo) *core.FieldDescriptor {
 		MethodName: t.fieldName,
 	}
 }
+
+func newReflex(tagName string, noneQuery bool) *reflex {
+	return &reflex{
+		ns:        naming.NewSnakeNamingStrategy(),
+		tagName:   tagName,
+		noneQuery: noneQuery,
+	}
+}

mirc/.gitignore

@@ -6,3 +6,4 @@
 /macaron
 /echo
 /iris
+/fiber

mirc/cmd/new.go

@@ -30,7 +30,7 @@ func init() {
 	// parse flags for agentCmd
 	newCmd.Flags().StringVarP(&dstPath, "dst", "d", ".", "genereted destination target directory")
 	newCmd.Flags().StringVarP(&pkgName, "pkg", "p", "github.com/alimy/mir-example", "project's package name")
-	newCmd.Flags().StringVarP(&style, "type", "t", "gin", "generated engine type style eg: gin,chi,mux,echo,iris,macaron,httprouter")
+	newCmd.Flags().StringVarP(&style, "type", "t", "gin", "generated engine type style eg: gin,chi,mux,echo,iris,fiber,macaron,httprouter")
 
 	// register agentCmd as sub-command
 	register(newCmd)

mirc/cmd/templates.go

@@ -69,6 +69,16 @@ var tmplFiles = map[string]map[string]tmplInfo{
 		"mirc/routes/v1/site.go": {"iris_mirc_routes_site_v1.tmpl", false},
 		"mirc/routes/v2/site.go": {"iris_mirc_routes_site_v2.tmpl", false},
 	},
+	"fiber": {
+		"Makefile":               {"makefile.tmpl", false},
+		"README.md":              {"readme.tmpl", false},
+		"go.mod":                 {"fiber_go_mod.tmpl", true},
+		"main.go":                {"fiber_main.tmpl", false},
+		"mirc/main.go":           {"fiber_mirc_main.tmpl", true},
+		"mirc/routes/site.go":    {"fiber_mirc_routes_site.tmpl", false},
+		"mirc/routes/v1/site.go": {"fiber_mirc_routes_site_v1.tmpl", false},
+		"mirc/routes/v2/site.go": {"fiber_mirc_routes_site_v2.tmpl", false},
+	},
 	"macaron": {
 		"Makefile":               {"makefile.tmpl", false},
 		"README.md":              {"readme.tmpl", false},

mirc/cmd/templates/chi_go_mod.tmpl

@@ -3,6 +3,6 @@ module {{ .PkgName }}
 go 1.12
 
 require (
-    github.com/alimy/mir/v2 v2.3.2
+    github.com/alimy/mir/v2 v2.4.0
     github.com/go-chi/chi v4.0.3+incompatible
 )

mirc/cmd/templates/echo_go_mod.tmpl

@@ -3,6 +3,6 @@ module {{ .PkgName }}
 go 1.12
 
 require (
-    github.com/alimy/mir/v2 v2.3.2
+    github.com/alimy/mir/v2 v2.4.0
     github.com/labstack/echo/v4 v4.1.15
 )

mirc/cmd/templates/fiber_go_mod.tmpl

@@ -0,0 +1,8 @@
+module {{ .PkgName }}
+
+go 1.12
+
+require (
+    github.com/alimy/mir/v2 v2.4.0
+    github.com/gofiber/fiber v1.8.431
+)

mirc/cmd/templates/fiber_main.tmpl

@@ -0,0 +1,23 @@
+package main
+
+import (
+    "log"
+
+    "github.com/gofiber/fiber"
+)
+
+func main() {
+    app := fiber.New()
+
+    // register servants to fiber
+    registerServants(app)
+
+    // start servant service
+    if err := app.Listen(3000); err != nil {
+        log.Fatal(err)
+    }
+}
+
+func registerServants(app *fiber.App) {
+    // TODO: register routes to app
+}

mirc/cmd/templates/fiber_mirc_main.tmpl

@@ -0,0 +1,27 @@
+package main
+
+import (
+    "log"
+
+    "github.com/alimy/mir/v2/core"
+    "github.com/alimy/mir/v2/engine"
+
+    _ "{{ .PkgName }}/mirc/routes"
+    _ "{{ .PkgName }}/mirc/routes/v1"
+    _ "{{ .PkgName }}/mirc/routes/v2"
+)
+
+//go:generate go run main.go
+func main() {
+    log.Println("generate code start")
+    opts := core.Options{
+        core.RunMode(core.InSerialMode),
+        core.GeneratorName(core.GeneratorFiber),
+        core.NoneQuery(true),
+        core.SinkPath("./gen"),
+    }
+    if err := engine.Generate(opts); err != nil {
+        log.Fatal(err)
+    }
+    log.Println("generate code finish")
+}

mirc/cmd/templates/fiber_mirc_routes_site.tmpl

@@ -0,0 +1,17 @@
+package routes
+
+import (
+    "github.com/alimy/mir/v2"
+    "github.com/alimy/mir/v2/engine"
+)
+
+func init() {
+    engine.AddEntry(new(Site))
+}
+
+// Site site interface info
+type Site struct {
+    Chain    mir.Chain `mir:"-"`
+    Index    mir.Get   `mir:"/index/"`
+    Articles mir.Get   `mir:"/articles/:category/"`
+}

mirc/cmd/templates/fiber_mirc_routes_site_v1.tmpl

@@ -0,0 +1,18 @@
+package v1
+
+import (
+    "github.com/alimy/mir/v2"
+    "github.com/alimy/mir/v2/engine"
+)
+
+func init() {
+    engine.AddEntry(new(Site))
+}
+
+// Site site v1 interface info
+type Site struct {
+    Chain    mir.Chain `mir:"-"`
+    Group    mir.Group `mir:"v1"`
+    Index    mir.Get   `mir:"/index/"`
+    Articles mir.Get   `mir:"/articles/:category/"`
+}