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
|
<?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\CommonMark\Node\Inline\Emphasis;
use League\CommonMark\Extension\Mention\Generator\MentionGeneratorInterface;
use League\CommonMark\Extension\Mention\Generator\StringTemplateLinkGenerator;
use League\CommonMark\Extension\Mention\Mention;
use League\CommonMark\Extension\Mention\MentionParser;
use League\CommonMark\MarkdownConverter;
use League\CommonMark\Node\Inline\Text;
use PHPUnit\Framework\TestCase;
final class MentionParserTest extends TestCase
{
public function testMentionParser(): void
{
$input = 'See #123 for more information.';
$expected = '<p>See <a href="https://www.example.com/123">#123</a> for more information.</p>';
$mentionParser = new MentionParser('test', '#', '\d+', new StringTemplateLinkGenerator('https://www.example.com/%s'));
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserWithMultiCharacterPrefix(): void
{
$input = 'Try asking u:colinodell about that.';
$expected = '<p>Try asking <a href="https://www.example.com/users/colinodell">u:colinodell</a> about that.</p>';
$mentionParser = new MentionParser('test', 'u:', '\w+', new StringTemplateLinkGenerator('https://www.example.com/users/%s'));
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserWithMultiCharacterPrefixContainingSpecialRegexCharsThatShouldBeEscaped(): void
{
$input = 'I spend too much time on the /r/php subreddit.';
$expected = '<p>I spend too much time on the <a href="https://www.reddit.com/r/php">/r/php</a> subreddit.</p>';
$mentionParser = new MentionParser('test', '/r/', '\w+', new StringTemplateLinkGenerator('https://www.reddit.com/r/%s'));
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserWithoutSpaceInFront(): void
{
$input = 'See#123 for more information.';
$expected = '<p>See#123 for more information.</p>';
$mentionParser = new MentionParser('test', '#', '\d+', $this->createMock(MentionGeneratorInterface::class));
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserWithNonMatchingPrefix(): void
{
$input = 'See #123 for more information.';
$expected = '<p>See #123 for more information.</p>';
$mentionParser = new MentionParser('test', '@', '\d+', $this->createMock(MentionGeneratorInterface::class));
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserWithNonMatchingRegex(): void
{
$input = 'See #123 for more information.';
$expected = '<p>See #123 for more information.</p>';
$mentionParser = new MentionParser('test', '#', '[a-z]+', $this->createMock(MentionGeneratorInterface::class));
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserWithNullUrl(): void
{
$input = 'See #123 for more information.';
$expected = '<p>See #123 for more information.</p>';
$returnsNull = $this->createMock(MentionGeneratorInterface::class);
$returnsNull->method('generateMention')->willReturn(null);
$mentionParser = new MentionParser('test', '#', '\d+', $returnsNull);
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserUsingCallback(): void
{
$callable = static function (Mention $mention) {
// Stuff the three params into the URL just to prove we received them all properly
$mention->setUrl(\sprintf('https://www.example.com/%s/%s/%s', $mention->getIdentifier(), $mention->getLabel(), $mention->getPrefix()));
// Change the label
$mention->setLabel('Replaced Label');
return $mention;
};
$input = 'This should parse #123.';
$expected = '<p>This should parse <a href="https://www.example.com/123/#123/#">Replaced Label</a>.</p>';
$mentionParser = MentionParser::createWithCallback('test', '#', '\d+', $callable);
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserUsingCallbackReturnsAbstractInline(): void
{
$callable = static function (Mention $mention) {
// Pretend callback does some access logic to determine visibility.
$emphasis = new Emphasis('*');
$emphasis->appendChild(new Text('[members only]'));
return $emphasis;
};
$input = 'This should parse #123.';
$expected = '<p>This should parse <em>[members only]</em>.</p>';
$mentionParser = MentionParser::createWithCallback('test', '#', '\d+', $callable);
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
public function testMentionParserWithNonWordCharacterBefore(): void
{
$input = "Test\n#123 for more information.";
$expected = "<p>Test\n<a href=\"https://www.example.com/123\">#123</a> for more information.</p>";
$mentionParser = new MentionParser(
'test',
'#',
'\d+',
new StringTemplateLinkGenerator('https://www.example.com/%s')
);
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addInlineParser($mentionParser);
$converter = new MarkdownConverter($environment);
$this->assertEquals($expected, \rtrim((string) $converter->convert($input)));
}
}
|
