feature(parser/renderer): unordered lists should support style (#660)

This converts unordered lists so that they can support multiple roles, and the style attribute properly. It includes both the parser side and renderer side changes. The templates were converted to use the exact HTML output that asciidoctor emits. Fixes #658
bytesparadise · Jun 28, 2020 · c93bc82 · c93bc82
1 parent 6b342f4
commit c93bc82
Show file tree

Hide file tree

Showing 8 changed files with 2,383 additions and 2,251 deletions.
diff --git a/pkg/parser/parser.go b/pkg/parser/parser.go
diff --git a/pkg/parser/parser.peg b/pkg/parser/parser.peg
@@ -764,8 +764,8 @@ OrderedListItemContent <- elements:(ListParagraph+) {
 // ------------------------------------------
 // Unordered List Items
 // ------------------------------------------
-UnorderedListItem <- attributes:(Attributes)? prefix:(UnorderedListItemPrefix) checkstyle:(UnorderedListItemCheckStyle)? content:(UnorderedListItemContent) {
-    return types.NewUnorderedListItem(prefix.(types.UnorderedListItemPrefix), checkstyle, content.([]interface{}), attributes)
+UnorderedListItem <- attrs:(BlockAttrs)* prefix:(UnorderedListItemPrefix) checkstyle:(UnorderedListItemCheckStyle)? content:(UnorderedListItemContent) {
+    return types.NewUnorderedListItem(prefix.(types.UnorderedListItemPrefix), checkstyle, content.([]interface{}), attrs)
 }
 
 UnorderedListItemPrefix <- 

diff --git a/pkg/parser/unordered_list_test.go b/pkg/parser/unordered_list_test.go
@@ -67,6 +67,39 @@ var _ = Describe("unordered lists", func() {
 				}
 				Expect(ParseDraftDocument(source)).To(MatchDraftDocument(expected))
 			})
+			It("unordered list with style ID, title, role and a single item", func() {
+				source := `.mytitle
+[square#listID]
+[.myrole]
+* a list item`
+				expected := types.DraftDocument{
+					Blocks: []interface{}{
+						types.UnorderedListItem{
+							Attributes: types.Attributes{
+								types.AttrTitle:    "mytitle",
+								types.AttrID:       "listID",
+								types.AttrCustomID: true,
+								types.AttrRole:     "myrole",
+								types.AttrStyle:    "square",
+							},
+							Level:       1,
+							BulletStyle: types.OneAsterisk,
+							CheckStyle:  types.NoCheck,
+							Elements: []interface{}{
+								types.Paragraph{
+									Lines: [][]interface{}{
+										{
+											types.StringElement{Content: "a list item"},
+										},
+									},
+								},
+							},
+						},
+					},
+				}
+				Expect(ParseDraftDocument(source)).To(MatchDraftDocument(expected))
+			})
+
 			It("unordered list with a title and a single item", func() {
 				source := `.a title
 	* a list item`

diff --git a/pkg/renderer/sgml/element_style.go b/pkg/renderer/sgml/element_style.go
@@ -0,0 +1,14 @@
+package sgml
+
+import (
+	"text/template"
+
+	"github.com/bytesparadise/libasciidoc/pkg/types"
+)
+
+func (r *sgmlRenderer) renderElementStyle(attrs types.Attributes) sanitized {
+	if id, ok := attrs[types.AttrStyle].(string); ok {
+		return sanitized(template.HTMLEscapeString(id))
+	}
+	return ""
+}
diff --git a/pkg/renderer/sgml/html5/unordered_list.go b/pkg/renderer/sgml/html5/unordered_list.go
@@ -3,10 +3,11 @@ package html5
 const (
 	unorderedListTmpl = `<div{{ if .ID }} id="{{ .ID }}"{{ end }}` +
 		` class="ulist{{ if .Checklist }} checklist{{ end }}` +
+		`{{ if .Style }} {{ .Style }}{{ end }}` +
 		`{{ if .Roles }} {{ .Roles }}{{ end }}"` +
 		">\n" +
 		"{{ if .Title }}<div class=\"title\">{{ .Title }}</div>\n{{ end }}" +
-		"<ul{{ if .Checklist }} class=\"checklist\"{{ end }}>\n" +
+		"<ul{{ if .Checklist }} class=\"checklist\"{{ else if .Style }} class=\"{{ .Style }}\"{{ end }}>\n" +
 		"{{ .Content }}</ul>\n</div>"
 
 	unorderedListItemTmpl = "<li>\n{{ .Content }}\n</li>\n"

diff --git a/pkg/renderer/sgml/html5/unordered_list_test.go b/pkg/renderer/sgml/html5/unordered_list_test.go
@@ -94,6 +94,26 @@ and a standalone paragraph`
 		Expect(RenderHTML(source)).To(MatchHTML(expected))
 	})
 
+	It("simple unordered list with style id, title and role", func() {
+		source := `.mytitle
+[#foo]
+[disc.myrole]
+* item 1
+* item 2`
+		expected := `<div id="foo" class="ulist disc myrole">
+<div class="title">mytitle</div>
+<ul class="disc">
+<li>
+<p>item 1</p>
+</li>
+<li>
+<p>item 2</p>
+</li>
+</ul>
+</div>`
+		Expect(RenderHTML(source)).To(MatchHTML(expected))
+	})
+
 	It("simple unordered list with continuation", func() {
 		source := `* item 1
 +
@@ -273,6 +293,27 @@ var _ = Describe("checklists", func() {
 		Expect(RenderHTML(source)).To(MatchHTML(expected))
 	})
 
+	It("simple checklist with style id, title and role", func() {
+		// style is overridden to checklist on ul, but div keeps it (asciidoctor compat)
+		source := `.mytitle
+[#foo]
+[disc.myrole]
+* [x] item 1
+* [x] item 2`
+		expected := `<div id="foo" class="ulist checklist disc myrole">
+<div class="title">mytitle</div>
+<ul class="checklist">
+<li>
+<p>&#10003; item 1</p>
+</li>
+<li>
+<p>&#10003; item 2</p>
+</li>
+</ul>
+</div>`
+		Expect(RenderHTML(source)).To(MatchHTML(expected))
+	})
+
 	It("parent checklist with title and nested checklist", func() {
 		source := `.Checklist
 * [ ] parent not checked

diff --git a/pkg/renderer/sgml/unordered_list.go b/pkg/renderer/sgml/unordered_list.go
@@ -31,6 +31,7 @@ func (r *sgmlRenderer) renderUnorderedList(ctx *renderer.Context, l types.Unorde
 		ID        sanitized
 		Title     sanitized
 		Roles     sanitized
+		Style     sanitized
 		Checklist bool
 		Items     []types.UnorderedListItem
 		Content   sanitized
@@ -42,6 +43,7 @@ func (r *sgmlRenderer) renderUnorderedList(ctx *renderer.Context, l types.Unorde
 		Items:     l.Items,
 		Content:   sanitized(content.String()),
 		Roles:     r.renderElementRoles(l.Attributes),
+		Style:     r.renderElementStyle(l.Attributes),
 	})
 	if err != nil {
 		return "", errors.Wrap(err, "unable to render unordered list")

diff --git a/pkg/renderer/sgml/xhtml5/unordered_list_test.go b/pkg/renderer/sgml/xhtml5/unordered_list_test.go
@@ -94,6 +94,26 @@ and a standalone paragraph`
 		Expect(RenderXHTML(source)).To(MatchHTML(expected))
 	})
 
+	It("simple unordered list with style id, title and role", func() {
+		source := `.mytitle
+[#foo]
+[disc.myrole]
+* item 1
+* item 2`
+		expected := `<div id="foo" class="ulist disc myrole">
+<div class="title">mytitle</div>
+<ul class="disc">
+<li>
+<p>item 1</p>
+</li>
+<li>
+<p>item 2</p>
+</li>
+</ul>
+</div>`
+		Expect(RenderXHTML(source)).To(MatchHTML(expected))
+	})
+
 	It("simple unordered list with continuation", func() {
 		source := `* item 1
 +
@@ -273,6 +293,27 @@ var _ = Describe("checklists", func() {
 		Expect(RenderXHTML(source)).To(MatchHTML(expected))
 	})
 
+	It("simple checklist with style id, title and role", func() {
+		// style is overridden to checklist on ul, but div keeps it (asciidoctor compat)
+		source := `.mytitle
+[#foo]
+[disc.myrole]
+* [x] item 1
+* [x] item 2`
+		expected := `<div id="foo" class="ulist checklist disc myrole">
+<div class="title">mytitle</div>
+<ul class="checklist">
+<li>
+<p>&#10003; item 1</p>
+</li>
+<li>
+<p>&#10003; item 2</p>
+</li>
+</ul>
+</div>`
+		Expect(RenderXHTML(source)).To(MatchHTML(expected))
+	})
+
 	It("parent checklist with title and nested checklist", func() {
 		source := `.Checklist
 * [ ] parent not checked