Added a Print function on router that prints out a stylized list of

routes, aka rake routes from Ruby on Rails

Author: markbates

router.go

@@ -1,6 +1,10 @@
 package echo
 
-import "net/http"
+import (
+	"fmt"
+	"io"
+	"net/http"
+)
 
 type (
 	router struct {
@@ -315,3 +319,61 @@ func (r *router) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	h(c)
 	r.echo.pool.Put(c)
 }
+
+/*
+Print writes out a formatted listing of paths corresponding to each
+HTTP method that has been added to the router.
+
+Example output:
+GET	/foo
+	/foo/:id
+	/bar/baz/:id
+	/:controller/:action/:id
+	/api/v1/users/:id
+	/api/v1/users/:id/edit
+POST	/api/v1/users/:id
+PUT	/foo
+*/
+func (r *router) Print(out io.Writer) {
+	for verb, node := range r.trees {
+		x := node.Paths()
+		if len(x) > 0 {
+			fmt.Fprintf(out, "%s\t%s\n", verb, x[0])
+			for _, n := range x[1:] {
+				fmt.Fprintf(out, "\t%s\n", n)
+			}
+		}
+	}
+}
+
+/*
+Paths generates a list of all of the paths, and subpaths, for a particular node.
+
+Example output:
+[]string{"/:controller/:action/:id", "/api/v1/users/:id", "/api/v1/users/:id/edit", "/bar/baz/:id", "/foo", "/foo/:id"}
+*/
+func (n *node) Paths() []string {
+	prefix := n.prefix
+	x := []string{}
+	if prefix != "" {
+		pl := len(n.pnames)
+		if pl > 0 && prefix == ":" {
+			prefix = prefix + n.pnames[pl-1]
+		}
+		children := n.children
+		if len(children) > 0 {
+			if n.handler != nil {
+				x = append(x, prefix)
+			}
+			for _, c := range children {
+				y := c.Paths()
+				for _, s := range y {
+					x = append(x, prefix+s)
+				}
+			}
+		} else {
+			x = append(x, prefix)
+		}
+	}
+	return x
+}

router_test.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"net/http"
 	"net/http/httptest"
+	"sort"
+	"strings"
 	"testing"
 )
 
@@ -634,6 +636,81 @@ func TestRouterServeHTTP(t *testing.T) {
 	r.ServeHTTP(w, req)
 }
 
+func TestPaths(t *testing.T) {
+	e := New()
+
+	e.Get("/foo", func(res http.ResponseWriter, req *http.Request) {})
+	e.Put("/foo", func(res http.ResponseWriter, req *http.Request) {})
+	e.Get("/foo/:id", func(res http.ResponseWriter, req *http.Request) {})
+	e.Get("/bar/baz/:id", func(res http.ResponseWriter, req *http.Request) {})
+	e.Get("/:controller/:action/:id", func(res http.ResponseWriter, req *http.Request) {})
+
+	g := e.Group("/api/v1")
+	g.Get("/users/:id", func(res http.ResponseWriter, req *http.Request) {})
+	g.Get("/users/:id/edit", func(res http.ResponseWriter, req *http.Request) {})
+	g.Post("/users/:id", func(res http.ResponseWriter, req *http.Request) {})
+
+	trees := e.Router.trees
+
+	exm := map[string][]string{
+		"GET":  []string{"/:controller/:action/:id", "/api/v1/users/:id", "/api/v1/users/:id/edit", "/bar/baz/:id", "/foo", "/foo/:id"},
+		"PUT":  []string{"/foo"},
+		"POST": []string{"/api/v1/users/:id"},
+	}
+
+	for verb, exp := range exm {
+		paths := trees[verb].Paths()
+		sort.Strings(paths)
+
+		for _, e := range exp {
+			found := false
+			for _, p := range paths {
+				if p == e {
+					found = true
+					break
+				}
+			}
+			if !found {
+				t.Errorf("expected %q to contain %s", paths, e)
+			}
+		}
+	}
+
+}
+
+func TestPrint(t *testing.T) {
+	e := New()
+
+	e.Get("/foo", func(res http.ResponseWriter, req *http.Request) {})
+	e.Put("/foo", func(res http.ResponseWriter, req *http.Request) {})
+	e.Get("/foo/:id", func(res http.ResponseWriter, req *http.Request) {})
+	e.Get("/bar/baz/:id", func(res http.ResponseWriter, req *http.Request) {})
+	e.Get("/:controller/:action/:id", func(res http.ResponseWriter, req *http.Request) {})
+
+	g := e.Group("/api/v1")
+	g.Get("/users/:id", func(res http.ResponseWriter, req *http.Request) {})
+	g.Get("/users/:id/edit", func(res http.ResponseWriter, req *http.Request) {})
+	g.Post("/users/:id", func(res http.ResponseWriter, req *http.Request) {})
+
+	var b bytes.Buffer
+	e.Router.Print(&b)
+	get := `GET	/foo
+	/foo/:id
+	/bar/baz/:id
+	/:controller/:action/:id
+	/api/v1/users/:id
+	/api/v1/users/:id/edit`
+	post := `POST	/api/v1/users/:id`
+	put := `PUT	/foo`
+
+	res := b.String()
+	for _, exp := range []string{get, post, put} {
+		if !strings.Contains(res, exp) {
+			t.Errorf("expected %q to contain %q", res, exp)
+		}
+	}
+}
+
 func (n *node) printTree(pfx string, tail bool) {
 	p := prefix(tail, pfx, "└── ", "├── ")
 	fmt.Printf("%s%s, %p: type=%d, parent=%p, handler=%v\n", p, n.prefix, n, n.typ, n.parent, n.handler)