Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #411 from thephpleague/feature/unordered-list-markers
Allow the unordered list markers to be configurable
- Loading branch information
Showing
4 changed files
with
206 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| <?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\Unit\Block\Parser; | ||
|
|
||
| use League\CommonMark\Block\Element\Document; | ||
| use League\CommonMark\Block\Element\ListBlock; | ||
| use League\CommonMark\Block\Element\ListItem; | ||
| use League\CommonMark\Block\Parser\ListParser; | ||
| use League\CommonMark\Context; | ||
| use League\CommonMark\Cursor; | ||
| use League\CommonMark\Environment; | ||
| use League\CommonMark\Util\Configuration; | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| final class ListParserTest extends TestCase | ||
| { | ||
| public function testOrderedListStartingAtOne() | ||
| { | ||
| $input = '1. Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $this->assertTrue($parser->parse($context, $cursor)); | ||
|
|
||
| $container = $context->getContainer(); | ||
|
|
||
| $this->assertTrue($container instanceof ListItem); | ||
| /** @var ListItem $container */ | ||
| $this->assertSame(ListBlock::TYPE_ORDERED, $container->getListData()->type); | ||
| $this->assertSame(1, $container->getListData()->start); | ||
| } | ||
|
|
||
| public function testOrderedListStartingAtTwo() | ||
| { | ||
| $input = '2. Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $this->assertTrue($parser->parse($context, $cursor)); | ||
|
|
||
| $container = $context->getContainer(); | ||
|
|
||
| $this->assertTrue($container instanceof ListItem); | ||
| /** @var ListItem $container */ | ||
| $this->assertSame(ListBlock::TYPE_ORDERED, $container->getListData()->type); | ||
| $this->assertSame(2, $container->getListData()->start); | ||
| } | ||
|
|
||
| public function testUnorderedListWithDashMarker() | ||
| { | ||
| $input = '- Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $this->assertTrue($parser->parse($context, $cursor)); | ||
|
|
||
| $container = $context->getContainer(); | ||
|
|
||
| $this->assertTrue($container instanceof ListItem); | ||
| /** @var ListItem $container */ | ||
| $this->assertSame(ListBlock::TYPE_UNORDERED, $container->getListData()->type); | ||
| $this->assertSame('-', $container->getListData()->bulletChar); | ||
| } | ||
|
|
||
| public function testUnorderedListWithAsteriskMarker() | ||
| { | ||
| $input = '* Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $this->assertTrue($parser->parse($context, $cursor)); | ||
|
|
||
| $container = $context->getContainer(); | ||
|
|
||
| $this->assertTrue($container instanceof ListItem); | ||
| /** @var ListItem $container */ | ||
| $this->assertSame(ListBlock::TYPE_UNORDERED, $container->getListData()->type); | ||
| $this->assertSame('*', $container->getListData()->bulletChar); | ||
| } | ||
|
|
||
| public function testUnorderedListWithPlusMarker() | ||
| { | ||
| $input = '+ Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $this->assertTrue($parser->parse($context, $cursor)); | ||
|
|
||
| $container = $context->getContainer(); | ||
|
|
||
| $this->assertTrue($container instanceof ListItem); | ||
| /** @var ListItem $container */ | ||
| $this->assertSame(ListBlock::TYPE_UNORDERED, $container->getListData()->type); | ||
| $this->assertSame('+', $container->getListData()->bulletChar); | ||
| } | ||
|
|
||
| public function testUnorderedListWithCustomMarker() | ||
| { | ||
| $input = '^ Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $parser->setConfiguration(new Configuration(['unordered_list_markers' => ['^']])); | ||
| $this->assertTrue($parser->parse($context, $cursor)); | ||
|
|
||
| $container = $context->getContainer(); | ||
|
|
||
| $this->assertTrue($container instanceof ListItem); | ||
| /** @var ListItem $container */ | ||
| $this->assertSame(ListBlock::TYPE_UNORDERED, $container->getListData()->type); | ||
| $this->assertSame('^', $container->getListData()->bulletChar); | ||
| } | ||
|
|
||
| public function testUnorderedListWithDisabledMarker() | ||
| { | ||
| $input = '+ Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $parser->setConfiguration(new Configuration(['unordered_list_markers' => ['-', '*']])); | ||
| $this->assertFalse($parser->parse($context, $cursor)); | ||
| } | ||
|
|
||
| public function testInvalidListMarkerConfiguration() | ||
| { | ||
| $this->expectException(\RuntimeException::class); | ||
| $this->expectExceptionMessage('Invalid configuration option "unordered_list_markers": value must be an array of strings'); | ||
| $input = '+ Foo'; | ||
|
|
||
| $context = new Context(new Document(), new Environment()); | ||
| $context->setNextLine($input); | ||
| $cursor = new Cursor($input); | ||
|
|
||
| $parser = new ListParser(); | ||
| $parser->setConfiguration(new Configuration(['unordered_list_markers' => '-'])); | ||
|
|
||
| $parser->parse($context, $cursor); | ||
| } | ||
| } |