2015-12-10 17:19:38 -05: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.
|
|
|
|
|
|
2015-09-07 14:41:02 -04:00
|
|
|
package helpers
|
2015-10-12 14:47:06 -04:00
|
|
|
|
2015-09-07 14:41:02 -04:00
|
|
|
import (
|
|
|
|
|
"bytes"
|
2016-03-13 17:06:51 -04:00
|
|
|
"regexp"
|
2015-10-12 14:47:06 -04:00
|
|
|
"testing"
|
2016-03-21 03:16:39 -04:00
|
|
|
|
|
|
|
|
"github.com/spf13/viper"
|
2017-09-25 02:59:02 -04:00
|
|
|
"github.com/stretchr/testify/require"
|
2015-09-07 14:41:02 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// Renders a codeblock using Blackfriday
|
2017-02-04 22:20:06 -05: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 12:56:58 -05:00
|
|
|
ctx := &RenderingContext{Cfg: c.cfg, Config: c.BlackFriday}
|
2017-02-04 22:20:06 -05:00
|
|
|
render := c.getHTMLRenderer(0, ctx)
|
2015-09-07 14:41:02 -04:00
|
|
|
|
|
|
|
|
buf := &bytes.Buffer{}
|
|
|
|
|
render.BlockCode(buf, []byte(input), "html")
|
|
|
|
|
return buf.String()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Renders a codeblock using Mmark
|
2017-02-04 22:20:06 -05: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 12:56:58 -05:00
|
|
|
ctx := &RenderingContext{Cfg: c.cfg, Config: c.BlackFriday}
|
2017-02-04 22:20:06 -05:00
|
|
|
render := c.getMmarkHTMLRenderer(0, ctx)
|
2015-09-07 14:41:02 -04:00
|
|
|
|
|
|
|
|
buf := &bytes.Buffer{}
|
|
|
|
|
render.BlockCode(buf, []byte(input), "html", []byte(""), false, false)
|
|
|
|
|
return buf.String()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestCodeFence(t *testing.T) {
|
2017-09-25 02:59:02 -04:00
|
|
|
assert := require.New(t)
|
2015-09-07 14:41:02 -04:00
|
|
|
|
|
|
|
|
type test struct {
|
|
|
|
|
enabled bool
|
|
|
|
|
input, expected string
|
|
|
|
|
}
|
2016-03-13 17:06:51 -04:00
|
|
|
|
|
|
|
|
// Pygments 2.0 and 2.1 have slightly different outputs so only do partial matching
|
2015-09-07 14:41:02 -04:00
|
|
|
data := []test{
|
2017-09-25 02:59:02 -04: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$`},
|
2015-09-07 14:41:02 -04:00
|
|
|
}
|
|
|
|
|
|
2017-09-25 02:59:02 -04: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)
|
2015-09-07 14:41:02 -04:00
|
|
|
|
2017-09-25 02:59:02 -04:00
|
|
|
c, err := NewContentSpec(v)
|
|
|
|
|
assert.NoError(err)
|
2015-09-07 14:41:02 -04:00
|
|
|
|
2017-09-25 02:59:02 -04:00
|
|
|
result := c.render(d.input)
|
2015-09-07 14:41:02 -04:00
|
|
|
|
2017-09-25 02:59:02 -04:00
|
|
|
expectedRe, err := regexp.Compile(d.expected)
|
2016-03-13 17:06:51 -04:00
|
|
|
|
2017-09-25 02:59:02 -04:00
|
|
|
if err != nil {
|
|
|
|
|
t.Fatal("Invalid regexp", err)
|
|
|
|
|
}
|
|
|
|
|
matched := expectedRe.MatchString(result)
|
2016-03-13 17:06:51 -04:00
|
|
|
|
2017-09-25 02:59:02 -04:00
|
|
|
if !matched {
|
|
|
|
|
t.Errorf("Test %d failed. BlackFriday enabled:%t, Expected:\n%q got:\n%q", i, d.enabled, d.expected, result)
|
|
|
|
|
}
|
2015-09-07 14:41:02 -04:00
|
|
|
|
2017-09-25 02:59:02 -04: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)
|
|
|
|
|
}
|
2015-09-07 14:41:02 -04:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2016-09-09 07:08:20 -04:00
|
|
|
|
|
|
|
|
func TestBlackfridayTaskList(t *testing.T) {
|
2017-02-04 22:20:06 -05:00
|
|
|
c := newTestContentSpec()
|
|
|
|
|
|
2016-09-09 07:08:20 -04: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">
|
2017-08-04 11:08:27 -04: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>
|
2016-09-09 07:08:20 -04:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<p>END</p>
|
|
|
|
|
`},
|
|
|
|
|
{`- [x] On1`, false, `<ul>
|
|
|
|
|
<li>[x] On1</li>
|
|
|
|
|
</ul>
|
2017-07-29 14:52:45 -04:00
|
|
|
`},
|
|
|
|
|
{`* [ ] Off
|
|
|
|
|
|
|
|
|
|
END`, true, `<ul class="task-list">
|
2017-08-04 11:08:27 -04:00
|
|
|
<li><label><input type="checkbox" disabled class="task-list-item"> Off</label></li>
|
2017-07-29 14:52:45 -04:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<p>END</p>
|
2016-09-09 07:08:20 -04: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 12:56:58 -05:00
|
|
|
blackFridayConfig := c.BlackFriday
|
2016-09-09 07:08:20 -04:00
|
|
|
blackFridayConfig.TaskLists = this.taskListEnabled
|
|
|
|
|
ctx := &RenderingContext{Content: []byte(this.markdown), PageFmt: "markdown", Config: blackFridayConfig}
|
|
|
|
|
|
2017-02-04 22:20:06 -05:00
|
|
|
result := string(c.RenderBytes(ctx))
|
2016-09-09 07:08:20 -04:00
|
|
|
|
|
|
|
|
if result != this.expect {
|
|
|
|
|
t.Errorf("[%d] got \n%v but expected \n%v", i, result, this.expect)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
