SkipLinesStartingWithLettersParser::tryStart() - Code Metrics - Inspection of "Fix ability to register block parsers that identif..." - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.0 ( 040f68...c13575 )

by Colin

created 2021-08-14 14:04 UTC

SkipLinesStartingWithLettersParser::tryStart() A

↳ Parent: SkipLinesStartingWithLettersParser

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	9
ccs	5
cts	5
cp	1
rs	10
cc	3
nc	2
nop	2
crap	3

<?php

declare(strict_types=1);

/*
 * This file is part of the league/commonmark package.
 *
 * (c) Colin O'Dell <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace League\CommonMark\Parser\Block;

use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\MarkdownParserStateInterface;
use League\CommonMark\Util\RegexHelper;

/**
 * @internal
 *
 * This "parser" is actually a performance optimization.
 *
 * Most lines in a typical Markdown document probably won't match a block start. This is especially true for lines starting
 * with letters - nothing in the core CommonMark spec or our supported extensions will match those lines as blocks. Therefore,
 * if we can identify those lines and skip block start parsing, we can optimize performance by ~10%.
 *
 * Previously this optimization was hard-coded in the MarkdownParser but did not allow users to override this behavior.
 * By implementing this optimization as a block parser instead, users wanting custom blocks starting with letters
 * can instead register their block parser with a higher priority to ensure their parser is always called first.
 */
final class SkipLinesStartingWithLettersParser implements BlockStartParserInterface
{
    public function tryStart(Cursor $cursor, MarkdownParserStateInterface $parserState): ?BlockStart
    {
        if (! $cursor->isIndented() && RegexHelper::isLetter($cursor->getNextNonSpaceCharacter())) {
            $cursor->advanceToNextNonSpaceOrTab();

            return BlockStart::abort();
        }

        return BlockStart::none();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of the league/commonmark package.
7		*
8		* (c) Colin O'Dell <[email protected]>
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace League\CommonMark\Parser\Block;
15
16		use League\CommonMark\Parser\Cursor;
17		use League\CommonMark\Parser\MarkdownParserStateInterface;
18		use League\CommonMark\Util\RegexHelper;
19
20		/**
21		* @internal
22		*
23		* This "parser" is actually a performance optimization.
24		*
25		* Most lines in a typical Markdown document probably won't match a block start. This is especially true for lines starting
26		* with letters - nothing in the core CommonMark spec or our supported extensions will match those lines as blocks. Therefore,
27		* if we can identify those lines and skip block start parsing, we can optimize performance by ~10%.
28		*
29		* Previously this optimization was hard-coded in the MarkdownParser but did not allow users to override this behavior.
30		* By implementing this optimization as a block parser instead, users wanting custom blocks starting with letters
31		* can instead register their block parser with a higher priority to ensure their parser is always called first.
32		*/
33		final class SkipLinesStartingWithLettersParser implements BlockStartParserInterface
34		{
35	2136	public function tryStart(Cursor $cursor, MarkdownParserStateInterface $parserState): ?BlockStart
36		{
37	2136	if (! $cursor->isIndented() && RegexHelper::isLetter($cursor->getNextNonSpaceCharacter())) {
38	1050	$cursor->advanceToNextNonSpaceOrTab();
39
40	1050	return BlockStart::abort();
41		}
42
43	1678	return BlockStart::none();
44		}
45		}
46

thephpleague / commonmark

Push — 2.0 ( 040f68...c13575 )

SkipLinesStartingWithLettersParser::tryStart() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like