File: ListBlockStartParserTest.php

package info (click to toggle)
php-league-commonmark 2.7.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,264 kB
  • sloc: php: 20,396; xml: 1,988; ruby: 45; makefile: 21; javascript: 15
file content (227 lines) | stat: -rw-r--r-- 8,116 bytes parent folder | download | duplicates (3)
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
<?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\Unit\Extension\CommonMark\Parser\Block;

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\CommonMark\Node\Block\ListBlock;
use League\CommonMark\Extension\CommonMark\Node\Block\ListItem;
use League\CommonMark\Extension\CommonMark\Parser\Block\ListBlockStartParser;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\MarkdownParserStateInterface;
use League\Config\ConfigurationInterface;
use League\Config\Exception\InvalidConfigurationException;
use PHPUnit\Framework\TestCase;

final class ListBlockStartParserTest extends TestCase
{
    public function testOrderedListStartingAtOne(): void
    {
        $cursor = new Cursor('1. Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration());
        $start = $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));

        $this->assertNotNull($start);

        $parsers = $start->getBlockParsers();
        $this->assertCount(2, $parsers);

        $block = $parsers[0]->getBlock();
        \assert($block instanceof ListBlock);
        $this->assertInstanceOf(ListBlock::class, $block);

        $item = $parsers[1]->getBlock();
        \assert($item instanceof ListItem);
        $this->assertInstanceOf(ListItem::class, $item);

        $this->assertSame(ListBlock::TYPE_ORDERED, $block->getListData()->type);
        $this->assertSame(1, $block->getListData()->start);

        $this->assertSame(ListBlock::TYPE_ORDERED, $item->getListData()->type);
    }

    public function testOrderedListStartingAtTwo(): void
    {
        $cursor = new Cursor('2. Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration());

        $start = $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));

        $this->assertNotNull($start);

        $parsers = $start->getBlockParsers();
        $this->assertCount(2, $parsers);

        $block = $parsers[0]->getBlock();
        \assert($block instanceof ListBlock);
        $this->assertInstanceOf(ListBlock::class, $block);

        $item = $parsers[1]->getBlock();
        \assert($item instanceof ListItem);
        $this->assertInstanceOf(ListItem::class, $item);

        $this->assertSame(ListBlock::TYPE_ORDERED, $block->getListData()->type);
        $this->assertSame(2, $block->getListData()->start);

        $this->assertSame(ListBlock::TYPE_ORDERED, $item->getListData()->type);
    }

    public function testUnorderedListWithDashMarker(): void
    {
        $cursor = new Cursor('- Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration());

        $start = $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));

        $this->assertNotNull($start);

        $parsers = $start->getBlockParsers();
        $this->assertCount(2, $parsers);

        $block = $parsers[0]->getBlock();
        \assert($block instanceof ListBlock);
        $this->assertInstanceOf(ListBlock::class, $block);

        $item = $parsers[1]->getBlock();
        \assert($item instanceof ListItem);
        $this->assertInstanceOf(ListItem::class, $item);

        $this->assertSame(ListBlock::TYPE_BULLET, $block->getListData()->type);
        $this->assertSame('-', $block->getListData()->bulletChar);

        $this->assertSame(ListBlock::TYPE_BULLET, $item->getListData()->type);
    }

    public function testUnorderedListWithAsteriskMarker(): void
    {
        $cursor = new Cursor('* Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration());
        $start = $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));

        $this->assertNotNull($start);

        $parsers = $start->getBlockParsers();
        $this->assertCount(2, $parsers);

        $block = $parsers[0]->getBlock();
        \assert($block instanceof ListBlock);
        $this->assertInstanceOf(ListBlock::class, $block);

        $item = $parsers[1]->getBlock();
        \assert($item instanceof ListItem);
        $this->assertInstanceOf(ListItem::class, $item);

        $this->assertSame(ListBlock::TYPE_BULLET, $block->getListData()->type);
        $this->assertSame('*', $block->getListData()->bulletChar);

        $this->assertSame(ListBlock::TYPE_BULLET, $item->getListData()->type);
    }

    public function testUnorderedListWithPlusMarker(): void
    {
        $cursor = new Cursor('+ Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration());
        $start = $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));

        $this->assertNotNull($start);

        $parsers = $start->getBlockParsers();
        $this->assertCount(2, $parsers);

        $block = $parsers[0]->getBlock();
        \assert($block instanceof ListBlock);
        $this->assertInstanceOf(ListBlock::class, $block);

        $item = $parsers[1]->getBlock();
        \assert($item instanceof ListItem);
        $this->assertInstanceOf(ListItem::class, $item);

        $this->assertSame(ListBlock::TYPE_BULLET, $block->getListData()->type);
        $this->assertSame('+', $block->getListData()->bulletChar);

        $this->assertSame(ListBlock::TYPE_BULLET, $item->getListData()->type);
    }

    public function testUnorderedListWithCustomMarker(): void
    {
        $cursor = new Cursor('^ Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration(['commonmark' => ['unordered_list_markers' => ['^']]]));
        $start = $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));

        $this->assertNotNull($start);

        $parsers = $start->getBlockParsers();
        $this->assertCount(2, $parsers);

        $block = $parsers[0]->getBlock();
        \assert($block instanceof ListBlock);
        $this->assertInstanceOf(ListBlock::class, $block);

        $item = $parsers[1]->getBlock();
        \assert($item instanceof ListItem);
        $this->assertInstanceOf(ListItem::class, $item);

        $this->assertSame(ListBlock::TYPE_BULLET, $block->getListData()->type);
        $this->assertSame('^', $block->getListData()->bulletChar);

        $this->assertSame(ListBlock::TYPE_BULLET, $item->getListData()->type);
    }

    public function testUnorderedListWithDisabledMarker(): void
    {
        $cursor = new Cursor('+ Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration(['commonmark' => ['unordered_list_markers' => ['-', '*']]]));
        $start = $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));

        $this->assertNull($start);
    }

    public function testInvalidListMarkerConfiguration(): void
    {
        $this->expectException(InvalidConfigurationException::class);
        $this->expectExceptionMessageMatches('/expects to be list/');

        $cursor = new Cursor('- Foo');

        $parser = new ListBlockStartParser();
        $parser->setConfiguration($this->createConfiguration(['commonmark' => ['unordered_list_markers' => '-']]));
        $parser->tryStart($cursor, $this->createMock(MarkdownParserStateInterface::class));
    }

    /**
     * @param array<string, mixed> $values
     */
    private function createConfiguration(array $values = []): ConfigurationInterface
    {
        $config = Environment::createDefaultConfiguration();
        (new CommonMarkCoreExtension())->configureSchema($config);
        $config->merge($values);

        return $config->reader();
    }
}