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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
<?php
declare(strict_types=1);
/*
* This file is part of the league/commonmark package.
*
* (c) Colin O'Dell <colinodell@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace League\CommonMark\Tests\Functional\Extension\HeadingPermalink;
use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension;
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkProcessor;
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkRenderer;
use League\CommonMark\MarkdownConverter;
use League\CommonMark\Parser\MarkdownParser;
use League\CommonMark\Xml\XmlRenderer;
use League\Config\Exception\InvalidConfigurationException;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
final class HeadingPermalinkExtensionTest extends TestCase
{
#[DataProvider('dataProviderForTestHeadingPermalinksWithDefaultOptions')]
public function testHeadingPermalinksWithDefaultOptions(string $input, string $expected): void
{
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public static function dataProviderForTestHeadingPermalinksWithDefaultOptions(): \Generator
{
yield ['# Hello World!', \sprintf('<h1><a id="content-hello-world" href="#content-hello-world" class="heading-permalink" aria-hidden="true" title="Permalink">%s</a>Hello World!</h1>', HeadingPermalinkRenderer::DEFAULT_SYMBOL)];
yield ['# Hello *World*', \sprintf('<h1><a id="content-hello-world" href="#content-hello-world" class="heading-permalink" aria-hidden="true" title="Permalink">%s</a>Hello <em>World</em></h1>', HeadingPermalinkRenderer::DEFAULT_SYMBOL)];
yield ['# Hello `World`', \sprintf('<h1><a id="content-hello-world" href="#content-hello-world" class="heading-permalink" aria-hidden="true" title="Permalink">%s</a>Hello <code>World</code></h1>', HeadingPermalinkRenderer::DEFAULT_SYMBOL)];
yield ["Test\n----", \sprintf('<h2><a id="content-test" href="#content-test" class="heading-permalink" aria-hidden="true" title="Permalink">%s</a>Test</h2>', HeadingPermalinkRenderer::DEFAULT_SYMBOL)];
yield ["# Hello World!\n\n# Hello World!", \sprintf("<h1><a id=\"content-hello-world\" href=\"#content-hello-world\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">%s</a>Hello World!</h1>\n<h1><a id=\"content-hello-world-1\" href=\"#content-hello-world-1\" class=\"heading-permalink\" aria-hidden=\"true\" title=\"Permalink\">%s</a>Hello World!</h1>", HeadingPermalinkRenderer::DEFAULT_SYMBOL, HeadingPermalinkRenderer::DEFAULT_SYMBOL)];
}
#[DataProvider('dataProviderForTestHeadingPermalinksWithCustomOptions')]
public function testHeadingPermalinksWithCustomOptions(string $input, string $expected): void
{
$environment = new Environment([
'heading_permalink' => [
'html_class' => 'custom-class',
'id_prefix' => 'custom-id-prefix',
'fragment_prefix' => 'custom-fragment-prefix',
// Ensure multiple characters are allowed (including multibyte) and special HTML characters are escaped.
'symbol' => '¶ 🦄️ <3 You',
'insert' => HeadingPermalinkProcessor::INSERT_AFTER,
'title' => 'Link',
'aria_hidden' => false,
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public static function dataProviderForTestHeadingPermalinksWithCustomOptions(): \Generator
{
yield ['# Hello World!', '<h1>Hello World!<a id="custom-id-prefix-hello-world" href="#custom-fragment-prefix-hello-world" class="custom-class" title="Link">¶ 🦄️ <3 You</a></h1>'];
yield ['# Hello *World*', '<h1>Hello <em>World</em><a id="custom-id-prefix-hello-world" href="#custom-fragment-prefix-hello-world" class="custom-class" title="Link">¶ 🦄️ <3 You</a></h1>'];
yield ["Test\n----", '<h2>Test<a id="custom-id-prefix-test" href="#custom-fragment-prefix-test" class="custom-class" title="Link">¶ 🦄️ <3 You</a></h2>'];
}
public function testHeadingPermalinksWithEmptyPrefixes(): void
{
$environment = new Environment([
'heading_permalink' => [
'id_prefix' => '',
'fragment_prefix' => '',
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$input = '# Hello World!';
$expected = \sprintf('<h1><a id="hello-world" href="#hello-world" class="heading-permalink" aria-hidden="true" title="Permalink">%s</a>Hello World!</h1>', HeadingPermalinkRenderer::DEFAULT_SYMBOL);
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public function testHeadingPermalinksWithEmptySymbol(): void
{
$environment = new Environment([
'heading_permalink' => [
'symbol' => '',
'id_prefix' => '',
'fragment_prefix' => '',
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$input = '# Hello World!';
$expected = '<h1><a id="hello-world" href="#hello-world" class="heading-permalink" aria-hidden="true" title="Permalink"></a>Hello World!</h1>';
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public function testHeadingPermalinksWithInvalidInsertConfigurationValue(): void
{
$this->expectException(InvalidConfigurationException::class);
$environment = new Environment([
'heading_permalink' => [
'insert' => 'invalid value here',
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$converter->convert('# This will fail');
}
public function testWithCustomLevels(): void
{
$environment = new Environment([
'heading_permalink' => [
'min_heading_level' => 2,
'max_heading_level' => 3,
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$input = <<<EOT
# 1
## 2
### 3
#### 4
EOT;
$expected = <<<EOT
<h1>1</h1>
<h2><a id="content-2" href="#content-2" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>2</h2>
<h3><a id="content-3" href="#content-3" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>3</h3>
<h4>4</h4>
EOT;
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public function testHeadingPermalinksWithApplyIdToHeading(): void
{
$environment = new Environment([
'heading_permalink' => [
'apply_id_to_heading' => true,
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$input = '# Hello World!';
$expected = \sprintf('<h1 id="content-hello-world"><a href="#content-hello-world" class="heading-permalink" aria-hidden="true" title="Permalink">%s</a>Hello World!</h1>', HeadingPermalinkRenderer::DEFAULT_SYMBOL);
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public function testHeadingPermalinksWithApplyIdToHeadingAndClass(): void
{
$environment = new Environment([
'heading_permalink' => [
'apply_id_to_heading' => true,
'heading_class' => 'heading-anchor',
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$input = '# Hello World!';
$expected = \sprintf('<h1 id="content-hello-world" class="heading-anchor"><a href="#content-hello-world" class="heading-permalink" aria-hidden="true" title="Permalink">%s</a>Hello World!</h1>', HeadingPermalinkRenderer::DEFAULT_SYMBOL);
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public function testHeadingPermalinksWithApplyIdToHeadingWithoutLink(): void
{
$environment = new Environment([
'heading_permalink' => [
'insert' => HeadingPermalinkProcessor::INSERT_NONE,
'apply_id_to_heading' => true,
'heading_class' => 'heading-anchor',
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$converter = new MarkdownConverter($environment);
$input = '# Hello World!';
$expected = '<h1 id="content-hello-world" class="heading-anchor">Hello World!</h1>';
$this->assertEquals($expected, \trim((string) $converter->convert($input)));
}
public function testXml(): void
{
$md = '# Hello *World*';
$expectedXml = <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://commonmark.org/xml/1.0">
<heading level="1">
<heading_permalink slug="hello-world" />
<text>Hello </text>
<emph>
<text>World</text>
</emph>
</heading>
</document>
XML;
$environment = new Environment([
'heading_permalink' => [
'id_prefix' => '',
'fragment_prefix' => '',
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new HeadingPermalinkExtension());
$document = (new MarkdownParser($environment))->parse($md);
$this->assertSame($expectedXml, \rtrim((new XmlRenderer($environment))->renderDocument($document)->getContent()));
}
}
|
