CloseBracketParser::tryParseReference() - Code Metrics - Inspection of "Prepare to release 2.6.0" - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.6 ( d150f9 )

by Colin

created 2024-12-07 15:38 UTC

CloseBracketParser::tryParseReference() A

↳ Parent: CloseBracketParser

Complexity

Conditions	4
Paths	5

Size

Total Lines	27
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	4.0312

Importance

Changes

Metric	Value
cc	4
eloc	16
c	0
b	0
f	0
nc	5
nop	4
dl	0
loc	27
ccs	14
cts	16
cp	0.875
crap	4.0312
rs	9.7333

<?php

declare(strict_types=1);

/*
 * This file is part of the league/commonmark package.
 *
 * (c) Colin O'Dell <[email protected]>
 *
 * Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
 *  - (c) John MacFarlane
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace League\CommonMark\Extension\CommonMark\Parser\Inline;

use League\CommonMark\Delimiter\Bracket;
use League\CommonMark\Environment\EnvironmentAwareInterface;
use League\CommonMark\Environment\EnvironmentInterface;
use League\CommonMark\Extension\CommonMark\Node\Inline\AbstractWebResource;
use League\CommonMark\Extension\CommonMark\Node\Inline\Image;
use League\CommonMark\Extension\CommonMark\Node\Inline\Link;
use League\CommonMark\Extension\Mention\Mention;
use League\CommonMark\Node\Inline\AdjacentTextMerger;
use League\CommonMark\Node\Inline\Text;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\Inline\InlineParserInterface;
use League\CommonMark\Parser\Inline\InlineParserMatch;
use League\CommonMark\Parser\InlineParserContext;
use League\CommonMark\Reference\ReferenceInterface;
use League\CommonMark\Reference\ReferenceMapInterface;
use League\CommonMark\Util\LinkParserHelper;
use League\CommonMark\Util\RegexHelper;

final class CloseBracketParser implements InlineParserInterface, EnvironmentAwareInterface
{
    /** @psalm-readonly-allow-private-mutation */
    private EnvironmentInterface $environment;

    public function getMatchDefinition(): InlineParserMatch
    {
        return InlineParserMatch::string(']');
    }

    public function parse(InlineParserContext $inlineContext): bool
    {
        // Look through stack of delimiters for a [ or !
        $opener = $inlineContext->getDelimiterStack()->getLastBracket();
        if ($opener === null) {
            return false;
        }

        if (! $opener->isImage() && ! $opener->isActive()) {
            // no matched opener; remove from stack
            $inlineContext->getDelimiterStack()->removeBracket();

            return false;
        }

        $cursor = $inlineContext->getCursor();

        $startPos      = $cursor->getPosition();
        $previousState = $cursor->saveState();

        $cursor->advanceBy(1);

        // Check to see if we have a link/image

        // Inline link?
        if ($result = $this->tryParseInlineLinkAndTitle($cursor)) {
            $link = $result;
        } elseif ($link = $this->tryParseReference($cursor, $inlineContext->getReferenceMap(), $opener, $startPos)) {
            $reference = $link;
            $link      = ['url' => $link->getDestination(), 'title' => $link->getTitle()];
        } else {
            // No match; remove this opener from stack
            $inlineContext->getDelimiterStack()->removeBracket();
            $cursor->restoreState($previousState);

            return false;
        }

        $inline = $this->createInline($link['url'], $link['title'], $opener->isImage(), $reference ?? null);
        $opener->getNode()->replaceWith($inline);
        while (($label = $inline->next()) !== null) {
            // Is there a Mention or Link contained within this link?
            // CommonMark does not allow nested links, so we'll restore the original text.
            if ($label instanceof Mention) {
                $label->replaceWith($replacement = new Text($label->getPrefix() . $label->getIdentifier()));
                $inline->appendChild($replacement);
            } elseif ($label instanceof Link) {
                foreach ($label->children() as $child) {
                    $label->insertBefore($child);
                }

                $label->detach();
            } else {
                $inline->appendChild($label);
            }
        }

        // Process delimiters such as emphasis inside link/image
        $delimiterStack = $inlineContext->getDelimiterStack();
        $stackBottom    = $opener->getPosition();
        $delimiterStack->processDelimiters($stackBottom, $this->environment->getDelimiterProcessors());
        $delimiterStack->removeBracket();
        $delimiterStack->removeAll($stackBottom);

        // Merge any adjacent Text nodes together
        AdjacentTextMerger::mergeChildNodes($inline);

        // processEmphasis will remove this and later delimiters.
        // Now, for a link, we also remove earlier link openers (no links in links)
        if (! $opener->isImage()) {
            $inlineContext->getDelimiterStack()->deactivateLinkOpeners();
        }

        return true;
    }

    public function setEnvironment(EnvironmentInterface $environment): void
    {
        $this->environment = $environment;
    }

    /**
     * @return array<string, string>|null
     */
    private function tryParseInlineLinkAndTitle(Cursor $cursor): ?array
    {
        if ($cursor->getCurrentCharacter() !== '(') {
            return null;
        }

        $previousState = $cursor->saveState();

        $cursor->advanceBy(1);
        $cursor->advanceToNextNonSpaceOrNewline();
        if (($dest = LinkParserHelper::parseLinkDestination($cursor)) === null) {
            $cursor->restoreState($previousState);

            return null;
        }

        $cursor->advanceToNextNonSpaceOrNewline();
        $previousCharacter = $cursor->peek(-1);
        // We know from previous lines that we've advanced at least one space so far, so this next call should never be null
        \assert(\is_string($previousCharacter));

        $title = '';
        // make sure there's a space before the title:
        if (\preg_match(RegexHelper::REGEX_WHITESPACE_CHAR, $previousCharacter)) {
            $title = LinkParserHelper::parseLinkTitle($cursor) ?? '';
        }

        $cursor->advanceToNextNonSpaceOrNewline();

        if ($cursor->getCurrentCharacter() !== ')') {
            $cursor->restoreState($previousState);

            return null;
        }

        $cursor->advanceBy(1);

        return ['url' => $dest, 'title' => $title];
    }

    private function tryParseReference(Cursor $cursor, ReferenceMapInterface $referenceMap, Bracket $opener, int $startPos): ?ReferenceInterface
    {
        $savePos     = $cursor->saveState();
        $beforeLabel = $cursor->getPosition();
        $n           = LinkParserHelper::parseLinkLabel($cursor);
        if ($n > 2) {
            $start  = $beforeLabel + 1;
            $length = $n - 2;
        } elseif (! $opener->hasNext()) {
            // Empty or missing second label means to use the first label as the reference.
            // The reference must not contain a bracket. If we know there's a bracket, we don't even bother checking it.
            $start  = $opener->getPosition();
            $length = $startPos - $start;
        } else {
            $cursor->restoreState($savePos);

            return null;
        }

        $referenceLabel = $cursor->getSubstring($start, $length);

        if ($n === 0) {
            // If shortcut reference link, rewind before spaces we skipped
            $cursor->restoreState($savePos);
        }

        return $referenceMap->get($referenceLabel);
    }

    private function createInline(string $url, string $title, bool $isImage, ?ReferenceInterface $reference = null): AbstractWebResource
    {
        if ($isImage) {
            $inline = new Image($url, null, $title);
        } else {
            $inline = new Link($url, null, $title);
        }

        if ($reference) {
            $inline->data->set('reference', $reference);
        }

        return $inline;
    }
}


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		* Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
11		* - (c) John MacFarlane
12		*
13		* For the full copyright and license information, please view the LICENSE
14		* file that was distributed with this source code.
15		*/
16
17		namespace League\CommonMark\Extension\CommonMark\Parser\Inline;
18
19		use League\CommonMark\Delimiter\Bracket;
20		use League\CommonMark\Environment\EnvironmentAwareInterface;
21		use League\CommonMark\Environment\EnvironmentInterface;
22		use League\CommonMark\Extension\CommonMark\Node\Inline\AbstractWebResource;
23		use League\CommonMark\Extension\CommonMark\Node\Inline\Image;
24		use League\CommonMark\Extension\CommonMark\Node\Inline\Link;
25		use League\CommonMark\Extension\Mention\Mention;
26		use League\CommonMark\Node\Inline\AdjacentTextMerger;
27		use League\CommonMark\Node\Inline\Text;
28		use League\CommonMark\Parser\Cursor;
29		use League\CommonMark\Parser\Inline\InlineParserInterface;
30		use League\CommonMark\Parser\Inline\InlineParserMatch;
31		use League\CommonMark\Parser\InlineParserContext;
32		use League\CommonMark\Reference\ReferenceInterface;
33		use League\CommonMark\Reference\ReferenceMapInterface;
34		use League\CommonMark\Util\LinkParserHelper;
35		use League\CommonMark\Util\RegexHelper;
36
37		final class CloseBracketParser implements InlineParserInterface, EnvironmentAwareInterface
38		{
39		/** @psalm-readonly-allow-private-mutation */
40		private EnvironmentInterface $environment;
41
42	2298	public function getMatchDefinition(): InlineParserMatch
43		{
44	2298	return InlineParserMatch::string(']');
45		}
46
47	394	public function parse(InlineParserContext $inlineContext): bool
48		{
49		// Look through stack of delimiters for a [ or !
50	394	$opener = $inlineContext->getDelimiterStack()->getLastBracket();
51	394	if ($opener === null) {
52	8	return false;
53		}
54
55	388	if (! $opener->isImage() && ! $opener->isActive()) {
56		// no matched opener; remove from stack
57	12	$inlineContext->getDelimiterStack()->removeBracket();
58
59	12	return false;
60		}
61
62	388	$cursor = $inlineContext->getCursor();
63
64	388	$startPos = $cursor->getPosition();
65	388	$previousState = $cursor->saveState();
66
67	388	$cursor->advanceBy(1);
68
69		// Check to see if we have a link/image
70
71		// Inline link?
72	388	if ($result = $this->tryParseInlineLinkAndTitle($cursor)) {
73	176	$link = $result;
74	222	} elseif ($link = $this->tryParseReference($cursor, $inlineContext->getReferenceMap(), $opener, $startPos)) {
75	144	$reference = $link;
76	144	$link = ['url' => $link->getDestination(), 'title' => $link->getTitle()];
77		} else {
78		// No match; remove this opener from stack
79	92	$inlineContext->getDelimiterStack()->removeBracket();
80	92	$cursor->restoreState($previousState);
81
82	92	return false;
83		}
84
85	316	$inline = $this->createInline($link['url'], $link['title'], $opener->isImage(), $reference ?? null);
86	316	$opener->getNode()->replaceWith($inline);
87	316	while (($label = $inline->next()) !== null) {
88		// Is there a Mention or Link contained within this link?
89		// CommonMark does not allow nested links, so we'll restore the original text.
90	306	if ($label instanceof Mention) {
91	2	$label->replaceWith($replacement = new Text($label->getPrefix() . $label->getIdentifier()));
92	2	$inline->appendChild($replacement);
93	306	} elseif ($label instanceof Link) {
94	10	foreach ($label->children() as $child) {
95	10	$label->insertBefore($child);
96		}
97
98	10	$label->detach();
99		} else {
100	306	$inline->appendChild($label);
101		}
102		}
103
104		// Process delimiters such as emphasis inside link/image
105	316	$delimiterStack = $inlineContext->getDelimiterStack();
106	316	$stackBottom = $opener->getPosition();
107	316	$delimiterStack->processDelimiters($stackBottom, $this->environment->getDelimiterProcessors());
108	316	$delimiterStack->removeBracket();
109	316	$delimiterStack->removeAll($stackBottom);
110
111		// Merge any adjacent Text nodes together
112	316	AdjacentTextMerger::mergeChildNodes($inline);
113
114		// processEmphasis will remove this and later delimiters.
115		// Now, for a link, we also remove earlier link openers (no links in links)
116	316	if (! $opener->isImage()) {
117	274	$inlineContext->getDelimiterStack()->deactivateLinkOpeners();
118		}
119
120	316	return true;
121		}
122
123	2312	public function setEnvironment(EnvironmentInterface $environment): void
124		{
125	2312	$this->environment = $environment;
126		}
127
128		/**
129		* @return array<string, string>\|null
130		*/
131	388	private function tryParseInlineLinkAndTitle(Cursor $cursor): ?array
132		{
133	388	if ($cursor->getCurrentCharacter() !== '(') {
134	188	return null;
135		}
136
137	208	$previousState = $cursor->saveState();
138
139	208	$cursor->advanceBy(1);
140	208	$cursor->advanceToNextNonSpaceOrNewline();
141	208	if (($dest = LinkParserHelper::parseLinkDestination($cursor)) === null) {
142	8	$cursor->restoreState($previousState);
143
144	8	return null;
145		}
146
147	202	$cursor->advanceToNextNonSpaceOrNewline();
148	202	$previousCharacter = $cursor->peek(-1);
149		// We know from previous lines that we've advanced at least one space so far, so this next call should never be null
150		\assert(\is_string($previousCharacter));
151
152	202	$title = '';
153		// make sure there's a space before the title:
154	202	if (\preg_match(RegexHelper::REGEX_WHITESPACE_CHAR, $previousCharacter)) {
155	44	$title = LinkParserHelper::parseLinkTitle($cursor) ?? '';
156		}
157
158	202	$cursor->advanceToNextNonSpaceOrNewline();
159
160	202	if ($cursor->getCurrentCharacter() !== ')') {
161	30	$cursor->restoreState($previousState);
162
163	30	return null;
164		}
165
166	176	$cursor->advanceBy(1);
167
168	176	return ['url' => $dest, 'title' => $title];
169		}
170
171	222	private function tryParseReference(Cursor $cursor, ReferenceMapInterface $referenceMap, Bracket $opener, int $startPos): ?ReferenceInterface
172		{
173	222	$savePos = $cursor->saveState();
174	222	$beforeLabel = $cursor->getPosition();
175	222	$n = LinkParserHelper::parseLinkLabel($cursor);
176	222	if ($n > 2) {
177	44	$start = $beforeLabel + 1;
178	44	$length = $n - 2;
179	186	} elseif (! $opener->hasNext()) {
180		// Empty or missing second label means to use the first label as the reference.
181		// The reference must not contain a bracket. If we know there's a bracket, we don't even bother checking it.
182	186	$start = $opener->getPosition();
183	186	$length = $startPos - $start;
184		} else {
185		$cursor->restoreState($savePos);
186
187		return null;
188		}
189
190	222	$referenceLabel = $cursor->getSubstring($start, $length);
191
192	222	if ($n === 0) {
193		// If shortcut reference link, rewind before spaces we skipped
194	170	$cursor->restoreState($savePos);
195		}
196
197	222	return $referenceMap->get($referenceLabel);
198		}
199
200	316	private function createInline(string $url, string $title, bool $isImage, ?ReferenceInterface $reference = null): AbstractWebResource
201		{
202	316	if ($isImage) {
203	58	$inline = new Image($url, null, $title);
204		} else {
205	274	$inline = new Link($url, null, $title);
206		}
207
208	316	if ($reference) {
209	144	$inline->data->set('reference', $reference);
210		}
211
212	316	return $inline;
213		}
214		}
215

thephpleague / commonmark

Push — 2.6 ( d150f9 )

CloseBracketParser::tryParseReference() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like