fix patterns

Author: deadc0de6

README.md

@@ -155,9 +155,17 @@ $ gocatcli index /some/other/path myStorageName
 [gocatcli](https://github.com/deadc0de6/gocatcli) uses the *basename* of the
 path to index as the storage name unless you specify the name when indexing.
 
+### ignore pattern
+
 The below example ignores any file ending with `.go` or `.md` and anything in the `.git` directory:
 ```bash
-$ gocatcli index ../gocatcli --ignore="*.go" --ignore="*.md" --ignore="*.git/*"
+$ gocatcli index ../gocatcli --ignore="\.go" --ignore="\.md" --ignore="\.git/*"
+```
+
+To ignore any hidden file for example, you would use `\.+` to ensure
+that at least a single dot (`.`) is matched.
+```bash
+$ gocatcli index ../gocatcli --ignore='\.+'
 ```
 
 ## Reindex and update

internal/commands/find.go

@@ -11,7 +11,6 @@ import (
 	"gocatcli/internal/node"
 	"gocatcli/internal/stringer"
 	"gocatcli/internal/tree"
-	"gocatcli/internal/utilities"
 	"regexp"
 	"strings"
 	"time"
@@ -83,7 +82,7 @@ func find(_ *cobra.Command, args []string) error {
 
 	for _, arg := range args {
 		// patch pattern
-		arg = utilities.PatchPattern(arg)
+		arg = patchFindPattern(arg)
 		// get the pattern to search for
 		patt := arg
 		re, err := regexp.Compile(patt)
@@ -127,3 +126,38 @@ func matchNodes(t *tree.Tree, startNode node.Node, patt *regexp.Regexp, prt stri
 
 	log.Debugf("found %d entries matching \"%s\" in %v", cnt, patt.String(), time.Since(t0))
 }
+
+// fix pattern
+func patchFindPattern(pattern string) string {
+	// replace any dot with \.
+	patt := strings.ReplaceAll(pattern, ".", "\\.")
+
+	// ensure pattern is enclosed in stars
+	if !strings.Contains(patt, "*") {
+		ret := fmt.Sprintf(".*%s.*", patt)
+		log.Debugf("patched non pattern from \"%s\" to \"%s\"", patt, ret)
+		return ret
+	}
+
+	// replace all "*" with ".*" for golang pattern
+	notDotStar := regexp.MustCompile(`([^\.])\*`)
+	ret := notDotStar.ReplaceAllString(patt, "$1.*")
+
+	// replace the first star if any
+	if strings.HasPrefix(ret, "*") {
+		ret = fmt.Sprintf(".*%s", ret[1:])
+	}
+
+	// limit start of line if not star
+	if !strings.HasPrefix(ret, ".*") {
+		ret = fmt.Sprintf("^%s", ret)
+	}
+
+	// limit end of line if not star
+	if !strings.HasSuffix(ret, ".*") {
+		ret = fmt.Sprintf("%s$", ret)
+	}
+
+	log.Debugf("patched pattern from \"%s\" to \"%s\"", pattern, ret)
+	return ret
+}

internal/utilities/fs.go

@@ -15,7 +15,6 @@ import (
 	"math"
 	"os"
 	"path/filepath"
-	"regexp"
 	"strings"
 	"time"
 
@@ -203,35 +202,5 @@ func NotIn(needle string, stack []string) bool {
 
 // PatchPattern fix pattern
 func PatchPattern(pattern string) string {
-	// replace any dot with \.
-	patt := strings.ReplaceAll(pattern, ".", "\\..")
-
-	// ensure pattern is enclosed in stars
-	if !strings.Contains(patt, "*") {
-		ret := fmt.Sprintf(".*%s.*", patt)
-		log.Debugf("patched non pattern from \"%s\" to \"%s\"", patt, ret)
-		return ret
-	}
-
-	// replace all "*" with ".*" for golang pattern
-	notDotStar := regexp.MustCompile(`([^\.])\*`)
-	ret := notDotStar.ReplaceAllString(patt, "$1.*")
-
-	// replace the first star if any
-	if strings.HasPrefix(ret, "*") {
-		ret = fmt.Sprintf(".*%s", ret[1:])
-	}
-
-	// limit start of line if not star
-	if !strings.HasPrefix(ret, ".*") {
-		ret = fmt.Sprintf("^%s", ret)
-	}
-
-	// limit end of line if not star
-	if !strings.HasSuffix(ret, ".*") {
-		ret = fmt.Sprintf("%s$", ret)
-	}
-
-	log.Debugf("patched pattern from \"%s\" to \"%s\"", pattern, ret)
-	return ret
+	return pattern
 }

tests-ng/test-index-ignores.sh

@@ -26,36 +26,42 @@ out="${tmpd}/output.txt"
 ## create a fake dir
 src="${tmpd}/to-index"
 mkdir -p "${src}"
+
+# add some hidden and non hidden files
 mkdir "${src}/.hidden"
 echo "hidden" > "${src}/.hidden/hiddenfile"
 mkdir "${src}/nothidden"
 echo "not-hidden" > "${src}/nothidden/subfile"
 echo "hidden" > "${src}/.file-hidden"
 echo "not-hidden" > "${src}/notfile-hidden"
 
+# add some with extensions
+mkdir -p "${src}/with.ext"
+echo "withext" > "${src}/with.ext/inside"
+echo "theext" > "${src}/file.ext"
+
 # index
 echo ">>> indexing <<<"
-"${bin}" index -a -C -c "${catalog}" --ignore='.*' "${tmpd}/to-index" gocatcli
+"${bin}" index -a -C -c "${catalog}" --debug --ignore='\.+' --ignore='\.ext' "${tmpd}/to-index" gocatcli
 [ ! -e "${catalog}" ] && echo "catalog not created" && exit 1
 
 # ls
-echo ">>> test ls <<<"
+echo ">>> test index ignore ls <<<"
 "${bin}" -c "${catalog}" ls -a -r | sed -e 's/\x1b\[[0-9;]*m//g' > "${out}"
 # shellcheck disable=SC2126
 #expected=$(find "${cur}/../" -not -path '*/.git*' | grep -v '^.$' | wc -l)
 cat_file "${out}"
 
 expected=4
-cnt=$(cat "${out}" | wc -l)
+cnt=$(wc -l "${out}" | awk '{print $1}')
 [ "${cnt}" != "${expected}" ] && echo "expecting ${expected} lines got ${cnt}" && exit 1
 
-cat "${out}" | grep 'notfile-hidden' || exit 1
-cat "${out}" | grep 'nothidden' || exit 1
-cat "${out}" | grep 'subfile' || exit 1
-
-cat "${out}" | grep '\.hidden' && exit 1
-cat "${out}" | grep 'hiddenfile' && exit 1
-cat "${out}" | grep '\.file-hidden' && exit 1
+grep 'notfile-hidden' "${out}" || exit 1
+grep 'nothidden' "${out}" || exit 1
+grep 'subfile' "${out}" || exit 1
+grep '\.hidden' "${out}" && exit 1
+grep 'hiddenfile' "${out}" && exit 1
+grep '\.file-hidden' "${out}" && exit 1
 
 echo "test $(basename "${0}") OK!"
 exit 0

tests-ng/test-index.sh

@@ -25,16 +25,16 @@ out="${tmpd}/output.txt"
 
 # index
 echo ">>> test index <<<"
-"${bin}" index -a -C -c "${catalog}" --ignore=".git" "${cur}/../" gocatcli
+"${bin}" index -a -C -c "${catalog}" --debug --ignore='\.git' "${cur}/../" gocatcli
 [ ! -e "${catalog}" ] && echo "catalog not created" && exit 1
 
 # ls
-echo ">>> test ls <<<"
+echo ">>> test index ls <<<"
 "${bin}" -c "${catalog}" ls -a -r | sed -e 's/\x1b\[[0-9;]*m//g' > "${out}"
 # shellcheck disable=SC2126
 #expected=$(find "${cur}/../" -not -path '*/.git*' | grep -v '^.$' | wc -l)
 cat_file "${out}"
-"${cur}/plist.py" -l "${cur}/../" --ignore '*/.git*'
+"${cur}/plist.py" -l "${cur}/../" --ignore '*/\.git*'
 expected=$("${cur}/plist.py" "${cur}/../" --ignore '*/.git*')
 cnt=$(tail -n +2 "${out}" | sed '/^$/d' | wc -l)
 [ "${cnt}" != "${expected}" ] && echo "expecting ${expected} lines got ${cnt}" && exit 1
@@ -47,11 +47,11 @@ echo ">>> test index <<<"
 [ ! -e "${catalog}" ] && echo "catalog not created" && exit 1
 
 # ls
-echo ">>> test ls (2) <<<"
+echo ">>> test index ls (2) <<<"
 "${bin}" --debug -c "${catalog}" ls -a -r | sed -e 's/\x1b\[[0-9;]*m//g' > "${out}"
 # shellcheck disable=SC2126
 #expected=$(find "${cur}/../internal" -not -path '*/.git*' | grep -v '^.$' | wc -l)
-expected=$("${cur}/plist.py" "${cur}/../internal" --ignore '*/.git*')
+expected=$("${cur}/plist.py" "${cur}/../internal" --ignore '*/\.git*')
 cnt=$(tail -n +2 "${out}" | sed '/^$/d' | wc -l)
 [ "${cnt}" != "${expected}" ] && echo "expecting ${expected} lines got ${cnt}" && exit 1
 

tests-ng/test-long.sh

@@ -27,7 +27,7 @@ out="${tmpd}/output.txt"
 "${bin}" --debug index -a -C -c "${catalog}" "${cur}/../internal" internal
 [ ! -e "${catalog}" ] && echo "catalog not created" && exit 1
 
-echo ">>> test ls <<<"
+echo ">>> test long ls <<<"
 "${bin}" --debug ls -l -r -a -c "${catalog}" | sed -e 's/\x1b\[[0-9;]*m//g' > "${out}"
 # shellcheck disable=SC2126
 expected=$(find "${cur}/../internal" -not -path '*/.git*' | grep -v '^.$' | wc -l)

tests-ng/test-nested-same-name.sh

@@ -40,7 +40,7 @@ echo "top-file" > "${topf}"
 
 # index
 echo ">>> index dir <<<"
-"${bin}" index -a -C --debug -c "${catalog}" --ignore=".git" "${top}" top
+"${bin}" index -a -C --debug -c "${catalog}" --ignore="\.git" "${top}" top
 [ ! -e "${catalog}" ] && echo "catalog not created" && exit 1
 
 # ls

tests-ng/test-tree.sh

@@ -24,7 +24,7 @@ catalog="${tmpd}/catalog"
 out="${tmpd}/output.txt"
 
 # index
-"${bin}" index -a -C -c "${catalog}" --ignore=".git" "${cur}/../" gocatcli
+"${bin}" index -a -C -c "${catalog}" --ignore="\.git" "${cur}/../" gocatcli
 [ ! -e "${catalog}" ] && echo "catalog not created" && exit 1
 
 # tree

tests-ng/test-update.sh

@@ -56,7 +56,7 @@ echo "size:${size} VS exp:${expected}"
 [ "${size}" != "${expected}" ] && echo "expecting ${expected} (got ${size})" && exit 1
 
 echo ">>> test re-index with ignore <<<"
-"${bin}" index -a -f -C -c "${catalog}" --ignore='*.go' "${tmpd}/internal" internal
+"${bin}" index -a -f -C -c "${catalog}" --ignore='tes\.go' "${tmpd}/internal" internal
 "${bin}" ls -r -S -a -c "${catalog}" | sed -e 's/\x1b\[[0-9;]*m//g' > "${out}"
 cat_file "${out}"
 grep '^.*.go$' "${out}" && (echo ".go files found" && exit 1)