1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
package converter_test
import (
"testing"
"github.com/JohannesKaufmann/dom"
"github.com/JohannesKaufmann/html-to-markdown/v2/converter"
"github.com/JohannesKaufmann/html-to-markdown/v2/plugin/base"
"github.com/JohannesKaufmann/html-to-markdown/v2/plugin/commonmark"
"golang.org/x/net/html"
)
func TestConvertString(t *testing.T) {
conv := converter.NewConverter()
preRenderer := func(ctx converter.Context, doc *html.Node) {
for _, node := range dom.AllNodes(doc) {
name := dom.NodeName(node)
if name == "test" {
node.Attr[0].Val = "other_value"
}
}
}
renderer := func(ctx converter.Context, w converter.Writer, n *html.Node) converter.RenderStatus {
name := dom.NodeName(n)
if name == "#text" {
w.WriteString(n.Data)
return converter.RenderSuccess
} else if name == "test" {
val := dom.GetAttributeOr(n, "key", "")
w.WriteString(val)
return converter.RenderSuccess
}
return converter.RenderTryNext
}
postRenderer := func(ctx converter.Context, content []byte) []byte {
return content
}
conv.Register.PreRenderer(preRenderer, converter.PriorityStandard)
conv.Register.Renderer(renderer, converter.PriorityStandard)
conv.Register.PostRenderer(postRenderer, converter.PriorityStandard)
output, err := conv.ConvertString(`before<test key="initial_value"></test>after`)
if err != nil {
t.Error(err)
}
expected := "beforeother_valueafter"
if output != expected {
t.Errorf("expected %q but got %q", expected, output)
}
}
func TestConvertString_ErrNoRenderHandlers(t *testing.T) {
conv := converter.NewConverter()
_, err := conv.ConvertString("<strong>bold text</strong>")
if err == nil {
t.Fatal("expected an error")
}
if err.Error() != `no render handlers are registered. did you forget to register the "commonmark" and "base" plugins?` {
t.Fatal("expected a different error but got", err)
}
// - - - - //
// Now that we registered something we should not receive an error anymore...
conv.Register.Renderer(func(ctx converter.Context, w converter.Writer, n *html.Node) converter.RenderStatus {
return converter.RenderTryNext
}, converter.PriorityStandard)
_, err = conv.ConvertString("<strong>bold text</strong>")
if err != nil {
t.Fatal("did not expect an error since we registered a renderer")
}
}
func TestConvertString_ErrBasePluginMissing(t *testing.T) {
conv := converter.NewConverter(
converter.WithPlugins(
commonmark.NewCommonmarkPlugin(),
),
)
_, err := conv.ConvertString("<strong>bold text</strong>")
if err == nil {
t.Fatal("expected an error")
}
if err.Error() != `you registered the "commonmark" plugin but the "base" plugin is also required` {
t.Fatal("expected a different error but got", err)
}
}
func TestWithEscapeMode(t *testing.T) {
mockRenderer := func(ctx converter.Context, w converter.Writer, n *html.Node) converter.RenderStatus {
return converter.RenderTryNext
}
mockUnEscaper := func(chars []byte, index int) int {
if chars[index] != '|' {
return -1
}
// A bit too simplistic for demonstration purposes.
// Normally here would be content to check if the escaping is necessary...
return 1
}
input := "a|b"
expectedWithSmart := "a\\|b"
expectedWithDisabled := "a|b"
t.Run("EscapeSmart", func(t *testing.T) {
conv := converter.NewConverter(
converter.WithPlugins(
base.NewBasePlugin(),
),
converter.WithEscapeMode(converter.EscapeModeSmart), // <--
)
conv.Register.Renderer(mockRenderer, converter.PriorityStandard)
conv.Register.EscapedChar('|')
conv.Register.UnEscaper(mockUnEscaper, converter.PriorityStandard)
output, err := conv.ConvertString(input)
if err != nil {
t.Error(err)
}
if output != expectedWithSmart {
t.Errorf("expected %q but got %q", expectedWithSmart, output)
}
})
t.Run("EscapeDisabled", func(t *testing.T) {
conv := converter.NewConverter(
converter.WithPlugins(
base.NewBasePlugin(),
),
converter.WithEscapeMode(converter.EscapeModeDisabled), // <--
)
conv.Register.Renderer(mockRenderer, converter.PriorityStandard)
conv.Register.EscapedChar('|')
conv.Register.UnEscaper(mockUnEscaper, converter.PriorityStandard)
output, err := conv.ConvertString(input)
if err != nil {
t.Error(err)
}
if output != expectedWithDisabled {
t.Errorf("expected %q but got %q", expectedWithDisabled, output)
}
})
}
|
