feat: make resources tree traverseable (#4)

* Some internal fields are now public
* Also a function Tree has been added to boxutil package
* Upgrade travis to pass tests until go 1.13

Author: fulldump

.travis.yml

@@ -3,6 +3,9 @@ go:
   - "1.8"
   - "1.9"
   - "1.10"
+  - "1.11"
+  - "1.12"
+  - "1.13"
 
 script:
  - make setup && make test

action.go

@@ -7,11 +7,17 @@ type A struct {
 	Attr
 	HttpMethod string
 
-	name         string
-	bound        bool
-	resource     *R
-	handler      interface{}
-	interceptors []I
+	// Name is the name to identify the action AND the invocation to url suffix
+	Name string
+
+	// Bound is true if this action is not an extended action
+	Bound bool
+
+	// Interceptors is the list of actions that will be executed before executing handler
+	Interceptors []I
+
+	resource *R
+	handler  interface{}
 }
 
 func Action(handler interface{}) *A {
@@ -22,7 +28,7 @@ func Action(handler interface{}) *A {
 		HttpMethod:   "GET",
 		Attr:         Attr{},
 		handler:      handler,
-		interceptors: []I{},
+		Interceptors: []I{},
 	}
 }
 
@@ -32,13 +38,13 @@ func ActionPost(handler interface{}) *A {
 		HttpMethod:   "POST",
 		Attr:         Attr{},
 		handler:      handler,
-		interceptors: []I{},
+		Interceptors: []I{},
 	}
 }
 
 func actionBound(handler interface{}, method string) *A {
 	a := Action(handler)
-	a.bound = true
+	a.Bound = true
 	a.HttpMethod = method
 	return a
 }
@@ -74,13 +80,13 @@ func Trace(handler interface{}) *A {
 
 // WithName overwrite default action name
 func (a *A) WithName(name string) *A {
-	a.name = name
+	a.Name = name
 	return a
 }
 
 func (a *A) Bind(method string) *A {
 	a.HttpMethod = method
-	a.bound = true
+	a.Bound = true
 	return a
 }
 
@@ -92,7 +98,7 @@ func (a *A) WithAttribute(key string, value interface{}) *A {
 func (a *A) WithInterceptors(interceptor ...I) *A {
 
 	for _, i := range interceptor {
-		a.interceptors = append(a.interceptors, i)
+		a.Interceptors = append(a.Interceptors, i)
 	}
 
 	return a

boxutil/tree.go

@@ -0,0 +1,97 @@
+package boxutil
+
+import (
+	"box"
+	"fmt"
+	"reflect"
+	"runtime"
+	"sort"
+	"strings"
+)
+
+// Tree return a string representation of resources hierarchy
+func Tree(root *box.R) (s string) {
+
+	traverse(root, func(r *box.R) {
+
+		actions := r.GetActions()
+
+		sortActions(actions)
+
+		if len(r.Interceptors) == 0 && len(actions) == 0 {
+			return
+		}
+
+		s += getFullPath(r) + "\n"
+
+		for _, i := range r.Interceptors {
+			s += fmt.Sprintf("    <%s>\n", getFunctionName(i))
+		}
+
+		for _, a := range actions {
+			s += fmt.Sprintf("    %s", a.HttpMethod)
+
+			if !a.Bound {
+				s += fmt.Sprintf(" :%s", a.Name)
+			}
+
+			s += " "
+
+			for _, i := range a.Interceptors {
+				s += fmt.Sprintf("<%s>", getFunctionName(i))
+			}
+
+			s += "\n"
+		}
+	})
+
+	return
+}
+
+func traverse(r *box.R, f func(r *box.R)) {
+	f(r)
+	for _, c := range r.Children {
+		traverse(c, f)
+	}
+}
+
+func getFullPath(r *box.R) (s string) {
+	s = r.Path
+	for {
+		if r.Parent == nil {
+			return
+		}
+		s = r.Parent.Path + "/" + s
+		r = r.Parent
+	}
+}
+
+func sortActions(actions []*box.A) {
+	// Sort actions:
+	// First bound (by method between them)
+	// Second unbound (by name between them)
+	sort.Slice(actions, func(i, j int) bool {
+		a := actions[i]
+		b := actions[j]
+
+		if a.Bound {
+			if b.Bound {
+				return a.HttpMethod < b.HttpMethod
+			}
+			return true
+		} else {
+			if b.Bound {
+				return false
+			}
+			return a.Name < b.Name
+		}
+	})
+}
+
+func getFunctionName(i interface{}) string {
+	name := runtime.FuncForPC(reflect.ValueOf(i).Pointer()).Name()
+
+	parts := strings.Split(name, ".")
+
+	return parts[1]
+}

boxutil/tree_test.go

@@ -0,0 +1,117 @@
+package boxutil
+
+import (
+	. "box"
+	"context"
+	"fmt"
+	"testing"
+)
+
+func TestTree(t *testing.T) {
+
+	root := NewResource()
+	v1 := root.Resource("/api/v1").
+		WithInterceptors(Auth, AccessLog)
+	v1.Resource("/users").
+		WithActions(
+			Get(ListUsers).WithInterceptors(AdminRequired, NoAudit),
+			Post(CreateUser).WithInterceptors(AdminRequired),
+		)
+	v1.Resource("/users/{userId}").
+		WithActions(
+			Get(GetUser),
+			Delete(DeleteUser),
+			ActionPost(BanUser).WithInterceptors(AdminRequired),
+			ActionPost(EnableUser).WithInterceptors(AdminRequired),
+			ActionPost(DisableUser).WithInterceptors(AdminRequired),
+		)
+	v1.Resource("/spots/{spotId}/menus/{menuId}").
+		WithActions(
+			Delete(DeleteMenu).WithInterceptors(AdminRequired, NoAudit),
+			Patch(UpdateMenu),
+		)
+
+	s := Tree(root)
+
+	expected := `/api/v1
+    <Auth>
+    <AccessLog>
+/api/v1/users
+    GET <AdminRequired><NoAudit>
+    POST <AdminRequired>
+/api/v1/users/{userId}
+    DELETE 
+    GET 
+    POST :banUser <AdminRequired>
+    POST :disableUser <AdminRequired>
+    POST :enableUser <AdminRequired>
+/api/v1/spots/{spotId}/menus/{menuId}
+    DELETE <AdminRequired><NoAudit>
+    PATCH 
+`
+
+	if s != expected {
+		t.Errorf("Tree output does not match\nExpected: %s\nObtained:%s\n", expected, s)
+	}
+
+}
+
+func CreateUser()  {}
+func GetUser()     {}
+func BanUser()     {}
+func DisableUser() {}
+func EnableUser()  {}
+func DeleteUser()  {}
+func ListUsers()   {}
+func DeleteMenu()  {}
+func UpdateMenu()  {}
+
+func Auth(next H) H {
+	return func(ctx context.Context) {
+		next(ctx)
+	}
+}
+func AccessLog(next H) H {
+	return func(ctx context.Context) {
+		next(ctx)
+	}
+}
+
+func AdminRequired(next H) H {
+	return func(ctx context.Context) {
+		next(ctx)
+	}
+}
+
+func NoAudit(next H) H {
+	return func(ctx context.Context) {
+		next(ctx)
+	}
+}
+
+func TestSortActions(t *testing.T) {
+
+	actions := []*A{
+		{Name: "D", Bound: false},
+		{Name: "C", Bound: false},
+		{Name: "B", Bound: true, HttpMethod: "B"},
+		{Name: "A", Bound: true, HttpMethod: "A"},
+	}
+
+	fmt.Println(actions)
+	sortActions(actions)
+	fmt.Println(actions)
+
+	if actions[0].Name != "A" {
+		t.Errorf("A should be action[0]")
+	}
+	if actions[1].Name != "B" {
+		t.Errorf("B should be action[1]")
+	}
+	if actions[2].Name != "C" {
+		t.Errorf("C should be action[2]")
+	}
+	if actions[3].Name != "D" {
+		t.Errorf("D should be action[3]")
+	}
+}

http.go

@@ -53,11 +53,11 @@ func Box2Http(b *B) http.Handler {
 				if nil == ri {
 					break
 				}
-				interceptors = append(ri.interceptors, interceptors...)
-				ri = ri.parent
+				interceptors = append(ri.Interceptors, interceptors...)
+				ri = ri.Parent
 			}
 		}
-		interceptors = append(interceptors, c.Action.interceptors...)
+		interceptors = append(interceptors, c.Action.Interceptors...)
 
 		hi := func(ctx context.Context) {
 

main_test.go

@@ -23,7 +23,7 @@ func BenchmarkList(b *testing.B) {
 		//last = P + strconv.Itoa(rand.Intn(N))
 
 		for _, v := range l {
-			if last == v.name {
+			if last == v.Name {
 				//fmt.Println(v)
 				break
 			}