Merge pull request #87 from k1LoW/hide-details

Add `--hide-details` option

cmd/doc.go

@@ -352,6 +352,13 @@ func newConfig() (*config.Config, error) {
 	if err := cfg.Build(); err != nil {
 		return nil, err
 	}
+
+	if hideDetails {
+		if err := cfg.HideDetails(); err != nil {
+			return nil, err
+		}
+	}
+
 	return cfg, nil
 }
 
@@ -360,5 +367,6 @@ func init() {
 	docCmd.Flags().StringVarP(&configPath, "config", "c", "", "config file path")
 	docCmd.Flags().StringSliceVarP(&nodeLists, "nodes", "n", []string{}, "real node list file path")
 	docCmd.Flags().BoolVarP(&rmDist, "rm-dist", "", false, "remove all files in the document directory before generating the documents")
+	docCmd.Flags().BoolVarP(&hideDetails, "hide-details", "", false, "hide details")
 	rootCmd.AddCommand(docCmd)
 }

cmd/draw.go

@@ -86,5 +86,6 @@ func init() {
 	drawCmd.Flags().StringVarP(&configPath, "config", "c", "", "config file path")
 	drawCmd.Flags().StringSliceVarP(&nodeLists, "nodes", "n", []string{}, "real node list file path")
 	drawCmd.Flags().StringVarP(&out, "out", "", "", "output file path")
+	drawCmd.Flags().BoolVarP(&hideDetails, "hide-details", "", false, "hide details")
 	rootCmd.AddCommand(drawCmd)
 }

cmd/root.go

@@ -32,14 +32,15 @@ import (
 )
 
 var (
-	force      bool
-	format     string
-	layers     []string
-	nodeLists  []string
-	configPath string
-	out        string
-	rmDist     bool
-	iconPrefix string
+	force       bool
+	format      string
+	layers      []string
+	nodeLists   []string
+	configPath  string
+	out         string
+	rmDist      bool
+	iconPrefix  string
+	hideDetails bool
 )
 
 var rootCmd = &cobra.Command{

config/build.go

@@ -465,3 +465,86 @@ func (cfg *Config) buildColors() error {
 	}
 	return nil
 }
+
+const maskedDesc = "\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*."
+
+func (cfg *Config) HideDetails() error {
+
+	// labels
+	labelMap := map[string]string{}
+	for i, l := range cfg.labels {
+		n := fmt.Sprintf("label%d", i)
+		labelMap[l.Id()] = n
+		l.Name = n
+		if l.Desc != "" {
+			l.Desc = maskedDesc
+		}
+	}
+
+	// layers
+	layerMap := map[string]string{}
+	for i, l := range cfg.Layers() {
+		n := fmt.Sprintf("layer%d", i)
+		layerMap[l.Id()] = n
+		l.Name = n
+		if l.Desc != "" {
+			l.Desc = maskedDesc
+		}
+	}
+
+	// views
+	for i, v := range cfg.Views {
+		v.Name = fmt.Sprintf("view%d", i)
+		if v.Desc != "" {
+			v.Desc = maskedDesc
+		}
+		for i, l := range v.Labels {
+			ll, ok := labelMap[strings.ToLower(l)]
+			if !ok {
+				return fmt.Errorf("label not found: %s", l)
+			}
+			v.Labels[i] = ll
+		}
+		for i, l := range v.Layers {
+			ll, ok := layerMap[strings.ToLower(l)]
+			if !ok {
+				return fmt.Errorf("layer not found: %s", l)
+			}
+			v.Layers[i] = ll
+		}
+	}
+
+	// clusters
+	for i, c := range cfg.Clusters() {
+		c.Name = fmt.Sprintf("cluster%d", i)
+		if c.Desc != "" {
+			c.Desc = maskedDesc
+		}
+	}
+
+	// nodes
+	for i, n := range cfg.Nodes {
+		n.Name = fmt.Sprintf("node%d", i)
+		if n.Desc != "" {
+			n.Desc = maskedDesc
+		}
+		n.RealNodes = nil
+	}
+
+	// components
+	for i, c := range cfg.Components() {
+		c.Name = fmt.Sprintf("component%d", i)
+		if c.Desc != "" {
+			c.Desc = maskedDesc
+		}
+	}
+
+	// relations
+	for _, r := range cfg.Relations {
+		if r.Desc != "" {
+			r.Desc = maskedDesc
+		}
+	}
+
+	return nil
+}

config/config_test.go

@@ -4,6 +4,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 )
 
@@ -241,6 +242,36 @@ func TestBuildNestedCluster(t *testing.T) {
 	}
 }
 
+func TestHideDetails(t *testing.T) {
+	func() {
+		tempDir, err := ioutil.TempDir("", "ndiag")
+		if err != nil {
+			t.Fatal(err)
+		}
+		defer os.RemoveAll(tempDir)
+		cfg := New()
+		if err := cfg.LoadConfigFile(filepath.Join(testdataDir(t), "..", "example", "3-tier", "input", "ndiag.yml")); err != nil {
+			t.Fatal(err)
+		}
+		cfg.DocPath = tempDir
+		if err := cfg.Build(); err != nil {
+			t.Fatal(err)
+		}
+		want := len(cfg.Components())
+		if err := cfg.HideDetails(); err != nil {
+			t.Fatal(err)
+		}
+		if got := len(cfg.Components()); got != want {
+			t.Errorf("got %v\nwant %v", got, want)
+		}
+		for _, c := range cfg.Components() {
+			if !strings.Contains(c.Name, "component") {
+				t.Errorf("got %v\nwant %v", c.Name, "component*")
+			}
+		}
+	}()
+}
+
 func testdataDir(t *testing.T) string {
 	t.Helper()
 	wd, err := os.Getwd()