Fix overwriting dep tables

Author: ole108

doc/doc.go

@@ -11,8 +11,12 @@ import (
 	"github.com/flowdev/spaghetti-analyzer/data"
 )
 
-// FileName is the name of the documentation file (package_dependencies.md).
-const FileName = "package_dependencies.md"
+const (
+	// FileName is the name of the documentation file (package_dependencies.md)
+	FileName = "package_dependencies.md"
+	// Title is the mark down title of the package dependencies
+	Title = `# Dependency Table For: `
+)
 
 // WriteDocs generates documentation for the packages 'dtPkgs' and writes it to
 // files.
@@ -96,7 +100,7 @@ func GenerateTable(
 	sort.Strings(allCols)
 
 	sb := &strings.Builder{}
-	intro := `# Dependency Table For: ` + path.Join(rootPkg, pattern) + `
+	intro := Title + path.Join(rootPkg, pattern) + `
 
 | `
 	sb.WriteString(intro)

main.go

@@ -21,13 +21,13 @@ import (
 )
 
 func main() {
-	rc := cut(os.Args[1:])
+	rc := analyze(os.Args[1:])
 	if rc != 0 {
 		os.Exit(rc)
 	}
 }
 
-func cut(args []string) int {
+func analyze(args []string) int {
 	const (
 		usageShort     = " (shorthand)"
 		defaultRoot    = "."
@@ -119,7 +119,7 @@ func cut(args []string) int {
 	}
 
 	if docPkgs != "" {
-		writeDocumentation(docPkgs, root, rootPkg, noLinks, depMap)
+		writeDepTables(docPkgs, root, rootPkg, noLinks, depMap)
 	} else {
 		log.Print("INFO - No dependency table wanted.")
 	}
@@ -150,20 +150,6 @@ func writeStatistics(root string, depMap data.DependencyMap) {
 	}
 }
 
-func writeDocumentation(docPkgs, root, rootPkg string, noLinks bool, depMap data.DependencyMap) {
-	log.Print("INFO - Writing dependency tables:")
-	dtPkgs := findPackagesWithFileAsSlice(doc.FileName, docPkgs, root, "documentation")
-
-	linkDocPkgs := map[string]struct{}{}
-	if !noLinks {
-		linkDocPkgs = dirs.FindPkgsWithFile(doc.FileName, dtPkgs, root, true)
-		for _, p := range dtPkgs {
-			linkDocPkgs[p] = struct{}{}
-		}
-	}
-	doc.WriteDocs(dtPkgs, depMap, linkDocPkgs, rootPkg, root)
-}
-
 func writeDirTree(root, name string, packs []*pkgs.Package) error {
 	treeFile := filepath.Join(root, tree.File)
 	log.Printf("INFO - Writing directory tree to file: %s", treeFile)
@@ -180,10 +166,21 @@ func writeDirTree(root, name string, packs []*pkgs.Package) error {
 	return nil
 }
 
-func findPackagesWithFileAsSlice(signalFile, pkgNames, root, pkgType string) []string {
+func writeDepTables(docPkgs, root, rootPkg string, noLinks bool, depMap data.DependencyMap) {
+	log.Print("INFO - Writing dependency tables:")
+	dtPkgs := findDepTablesAsSlice(docPkgs, root, rootPkg, "documentation")
+
+	linkDocPkgs := map[string]struct{}{}
+	if !noLinks {
+		linkDocPkgs = dirs.FindDepTables(doc.FileName, doc.Title, dtPkgs, root, rootPkg)
+	}
+	doc.WriteDocs(dtPkgs, depMap, linkDocPkgs, rootPkg, root)
+}
+
+func findDepTablesAsSlice(pkgNames, root, rootPkg, pkgType string) []string {
 	var packs []string
 	if pkgNames == "*" { // find all existing files
-		pkgMap := dirs.FindPkgsWithFile(signalFile, nil, root, false)
+		pkgMap := dirs.FindDepTables(doc.FileName, doc.Title, nil, root, rootPkg)
 		packs = make([]string, 0, len(pkgMap))
 		for p := range pkgMap {
 			packs = append(packs, p)

main_test.go

@@ -51,7 +51,7 @@ func TestCut(t *testing.T) {
 			root := mustAbs(filepath.Join("testdata", spec.givenRoot))
 			mustWriteFile(filepath.Join(root, config.File), []byte(spec.givenConfig))
 			args := []string{"--root", root}
-			actualReturnCode := cut(args)
+			actualReturnCode := analyze(args)
 
 			if actualReturnCode != spec.expectedReturnCode {
 				t.Errorf("Expected return code %d but got: %d", spec.expectedReturnCode, actualReturnCode)

x/dirs/dirs.go

@@ -1,6 +1,7 @@
 package dirs
 
 import (
+	"bufio"
 	"fmt"
 	"log"
 	"os"
@@ -37,11 +38,11 @@ func crawlUpAndFindDirOf(startDir string, files ...string) (string, error) {
 	return "", nil
 }
 
-// FindPkgsWithFile is finding packages containing file on disk starting at
-// 'root' and adding them to those given in 'startPkgs'.
-func FindPkgsWithFile(file string, startPkgs []string, root string, excludeRoot bool) map[string]struct{} {
+// FindDepTables is finding packages containing a dependency table on disk
+// starting at 'root' and adding them to those given in 'startPkgs'.
+func FindDepTables(file, title string, startPkgs []string, root, rootPkg string) map[string]struct{} {
 	val := struct{}{}
-	// prefill doc packages from dtPkgs
+	// prefill doc packages from startPkgs
 	retPkgs := make(map[string]struct{}, 128)
 	for _, p := range startPkgs {
 		retPkgs[p] = val
@@ -56,26 +57,31 @@ func FindPkgsWithFile(file string, startPkgs []string, root string, excludeRoot
 			log.Printf("WARN - Unable to list directory %q: %v", path, err)
 			return filepath.SkipDir
 		}
-		if excludeRoot && path == root {
-			return nil // don't add the root 'file'
-		}
 
-		// no valid package starts with '.' and we don't want to search in '.git' and similar
+		// no valid package starts with '.' and we don't want to search in testdata
 		if strings.HasPrefix(info.Name(), ".") || info.Name() == "testdata" {
 			return filepath.SkipDir
 		}
 
-		if _, err := os.Lstat(filepath.Join(path, file)); err == nil {
+		depFile := filepath.Join(path, file)
+		if _, err := os.Lstat(depFile); err == nil {
 			pkg, err := filepath.Rel(root, path)
 			if err != nil {
 				log.Printf("WARN - Unable to compute package for %q: %v", path, err)
 				return nil // sub-directories might work
 			}
-			pkg = strings.ReplaceAll(pkg, "\\", "/") // packages like URLs have always '/'s
-			if pkg == "." {
+			pattern, err := readPatternFromFile(depFile, title, rootPkg)
+			if err != nil {
+				log.Printf("WARN - Problem reading pattern from file %q: %v", depFile, err)
+				err = nil
+			}
+			if pattern == "" {
+				pattern = strings.ReplaceAll(pkg, "\\", "/") // packages like URLs have always '/'s
+			}
+			if pattern == "." {
 				retPkgs["/"] = val
 			} else {
-				retPkgs[pkg] = val
+				retPkgs[pattern] = val
 			}
 		}
 		return nil
@@ -85,3 +91,43 @@ func FindPkgsWithFile(file string, startPkgs []string, root string, excludeRoot
 	}
 	return retPkgs
 }
+
+func readPatternFromFile(depFile, prefix, rootPkg string) (string, error) {
+	lines, err := readFirstLines(depFile, 5)
+	prefix = strings.ToLower(prefix)
+	for _, l := range lines {
+		if strings.HasPrefix(strings.ToLower(l), prefix) {
+			pattern := l[len(prefix):]
+			pattern = strings.TrimSpace(pattern)
+			if strings.HasPrefix(rootPkg, pattern) {
+				pattern = pattern[len(rootPkg):]
+				if pattern != "" && pattern[0] == '/' {
+					pattern = pattern[1:]
+				}
+				if pattern == "" {
+					pattern = "/"
+				}
+			}
+			return pattern, err
+		}
+	}
+	return "", err
+}
+
+func readFirstLines(fileName string, n int) ([]string, error) {
+	file, err := os.Open(fileName)
+	if err != nil {
+		return nil, err
+	}
+	defer file.Close()
+
+	lines := make([]string, 0, n)
+	scanner := bufio.NewScanner(file)
+	for i := 0; i < n && scanner.Scan(); i++ {
+		lines = append(lines, scanner.Text())
+	}
+	if err := scanner.Err(); err != nil {
+		return lines, err
+	}
+	return lines, nil
+}