add sub-sub-directory support for ignored_folder

This commit also "fixes" a subtle "bug" with the previous implementation
of isIgnoredFolder. The previous implementation tested whether a folder
is ignored by (1) splitting the path to be tested using strings.Split with
the seperator "/" and (2) testing whether the first part of the path exists in
w.IgnoredFolders. However, this does not work on architectures that use
a different path seperator. In practice, this "bug" does not present an
issue as an ignored sub-directory is skipped entirely by filepath.Walk.

Author: shasderias

README.md

@@ -56,7 +56,8 @@ err = http.ListenAndServe(":3000", web.ErrorChecker(m))
 # The root of your application relative to your configuration file.
 app_root: .
 # List of folders you don't want to watch. The more folders you ignore, the 
-# faster things will be.
+# faster things will be. For cross-platform compatibility, use forward slashes
+# as the path separator (i.e. 'cmd/web/client', not 'cmd\\web\\client').
 ignored_folders:
   - vendor
   - log

refresh/watcher.go

@@ -58,15 +58,20 @@ func (w *Watcher) Start() {
 }
 
 func (w Watcher) isIgnoredFolder(path string) bool {
-	paths := strings.Split(path, "/")
-	if len(paths) <= 0 {
-		return false
-	}
-
 	for _, e := range w.IgnoredFolders {
-		if strings.TrimSpace(e) == paths[0] {
-			return true
+		rel, err := filepath.Rel(e, path)
+		if err != nil {
+			// unable to construct relative path, not an ignored folder
+			continue
 		}
+
+		if strings.Contains(rel, "..") {
+			// to construct a relative path requires going up the directory tree, not
+			// an ignored folder
+			continue
+		}
+
+		return true
 	}
 	return false
 }

refresh/watcher_posix_test.go

@@ -0,0 +1,45 @@
+// +build linux darwin
+
+package refresh
+
+import (
+	"testing"
+)
+
+func TestIsIgnoredFolder(t *testing.T) {
+	ignoredFolders := []string{
+		"cmd/web/client",
+		"vendor",
+	}
+
+	isIgnoredFolderTests := []struct {
+		path          string
+		ignoredFolder bool
+	}{
+		{"cmd/web", false},
+		{"cmd/web/main.go", false},
+		{"cmd/web/client", true},
+		{"cmd/web/client/src", true},
+		{"pkg", false},
+		{"pkg/cmd/web/client", false},
+		{".", false},
+	}
+
+	watcher := Watcher{
+		Manager: &Manager{
+			Configuration: &Configuration{
+				IgnoredFolders: ignoredFolders,
+			},
+		},
+	}
+
+	for _, tc := range isIgnoredFolderTests {
+		if watcher.isIgnoredFolder(tc.path) != tc.ignoredFolder {
+			if tc.ignoredFolder {
+				t.Errorf("expected path '%s' to be ignored", tc.path)
+			} else {
+				t.Errorf("expected path '%s' not to be ignored", tc.path)
+			}
+		}
+	}
+}

refresh/watcher_windows_test.go

@@ -0,0 +1,45 @@
+// +build windows
+
+package refresh
+
+import (
+	"testing"
+)
+
+func TestIsIgnoredFolder(t *testing.T) {
+	ignoredFolders := []string{
+		"cmd/web/client",
+		"vendor",
+	}
+
+	isIgnoredFolderTests := []struct {
+		path          string
+		ignoredFolder bool
+	}{
+		{"cmd\\web", false},
+		{"cmd\\web\\main.go", false},
+		{"cmd\\web\\client", true},
+		{"cmd\\web\\client\\src", true},
+		{"pkg", false},
+		{"pkg\\cmd\\web\\client", false},
+		{".", false},
+	}
+
+	watcher := Watcher{
+		Manager: &Manager{
+			Configuration: &Configuration{
+				IgnoredFolders: ignoredFolders,
+			},
+		},
+	}
+
+	for _, tc := range isIgnoredFolderTests {
+		if watcher.isIgnoredFolder(tc.path) != tc.ignoredFolder {
+			if tc.ignoredFolder {
+				t.Errorf("expected path '%s' to be ignored", tc.path)
+			} else {
+				t.Errorf("expected path '%s' not to be ignored", tc.path)
+			}
+		}
+	}
+}