vinchent/gin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #348 from WnP/master

Browse Source 
Exporting routesInterface
This commit is contained in:
Manu Mtz.-Almeida
2015-06-26 15:27:51 +02:00
parent 95c08d5f84 4238c5b83d
commit 88a65eacff
3 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
gin.go
View File

@ -157,7 +157,7 @@ func (engine *Engine) NoMethod(handlers ...HandlerFunc) {
// Attachs a global middleware to the router. ie. the middlewares attached though Use() will be // Attachs a global middleware to the router. ie. the middlewares attached though Use() will be
// included in the handlers chain for every single request. Even 404, 405, static files... // included in the handlers chain for every single request. Even 404, 405, static files...
// For example, this is the right place for a logger or error management middleware. // For example, this is the right place for a logger or error management middleware.
func (engine *Engine) Use(middlewares ...HandlerFunc) routesInterface { func (engine *Engine) Use(middlewares ...HandlerFunc) RoutesInterface {
engine.RouterGroup.Use(middlewares...) engine.RouterGroup.Use(middlewares...)
engine.rebuild404Handlers() engine.rebuild404Handlers()
engine.rebuild405Handlers() engine.rebuild405Handlers()

58
routergroup.go
View File

@ -11,22 +11,22 @@ import (
"strings" "strings"
) )
type routesInterface interface { type RoutesInterface interface {
Use(...HandlerFunc) routesInterface Use(...HandlerFunc) RoutesInterface
Handle(string, string, ...HandlerFunc) routesInterface Handle(string, string, ...HandlerFunc) RoutesInterface
Any(string, ...HandlerFunc) routesInterface Any(string, ...HandlerFunc) RoutesInterface
GET(string, ...HandlerFunc) routesInterface GET(string, ...HandlerFunc) RoutesInterface
POST(string, ...HandlerFunc) routesInterface POST(string, ...HandlerFunc) RoutesInterface
DELETE(string, ...HandlerFunc) routesInterface DELETE(string, ...HandlerFunc) RoutesInterface
PATCH(string, ...HandlerFunc) routesInterface PATCH(string, ...HandlerFunc) RoutesInterface
PUT(string, ...HandlerFunc) routesInterface PUT(string, ...HandlerFunc) RoutesInterface
OPTIONS(string, ...HandlerFunc) routesInterface OPTIONS(string, ...HandlerFunc) RoutesInterface
HEAD(string, ...HandlerFunc) routesInterface HEAD(string, ...HandlerFunc) RoutesInterface
StaticFile(string, string) routesInterface StaticFile(string, string) RoutesInterface
Static(string, string) routesInterface Static(string, string) RoutesInterface
StaticFS(string, http.FileSystem) routesInterface StaticFS(string, http.FileSystem) RoutesInterface
} }
// Used internally to configure router, a RouterGroup is associated with a prefix // Used internally to configure router, a RouterGroup is associated with a prefix
@ -39,7 +39,7 @@ type RouterGroup struct {
} }
// Adds middlewares to the group, see example code in github. // Adds middlewares to the group, see example code in github.
func (group *RouterGroup) Use(middlewares ...HandlerFunc) routesInterface { func (group *RouterGroup) Use(middlewares ...HandlerFunc) RoutesInterface {
group.Handlers = append(group.Handlers, middlewares...) group.Handlers = append(group.Handlers, middlewares...)
return group.returnObj() return group.returnObj()
} }
@ -64,14 +64,14 @@ func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *R
// This function is intended for bulk loading and to allow the usage of less // This function is intended for bulk loading and to allow the usage of less
// frequently used, non-standardized or custom methods (e.g. for internal // frequently used, non-standardized or custom methods (e.g. for internal
// communication with a proxy). // communication with a proxy).
func (group *RouterGroup) handle(httpMethod, relativePath string, handlers HandlersChain) routesInterface { func (group *RouterGroup) handle(httpMethod, relativePath string, handlers HandlersChain) RoutesInterface {
absolutePath := group.calculateAbsolutePath(relativePath) absolutePath := group.calculateAbsolutePath(relativePath)
handlers = group.combineHandlers(handlers) handlers = group.combineHandlers(handlers)
group.engine.addRoute(httpMethod, absolutePath, handlers) group.engine.addRoute(httpMethod, absolutePath, handlers)
return group.returnObj() return group.returnObj()
} }
func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) RoutesInterface {
if matches, err := regexp.MatchString("^[A-Z]+$", httpMethod); !matches || err != nil { if matches, err := regexp.MatchString("^[A-Z]+$", httpMethod); !matches || err != nil {
panic("http method " + httpMethod + " is not valid") panic("http method " + httpMethod + " is not valid")
} }
@ -79,41 +79,41 @@ func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...Ha
} }
// POST is a shortcut for router.Handle("POST", path, handle) // POST is a shortcut for router.Handle("POST", path, handle)
func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) RoutesInterface {
return group.handle("POST", relativePath, handlers) return group.handle("POST", relativePath, handlers)
} }
// GET is a shortcut for router.Handle("GET", path, handle) // GET is a shortcut for router.Handle("GET", path, handle)
func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) RoutesInterface {
return group.handle("GET", relativePath, handlers) return group.handle("GET", relativePath, handlers)
} }
// DELETE is a shortcut for router.Handle("DELETE", path, handle) // DELETE is a shortcut for router.Handle("DELETE", path, handle)
func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) RoutesInterface {
return group.handle("DELETE", relativePath, handlers) return group.handle("DELETE", relativePath, handlers)
} }
// PATCH is a shortcut for router.Handle("PATCH", path, handle) // PATCH is a shortcut for router.Handle("PATCH", path, handle)
func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) RoutesInterface {
return group.handle("PATCH", relativePath, handlers) return group.handle("PATCH", relativePath, handlers)
} }
// PUT is a shortcut for router.Handle("PUT", path, handle) // PUT is a shortcut for router.Handle("PUT", path, handle)
func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) RoutesInterface {
return group.handle("PUT", relativePath, handlers) return group.handle("PUT", relativePath, handlers)
} }
// OPTIONS is a shortcut for router.Handle("OPTIONS", path, handle) // OPTIONS is a shortcut for router.Handle("OPTIONS", path, handle)
func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) RoutesInterface {
return group.handle("OPTIONS", relativePath, handlers) return group.handle("OPTIONS", relativePath, handlers)
} }
// HEAD is a shortcut for router.Handle("HEAD", path, handle) // HEAD is a shortcut for router.Handle("HEAD", path, handle)
func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) RoutesInterface {
return group.handle("HEAD", relativePath, handlers) return group.handle("HEAD", relativePath, handlers)
} }
func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) routesInterface { func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) RoutesInterface {
// GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE, CONNECT, TRACE // GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE, CONNECT, TRACE
group.handle("GET", relativePath, handlers) group.handle("GET", relativePath, handlers)
group.handle("POST", relativePath, handlers) group.handle("POST", relativePath, handlers)
@ -127,7 +127,7 @@ func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) rout
return group.returnObj() return group.returnObj()
} }
func (group *RouterGroup) StaticFile(relativePath, filepath string) routesInterface { func (group *RouterGroup) StaticFile(relativePath, filepath string) RoutesInterface {
if strings.Contains(relativePath, ":") || strings.Contains(relativePath, "*") { if strings.Contains(relativePath, ":") || strings.Contains(relativePath, "*") {
panic("URL parameters can not be used when serving a static file") panic("URL parameters can not be used when serving a static file")
} }
@ -145,11 +145,11 @@ func (group *RouterGroup) StaticFile(relativePath, filepath string) routesInterf
// To use the operating system's file system implementation, // To use the operating system's file system implementation,
// use : // use :
// router.Static("/static", "/var/www") // router.Static("/static", "/var/www")
func (group *RouterGroup) Static(relativePath, root string) routesInterface { func (group *RouterGroup) Static(relativePath, root string) RoutesInterface {
return group.StaticFS(relativePath, Dir(root, false)) return group.StaticFS(relativePath, Dir(root, false))
} }
func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) routesInterface { func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) RoutesInterface {
if strings.Contains(relativePath, ":") || strings.Contains(relativePath, "*") { if strings.Contains(relativePath, ":") || strings.Contains(relativePath, "*") {
panic("URL parameters can not be used when serving a static folder") panic("URL parameters can not be used when serving a static folder")
} }
@ -189,7 +189,7 @@ func (group *RouterGroup) calculateAbsolutePath(relativePath string) string {
return joinPaths(group.BasePath, relativePath) return joinPaths(group.BasePath, relativePath)
} }
func (group *RouterGroup) returnObj() routesInterface { func (group *RouterGroup) returnObj() RoutesInterface {
if group.root { if group.root {
return group.engine return group.engine
} else { } else {

2
routergroup_test.go
View File

@ -157,7 +157,7 @@ func TestRouterGroupPipeline(t *testing.T) {
testRoutesInterface(t, v1) testRoutesInterface(t, v1)
} }
func testRoutesInterface(t *testing.T, r routesInterface) { func testRoutesInterface(t *testing.T, r RoutesInterface) {
handler := func(c *Context) {} handler := func(c *Context) {}
assert.Equal(t, r, r.Use(handler)) assert.Equal(t, r, r.Use(handler))