Feature - Issue #170 - Update YAML Viewer (#191)

* Changes tabular YAML view to only work with toc.yaml files * Used switch for YAML module per code review * Uses a 'type' switch as per code review
unfoldingWord · Jun 7, 2017 · ee3d2e1 · ee3d2e1
1 parent 9b0ac3d
commit ee3d2e1
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 18 deletions.
diff --git a/modules/yaml/yaml.go b/modules/yaml/yaml.go
@@ -35,13 +35,22 @@ func renderHorizontalHtmlTable(m yaml.MapSlice) string {
 		key := mi.Key
 		value := mi.Value
 
-		if key != nil && reflect.TypeOf(key).String() == "yaml.MapSlice" {
+		switch key.(type) {
+		case yaml.MapSlice:
 			key = renderHorizontalHtmlTable(key.(yaml.MapSlice))
 		}
 		thead += fmt.Sprintf("<th>%v</th>", key)
 
-		if value != nil && reflect.TypeOf(value).String() == "yaml.MapSlice" {
+		switch value.(type) {
+		case yaml.MapSlice:
 			value = renderHorizontalHtmlTable(value.(yaml.MapSlice))
+		case []interface {}:
+			value = value.([]interface{})
+			v := make([]yaml.MapSlice, len(value.([]interface{})))
+			for i, vs := range value.([]interface{}) {
+				v[i] = vs.(yaml.MapSlice)
+			}
+			value = renderVerticalHtmlTable(v)
 		}
 		tbody += fmt.Sprintf("<td>%v</td>", value)
 	}
@@ -65,9 +74,10 @@ func renderVerticalHtmlTable(m []yaml.MapSlice) string {
 			value := mi.Value
 
 			table += `<tr>`
-			if key != nil && reflect.TypeOf(key).String() == "yaml.MapSlice" {
+			switch key.(type) {
+			case yaml.MapSlice:
 				key = renderHorizontalHtmlTable(key.(yaml.MapSlice))
-			} else if key != nil && reflect.TypeOf(key).String() == "[]interface {}" {
+			case []interface {}:
 				var ks string
 				for _, ki := range key.([]interface{}) {
 					log.Info("KI: %v", ki)
@@ -78,21 +88,25 @@ func renderVerticalHtmlTable(m []yaml.MapSlice) string {
 			}
 			table += fmt.Sprintf("<td>%v</td>", key)
 
-			if value != nil && reflect.TypeOf(value).String() == "yaml.MapSlice" {
+			switch value.(type) {
+			case yaml.MapSlice:
 				value = renderHorizontalHtmlTable(value.(yaml.MapSlice))
-			} else if value != nil && reflect.TypeOf(value).String() == "[]interface {}" {
+			case []interface {}:
 				value = value.([]interface{})
 				v := make([]yaml.MapSlice, len(value.([]interface{})))
 				for i, vs := range value.([]interface{}) {
 					v[i] = vs.(yaml.MapSlice)
 				}
 				value = renderVerticalHtmlTable(v)
 			}
-			if key == "slug" {
+
+			switch key {
+			case "slug":
 				value = fmt.Sprintf(`<a href="content/%v.md">%v</a>`, value, value)
+			case "link":
+				value = fmt.Sprintf(`<a href="%v/01.md">%v</a>`, value, value)
 			}
 			table += fmt.Sprintf("<td>%v</td>", value)
-
 			table += `</tr>`
 		}
 		table += "</table>"

diff --git a/routers/repo/view.go b/routers/repo/view.go
@@ -196,20 +196,19 @@ func renderFile(ctx *context.Context, entry *git.TreeEntry, treeLink, rawLink st
 
 		readmeExist := isSupportedMarkup || markup.IsReadmeFile(blob.Name())
 		ctx.Data["ReadmeExist"] = readmeExist
-		isYaml := yaml.IsYamlFile(blob.Name())
-		ctx.Data["IsYaml"] = isYaml
+		isTocYaml := blob.Name() == "toc.yaml"
+		ctx.Data["IsTocYaml"] = isTocYaml
 		if readmeExist && isSupportedMarkup {
 			yamlHtml := yaml.RenderMarkdownYaml(buf)
 			markupBody := markup.Render(blob.Name(), yaml.StripYamlFromText(buf), path.Dir(treeLink), ctx.Repo.Repository.ComposeMetas())
 			ctx.Data["FileContent"] = string(append(yamlHtml, markupBody...))
-		} else if isYaml {
-			rendered, err := yaml.RenderYaml(buf)
-			if err == nil {
+		} else if isTocYaml {
+			if rendered, err := yaml.RenderYaml(buf); err != nil {
+				ctx.Flash.ErrorMsg = fmt.Sprintf("Unable to parse YAML: %v", err)
+				ctx.Data["Flash"] = ctx.Flash
+			} else {
 				ctx.Data["FileContent"] = string(rendered)
-				break
 			}
-			ctx.Flash.ErrorMsg = fmt.Sprintf("Unable to parse YAML: %v", err)
-			ctx.Data["Flash"] = ctx.Flash
 		} else {
 			// Building code view blocks with line number on server side.
 			var fileContent string

diff --git a/templates/repo/view_file.tmpl b/templates/repo/view_file.tmpl
@@ -36,12 +36,12 @@
 		{{end}}
 	</h4>
 	<div class="ui attached table segment">
-		<div class="file-view {{if .IsMarkdown}}markdown{{else if .IsYaml}}markdown yaml{{else if .IsTextFile}}code-view{{end}} has-emoji">
+		<div class="file-view {{if .IsMarkdown}}markdown{{else if .IsTocYaml}}markdown yaml{{else if .IsTextFile}}code-view{{end}} has-emoji">
 			{{if .IsMarkdown}}
 				<article class="markdown-body" itemprop="text">
 				{{if .FileContent}}{{.FileContent | Str2html}}{{end}}
 				</article>
-			{{else if .IsYaml}}
+			{{else if .IsTocYaml}}
 				<article class="markdown-body" itemprop="text">
 				{{if .FileContent}}{{.FileContent | Str2html}}{{end}}
 				</article>