Fixed minor issues reported by golint and go vet

cbonello · cbonello · commit 9a988634828b · 2014-02-04T08:57:57.000+05:30
diff --git a/csrf.go b/csrf.go
@@ -1,4 +1,4 @@
-// Synchronizer Token Pattern implementation.
+// Package csrf is a synchronizer Token Pattern implementation.
 //
 // See [OWASP] https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet
 package csrf
@@ -24,6 +24,7 @@ var (
 	safeMethods   = regexp.MustCompile("^(GET|HEAD|OPTIONS|TRACE|WS)$")
 )
 
+// CSRFFilter implements the CSRF filter.
 var CSRFFilter = func(c *revel.Controller, fc []revel.Filter) {
 	r := c.Request.Request
 
diff --git a/exemptions.go b/exemptions.go
@@ -1,3 +1,5 @@
+// Package csrf is a synchronizer Token Pattern implementation.
+//
 // Management of routes exempted from CSRF checks.
 package csrf
 
@@ -26,7 +28,7 @@ var (
 	exemptionsGlobs globPath
 )
 
-// Checks if given path is exempt from CSRF checks.
+// IsExempted checks whether given path is exempt from CSRF checks or not.
 func IsExempted(path string) bool {
 	exemptionsFullPath.RLock()
 	_, found := exemptionsFullPath.list[path]
@@ -52,21 +54,22 @@ func IsExempted(path string) bool {
 	return false
 }
 
-// Exempts an exact path from CSRF checks.
+// ExemptedFullPath exempts one exact path from CSRF checks.
 func ExemptedFullPath(path string) {
 	glog.V(2).Infof("REVEL-CSRF: Adding exemption '%s'...", path)
 	exemptionsFullPath.Lock()
 	exemptionsFullPath.list[path] = struct{}{}
 	exemptionsFullPath.Unlock()
 }
 
+// ExemptedFullPath exempts exact paths from CSRF checks.
 func ExemptedFullPaths(paths ...string) {
 	for _, v := range paths {
 		ExemptedFullPath(v)
 	}
 }
 
-// Exempts a path from CSRF checks using pattern matching.
+// ExemptedGlob exempts one path from CSRF checks using pattern matching.
 // See http://golang.org/pkg/path/#Match
 func ExemptedGlob(path string) {
 	glog.V(2).Infof("REVEL-CSRF: Adding exemption GLOB '%s'...", path)
@@ -75,6 +78,7 @@ func ExemptedGlob(path string) {
 	exemptionsGlobs.Unlock()
 }
 
+// ExemptedGlobs exempts paths from CSRF checks using pattern matching.
 func ExemptedGlobs(paths ...string) {
 	for _, v := range paths {
 		ExemptedGlob(v)
diff --git a/exemptions_test.go b/exemptions_test.go
@@ -5,7 +5,6 @@ import (
 )
 
 func TestExemptedFullPath(t *testing.T) {
-	//hand := New(nil)
 	path := "/Hello"
 
 	ExemptedFullPath(path)
@@ -20,25 +19,22 @@ func TestExemptedFullPath(t *testing.T) {
 }
 
 func TestExemptedFullPaths(t *testing.T) {
-	//hand := New(nil)
 	paths := []string{"/home", "/news", "/help"}
-	ExemptedFullPaths(paths...)
 
+	ExemptedFullPaths(paths...)
 	for _, v := range paths {
 		if !IsExempted(v) {
 			t.Errorf("%v should be exempted, but it isn't", v)
 		}
 	}
 
 	other := "/accounts"
-
 	if IsExempted(other) {
-		t.Errorf("%v is exempted, but it shouldn't be")
+		t.Errorf("%v is exempted, but it shouldn't be", other)
 	}
 }
 
 func TestExemptedGlob(t *testing.T) {
-	//hand := New(nil)
 	glob := "/[m-n]ail"
 
 	ExemptedGlob(glob)
@@ -67,25 +63,23 @@ func TestExemptedGlob(t *testing.T) {
 func TestExemptedGlobs(t *testing.T) {
 	slice := []string{"/", "/accounts/*", "/post/?*"}
 	matching := []string{"/", "/accounts/", "/accounts/johndoe", "/post/1", "/post/123"}
-
 	nonMatching := []string{"", "/accounts",
 		// Glob's * and ? don't match a forward slash.
 		"/accounts/johndoe/posts",
 		"/post/",
 	}
 
-	//hand := New(nil)
 	ExemptedGlobs(slice...)
 
 	for _, v := range matching {
 		if !IsExempted(v) {
-			t.Error("%v should be exempted, but it isn't.")
+			t.Errorf("%v should be exempted, but it isn't.", v)
 		}
 	}
 
 	for _, v := range nonMatching {
 		if IsExempted(v) {
-			t.Error("%v shouldn't be exempted, but it is")
+			t.Errorf("%v shouldn't be exempted, but it is", v)
 		}
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@ import (`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`func TestExemptedFullPath(t *testing.T) {`
`8`		`- //hand := New(nil)`
`9`	`8`	`path := "/Hello"`
`10`	`9`
`11`	`10`	`ExemptedFullPath(path)`
`@@ -20,25 +19,22 @@ func TestExemptedFullPath(t *testing.T) {`
`20`	`19`	`}`
`21`	`20`
`22`	`21`	`func TestExemptedFullPaths(t *testing.T) {`
`23`		`- //hand := New(nil)`
`24`	`22`	`paths := []string{"/home", "/news", "/help"}`
`25`		`- ExemptedFullPaths(paths...)`
`26`	`23`
	`24`	`+ ExemptedFullPaths(paths...)`
`27`	`25`	`for _, v := range paths {`
`28`	`26`	`if !IsExempted(v) {`
`29`	`27`	`t.Errorf("%v should be exempted, but it isn't", v)`
`30`	`28`	`}`
`31`	`29`	`}`
`32`	`30`
`33`	`31`	`other := "/accounts"`
`34`		`-`
`35`	`32`	`if IsExempted(other) {`
`36`		`- t.Errorf("%v is exempted, but it shouldn't be")`
	`33`	`+ t.Errorf("%v is exempted, but it shouldn't be", other)`
`37`	`34`	`}`
`38`	`35`	`}`
`39`	`36`
`40`	`37`	`func TestExemptedGlob(t *testing.T) {`
`41`		`- //hand := New(nil)`
`42`	`38`	`glob := "/[m-n]ail"`
`43`	`39`
`44`	`40`	`ExemptedGlob(glob)`
`@@ -67,25 +63,23 @@ func TestExemptedGlob(t *testing.T) {`
`67`	`63`	`func TestExemptedGlobs(t *testing.T) {`
`68`	`64`	`slice := []string{"/", "/accounts/", "/post/?"}`
`69`	`65`	`matching := []string{"/", "/accounts/", "/accounts/johndoe", "/post/1", "/post/123"}`
`70`		`-`
`71`	`66`	`nonMatching := []string{"", "/accounts",`
`72`	`67`	`// Glob's * and ? don't match a forward slash.`
`73`	`68`	`"/accounts/johndoe/posts",`
`74`	`69`	`"/post/",`
`75`	`70`	`}`
`76`	`71`
`77`		`- //hand := New(nil)`
`78`	`72`	`ExemptedGlobs(slice...)`
`79`	`73`
`80`	`74`	`for _, v := range matching {`
`81`	`75`	`if !IsExempted(v) {`
`82`		`- t.Error("%v should be exempted, but it isn't.")`
	`76`	`+ t.Errorf("%v should be exempted, but it isn't.", v)`
`83`	`77`	`}`
`84`	`78`	`}`
`85`	`79`
`86`	`80`	`for _, v := range nonMatching {`
`87`	`81`	`if IsExempted(v) {`
`88`		`- t.Error("%v shouldn't be exempted, but it is")`
	`82`	`+ t.Errorf("%v shouldn't be exempted, but it is", v)`
`89`	`83`	`}`
`90`	`84`	`}`
`91`	`85`	`}`