MentionParser::createGitHubIssueParser() - Code Metrics - Inspection of "Merge branch '1.5' into latest" - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — latest ( 02d08e...e7e0af )

by Colin

created 2020-06-20 13:40 UTC

MentionParser::createGitHubIssueParser() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?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\Extension\Mention;

use League\CommonMark\Extension\Mention\Generator\CallbackGenerator;
use League\CommonMark\Extension\Mention\Generator\MentionGeneratorInterface;
use League\CommonMark\Extension\Mention\Generator\StringTemplateLinkGenerator;
use League\CommonMark\Parser\Inline\InlineParserInterface;
use League\CommonMark\Parser\InlineParserContext;

final class MentionParser implements InlineParserInterface
{
    /**
     * @var string
     *
     * @psalm-readonly
     */
    private $symbol;

    /**
     * @var string
     *
     * @psalm-readonly
     */
    private $mentionRegex;

    /**
     * @var MentionGeneratorInterface
     *
     * @psalm-readonly
     */
    private $mentionGenerator;

    public function __construct(string $symbol, string $mentionRegex, MentionGeneratorInterface $mentionGenerator)
    {
        $this->symbol           = $symbol;
        $this->mentionRegex     = $mentionRegex;
        $this->mentionGenerator = $mentionGenerator;
    }

    /**
     * {@inheritDoc}
     */
    public function getCharacters(): array
    {
        return [$this->symbol];
    }

    public function parse(InlineParserContext $inlineContext): bool
    {
        $cursor = $inlineContext->getCursor();

        // The symbol must not have any other characters immediately prior
        $previousChar = $cursor->peek(-1);
        if ($previousChar !== null && $previousChar !== ' ') {
            // peek() doesn't modify the cursor, so no need to restore state first
            return false;
        }

        // Save the cursor state in case we need to rewind and bail
        $previousState = $cursor->saveState();

        // Advance past the symbol to keep parsing simpler
        $cursor->advance();

        // Parse the identifier
        $identifier = $cursor->match($this->mentionRegex);
        if ($identifier === null) {
            // Regex failed to match; this isn't a valid mention
            $cursor->restoreState($previousState);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

            return false;
        }

        $mention = $this->mentionGenerator->generateMention(new Mention($this->symbol, $identifier));

        if ($mention === null) {
            $cursor->restoreState($previousState);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

            return false;
        }

        $inlineContext->getContainer()->appendChild($mention);

        return true;
    }

    public static function createWithStringTemplate(string $symbol, string $mentionRegex, string $urlTemplate): MentionParser
    {
        return new self($symbol, $mentionRegex, new StringTemplateLinkGenerator($urlTemplate));
    }

    public static function createWithCallback(string $symbol, string $mentionRegex, callable $callback): MentionParser
    {
        return new self($symbol, $mentionRegex, new CallbackGenerator($callback));
    }
}


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\Extension\Mention;
15
16		use League\CommonMark\Extension\Mention\Generator\CallbackGenerator;
17		use League\CommonMark\Extension\Mention\Generator\MentionGeneratorInterface;
18		use League\CommonMark\Extension\Mention\Generator\StringTemplateLinkGenerator;
19		use League\CommonMark\Parser\Inline\InlineParserInterface;
20		use League\CommonMark\Parser\InlineParserContext;
21
22		final class MentionParser implements InlineParserInterface
23		{
24		/**
25		* @var string
26		*
27		* @psalm-readonly
28		*/
29		private $symbol;
30
31		/**
32		* @var string
33		*
34		* @psalm-readonly
35		*/
36		private $mentionRegex;
37
38		/**
39		* @var MentionGeneratorInterface
40		*
41		* @psalm-readonly
42		*/
43		private $mentionGenerator;
44
45	30	public function __construct(string $symbol, string $mentionRegex, MentionGeneratorInterface $mentionGenerator)
46		{
47	30	$this->symbol = $symbol;
48	30	$this->mentionRegex = $mentionRegex;
49	30	$this->mentionGenerator = $mentionGenerator;
50	30	}
51
52		/**
53		* {@inheritDoc}
54		*/
55	30	public function getCharacters(): array
56		{
57	30	return [$this->symbol];
58		}
59
60	27	public function parse(InlineParserContext $inlineContext): bool
61		{
62	27	$cursor = $inlineContext->getCursor();
63
64		// The symbol must not have any other characters immediately prior
65	27	$previousChar = $cursor->peek(-1);
66	27	if ($previousChar !== null && $previousChar !== ' ') {
67		// peek() doesn't modify the cursor, so no need to restore state first
68	3	return false;
69		}
70
71		// Save the cursor state in case we need to rewind and bail
72	24	$previousState = $cursor->saveState();
73
74		// Advance past the symbol to keep parsing simpler
75	24	$cursor->advance();
76
77		// Parse the identifier
78	24	$identifier = $cursor->match($this->mentionRegex);
79	24	if ($identifier === null) {
80		// Regex failed to match; this isn't a valid mention
81	3	$cursor->restoreState($previousState);
		0 ignored issues – show Unused Code introduced 2020-04-26 17:35 UTC by Report Bug Copy Issue Report The call to the method `League\CommonMark\Parser\Cursor::restoreState()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
82
83	3	return false;
84		}
85
86	21	$mention = $this->mentionGenerator->generateMention(new Mention($this->symbol, $identifier));
87
88	21	if ($mention === null) {
89	3	$cursor->restoreState($previousState);
		0 ignored issues – show Unused Code introduced 2020-05-17 19:28 UTC by Report Bug Copy Issue Report The call to the method `League\CommonMark\Parser\Cursor::restoreState()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
90
91	3	return false;
92		}
93
94	18	$inlineContext->getContainer()->appendChild($mention);
95
96	18	return true;
97		}
98
99	3	public static function createWithStringTemplate(string $symbol, string $mentionRegex, string $urlTemplate): MentionParser
100		{
101	3	return new self($symbol, $mentionRegex, new StringTemplateLinkGenerator($urlTemplate));
102		}
103
104	9	public static function createWithCallback(string $symbol, string $mentionRegex, callable $callback): MentionParser
105		{
106	9	return new self($symbol, $mentionRegex, new CallbackGenerator($callback));
107		}
108		}
109

thephpleague / commonmark

Push — latest ( 02d08e...e7e0af )

MentionParser::createGitHubIssueParser() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like