github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-29 17:50:59 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/helpers/content_renderer_test.go

142 lines
3.7 KiB
Go
Raw Normal View History

Add copyright header to that source files that don’t have one. See #1646
2015-12-10 22:19:38 +00:00
// Copyright 2015 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
package helpers
Apply project wide go fmt
2015-10-12 18:47:06 +00:00
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
import (
"bytes"
Make tests green on both Pygments 2.0.2 and 2.1.3 See #1969
2016-03-13 21:06:51 +00:00
"regexp"
Apply project wide go fmt
2015-10-12 18:47:06 +00:00
"testing"
helpers: Rename getMmarkHtmlRenderer to getMmarkHTMLRenderer To be consistent with the changes made in commit 67df33f, see #959.
2016-03-21 07:16:39 +00:00
"github.com/spf13/viper"
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
"github.com/stretchr/testify/require"
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
)
// Renders a codeblock using Blackfriday
all: Refactor to nonglobal Viper, i18n etc. This is a final rewrite that removes all the global state in Hugo, which also enables the use if `t.Parallel` in tests. Updates #2701 Fixes #3016
2017-02-05 03:20:06 +00:00
func (c ContentSpec) render(input string) string {
Reuse the BlackFriday instance when possible This is in heavy use in rendering, so this makes a difference: ```bash benchmark old ns/op new ns/op delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 124551144 107743429 -13.49% benchmark old allocs new allocs delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 528684 435118 -17.70% benchmark old bytes new bytes delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 53306848 45147832 -15.31% ```
2017-12-16 17:56:58 +00:00
ctx := &RenderingContext{Cfg: c.cfg, Config: c.BlackFriday}
all: Refactor to nonglobal Viper, i18n etc. This is a final rewrite that removes all the global state in Hugo, which also enables the use if `t.Parallel` in tests. Updates #2701 Fixes #3016
2017-02-05 03:20:06 +00:00
render := c.getHTMLRenderer(0, ctx)
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
buf := &bytes.Buffer{}
render.BlockCode(buf, []byte(input), "html")
return buf.String()
}
// Renders a codeblock using Mmark
all: Refactor to nonglobal Viper, i18n etc. This is a final rewrite that removes all the global state in Hugo, which also enables the use if `t.Parallel` in tests. Updates #2701 Fixes #3016
2017-02-05 03:20:06 +00:00
func (c ContentSpec) renderWithMmark(input string) string {
Reuse the BlackFriday instance when possible This is in heavy use in rendering, so this makes a difference: ```bash benchmark old ns/op new ns/op delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 124551144 107743429 -13.49% benchmark old allocs new allocs delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 528684 435118 -17.70% benchmark old bytes new bytes delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 53306848 45147832 -15.31% ```
2017-12-16 17:56:58 +00:00
ctx := &RenderingContext{Cfg: c.cfg, Config: c.BlackFriday}
all: Refactor to nonglobal Viper, i18n etc. This is a final rewrite that removes all the global state in Hugo, which also enables the use if `t.Parallel` in tests. Updates #2701 Fixes #3016
2017-02-05 03:20:06 +00:00
render := c.getMmarkHTMLRenderer(0, ctx)
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
buf := &bytes.Buffer{}
render.BlockCode(buf, []byte(input), "html", []byte(""), false, false)
return buf.String()
}
func TestCodeFence(t *testing.T) {
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
assert := require.New(t)
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
type test struct {
enabled bool
input, expected string
}
Make tests green on both Pygments 2.0.2 and 2.1.3 See #1969
2016-03-13 21:06:51 +00:00
// Pygments 2.0 and 2.1 have slightly different outputs so only do partial matching
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
data := []test{
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
{true, "<html></html>", `(?s)^<div class="highlight">\n?<pre.*><code class="language-html" data-lang="html">.*?</code></pre>\n?</div>\n?$`},
{false, "<html></html>", `(?s)^<pre.*><code class="language-html">.*?</code></pre>\n$`},
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
}
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
for _, useClassic := range []bool{false, true} {
for i, d := range data {
v := viper.New()
v.Set("pygmentsStyle", "monokai")
v.Set("pygmentsUseClasses", true)
v.Set("pygmentsCodeFences", d.enabled)
v.Set("pygmentsUseClassic", useClassic)
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
c, err := NewContentSpec(v)
assert.NoError(err)
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
result := c.render(d.input)
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
expectedRe, err := regexp.Compile(d.expected)
Make tests green on both Pygments 2.0.2 and 2.1.3 See #1969
2016-03-13 21:06:51 +00:00
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
if err != nil {
t.Fatal("Invalid regexp", err)
}
matched := expectedRe.MatchString(result)
Make tests green on both Pygments 2.0.2 and 2.1.3 See #1969
2016-03-13 21:06:51 +00:00
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
if !matched {
t.Errorf("Test %d failed. BlackFriday enabled:%t, Expected:\n%q got:\n%q", i, d.enabled, d.expected, result)
}
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
Use Chroma as new default syntax highlighter If you want to use Pygments, set `pygmentsUseClassic=true` in your site config. Fixes #3888
2017-09-25 06:59:02 +00:00
result = c.renderWithMmark(d.input)
matched = expectedRe.MatchString(result)
if !matched {
t.Errorf("Test %d failed. Mmark enabled:%t, Expected:\n%q got:\n%q", i, d.enabled, d.expected, result)
}
Add GitHub style code fence support to mmark Fixes #1258.
2015-09-07 18:41:02 +00:00
}
}
}
Add TODO list support for Blackfriday * Add CSS class to TODO list and list items * Add a flag to turn task list support off Fixes #2269
2016-09-09 11:08:20 +00:00
func TestBlackfridayTaskList(t *testing.T) {
all: Refactor to nonglobal Viper, i18n etc. This is a final rewrite that removes all the global state in Hugo, which also enables the use if `t.Parallel` in tests. Updates #2701 Fixes #3016
2017-02-05 03:20:06 +00:00
c := newTestContentSpec()
Add TODO list support for Blackfriday * Add CSS class to TODO list and list items * Add a flag to turn task list support off Fixes #2269
2016-09-09 11:08:20 +00:00
for i, this := range []struct {
markdown string
taskListEnabled bool
expect string
}{
{`
TODO:
- [x] On1
- [X] On2
- [ ] Off
END
`, true, `<p>TODO:</p>
<ul class="task-list">
Render task list item inside label for correct accessibility Fixes #3303
2017-08-04 15:08:27 +00:00
<li><label><input type="checkbox" checked disabled class="task-list-item"> On1</label></li>
<li><label><input type="checkbox" checked disabled class="task-list-item"> On2</label></li>
<li><label><input type="checkbox" disabled class="task-list-item"> Off</label></li>
Add TODO list support for Blackfriday * Add CSS class to TODO list and list items * Add a flag to turn task list support off Fixes #2269
2016-09-09 11:08:20 +00:00
</ul>
<p>END</p>
`},
{`- [x] On1`, false, `<ul>
<li>[x] On1</li>
</ul>
helpers: Fix broken TaskList in Markdown As per the referenced issue, if the task list in Markdown has nothing before it, it will be rendered wrongly: ``` --- title: "My First Post" date: 2017-07-29T20:21:57+02:00 draft: true --- * [ ] TaskList ``` is rendered as: ``` <ul> class="task-list" <li><input type="checkbox" disabled class="task-list-item"> TaskList</li> </ul> ``` The problem lies in the `List` function of `HugoHTMLRenderer`, it had a hardocded index of `4` for the first `>` of the list, it is used to insert the class into the text before the closing bracket, but that hardcoded index is only right when there is a newline before the opening bracket, which is the case when there is anything in the document before the task list, but if there is nothing, then there is no newline, and the correct index of the first `>` will be `3`. To fix that we're changing the hardcoded index to be dynamic by using `bytes.Index` to find it properly. We're also adding a test case to make sure this is tested against. Fixes #3710
2017-07-29 18:52:45 +00:00
`},
{`* [ ] Off
END`, true, `<ul class="task-list">
Render task list item inside label for correct accessibility Fixes #3303
2017-08-04 15:08:27 +00:00
<li><label><input type="checkbox" disabled class="task-list-item"> Off</label></li>
helpers: Fix broken TaskList in Markdown As per the referenced issue, if the task list in Markdown has nothing before it, it will be rendered wrongly: ``` --- title: "My First Post" date: 2017-07-29T20:21:57+02:00 draft: true --- * [ ] TaskList ``` is rendered as: ``` <ul> class="task-list" <li><input type="checkbox" disabled class="task-list-item"> TaskList</li> </ul> ``` The problem lies in the `List` function of `HugoHTMLRenderer`, it had a hardocded index of `4` for the first `>` of the list, it is used to insert the class into the text before the closing bracket, but that hardcoded index is only right when there is a newline before the opening bracket, which is the case when there is anything in the document before the task list, but if there is nothing, then there is no newline, and the correct index of the first `>` will be `3`. To fix that we're changing the hardcoded index to be dynamic by using `bytes.Index` to find it properly. We're also adding a test case to make sure this is tested against. Fixes #3710
2017-07-29 18:52:45 +00:00
</ul>
<p>END</p>
Add TODO list support for Blackfriday * Add CSS class to TODO list and list items * Add a flag to turn task list support off Fixes #2269
2016-09-09 11:08:20 +00:00
`},
} {
Reuse the BlackFriday instance when possible This is in heavy use in rendering, so this makes a difference: ```bash benchmark old ns/op new ns/op delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 124551144 107743429 -13.49% benchmark old allocs new allocs delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 528684 435118 -17.70% benchmark old bytes new bytes delta BenchmarkSiteBuilding/TOML,num_langs=1,num_pages=500,tags_per_page=5,shortcodes,render-4 53306848 45147832 -15.31% ```
2017-12-16 17:56:58 +00:00
blackFridayConfig := c.BlackFriday
Add TODO list support for Blackfriday * Add CSS class to TODO list and list items * Add a flag to turn task list support off Fixes #2269
2016-09-09 11:08:20 +00:00
blackFridayConfig.TaskLists = this.taskListEnabled
ctx := &RenderingContext{Content: []byte(this.markdown), PageFmt: "markdown", Config: blackFridayConfig}
all: Refactor to nonglobal Viper, i18n etc. This is a final rewrite that removes all the global state in Hugo, which also enables the use if `t.Parallel` in tests. Updates #2701 Fixes #3016
2017-02-05 03:20:06 +00:00
result := string(c.RenderBytes(ctx))
Add TODO list support for Blackfriday * Add CSS class to TODO list and list items * Add a flag to turn task list support off Fixes #2269
2016-09-09 11:08:20 +00:00
if result != this.expect {
t.Errorf("[%d] got \n%v but expected \n%v", i, result, this.expect)
}
}
}
Reference in a new issue Copy permalink