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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
<?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\Mention;
use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\Mention\Generator\MentionGeneratorInterface;
use League\CommonMark\Extension\Mention\Mention;
use League\CommonMark\Extension\Mention\MentionExtension;
use League\CommonMark\MarkdownConverter;
use League\CommonMark\Node\Inline\AbstractInline;
use League\CommonMark\Parser\MarkdownParser;
use League\CommonMark\Xml\XmlRenderer;
use League\Config\Exception\InvalidConfigurationException;
use PHPUnit\Framework\TestCase;
final class MentionExtensionTest extends TestCase
{
public function testNoConfig(): void
{
$input = <<<'EOT'
You can follow the author of this library on GitHub - he's @colinodell!
EOT;
$expected = <<<'EOT'
<p>You can follow the author of this library on GitHub - he's @colinodell!</p>
EOT;
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, $converter->convert($input)->getContent());
}
public function testConfigStringGenerator(): void
{
$input = <<<'EOT'
You can follow the author of this library on GitHub - he's @colinodell!
EOT;
$expected = <<<'EOT'
<p>You can follow the author of this library on GitHub - he's <a href="https://github.com/colinodell">@colinodell</a>!</p>
EOT;
$environment = new Environment([
'mentions' => [
'github_handle' => [
'prefix' => '@',
'pattern' => '[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)',
'generator' => 'https://github.com/%s',
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, $converter->convert($input)->getContent());
}
public function testConfigCallableGenerator(): void
{
$input = <<<'EOT'
You can follow the author of this library on GitHub - he's @colinodell!
EOT;
$expected = <<<'EOT'
<p>You can follow the author of this library on GitHub - he's <a href="https://github.com/colinodell">@colinodell</a>!</p>
EOT;
$environment = new Environment([
'mentions' => [
'github_handle' => [
'prefix' => '@',
'pattern' => '[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)',
'generator' => static function (Mention $mention) {
$mention->setUrl(\sprintf('https://github.com/%s', $mention->getIdentifier()));
return $mention;
},
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, $converter->convert($input)->getContent());
}
public function testConfigObjectImplementingMentionGeneratorInterface(): void
{
$input = <<<'EOT'
You can follow the author of this library on GitHub - he's @colinodell!
EOT;
$expected = <<<'EOT'
<p>You can follow the author of this library on GitHub - he's <a href="https://github.com/colinodell">@colinodell</a>!</p>
EOT;
$environment = new Environment([
'mentions' => [
'github_handle' => [
'prefix' => '@',
'pattern' => '[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)',
'generator' => new class () implements MentionGeneratorInterface {
public function generateMention(Mention $mention): ?AbstractInline
{
$mention->setUrl(\sprintf('https://github.com/%s', $mention->getIdentifier()));
return $mention;
}
},
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, $converter->convert($input)->getContent());
}
public function testConfigUnknownGenerator(): void
{
$this->expectException(InvalidConfigurationException::class);
$environment = new Environment([
'mentions' => [
'github_handle' => [
'prefix' => '@',
'pattern' => '[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)',
'generator' => new \stdClass(),
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$converter->convert('');
}
public function testLegacySymbolOption(): void
{
$this->expectException(InvalidConfigurationException::class);
$environment = new Environment([
'mentions' => [
'github_handle' => [
'symbol' => '@',
'pattern' => '[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)',
'generator' => 'https://github.com/%s',
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$converter->convert('foo');
}
public function testWithFullRegexOption(): void
{
$this->expectException(InvalidConfigurationException::class);
$environment = new Environment([
'mentions' => [
'github_handle' => [
'prefix' => '@',
'pattern' => '/[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)/i',
'generator' => 'https://github.com/%s',
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$converter->convert('foo');
}
public function testXmlRendering(): void
{
$input = <<<'EOT'
You can follow the author of this library on GitHub - he's @colinodell!
EOT;
$expected = <<<'EOT'
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://commonmark.org/xml/1.0">
<paragraph>
<text>You can follow the author of this library on GitHub - he's </text>
<link destination="https://github.com/colinodell" title="">
<text>@colinodell</text>
</link>
<text>!</text>
</paragraph>
</document>
EOT;
$environment = new Environment([
'mentions' => [
'github_handle' => [
'prefix' => '@',
'pattern' => '[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)',
'generator' => new class () implements MentionGeneratorInterface {
public function generateMention(Mention $mention): ?AbstractInline
{
$mention->setUrl(\sprintf('https://github.com/%s', $mention->getIdentifier()));
return $mention;
}
},
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$document = (new MarkdownParser($environment))->parse($input);
$xml = (new XmlRenderer($environment))->renderDocument($document)->getContent();
$this->assertSame($expected, $xml);
}
public function testMentionLikeLabelInExistingLinks(): void
{
$input = <<<'EOT'
Try [asking **@driesvints**](https://github.com/driesvints).
EOT;
$expected = <<<'EOT'
<p>Try <a href="https://github.com/driesvints">asking <strong>@driesvints</strong></a>.</p>
EOT;
$environment = new Environment([
'mentions' => [
'username' => [
'prefix' => '@',
'pattern' => '[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}(?!\w)',
'generator' => 'https://github.com/user/%s',
],
],
]);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new MentionExtension());
$converter = new MarkdownConverter($environment);
$this->assertSame($expected, $converter->convert($input)->getContent());
}
}
|
