Merge pull request #42 from alenkacz/av/refactor

Wrap main graph properties into a struct

Author: RinkiyaKeDad

cmd/cycles.go

@@ -31,10 +31,10 @@ var cyclesCmd = &cobra.Command{
 	Short: "Prints cycles in dependency chains.",
 	Long:  `Will show all the cycles in the dependencies of the project.`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		depGraph, _, mainModule := getDepInfo()
+		overview := getDepInfo()
 		var cycleChains []Chain
 		var temp Chain
-		getCycleChains(mainModule, depGraph, temp, &cycleChains)
+		getCycleChains(overview.MainModuleName, overview.Graph, temp, &cycleChains)
 		cycles := getCycles(cycleChains)
 
 		if !jsonOutputCycles {

cmd/graph.go

@@ -33,7 +33,7 @@ var graphCmd = &cobra.Command{
 	For example to generate a svg image use:
 	twopi -Tsvg -o dag.svg graph.dot`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		depGraph, deps, mainModule := getDepInfo()
+		overview := getDepInfo()
 		// strict ensures that there is only one edge between two vertices
 		// overlap = false ensures the vertices don't overlap
 		fileContents := "strict digraph {\ngraph [overlap=false];\n"
@@ -42,10 +42,10 @@ var graphCmd = &cobra.Command{
 		if dep != "" {
 			var chains []Chain
 			var temp Chain
-			getAllChains(mainModule, depGraph, temp, &chains)
+			getAllChains(overview.MainModuleName, overview.Graph, temp, &chains)
 			fileContents += getFileContentsForSingleDep(chains, dep)
 		} else {
-			fileContents += getFileContentsForAllDeps(deps, depGraph, mainModule)
+			fileContents += getFileContentsForAllDeps(overview)
 		}
 		fileContents += "}"
 		fileContentsByte := []byte(fileContents)
@@ -102,18 +102,18 @@ func getFileContentsForSingleDep(chains []Chain, dep string) string {
 
 // get the contents of the .dot file for the graph
 // of all dependencies (when -d is not set)
-func getFileContentsForAllDeps(deps []string, depGraph map[string][]string, mainModule string) string {
+func getFileContentsForAllDeps(overview *DependencyOverview) string {
 
 	// color the main module as yellow
-	data := colorMainNode(mainModule)
-	for _, dep := range deps {
-		_, ok := depGraph[dep]
+	data := colorMainNode(overview.MainModuleName)
+	for _, dep := range overview.DepList {
+		_, ok := overview.Graph[dep]
 		if !ok {
 			continue
 		}
 		// main module can never be a neighbour
-		for _, neighbour := range depGraph[dep] {
-			if dep == mainModule {
+		for _, neighbour := range overview.Graph[dep] {
+			if dep == overview.MainModuleName {
 				// for the main module use a colored node
 				data += fmt.Sprintf("\"MainNode\" -> \"%s\"\n", neighbour)
 			} else {

cmd/list.go

@@ -29,9 +29,9 @@ var listCmd = &cobra.Command{
 	Long: `Gives a list of all the dependencies of the project. 
 	These include both direct as well as transitive dependencies.`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		_, deps, _ := getDepInfo()
+		depGraph := getDepInfo()
 		fmt.Println("List of all dependencies:")
-		printDeps(deps)
+		printDeps(depGraph.DepList)
 		return nil
 	},
 }

cmd/stats.go

@@ -37,17 +37,17 @@ var statsCmd = &cobra.Command{
 	2. Max Depth of Dependencies: Number of dependencies in the longest dependency chain
 	3. Transitive Dependencies: Total number of transitive dependencies (dependencies which are not direct dependencies of the project)`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		depGraph, deps, mainModule := getDepInfo()
+		depGraph := getDepInfo()
 
 		// get the longest chain
 		var longestChain Chain
 		var temp Chain
-		getLongestChain(mainModule, depGraph, temp, &longestChain)
+		getLongestChain(depGraph.MainModuleName, depGraph.Graph, temp, &longestChain)
 
 		// get values
-		totalDeps := len(deps)
+		totalDeps := len(depGraph.DepList)
 		maxDepth := len(longestChain)
-		directDeps := len(depGraph[mainModule])
+		directDeps := len(depGraph.Graph[depGraph.MainModuleName])
 		transitiveDeps := totalDeps - directDeps
 
 		if !jsonOutput {
@@ -58,7 +58,7 @@ var statsCmd = &cobra.Command{
 
 		if verbose {
 			fmt.Println("All dependencies:")
-			printDeps(deps)
+			printDeps(depGraph.DepList)
 		}
 
 		// print the longest chain

cmd/utils.go

@@ -30,8 +30,17 @@ func printChain(slice []string) {
 	fmt.Println(strings.Join(slice, " -> "))
 }
 
-func getDepInfo() (map[string][]string, []string, string) {
+// DependencyOverview holds dependency module informations
+type DependencyOverview struct {
+	// Dependency graph edges modelled as node plus adjacency nodes
+	Graph map[string][]string
+	// List of all (including transitive) dependencies
+	DepList []string
+	// Name of the module from which the dependencies are computed
+	MainModuleName string
+}
 
+func getDepInfo() *DependencyOverview {
 	// get output of "go mod graph" in a string
 	goModGraph := exec.Command("go", "mod", "graph")
 	goModGraphOutput, err := goModGraph.Output()
@@ -60,21 +69,26 @@ func getDepInfo() (map[string][]string, []string, string) {
 			depGraph[words[0]] = append(depGraph[words[0]], words[1])
 		}
 
+		isMainModule := false
 		if mainModule == "notset" {
 			mainModule = words[0]
-			// we don't want to add mainModule to deps list
-			continue
+			isMainModule = true
 		}
 
-		if !contains(deps, words[0]) {
+		if !contains(deps, words[0]) && !isMainModule {
+			// we don't want to add mainModule to deps list
 			deps = append(deps, words[0])
 		}
 		if !contains(deps, words[1]) {
 			deps = append(deps, words[1])
 		}
 
 	}
-	return depGraph, deps, mainModule
+	return &DependencyOverview{
+		Graph:          depGraph,
+		DepList:        deps,
+		MainModuleName: mainModule,
+	}
 }
 
 func printDeps(deps []string) {

cmd/utils_test.go

@@ -44,6 +44,11 @@ func Test_getChains_simple(t *testing.T) {
 	graph["F"] = []string{"H"}
 
 	deps := []string{"A", "B", "C", "D", "E", "F", "H"}
+	overview := &DependencyOverview{
+		Graph:          graph,
+		DepList:           deps,
+		MainModuleName: "A",
+	}
 
 	var cycleChains []Chain
 	var longestChain Chain
@@ -72,7 +77,7 @@ func Test_getChains_simple(t *testing.T) {
 "F" -> "H"
 `
 
-	if correctFileContentsForAllDeps != getFileContentsForAllDeps(deps, graph, "A") {
+	if correctFileContentsForAllDeps != getFileContentsForAllDeps(overview) {
 		t.Errorf("File contents for graph of all dependencies are wrong")
 	}
 
@@ -131,6 +136,11 @@ func Test_getChains_cycle(t *testing.T) {
 	graph["H"] = []string{"D"}
 
 	deps := []string{"A", "B", "C", "D", "E", "F", "G", "H"}
+	overview := &DependencyOverview{
+		Graph:          graph,
+		DepList:           deps,
+		MainModuleName: "A",
+	}
 
 	var cycleChains []Chain
 	var longestChain Chain
@@ -152,7 +162,7 @@ func Test_getChains_cycle(t *testing.T) {
 "G" -> "H"
 "H" -> "D"
 `
-	if correctFileContentsForAllDeps != getFileContentsForAllDeps(deps, graph, "A") {
+	if correctFileContentsForAllDeps != getFileContentsForAllDeps(overview) {
 		t.Errorf("File contents for graph of all dependencies are wrong")
 	}
 
@@ -218,6 +228,12 @@ func Test_getChains_cycle_2(t *testing.T) {
 
 	deps := []string{"A", "B", "C", "D", "E", "F"}
 
+	overview := &DependencyOverview{
+		Graph:          graph,
+		DepList:           deps,
+		MainModuleName: "A",
+	}
+
 	var cycleChains []Chain
 	var longestChain Chain
 	var chains []Chain
@@ -245,7 +261,7 @@ func Test_getChains_cycle_2(t *testing.T) {
 "E" -> "F"
 "F" -> "D"
 `
-	if correctFileContentsForAllDeps != getFileContentsForAllDeps(deps, graph, "A") {
+	if correctFileContentsForAllDeps != getFileContentsForAllDeps(overview) {
 		t.Errorf("File contents for graph of all dependencies are wrong")
 	}