Paragraph::getStrings() - Code Metrics - Inspection of "Use a new dedicated interface (and helpful base cl..." - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aeeeb2...74d969 )

by Colin

created 2019-04-10 05:30 UTC

Paragraph::getStrings() A

↳ Parent: Paragraph

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	0
crap	1

<?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\Block\Element;

use League\CommonMark\ContextInterface;
use League\CommonMark\Cursor;

class Paragraph extends AbstractStringContainerBlock implements InlineContainerInterface
{
    /**
     * Returns true if this block can contain the given block as a child node
     *
     * @param AbstractBlock $block
     *
     * @return bool
     */
    public function canContain(AbstractBlock $block): bool
    {
        return false;
    }

    /**
     * Whether this is a code block
     *
     * @return bool
     */
    public function isCode(): bool
    {
        return false;
    }

    public function matchesNextLine(Cursor $cursor): bool
    {
        if ($cursor->isBlank()) {
            $this->lastLineBlank = true;

            return false;
        }

        return true;
    }

    public function finalize(ContextInterface $context, int $endLineNumber)
    {
        parent::finalize($context, $endLineNumber);

        $this->finalStringContents = \preg_replace('/^  */m', '', \implode("\n", $this->getStrings()));

        // Short-circuit
        if ($this->finalStringContents === '' || $this->finalStringContents[0] !== '[') {
            return;
        }

        $cursor = new Cursor($this->finalStringContents);

        $referenceFound = $this->parseReferences($context, $cursor);

        $this->finalStringContents = $cursor->getRemainder();

        if ($referenceFound && $cursor->isAtEnd()) {
            $this->detach();
        }
    }

    /**
     * @param ContextInterface $context
     * @param Cursor           $cursor
     *
     * @return bool
     */
    protected function parseReferences(ContextInterface $context, Cursor $cursor)
    {
        $referenceFound = false;
        while ($cursor->getCharacter() === '[' && $context->getReferenceParser()->parse($cursor)) {
            $this->finalStringContents = $cursor->getRemainder();
            $referenceFound = true;
        }

        return $referenceFound;
    }

    /**
     * @param ContextInterface $context
     * @param Cursor           $cursor
     */
    public function handleRemainingContents(ContextInterface $context, Cursor $cursor)
    {
        $cursor->advanceToNextNonSpaceOrTab();
        $context->getTip()->addLine($cursor->getRemainder());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @return string[]
     */
    public function getStrings(): array
    {
        return $this->strings->toArray();
    }
}


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\Block\Element;
16
17		use League\CommonMark\ContextInterface;
18		use League\CommonMark\Cursor;
19
20		class Paragraph extends AbstractStringContainerBlock implements InlineContainerInterface
21		{
22		/**
23		* Returns true if this block can contain the given block as a child node
24		*
25		* @param AbstractBlock $block
26		*
27		* @return bool
28		*/
29	69	public function canContain(AbstractBlock $block): bool
30		{
31	69	return false;
32		}
33
34		/**
35		* Whether this is a code block
36		*
37		* @return bool
38		*/
39	381	public function isCode(): bool
40		{
41	381	return false;
42		}
43
44	723	public function matchesNextLine(Cursor $cursor): bool
45		{
46	723	if ($cursor->isBlank()) {
47	441	$this->lastLineBlank = true;
48
49	441	return false;
50		}
51
52	381	return true;
53		}
54
55	1659	public function finalize(ContextInterface $context, int $endLineNumber)
56		{
57	1659	parent::finalize($context, $endLineNumber);
58
59	1659	$this->finalStringContents = \preg_replace('/^ */m', '', \implode("\n", $this->getStrings()));
60
61		// Short-circuit
62	1659	if ($this->finalStringContents === '' \|\| $this->finalStringContents[0] !== '[') {
63	1311	return;
64		}
65
66	426	$cursor = new Cursor($this->finalStringContents);
67
68	426	$referenceFound = $this->parseReferences($context, $cursor);
69
70	426	$this->finalStringContents = $cursor->getRemainder();
71
72	426	if ($referenceFound && $cursor->isAtEnd()) {
73	222	$this->detach();
74		}
75	426	}
76
77		/**
78		* @param ContextInterface $context
79		* @param Cursor $cursor
80		*
81		* @return bool
82		*/
83	426	protected function parseReferences(ContextInterface $context, Cursor $cursor)
84		{
85	426	$referenceFound = false;
86	426	while ($cursor->getCharacter() === '[' && $context->getReferenceParser()->parse($cursor)) {
87	231	$this->finalStringContents = $cursor->getRemainder();
88	231	$referenceFound = true;
89		}
90
91	426	return $referenceFound;
92		}
93
94		/**
95		* @param ContextInterface $context
96		* @param Cursor $cursor
97		*/
98	276	public function handleRemainingContents(ContextInterface $context, Cursor $cursor)
99		{
100	276	$cursor->advanceToNextNonSpaceOrTab();
101	276	$context->getTip()->addLine($cursor->getRemainder());
		0 ignored issues – show Bug introduced 2019-04-10 05:33 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `League\CommonMark\Block\Element\AbstractBlock` as the method `addLine()` does only exist in the following sub-classes of `League\CommonMark\Block\Element\AbstractBlock`: `League\CommonMark\Block\...actStringContainerBlock`, `League\CommonMark\Block\Element\FencedCode`, `League\CommonMark\Block\Element\Heading`, `League\CommonMark\Block\Element\HtmlBlock`, `League\CommonMark\Block\Element\IndentedCode`, `League\CommonMark\Block\Element\Paragraph`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
102	276	}
103
104		/**
105		* @return string[]
106		*/
107	1698	public function getStrings(): array
108		{
109	1698	return $this->strings->toArray();
110		}
111		}
112

thephpleague / commonmark

Push — master ( aeeeb2...74d969 )

Paragraph::getStrings() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like