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

Completed

Push — 0.18.x ( c34984 )

by Colin

created 2019-06-20 01:27 UTC

CloseBracketParser::tryParseLink() A

↳ Parent: CloseBracketParser

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	6
cts	6
cp	1
rs	9.7998
c	0
b	0
f	0
cc	3
nc	3
nop	4
crap	3

<?php

/*
 * 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\Inline\Parser;

use League\CommonMark\Cursor;
use League\CommonMark\Delimiter\Delimiter;
use League\CommonMark\Delimiter\DelimiterStack;
use League\CommonMark\Environment;
use League\CommonMark\EnvironmentAwareInterface;
use League\CommonMark\Inline\Element\AbstractWebResource;
use League\CommonMark\Inline\Element\Image;
use League\CommonMark\Inline\Element\Link;
use League\CommonMark\InlineParserContext;
use League\CommonMark\Reference\Reference;
use League\CommonMark\Reference\ReferenceMap;
use League\CommonMark\Util\LinkParserHelper;
use League\CommonMark\Util\RegexHelper;

class CloseBracketParser extends AbstractInlineParser implements EnvironmentAwareInterface
{
    /**
     * @var Environment
     */
    protected $environment;

    /**
     * @return string[]
     */
    public function getCharacters()
    {
        return [']'];
    }

    /**
     * @param InlineParserContext $inlineContext
     *
     * @return bool
     */
    public function parse(InlineParserContext $inlineContext)
    {
        // Look through stack of delimiters for a [ or !
        $opener = $inlineContext->getDelimiterStack()->searchByCharacter(['[', '!']);
        if ($opener === null) {
            return false;
        }

        if (!$opener->isActive()) {
            // no matched opener; remove from emphasis stack
            $inlineContext->getDelimiterStack()->removeDelimiter($opener);

            return false;
        }

        $cursor = $inlineContext->getCursor();

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

        $cursor->advance();

        // Check to see if we have a link/image
        if (!($link = $this->tryParseLink($cursor, $inlineContext->getReferenceMap(), $opener, $startPos))) {
            // No match
            $inlineContext->getDelimiterStack()->removeDelimiter($opener); // Remove this opener from stack
            $cursor->restoreState($previousState);

            return false;
        }

        $isImage = $opener->getChar() === '!';

        $inline = $this->createInline($link['url'], $link['title'], $isImage);
        $opener->getInlineNode()->replaceWith($inline);
        while (($label = $inline->next()) !== null) {
            $inline->appendChild($label);
        }

        $delimiterStack = $inlineContext->getDelimiterStack();
        $stackBottom = $opener->getPrevious();
        foreach ($this->environment->getInlineProcessors() as $inlineProcessor) {
            $inlineProcessor->processInlines($delimiterStack, $stackBottom);
        }
        if ($delimiterStack instanceof DelimiterStack) {
            $delimiterStack->removeAll($stackBottom);
        }

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

        return true;
    }

    /**
     * @param Environment $environment
     */
    public function setEnvironment(Environment $environment)
    {
        $this->environment = $environment;
    }

    /**
     * @param Cursor       $cursor
     * @param ReferenceMap $referenceMap
     * @param Delimiter    $opener
     * @param int          $startPos
     *
     * @return array|bool
     */
    protected function tryParseLink(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, $startPos)
    {
        // Check to see if we have a link/image
        // Inline link?
        if ($result = $this->tryParseInlineLinkAndTitle($cursor)) {
            return $result;
        }

        if ($link = $this->tryParseReference($cursor, $referenceMap, $opener, $startPos)) {
            return ['url' => $link->getDestination(), 'title' => $link->getTitle()];
        }

        return false;
    }

    /**
     * @param Cursor $cursor
     *
     * @return array|bool
     */
    protected function tryParseInlineLinkAndTitle(Cursor $cursor)
    {
        if ($cursor->getCharacter() !== '(') {
            return false;
        }

        $previousState = $cursor->saveState();

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

            return false;
        }

        $cursor->advanceToNextNonSpaceOrNewline();

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

        $cursor->advanceToNextNonSpaceOrNewline();

        if ($cursor->match('/^\\)/') === null) {
            $cursor->restoreState($previousState);

            return false;
        }

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

    /**
     * @param Cursor       $cursor
     * @param ReferenceMap $referenceMap
     * @param Delimiter    $opener
     * @param int          $startPos
     *
     * @return Reference|null
     */
    protected function tryParseReference(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, $startPos)
    {
        $savePos = $cursor->saveState();
        $beforeLabel = $cursor->getPosition();
        $n = LinkParserHelper::parseLinkLabel($cursor);
        if ($n === 0 || $n === 2) {
            // Empty or missing second label
            $reflabel = mb_substr($cursor->getLine(), $opener->getIndex(), $startPos - $opener->getIndex(), 'utf-8');
        } else {
            $reflabel = mb_substr($cursor->getLine(), $beforeLabel + 1, $n - 2, 'utf-8');
        }

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

        return $referenceMap->getReference($reflabel);
    }

    /**
     * @param string $url
     * @param string $title
     * @param bool   $isImage
     *
     * @return AbstractWebResource
     */
    protected function createInline($url, $title, $isImage)
    {
        if ($isImage) {
            return new Image($url, null, $title);
        }

        return new Link($url, null, $title);
    }
}


1		<?php
2
3		/*
4		* This file is part of the league/commonmark package.
5		*
6		* (c) Colin O'Dell <[email protected]>
7		*
8		* Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
9		* - (c) John MacFarlane
10		*
11		* For the full copyright and license information, please view the LICENSE
12		* file that was distributed with this source code.
13		*/
14
15		namespace League\CommonMark\Inline\Parser;
16
17		use League\CommonMark\Cursor;
18		use League\CommonMark\Delimiter\Delimiter;
19		use League\CommonMark\Delimiter\DelimiterStack;
20		use League\CommonMark\Environment;
21		use League\CommonMark\EnvironmentAwareInterface;
22		use League\CommonMark\Inline\Element\AbstractWebResource;
23		use League\CommonMark\Inline\Element\Image;
24		use League\CommonMark\Inline\Element\Link;
25		use League\CommonMark\InlineParserContext;
26		use League\CommonMark\Reference\Reference;
27		use League\CommonMark\Reference\ReferenceMap;
28		use League\CommonMark\Util\LinkParserHelper;
29		use League\CommonMark\Util\RegexHelper;
30
31		class CloseBracketParser extends AbstractInlineParser implements EnvironmentAwareInterface
32		{
33		/**
34		* @var Environment
35		*/
36		protected $environment;
37
38		/**
39		* @return string[]
40		*/
41	1941	public function getCharacters()
42		{
43	1941	return [']'];
44		}
45
46		/**
47		* @param InlineParserContext $inlineContext
48		*
49		* @return bool
50		*/
51	405	public function parse(InlineParserContext $inlineContext)
52		{
53		// Look through stack of delimiters for a [ or !
54	405	$opener = $inlineContext->getDelimiterStack()->searchByCharacter(['[', '!']);
55	405	if ($opener === null) {
56	12	return false;
57		}
58
59	396	if (!$opener->isActive()) {
60		// no matched opener; remove from emphasis stack
61	18	$inlineContext->getDelimiterStack()->removeDelimiter($opener);
62
63	18	return false;
64		}
65
66	396	$cursor = $inlineContext->getCursor();
67
68	396	$startPos = $cursor->getPosition();
69	396	$previousState = $cursor->saveState();
70
71	396	$cursor->advance();
72
73		// Check to see if we have a link/image
74	396	if (!($link = $this->tryParseLink($cursor, $inlineContext->getReferenceMap(), $opener, $startPos))) {
75		// No match
76	93	$inlineContext->getDelimiterStack()->removeDelimiter($opener); // Remove this opener from stack
77	93	$cursor->restoreState($previousState);
78
79	93	return false;
80		}
81
82	333	$isImage = $opener->getChar() === '!';
83
84	333	$inline = $this->createInline($link['url'], $link['title'], $isImage);
85	333	$opener->getInlineNode()->replaceWith($inline);
86	333	while (($label = $inline->next()) !== null) {
87	330	$inline->appendChild($label);
88	110	}
89
90	333	$delimiterStack = $inlineContext->getDelimiterStack();
91	333	$stackBottom = $opener->getPrevious();
92	333	foreach ($this->environment->getInlineProcessors() as $inlineProcessor) {
93	333	$inlineProcessor->processInlines($delimiterStack, $stackBottom);
94	111	}
95	333	if ($delimiterStack instanceof DelimiterStack) {
96	333	$delimiterStack->removeAll($stackBottom);
97	111	}
98
99		// processEmphasis will remove this and later delimiters.
100		// Now, for a link, we also remove earlier link openers (no links in links)
101	333	if (!$isImage) {
102	279	$inlineContext->getDelimiterStack()->removeEarlierMatches('[');
103	93	}
104
105	333	return true;
106		}
107
108		/**
109		* @param Environment $environment
110		*/
111	1941	public function setEnvironment(Environment $environment)
112		{
113	1941	$this->environment = $environment;
114	1941	}
115
116		/**
117		* @param Cursor $cursor
118		* @param ReferenceMap $referenceMap
119		* @param Delimiter $opener
120		* @param int $startPos
121		*
122		* @return array\|bool
123		*/
124	396	protected function tryParseLink(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, $startPos)
125		{
126		// Check to see if we have a link/image
127		// Inline link?
128	396	if ($result = $this->tryParseInlineLinkAndTitle($cursor)) {
129	150	return $result;
130		}
131
132	261	if ($link = $this->tryParseReference($cursor, $referenceMap, $opener, $startPos)) {
133	189	return ['url' => $link->getDestination(), 'title' => $link->getTitle()];
134		}
135
136	93	return false;
137		}
138
139		/**
140		* @param Cursor $cursor
141		*
142		* @return array\|bool
143		*/
144	396	protected function tryParseInlineLinkAndTitle(Cursor $cursor)
145		{
146	396	if ($cursor->getCharacter() !== '(') {
147	237	return false;
148		}
149
150	168	$previousState = $cursor->saveState();
151
152	168	$cursor->advance();
153	168	$cursor->advanceToNextNonSpaceOrNewline();
154	168	if (($dest = LinkParserHelper::parseLinkDestination($cursor)) === null) {
155		$cursor->restoreState($previousState);
156
157		return false;
158		}
159
160	168	$cursor->advanceToNextNonSpaceOrNewline();
161
162	168	$title = null;
163		// make sure there's a space before the title:
164	168	if (preg_match(RegexHelper::REGEX_WHITESPACE_CHAR, $cursor->peek(-1))) {
165	51	$title = LinkParserHelper::parseLinkTitle($cursor) ?: '';
166	17	}
167
168	168	$cursor->advanceToNextNonSpaceOrNewline();
169
170	168	if ($cursor->match('/^\\)/') === null) {
171	24	$cursor->restoreState($previousState);
172
173	24	return false;
174		}
175
176	150	return ['url' => $dest, 'title' => $title];
177		}
178
179		/**
180		* @param Cursor $cursor
181		* @param ReferenceMap $referenceMap
182		* @param Delimiter $opener
183		* @param int $startPos
184		*
185		* @return Reference\|null
186		*/
187	261	protected function tryParseReference(Cursor $cursor, ReferenceMap $referenceMap, Delimiter $opener, $startPos)
188		{
189	261	$savePos = $cursor->saveState();
190	261	$beforeLabel = $cursor->getPosition();
191	261	$n = LinkParserHelper::parseLinkLabel($cursor);
192	261	if ($n === 0 \|\| $n === 2) {
193		// Empty or missing second label
194	210	$reflabel = mb_substr($cursor->getLine(), $opener->getIndex(), $startPos - $opener->getIndex(), 'utf-8');
195	70	} else {
196	63	$reflabel = mb_substr($cursor->getLine(), $beforeLabel + 1, $n - 2, 'utf-8');
197		}
198
199	261	if ($n === 0) {
200		// If shortcut reference link, rewind before spaces we skipped
201	186	$cursor->restoreState($savePos);
202	62	}
203
204	261	return $referenceMap->getReference($reflabel);
205		}
206
207		/**
208		* @param string $url
209		* @param string $title
210		* @param bool $isImage
211		*
212		* @return AbstractWebResource
213		*/
214	333	protected function createInline($url, $title, $isImage)
215		{
216	333	if ($isImage) {
217	78	return new Image($url, null, $title);
218		}
219
220	279	return new Link($url, null, $title);
221		}
222		}
223

thephpleague / commonmark

Push — 0.18.x ( c34984 )

CloseBracketParser::tryParseLink() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like