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
|
<?php
/*
* 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\TableOfContents;
use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension;
use League\CommonMark\Extension\TableOfContents\TableOfContentsExtension;
use League\CommonMark\Tests\Functional\AbstractLocalDataTest;
final class TableOfContentsExtensionTest extends AbstractLocalDataTest
{
public function testWithSampleData()
{
$this->setUpConverter();
foreach ($this->loadTests(__DIR__ . '/data', 'sample.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithWeirdNestingLeavingItAsIs()
{
$this->setUpConverter([
'table_of_contents' => [
'normalize' => 'as-is',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'weird-as-is.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithWeirdNestingWithRelativeNormalization()
{
$this->setUpConverter([
'table_of_contents' => [
'normalize' => 'relative',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'weird-relative.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithWeirdNestingWithFlattenedNormalization()
{
$this->setUpConverter([
'table_of_contents' => [
'normalize' => 'flat',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'weird-flattened.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithPositionTop()
{
$this->setUpConverter([
'table_of_contents' => [
'position' => 'top',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'position-top.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithPositionBeforeHeadings()
{
$this->setUpConverter([
'table_of_contents' => [
'position' => 'before-headings',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'position-before-headings.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithPositionPlaceholder()
{
$this->setUpConverter([
'table_of_contents' => [
'position' => 'placeholder',
'placeholder' => '[TOC]',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'position-placeholder*.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithCustomClass()
{
$this->setUpConverter([
'table_of_contents' => [
'html_class' => 'markdown-toc',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'custom-class.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithBulletedStyle()
{
$this->setUpConverter([
'table_of_contents' => [
'style' => 'bullet',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'style-bullet.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithOrderedStyle()
{
$this->setUpConverter([
'table_of_contents' => [
'style' => 'ordered',
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'style-ordered.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testWithNoHeadings()
{
$this->setUpConverter();
foreach ($this->loadTests(__DIR__ . '/data', 'no-headings.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
public function testMinMaxHeadingLevels()
{
$this->setUpConverter([
'table_of_contents' => [
'min_heading_level' => 2,
'max_heading_level' => 5,
],
]);
foreach ($this->loadTests(__DIR__ . '/data', 'min-max.md') as [$markdown, $html, $testName]) {
$this->assertMarkdownRendersAs($markdown, $html, $testName);
}
}
protected function setUpConverter(array $config = [])
{
$environment = Environment::createCommonMarkEnvironment();
$environment->addExtension(new HeadingPermalinkExtension());
$environment->addExtension(new TableOfContentsExtension());
$this->converter = new CommonMarkConverter($config, $environment);
}
}
|
