Merge pull request #590 from majimaccho/feat/issue/587

Show table comments for related tables of View (#587)
k1LoW · Jun 4, 2024 · 14d8bdc · 14d8bdc
2 parents d70e325 + e5240b1
commit 14d8bdc
Show file tree

Hide file tree

Showing 70 changed files with 415 additions and 176 deletions.
diff --git a/output/md/md.go b/output/md/md.go
@@ -701,20 +701,22 @@ func (m *Md) makeTableTemplateData(t *schema.Table) map[string]interface{} {
 	}
 
 	// Referenced Tables
-	referencedTables := []string{}
+	hasReferencedTableWithLabels := false
 	for _, rt := range t.ReferencedTables {
-		if rt.External {
-			referencedTables = append(referencedTables, rt.Name)
-			continue
+		if len(rt.Labels) > 0 {
+			hasReferencedTableWithLabels = true
+			break
 		}
-		referencedTables = append(referencedTables, fmt.Sprintf("[%s](%s%s.md)", rt.Name, m.config.BaseUrl, mdurl.Encode(rt.Name)))
 	}
 
+	referencedTables := m.tablesData(t.ReferencedTables, number, adjust, showOnlyFirstParagraph, hasReferencedTableWithLabels)
+
 	if number {
 		columnsData = m.addNumberToTable(columnsData)
 		constraintsData = m.addNumberToTable(constraintsData)
 		indexesData = m.addNumberToTable(indexesData)
 		triggersData = m.addNumberToTable(triggersData)
+		referencedTables = m.addNumberToTable(referencedTables)
 	}
 
 	if adjust {
@@ -725,7 +727,7 @@ func (m *Md) makeTableTemplateData(t *schema.Table) map[string]interface{} {
 			"Constraints":      adjustTable(constraintsData),
 			"Indexes":          adjustTable(indexesData),
 			"Triggers":         adjustTable(triggersData),
-			"ReferencedTables": referencedTables,
+			"ReferencedTables": adjustTable(referencedTables),
 		}
 	}
 

diff --git a/output/md/md_test.go b/output/md/md_test.go
@@ -32,7 +32,7 @@ var tests = []struct {
 	{"mermaid a.md", "mermaid", false, false, false, false, "b", "a.md", "md_test_a.md.mermaid"},
 	{"showOnlyFirstParagraph README.md", "png", false, false, false, true, "b", "README.md", "md_test_README.md.first_para"},
 	{"showOnlyFirstParagraph a.md", "png", false, false, false, true, "b", "a.md", "md_test_a.md.first_para"},
-
+	{"view.md", "png", false, false, true, false, "b", "view.md", "md_test_view.md"},
 	{"viewpoint-1.md", "png", false, false, false, false, "b", "viewpoint-1.md", "md_test_viewpoint-1.md"},
 	{"viewpoint-2.md", "png", false, false, false, false, "b", "viewpoint-2.md", "md_test_viewpoint-2.md"},
 	{"viewpoint-1.md", "mermaid", false, false, false, false, "b", "viewpoint-1.md", "md_test_viewpoint-1.md.mermaid"},
@@ -49,6 +49,7 @@ var testsTemplate = []struct {
 }{
 	{"README.md", false, false, true, false, "README.md", "md_template_test_README.md"},
 	{"a.md", false, false, true, false, "a.md", "md_template_test_a.md"},
+	{"view.md", false, false, true, false, "view.md", "md_template_test_view.md"},
 	{"--adjust option", true, false, true, false, "README.md", "md_template_test_README.md.adjust"},
 	{"number", false, true, true, false, "README.md", "md_template_test_README.md.number"},
 	{"showOnlyFirstParagraph", false, true, true, true, "README.md", "md_template_test_README.md.first_para"},

diff --git a/output/md/templates/table.md.tmpl b/output/md/templates/table.md.tmpl
@@ -15,11 +15,7 @@
 ```
 
 </details>
-{{- end }}{{ $len := len .ReferencedTables }}{{ if ne $len 0 }}
 
-## {{ "Referenced Tables" | lookup }}
-{{ range $rt := .ReferencedTables }}
-- {{ $rt }}{{ end }}
 {{- end }}
 {{- if ne (len .Table.Labels) 0 }}
 
@@ -34,6 +30,13 @@
 |{{ range $d := $l }} {{ $d | nl2br }} |{{ end }}
 {{- end }}
 
+{{ $len := len .ReferencedTables }}{{ if ne $len 2 -}}
+## {{ "Referenced Tables" | lookup }}
+{{ range $l := .ReferencedTables }}
+|{{ range $d := $l }} {{ $d | nl2br }} |{{ end }}
+{{- end }}
+
+{{ end -}}
 {{ $len := len .Viewpoints }}{{ if ne $len 2 -}}
 ## {{ "Viewpoints" | lookup }}
 {{ range $l := .Viewpoints }}

diff --git a/sample/adjust/public.post_comment_stars.md b/sample/adjust/public.post_comment_stars.md
@@ -21,12 +21,6 @@ CREATE MATERIALIZED VIEW post_comment_stars AS (
 
 </details>
 
-## Referenced Tables
-
-- [public.comments](public.comments.md)
-- [public.comment_stars](public.comment_stars.md)
-- [public.users](public.users.md)
-
 ## Columns
 
 | Name              | Type                        | Default | Nullable | Children | Parents | Comment |
@@ -37,6 +31,14 @@ CREATE MATERIALIZED VIEW post_comment_stars AS (
 | created           | timestamp without time zone |         | true     |          |         |         |
 | updated           | timestamp without time zone |         | true     |          |         |         |
 
+## Referenced Tables
+
+| Name                                            | Columns | Comment                                    | Type       |
+| ----------------------------------------------- | ------- | ------------------------------------------ | ---------- |
+| [public.comments](public.comments.md)           | 7       | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
+| [public.comment_stars](public.comment_stars.md) | 6       |                                            | BASE TABLE |
+| [public.users](public.users.md)                 | 6       | Users table                                | BASE TABLE |
+
 ## Relations
 
 ![er](public.post_comment_stars.svg)

diff --git a/sample/adjust/public.post_comments.md b/sample/adjust/public.post_comments.md
@@ -25,12 +25,6 @@ CREATE VIEW post_comments AS (
 
 </details>
 
-## Referenced Tables
-
-- [public.posts](public.posts.md)
-- [public.comments](public.comments.md)
-- [public.users](public.users.md)
-
 ## Columns
 
 | Name         | Type                        | Default | Nullable | Children | Parents | Comment                 |
@@ -43,6 +37,14 @@ CREATE VIEW post_comments AS (
 | created      | timestamp without time zone |         | true     |          |         | comments.created        |
 | updated      | timestamp without time zone |         | true     |          |         | comments.updated        |
 
+## Referenced Tables
+
+| Name                                  | Columns | Comment                                    | Type       |
+| ------------------------------------- | ------- | ------------------------------------------ | ---------- |
+| [public.posts](public.posts.md)       | 8       | Posts table                                | BASE TABLE |
+| [public.comments](public.comments.md) | 7       | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
+| [public.users](public.users.md)       | 6       | Users table                                | BASE TABLE |
+
 ## Relations
 
 ![er](public.post_comments.svg)

diff --git a/sample/adjust/schema.json b/sample/adjust/schema.json
diff --git a/sample/detect_relations/post_comments.md b/sample/detect_relations/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Children | Parents | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 | created | datetime |  | true |  |  | comments.created |
 | updated | datetime |  | true |  |  | comments.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
+| [comments](comments.md) | 6 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |  |
+| [users](users.md) | 6 | Users table | BASE TABLE |  |
+
 ## Relations
 
 ![er](post_comments.svg)

diff --git a/sample/detect_relations/schema.json b/sample/detect_relations/schema.json
diff --git a/sample/detect_relations_singular/post_comment.md b/sample/detect_relations_singular/post_comment.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comment AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2`
 
 </details>
 
-## Referenced Tables
-
-- [post](post.md)
-- [comment](comment.md)
-- [user](user.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Children | Parents | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comment AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2`
 | created | datetime |  | true |  |  | comment.created |
 | updated | datetime |  | true |  |  | comment.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [post](post.md) | 7 | Post table | BASE TABLE | `green` `red` `blue` |
+| [comment](comment.md) | 6 | Comment<br>Multi-line<br>table<br>comment | BASE TABLE |  |
+| [user](user.md) | 6 | User table | BASE TABLE |  |
+
 ## Relations
 
 ![er](post_comment.svg)

diff --git a/sample/detect_relations_singular/schema.json b/sample/detect_relations_singular/schema.json
diff --git a/sample/dict/post_comments.md b/sample/dict/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## カラム一覧
 
 | 名前           | タイプ          | デフォルト値       | Nullable | 子テーブル      | 親テーブル      | コメント                                       |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 | created      | datetime     |              | true     |            |            |                                            |
 | updated      | datetime     |              | true     |            |            |                                            |
 
+## Referenced Tables
+
+| 名前                        | カラム一覧           | コメント                                           | タイプ           |
+| ------------------------- | --------------- | ---------------------------------------------- | ------------- |
+| [posts](posts.md)         | 7               | Posts table                                    | BASE TABLE    |
+| [comments](comments.md)   | 7               | Comments<br>Multi-line<br>table<br>comment     | BASE TABLE    |
+| [users](users.md)         | 6               | Users table                                    | BASE TABLE    |
+
 ## ER図
 
 ![er](post_comments.svg)

diff --git a/sample/dict/schema.json b/sample/dict/schema.json
diff --git a/sample/exclude/post_comments.md b/sample/exclude/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Children | Parents | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 | created | datetime |  | true |  |  | comments.created |
 | updated | datetime |  | true |  |  | comments.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type |
+| ---- | ------- | ------- | ---- |
+| [posts](posts.md) | 7 | Posts table | BASE TABLE |
+| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
+| [users](users.md) | 6 | Users table | BASE TABLE |
+
 ## Relations
 
 ![er](post_comments.svg)

diff --git a/sample/exclude/schema.json b/sample/exclude/schema.json
diff --git a/sample/font/post_comments.md b/sample/font/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Children | Parents | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 | created | datetime |  | true |  |  | comments.created |
 | updated | datetime |  | true |  |  | comments.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type |
+| ---- | ------- | ------- | ---- |
+| [posts](posts.md) | 7 | エントリ | BASE TABLE |
+| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
+| [users](users.md) | 6 | Users table | BASE TABLE |
+
 ## Relations
 
 ![er](post_comments.png)

diff --git a/sample/font/schema.json b/sample/font/schema.json
diff --git a/sample/hide/post_comments.md b/sample/hide/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 | created | datetime |  | true | comments.created |
 | updated | datetime |  | true | comments.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
+| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |  |
+| [users](users.md) | 6 | Users table | BASE TABLE |  |
+
 ## Relations
 
 ![er](post_comments.svg)

diff --git a/sample/hide/schema.json b/sample/hide/schema.json
diff --git a/sample/hide_not_related_column/post_comments.md b/sample/hide_not_related_column/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Children | Parents | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 | created | datetime |  | true |  |  | comments.created |
 | updated | datetime |  | true |  |  | comments.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
+| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |  |
+| [users](users.md) | 6 | Users table | BASE TABLE |  |
+
 ## Relations
 
 ![er](post_comments.svg)

diff --git a/sample/hide_not_related_column/schema.json b/sample/hide_not_related_column/schema.json
diff --git a/sample/mariadb/post_comments.md b/sample/mariadb/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS ((select `c`.`id` AS `id`,`p`.`title` AS `title`,`u
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Children | Parents | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS ((select `c`.`id` AS `id`,`p`.`title` AS `title`,`u
 | created | datetime |  | true |  |  | comments.created |
 | updated | datetime | NULL | true |  |  | comments.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
+| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |  |
+| [users](users.md) | 6 | Users table | BASE TABLE |  |
+
 ## Relations
 
 ![er](post_comments.svg)

diff --git a/sample/mariadb/schema.json b/sample/mariadb/schema.json
diff --git a/sample/mermaid/post_comments.md b/sample/mermaid/post_comments.md
@@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 
 </details>
 
-## Referenced Tables
-
-- [posts](posts.md)
-- [comments](comments.md)
-- [users](users.md)
-
 ## Columns
 
 | Name | Type | Default | Nullable | Children | Parents | Comment |
@@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
 | created | datetime |  | true |  |  | comments.created |
 | updated | datetime |  | true |  |  | comments.updated |
 
+## Referenced Tables
+
+| Name | Columns | Comment | Type | Labels |
+| ---- | ------- | ------- | ---- | ------ |
+| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
+| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |  |
+| [users](users.md) | 6 | Users table | BASE TABLE |  |
+
 ## Relations
 
 ```mermaid

diff --git a/sample/mermaid/schema.json b/sample/mermaid/schema.json