Step 1212 pathutil (#141)

* Regroup pathutil functions.

* Group functions in pathutil.go.

* Introduce PathProvider and PathModifier.

* Fix lint issue.

* Regenerate pathutil mocks.

* Introduce PathChecker.

* Add IsPathExists to PathChecker interface.

* Use default prefix for implementation structs.

* Rename TempDir to CreateTempDir.

* Regenerate pathutil mocks.

Author: godrei

pathutil/glob.go

@@ -9,6 +9,27 @@ import (
 	"strings"
 )
 
+// ListEntries filters contents of a directory using the provided filters
+func ListEntries(dir string, filters ...FilterFunc) ([]string, error) {
+	absDir, err := filepath.Abs(dir)
+	if err != nil {
+		return []string{}, err
+	}
+
+	entries, err := ioutil.ReadDir(absDir)
+	if err != nil {
+		return []string{}, err
+	}
+
+	var paths []string
+	for _, entry := range entries {
+		pth := filepath.Join(absDir, entry.Name())
+		paths = append(paths, pth)
+	}
+
+	return FilterPaths(paths, filters...)
+}
+
 // FilterPaths ...
 func FilterPaths(fileList []string, filters ...FilterFunc) ([]string, error) {
 	var filtered []string

pathutil/glob_test.go

@@ -10,47 +10,34 @@ import (
 	"strings"
 )
 
-// RevokableChangeDir ...
-func RevokableChangeDir(dir string) (func() error, error) {
-	origDir, err := CurrentWorkingDirectoryAbsolutePath()
-	if err != nil {
-		return nil, err
-	}
-
-	revokeFn := func() error {
-		return os.Chdir(origDir)
+// NormalizedOSTempDirPath ...
+// Creates a temp dir, and returns its path.
+// If tmpDirNamePrefix is provided it'll be used
+//  as the tmp dir's name prefix.
+// Normalized: it's guaranteed that the path won't end with '/'.
+func NormalizedOSTempDirPath(tmpDirNamePrefix string) (retPth string, err error) {
+	retPth, err = ioutil.TempDir("", tmpDirNamePrefix)
+	if strings.HasSuffix(retPth, "/") {
+		retPth = retPth[:len(retPth)-1]
 	}
-
-	return revokeFn, os.Chdir(dir)
+	return
 }
 
-// ChangeDirForFunction ...
-func ChangeDirForFunction(dir string, fn func()) error {
-	revokeFn, err := RevokableChangeDir(dir)
-	if err != nil {
-		return err
-	}
-
-	fn()
-
-	return revokeFn()
+// CurrentWorkingDirectoryAbsolutePath ...
+func CurrentWorkingDirectoryAbsolutePath() (string, error) {
+	return filepath.Abs("./")
 }
 
-// IsRelativePath ...
-func IsRelativePath(pth string) bool {
-	if strings.HasPrefix(pth, "./") {
-		return true
-	}
-
-	if strings.HasPrefix(pth, "/") {
-		return false
-	}
-
-	if strings.HasPrefix(pth, "$") {
-		return false
+// UserHomeDir ...
+func UserHomeDir() string {
+	if runtime.GOOS == "windows" {
+		home := os.Getenv("HOMEDRIVE") + os.Getenv("HOMEPATH")
+		if home == "" {
+			home = os.Getenv("USERPROFILE")
+		}
+		return home
 	}
-
-	return true
+	return os.Getenv("HOME")
 }
 
 // EnsureDirExist ...
@@ -76,12 +63,6 @@ func genericIsPathExists(pth string) (os.FileInfo, bool, error) {
 	return fileInf, false, err
 }
 
-// IsPathExists ...
-func IsPathExists(pth string) (bool, error) {
-	_, isExists, err := genericIsPathExists(pth)
-	return isExists, err
-}
-
 // PathCheckAndInfos ...
 // Returns:
 // 1. file info or nil
@@ -106,6 +87,32 @@ func IsDirExists(pth string) (bool, error) {
 	return fileInf.IsDir(), nil
 }
 
+// IsPathExists ...
+func IsPathExists(pth string) (bool, error) {
+	_, isExists, err := genericIsPathExists(pth)
+	return isExists, err
+}
+
+//
+// Path modifier functions
+
+// PathModifier ...
+type PathModifier interface {
+	AbsPath(pth string) (string, error)
+}
+
+type defaultPathModifier struct{}
+
+// NewPathModifier ...
+func NewPathModifier() PathModifier {
+	return defaultPathModifier{}
+}
+
+// AbsPath ...
+func (defaultPathModifier) AbsPath(pth string) (string, error) {
+	return AbsPath(pth)
+}
+
 // AbsPath expands ENV vars and the ~ character
 //	then call Go's Abs
 func AbsPath(pth string) (string, error) {
@@ -150,89 +157,65 @@ func ExpandTilde(pth string) (string, error) {
 	return pth, nil
 }
 
-// CurrentWorkingDirectoryAbsolutePath ...
-func CurrentWorkingDirectoryAbsolutePath() (string, error) {
-	return filepath.Abs("./")
-}
+// IsRelativePath ...
+func IsRelativePath(pth string) bool {
+	if strings.HasPrefix(pth, "./") {
+		return true
+	}
 
-// UserHomeDir ...
-func UserHomeDir() string {
-	if runtime.GOOS == "windows" {
-		home := os.Getenv("HOMEDRIVE") + os.Getenv("HOMEPATH")
-		if home == "" {
-			home = os.Getenv("USERPROFILE")
-		}
-		return home
+	if strings.HasPrefix(pth, "/") {
+		return false
 	}
-	return os.Getenv("HOME")
-}
 
-// NormalizedOSTempDirPath ...
-// Creates a temp dir, and returns its path.
-// If tmpDirNamePrefix is provided it'll be used
-//  as the tmp dir's name prefix.
-// Normalized: it's guaranteed that the path won't end with '/'.
-func NormalizedOSTempDirPath(tmpDirNamePrefix string) (retPth string, err error) {
-	retPth, err = ioutil.TempDir("", tmpDirNamePrefix)
-	if strings.HasSuffix(retPth, "/") {
-		retPth = retPth[:len(retPth)-1]
+	if strings.HasPrefix(pth, "$") {
+		return false
 	}
-	return
+
+	return true
 }
 
 // GetFileName returns the name of the file from a given path or the name of the directory if it is a directory
 func GetFileName(path string) string {
 	return strings.TrimSuffix(filepath.Base(path), filepath.Ext(path))
 }
 
-// ListPathInDirSortedByComponents ...
-func ListPathInDirSortedByComponents(searchDir string, relPath bool) ([]string, error) {
-	searchDir, err := filepath.Abs(searchDir)
-	if err != nil {
-		return []string{}, err
-	}
-
-	var fileList []string
-
-	if err := filepath.Walk(searchDir, func(path string, _ os.FileInfo, walkErr error) error {
-		if walkErr != nil {
-			return walkErr
-		}
-
-		if relPath {
-			rel, err := filepath.Rel(searchDir, path)
-			if err != nil {
-				return err
-			}
-			path = rel
+// EscapeGlobPath escapes a partial path, determined at runtime, used as a parameter for filepath.Glob
+func EscapeGlobPath(path string) string {
+	var escaped string
+	for _, ch := range path {
+		if ch == '[' || ch == ']' || ch == '-' || ch == '*' || ch == '?' || ch == '\\' {
+			escaped += "\\"
 		}
-
-		fileList = append(fileList, path)
-
-		return nil
-	}); err != nil {
-		return []string{}, err
+		escaped += string(ch)
 	}
-	return SortPathsByComponents(fileList)
+	return escaped
 }
 
-// ListEntries filters contents of a directory using the provided filters
-func ListEntries(dir string, filters ...FilterFunc) ([]string, error) {
-	absDir, err := filepath.Abs(dir)
+//
+// Change dir functions
+
+// RevokableChangeDir ...
+func RevokableChangeDir(dir string) (func() error, error) {
+	origDir, err := CurrentWorkingDirectoryAbsolutePath()
 	if err != nil {
-		return []string{}, err
+		return nil, err
 	}
 
-	entries, err := ioutil.ReadDir(absDir)
-	if err != nil {
-		return []string{}, err
+	revokeFn := func() error {
+		return os.Chdir(origDir)
 	}
 
-	var paths []string
-	for _, entry := range entries {
-		pth := filepath.Join(absDir, entry.Name())
-		paths = append(paths, pth)
+	return revokeFn, os.Chdir(dir)
+}
+
+// ChangeDirForFunction ...
+func ChangeDirForFunction(dir string, fn func()) error {
+	revokeFn, err := RevokableChangeDir(dir)
+	if err != nil {
+		return err
 	}
 
-	return FilterPaths(paths, filters...)
+	fn()
+
+	return revokeFn()
 }

pathutil/path_filter.go

@@ -13,6 +13,46 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+func Test_globEscapePath(t *testing.T) {
+	type args struct {
+		path string
+	}
+	tests := []struct {
+		name string
+		args args
+		want string
+	}{
+		{
+			name: "Escaping test",
+			args: args{path: "[]-?*"},
+			want: "\\[\\]\\-\\?\\*",
+		},
+		// filepath.Glob(1) does not match for `test\.xcodeproj` if go version 1.8.3
+		{
+			name: "'.' is not escaped",
+			args: args{path: "test.xcodeproj"},
+			want: "test.xcodeproj",
+		},
+		{
+			name: "`\\` in path",
+			args: args{path: "\\"},
+			want: "\\\\",
+		},
+		{
+			name: "`\\` with",
+			args: args{path: "\\[?"},
+			want: "\\\\\\[\\?",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := EscapeGlobPath(tt.args.path); got != tt.want {
+				t.Errorf("globEscapePath() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
 func TestChangeDirForFunction(t *testing.T) {
 	origDir, err := CurrentWorkingDirectoryAbsolutePath()
 	require.NoError(t, err)