feat(parser/renderer): support 'target' and 'role' attributes in link

pkg/parser/link_test.go

@@ -12,35 +12,71 @@ var _ = Describe("links", func() {
 
 	Context("draft documents", func() {
 
-		It("link with special characters", func() {
-			source := `a link to https://example.com?a=1&b=2`
-			expected := types.DraftDocument{
-				Elements: []interface{}{
-					types.Paragraph{
-						Lines: [][]interface{}{
-							{types.StringElement{Content: "a link to "},
-								types.InlineLink{
-									Location: types.Location{
-										Scheme: "https://",
-										Path: []interface{}{
-											types.StringElement{
-												Content: "example.com?a=1",
-											},
-											types.SpecialCharacter{
-												Name: "&",
+		Context("external link", func() {
+
+			It("with special characters", func() {
+				source := `a link to https://example.com?a=1&b=2`
+				expected := types.DraftDocument{
+					Elements: []interface{}{
+						types.Paragraph{
+							Lines: [][]interface{}{
+								{types.StringElement{Content: "a link to "},
+									types.InlineLink{
+										Location: types.Location{
+											Scheme: "https://",
+											Path: []interface{}{
+												types.StringElement{
+													Content: "example.com?a=1",
+												},
+												types.SpecialCharacter{
+													Name: "&",
+												},
+												types.StringElement{
+													Content: "b=2",
+												},
 											},
-											types.StringElement{
-												Content: "b=2",
+										},
+									},
+								},
+							},
+						},
+					},
+				}
+				Expect(ParseDraftDocument(source)).To(MatchDraftDocument(expected))
+			})
+		})
+
+		Context("relative link", func() {
+
+			It("with text, target and role", func() {
+				source := `a link to link:https://example.com[example,window=mytarget,role=myrole]`
+				expected := types.DraftDocument{
+					Elements: []interface{}{
+						types.Paragraph{
+							Lines: [][]interface{}{
+								{types.StringElement{Content: "a link to "},
+									types.InlineLink{
+										Attributes: types.Attributes{
+											types.AttrInlineLinkText:   "example",
+											types.AttrInlineLinkTarget: "mytarget",
+											types.AttrRoles:            []interface{}{"myrole"},
+										},
+										Location: types.Location{
+											Scheme: "https://",
+											Path: []interface{}{
+												types.StringElement{
+													Content: "example.com",
+												},
 											},
 										},
 									},
 								},
 							},
 						},
 					},
-				},
-			}
-			Expect(ParseDraftDocument(source)).To(MatchDraftDocument(expected))
+				}
+				Expect(ParseDraftDocument(source)).To(MatchDraftDocument(expected))
+			})
 		})
 	})
 

pkg/renderer/sgml/html5/link.go

@@ -1,5 +1,5 @@
 package html5
 
 const (
-	linkTmpl = `<a href="{{ .URL }}"{{if .Class}} class="{{ .Class }}"{{ end }}>{{ .Text }}</a>`
+	linkTmpl = `<a href="{{ .URL }}"{{if .Class}} class="{{ .Class }}"{{ end }}{{if .Target}} target="{{ .Target }}"{{ end }}>{{ .Text }}</a>`
 )

pkg/renderer/sgml/html5/link_test.go

@@ -71,6 +71,24 @@ next lines</p>
 			Expect(RenderHTML(source)).To(MatchHTML(expected))
 		})
 
+		It("with text, target and role", func() {
+			source := `a link to https://example.com[example,window=mytarget,role=myrole]`
+			expected := `<div class="paragraph">
+<p>a link to <a href="https://example.com" class="myrole" target="mytarget">example</a></p>
+</div>
+`
+			Expect(RenderHTML(source)).To(MatchHTML(expected))
+		})
+
+		It("with target and role", func() {
+			source := `a link to https://example.com[window=mytarget,role=myrole]`
+			expected := `<div class="paragraph">
+<p>a link to <a href="https://example.com" class="bare myrole" target="mytarget">https://example.com</a></p>
+</div>
+`
+			Expect(RenderHTML(source)).To(MatchHTML(expected))
+		})
+
 		Context("with document attribute substitutions", func() {
 
 			It("with a document attribute substitution for the whole URL", func() {
@@ -227,6 +245,24 @@ a link to {scheme}://{path} and https://foo.baz`
 			Expect(RenderHTML(source)).To(MatchHTML(expected))
 		})
 
+		It("with text, target and role", func() {
+			source := `a link to link:https://example.com[example,window=mytarget,role=myrole]`
+			expected := `<div class="paragraph">
+<p>a link to <a href="https://example.com" class="myrole" target="mytarget">example</a></p>
+</div>
+`
+			Expect(RenderHTML(source)).To(MatchHTML(expected))
+		})
+
+		It("with target and role", func() {
+			source := `a link to link:https://example.com[window=mytarget,role=myrole]`
+			expected := `<div class="paragraph">
+<p>a link to <a href="https://example.com" class="bare myrole" target="mytarget">https://example.com</a></p>
+</div>
+`
+			Expect(RenderHTML(source)).To(MatchHTML(expected))
+		})
+
 		Context("with document attribute substitutions", func() {
 
 			It("relative link with two document attribute substitutions and a reset", func() {

pkg/renderer/sgml/link.go

@@ -15,6 +15,10 @@ func (r *sgmlRenderer) renderLink(ctx *renderer.Context, l types.InlineLink) (st
 	location := l.Location.Stringify()
 	text := ""
 	class := ""
+	roles, err := r.renderElementRoles(ctx, l.Attributes)
+	if err != nil {
+		return "", errors.Wrap(err, "unable to render link")
+	}
 	// TODO; support `mailto:` positional attributes
 	if t, exists := l.Attributes[types.AttrInlineLinkText]; exists {
 		switch t := t.(type) {
@@ -26,19 +30,25 @@ func (r *sgmlRenderer) renderLink(ctx *renderer.Context, l types.InlineLink) (st
 				return "", errors.Wrap(err, "unable to render link")
 			}
 		}
+		class = roles // can be empty (and it's fine)
 	} else {
-		class = "bare"
 		text = html.EscapeString(location)
+		if len(roles) > 0 {
+			class = "bare " + roles
+		} else {
+			class = "bare"
+		}
 	}
-
-	err := r.link.Execute(result, struct {
-		URL   string
-		Text  string
-		Class string
+	err = r.link.Execute(result, struct {
+		URL    string
+		Text   string
+		Class  string
+		Target string
 	}{
-		URL:   location,
-		Text:  text,
-		Class: class,
+		URL:    location,
+		Text:   text,
+		Class:  class,
+		Target: l.Attributes.GetAsStringWithDefault(types.AttrInlineLinkTarget, ""),
 	})
 	if err != nil {
 		return "", errors.Wrap(err, "unable to render link")

pkg/types/attributes.go

@@ -100,6 +100,8 @@ const (
 	AttrStyle = "style"
 	// AttrInlineLinkText the text attribute (first positional) of links
 	AttrInlineLinkText = "text"
+	// AttrInlineLinkTarget the 'window' attribute
+	AttrInlineLinkTarget = "window"
 	// AttrWidth the `width` attribute used ior images, tables, and so forth
 	AttrWidth = "width"
 	// AttrFrame the frame used mostly for tables (all, topbot, sides, none)