go vet and golint the project, release 3.1.5

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v3.1.5
+
+- Setup golint and go vet for the project
+- As per golint, we've redefined `func ServerBaseContext(h http.Handler, baseCtx context.Context) http.Handler`
+  to `func ServerBaseContext(baseCtx context.Context, h http.Handler) http.Handler`
+
+
 ## v3.1.0 (2017-07-10)
 
 - Fix a few minor issues after v3 release

_examples/graceful/main.go

@@ -83,7 +83,7 @@ func main() {
 		w.Write([]byte(fmt.Sprintf("all done.\n")))
 	})
 
-	srv := http.Server{Addr: ":3333", Handler: chi.ServerBaseContext(r, baseCtx)}
+	srv := http.Server{Addr: ":3333", Handler: chi.ServerBaseContext(baseCtx, r)}
 
 	c := make(chan os.Signal, 1)
 	signal.Notify(c, os.Interrupt)

chain.go

@@ -19,6 +19,8 @@ func (mws Middlewares) HandlerFunc(h http.HandlerFunc) http.Handler {
 	return &ChainHandler{mws, h, chain(mws, h)}
 }
 
+// ChainHandler is a http.Handler with support for handler composition and
+// execution.
 type ChainHandler struct {
 	Middlewares Middlewares
 	Endpoint    http.Handler

context.go

@@ -8,6 +8,7 @@ import (
 )
 
 var (
+	// RouteCtxKey is the context.Context key to store the request context.
 	RouteCtxKey = &contextKey{"RouteContext"}
 )
 
@@ -60,6 +61,8 @@ func (x *Context) reset() {
 	x.methodNotAllowed = false
 }
 
+// URLParam returns the corresponding URL parameter value from the request
+// routing context.
 func (x *Context) URLParam(key string) string {
 	for k := len(x.URLParams.Keys) - 1; k >= 0; k-- {
 		if x.URLParams.Keys[k] == key {
@@ -110,6 +113,7 @@ func URLParamFromCtx(ctx context.Context, key string) string {
 	return ""
 }
 
+// RouteParams is a structure to track URL routing parameters efficiently.
 type RouteParams struct {
 	Keys, Values []string
 }
@@ -122,7 +126,7 @@ func (s *RouteParams) Add(key, value string) {
 
 // ServerBaseContext wraps an http.Handler to set the request context to the
 // `baseCtx`.
-func ServerBaseContext(h http.Handler, baseCtx context.Context) http.Handler {
+func ServerBaseContext(baseCtx context.Context, h http.Handler) http.Handler {
 	fn := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		ctx := r.Context()
 		baseCtx := baseCtx

middleware/logger.go

@@ -10,8 +10,12 @@ import (
 )
 
 var (
+	// LogEntryCtxKey is the context.Context key to store the request log entry.
 	LogEntryCtxKey = &contextKey{"LogEntry"}
 
+	// DefaultLogger is called by the Logger middleware handler to log each request.
+	// Its made a package-level variable so that it can be reconfigured for custom
+	// logging configurations.
 	DefaultLogger = RequestLogger(&DefaultLogFormatter{Logger: log.New(os.Stdout, "", log.LstdFlags)})
 )
 
@@ -27,6 +31,7 @@ func Logger(next http.Handler) http.Handler {
 	return DefaultLogger(next)
 }
 
+// RequestLogger returns a logger handler using a custom LogFormatter.
 func RequestLogger(f LogFormatter) func(next http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
 		fn := func(w http.ResponseWriter, r *http.Request) {
@@ -44,29 +49,37 @@ func RequestLogger(f LogFormatter) func(next http.Handler) http.Handler {
 	}
 }
 
+// LogFormatter initiates the beginning of a new LogEntry per request.
+// See DefaultLogFormatter for an example implementation.
 type LogFormatter interface {
 	NewLogEntry(r *http.Request) LogEntry
 }
 
+// LogEntry records the final log when a request completes.
+// See defaultLogEntry for an example implementation.
 type LogEntry interface {
 	Write(status, bytes int, elapsed time.Duration)
 	Panic(v interface{}, stack []byte)
 }
 
+// GetLogEntry returns the in-context LogEntry for a request.
 func GetLogEntry(r *http.Request) LogEntry {
 	entry, _ := r.Context().Value(LogEntryCtxKey).(LogEntry)
 	return entry
 }
 
+// WithLogEntry sets the in-context LogEntry for a request.
 func WithLogEntry(r *http.Request, entry LogEntry) *http.Request {
 	r = r.WithContext(context.WithValue(r.Context(), LogEntryCtxKey, entry))
 	return r
 }
 
+// DefaultLogFormatter is a simple logger that implements a LogFormatter.
 type DefaultLogFormatter struct {
 	Logger *log.Logger
 }
 
+// NewLogEntry creates a new LogEntry for the request.
 func (l *DefaultLogFormatter) NewLogEntry(r *http.Request) LogEntry {
 	entry := &defaultLogEntry{
 		DefaultLogFormatter: l,

middleware/url_format.go

@@ -9,6 +9,8 @@ import (
 )
 
 var (
+	// URLFormatCtxKey is the context.Context key to store the URL format data
+	// for a request.
 	URLFormatCtxKey = &contextKey{"URLFormat"}
 )
 

mux.go

@@ -317,10 +317,13 @@ func (mx *Mux) Mount(pattern string, handler http.Handler) {
 	}
 }
 
+// Middlewares returns a slice of middleware handler functions.
 func (mx *Mux) Middlewares() Middlewares {
 	return mx.middlewares
 }
 
+// Routes returns a slice of routing information from the tree,
+// useful for traversing available routes of a router.
 func (mx *Mux) Routes() []Route {
 	return mx.tree.routes()
 }