Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(renderer): non-ascii characters in listing content #973

Merged
merged 1 commit into from
Mar 10, 2022
Merged

fix(renderer): non-ascii characters in listing content #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/renderer/sgml/elements.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ func (r *sgmlRenderer) renderPlainText(ctx *renderer.Context, element interface{
case *types.Symbol:
return r.renderSymbol(e)
case *types.StringElement:
return r.renderStringElement(ctx, e)
return e.Content, nil
case *types.QuotedString:
return r.renderQuotedString(ctx, e)
// case *types.Paragraph:
Expand Down
74 changes: 73 additions & 1 deletion pkg/renderer/sgml/html5/delimited_block_source_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,42 @@ const Cookie = "cookie"
<pre class="pygments highlight nowrap"><code data-lang="go"><span style="color:#069;font-weight:bold">const</span> Cookie = <span style="color:#c30">&#34;cookie&#34;</span></code></pre>
</div>
</div>
`
Expect(RenderHTML(source)).To(MatchHTML(expected))
})

It("with non-ascii content and syntax highlighting", func() {
// source content is `…`, not `...`
source := `:source-highlighter: chroma
:unicode: false

[source,c]
----
…
----`
expected := `<div class="listingblock">
<div class="content">
<pre class="chroma highlight"><code data-lang="c"><span class="tok-err">…</span></code></pre>
</div>
</div>
`
Expect(RenderHTML(source)).To(MatchHTML(expected))
})

It("with symbol content and syntax highlighting", func() {
// source content is `…`, not `...`
source := `:source-highlighter: chroma
:unicode: false

[source,c]
----
Copyright (C)
----`
expected := `<div class="listingblock">
<div class="content">
<pre class="chroma highlight"><code data-lang="c"><span class="tok-n">Copyright</span> <span class="tok-p">(</span><span class="tok-n">C</span><span class="tok-p">)</span></code></pre>
</div>
</div>
`
Expect(RenderHTML(source)).To(MatchHTML(expected))
})
Expand All @@ -447,7 +483,7 @@ const Cookie = "cookie"

Context("as Markdown block", func() {

It("with html content", func() {
It("with HTML content", func() {
source := ".title\n" +
"```html\n" +
"<!DOCTYPE html>\n" +
Expand All @@ -460,6 +496,42 @@ const Cookie = "cookie"
&lt;/html&gt;</code></pre>
</div>
</div>
`
Expect(RenderHTML(source)).To(MatchHTML(expected))
})

It("with non-ascii content and syntax highlighting", func() {
// source content is `…`, not `...`, but the `unicode:false` attribute should NOT affect the content of the listing/source block
source :=
":source-highlighter: chroma\n" +
":unicode: false\n" +
"\n" +
"```c\n" +
"…\n" +
"```\n"
expected := `<div class="listingblock">
<div class="content">
<pre class="chroma highlight"><code data-lang="c"><span class="tok-err">…</span></code></pre>
</div>
</div>
`
Expect(RenderHTML(source)).To(MatchHTML(expected))
})

It("with symbol content and syntax highlighting", func() {
// source content is `…`, not `...`, but the `unicode:false` attribute should NOT affect the content of the listing/source block
source :=
":source-highlighter: chroma\n" +
":unicode: false\n" +
"\n" +
"```c\n" +
"Copyright (C)\n" +
"```\n"
expected := `<div class="listingblock">
<div class="content">
<pre class="chroma highlight"><code data-lang="c"><span class="tok-n">Copyright</span> <span class="tok-p">(</span><span class="tok-n">C</span><span class="tok-p">)</span></code></pre>
</div>
</div>
`
Expect(RenderHTML(source)).To(MatchHTML(expected))
})
Expand Down
5 changes: 0 additions & 5 deletions pkg/renderer/sgml/html5/string.go
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion pkg/renderer/sgml/html5/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ var templates = sgml.Templates{
SectionHeader: sectionHeaderTmpl,
SidebarBlock: sidebarBlockTmpl,
SourceBlock: sourceBlockTmpl,
StringElement: stringTmpl,
SubscriptText: subscriptTextTmpl,
SuperscriptText: superscriptTextTmpl,
Table: tableTmpl,
Expand Down
2 changes: 0 additions & 2 deletions pkg/renderer/sgml/sgml_renderer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ type sgmlRenderer struct {
sectionTitle *textTemplate
sidebarBlock *textTemplate
sourceBlock *textTemplate
stringElement *textTemplate
subscriptText *textTemplate
superscriptText *textTemplate
table *textTemplate
Expand Down Expand Up @@ -146,7 +145,6 @@ func (r *sgmlRenderer) prepareTemplates() error {
r.quoteParagraph, err = r.newTemplate("quote-paragraph", tmpls.QuoteParagraph, err)
r.sectionContent, err = r.newTemplate("section-content", tmpls.SectionContent, err)
r.sectionTitle, err = r.newTemplate("section-header", tmpls.SectionHeader, err)
r.stringElement, err = r.newTemplate("string-element", tmpls.StringElement, err)
r.sidebarBlock, err = r.newTemplate("sidebar-block", tmpls.SidebarBlock, err)
r.sourceBlock, err = r.newTemplate("source-block", tmpls.SourceBlock, err)
r.subscriptText, err = r.newTemplate("subscript", tmpls.SubscriptText, err)
Expand Down
9 changes: 1 addition & 8 deletions pkg/renderer/sgml/string.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (

"github.com/bytesparadise/libasciidoc/pkg/renderer"
"github.com/bytesparadise/libasciidoc/pkg/types"
"github.com/pkg/errors"
)

var quotes = map[types.QuotedStringKind]struct {
Expand Down Expand Up @@ -37,15 +36,9 @@ func (r *sgmlRenderer) renderQuotedString(ctx *renderer.Context, s *types.Quoted
}

func (r *sgmlRenderer) renderStringElement(ctx *renderer.Context, str *types.StringElement) (string, error) {
buf := &strings.Builder{}
err := r.stringElement.Execute(buf, str.Content)
if err != nil {
return "", errors.Wrap(err, "unable to render string")
}

// NB: For all SGML flavors we are aware of, the numeric entities from
// Unicode are supported. We generally avoid named entities.
result := buf.String()
result := str.Content
if !ctx.UseUnicode() {
// convert to entities
result = asciiEntify(result)
Expand Down
1 change: 0 additions & 1 deletion pkg/renderer/sgml/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ type Templates struct {
SectionHeader string
SidebarBlock string
SourceBlock string
StringElement string
SubscriptText string
SuperscriptText string
Table string
Expand Down