Merge pull request #46 from RinkiyaKeDad/fix_stats

change metrics shown by stats command

cmd/graph.go

@@ -19,6 +19,7 @@ package cmd
 import (
 	"fmt"
 	"io/ioutil"
+	"sort"
 	"strings"
 
 	"github.com/spf13/cobra"
@@ -106,7 +107,10 @@ func getFileContentsForAllDeps(overview *DependencyOverview) string {
 
 	// color the main module as yellow
 	data := colorMainNode(overview.MainModuleName)
-	for _, dep := range overview.DepList {
+	allDeps := getAllDeps(overview.Graph[overview.MainModuleName], overview.TransDepList)
+	allDeps = append(allDeps, overview.MainModuleName)
+	sort.Strings(allDeps)
+	for _, dep := range allDeps {
 		_, ok := overview.Graph[dep]
 		if !ok {
 			continue

cmd/list.go

@@ -31,7 +31,8 @@ var listCmd = &cobra.Command{
 	RunE: func(cmd *cobra.Command, args []string) error {
 		depGraph := getDepInfo()
 		fmt.Println("List of all dependencies:")
-		printDeps(depGraph.DepList)
+		allDeps := getAllDeps(depGraph.Graph[depGraph.MainModuleName], depGraph.TransDepList)
+		printDeps(allDeps)
 		return nil
 	},
 }

cmd/stats.go

@@ -45,20 +45,21 @@ var statsCmd = &cobra.Command{
 		getLongestChain(depGraph.MainModuleName, depGraph.Graph, temp, &longestChain)
 
 		// get values
-		totalDeps := len(depGraph.DepList)
 		maxDepth := len(longestChain)
 		directDeps := len(depGraph.Graph[depGraph.MainModuleName])
-		transitiveDeps := totalDeps - directDeps
+		totalDeps := len(getAllDeps(depGraph.Graph[depGraph.MainModuleName], depGraph.TransDepList))
+		transitiveDeps := len(depGraph.TransDepList)
 
 		if !jsonOutput {
+			fmt.Printf("Direct Dependencies: %d \n", directDeps)
+			fmt.Printf("Transitive Dependencies: %d \n", transitiveDeps)
 			fmt.Printf("Total Dependencies: %d \n", totalDeps)
 			fmt.Printf("Max Depth Of Dependencies: %d \n", maxDepth)
-			fmt.Printf("Transitive Dependencies: %d \n", transitiveDeps)
 		}
 
 		if verbose {
 			fmt.Println("All dependencies:")
-			printDeps(depGraph.DepList)
+			printDeps(append(depGraph.Graph[depGraph.MainModuleName], depGraph.TransDepList...))
 		}
 
 		// print the longest chain
@@ -70,13 +71,15 @@ var statsCmd = &cobra.Command{
 		if jsonOutput {
 			// create json
 			outputObj := struct {
-				TotalDeps int `json:"totalDependencies"`
-				MaxDepth  int `json:"maxDepthOfDependencies"`
-				TransDeps int `json:"transitiveDependencies"`
+				DirectDeps int `json:"directDependencies"`
+				TransDeps  int `json:"transitiveDependencies"`
+				TotalDeps  int `json:"totalDependencies"`
+				MaxDepth   int `json:"maxDepthOfDependencies"`
 			}{
-				TotalDeps: totalDeps,
-				MaxDepth:  maxDepth,
-				TransDeps: transitiveDeps,
+				DirectDeps: directDeps,
+				TransDeps:  transitiveDeps,
+				TotalDeps:  totalDeps,
+				MaxDepth:   maxDepth,
 			}
 			outputRaw, err := json.MarshalIndent(outputObj, "", "\t")
 			if err != nil {

cmd/utils.go

@@ -34,8 +34,8 @@ func printChain(slice []string) {
 type DependencyOverview struct {
 	// Dependency graph edges modelled as node plus adjacency nodes
 	Graph map[string][]string
-	// List of all (including transitive) dependencies
-	DepList []string
+	// List of all transitive dependencies
+	TransDepList []string
 	// Name of the module from which the dependencies are computed
 	MainModuleName string
 }
@@ -53,8 +53,8 @@ func getDepInfo() *DependencyOverview {
 	depGraph := make(map[string][]string)
 	scanner := bufio.NewScanner(strings.NewReader(goModGraphOutputString))
 
-	// deps will store all the dependencies
-	var deps []string
+	// transDeps will store all the transitive dependencies
+	var transDeps []string
 	mainModule := "notset"
 
 	for scanner.Scan() {
@@ -69,24 +69,21 @@ func getDepInfo() *DependencyOverview {
 			depGraph[words[0]] = append(depGraph[words[0]], words[1])
 		}
 
-		isMainModule := false
 		if mainModule == "notset" {
 			mainModule = words[0]
-			isMainModule = true
 		}
 
-		if !contains(deps, words[0]) && !isMainModule {
-			// we don't want to add mainModule to deps list
-			deps = append(deps, words[0])
+		// anything where the LHS is not mainModule
+		// is a transitive dependency
+		if words[0] != mainModule {
+			if !contains(transDeps, words[1]) {
+				transDeps = append(transDeps, words[1])
+			}
 		}
-		if !contains(deps, words[1]) {
-			deps = append(deps, words[1])
-		}
-
 	}
 	return &DependencyOverview{
 		Graph:          depGraph,
-		DepList:        deps,
+		TransDepList:   transDeps,
 		MainModuleName: mainModule,
 	}
 }
@@ -100,6 +97,21 @@ func printDeps(deps []string) {
 	fmt.Println()
 }
 
+func getAllDeps(directDeps []string, transDeps []string) []string {
+	var allDeps []string
+	for _, dep := range directDeps {
+		if !contains(allDeps, dep) {
+			allDeps = append(allDeps, dep)
+		}
+	}
+	for _, dep := range transDeps {
+		if !contains(allDeps, dep) {
+			allDeps = append(allDeps, dep)
+		}
+	}
+	return allDeps
+}
+
 func contains(s []string, str string) bool {
 	for _, v := range s {
 		if v == str {

cmd/utils_test.go

@@ -17,6 +17,7 @@ limitations under the License.
 package cmd
 
 import (
+	"fmt"
 	"testing"
 )
 
@@ -43,10 +44,10 @@ func Test_getChains_simple(t *testing.T) {
 	graph["E"] = []string{"F"}
 	graph["F"] = []string{"H"}
 
-	deps := []string{"A", "B", "C", "D", "E", "F", "H"}
+	transDeps := []string{"E", "G", "F", "H"}
 	overview := &DependencyOverview{
 		Graph:          graph,
-		DepList:           deps,
+		TransDepList:   transDeps,
 		MainModuleName: "A",
 	}
 
@@ -76,7 +77,7 @@ func Test_getChains_simple(t *testing.T) {
 "E" -> "F"
 "F" -> "H"
 `
-
+	fmt.Println(getFileContentsForAllDeps(overview))
 	if correctFileContentsForAllDeps != getFileContentsForAllDeps(overview) {
 		t.Errorf("File contents for graph of all dependencies are wrong")
 	}
@@ -135,10 +136,10 @@ func Test_getChains_cycle(t *testing.T) {
 	graph["G"] = []string{"H"}
 	graph["H"] = []string{"D"}
 
-	deps := []string{"A", "B", "C", "D", "E", "F", "G", "H"}
+	transDeps := []string{"D", "E", "F", "G", "H"}
 	overview := &DependencyOverview{
 		Graph:          graph,
-		DepList:           deps,
+		TransDepList:   transDeps,
 		MainModuleName: "A",
 	}
 
@@ -226,11 +227,11 @@ func Test_getChains_cycle_2(t *testing.T) {
 	graph["F"] = []string{"D"}
 	graph["D"] = []string{"C"}
 
-	deps := []string{"A", "B", "C", "D", "E", "F"}
+	transDeps := []string{"C", "B", "E", "F", "D"}
 
 	overview := &DependencyOverview{
 		Graph:          graph,
-		DepList:           deps,
+		TransDepList:   transDeps,
 		MainModuleName: "A",
 	}