Issues in IndentedCode.php - Fixed Issues - Inspection of "Fix phpstan failures" - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fbf2a7...00045a )

by Colin

created 2019-04-10 05:52 UTC

src/Block/Element/IndentedCode.php (1 issue)

Showing only issues like (Show All)

strict.coding_against_specific_subtype

Bug Minor

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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 IndentedCode extends AbstractStringContainerBlock
{
    /**
     * 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 true;
    }

    public function matchesNextLine(Cursor $cursor): bool
    {
        if ($cursor->isIndented()) {
            $cursor->advanceBy(Cursor::INDENT_LEVEL, true);
        } elseif ($cursor->isBlank()) {
            $cursor->advanceToNextNonSpaceOrTab();
        } else {
            return false;
        }

        return true;
    }

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

        $reversed = \array_reverse($this->strings->toArray(), true);
        foreach ($reversed as $index => $line) {
            if ($line === '' || $line === "\n" || \preg_match('/^(\n *)$/', $line)) {
                unset($reversed[$index]);
            } else {
                break;
            }
        }
        $fixed = \array_reverse($reversed);
        $tmp = \implode("\n", $fixed);
        if (\substr($tmp, -1) !== "\n") {
            $tmp .= "\n";
        }

        $this->finalStringContents = $tmp;
    }

    /**
     * @param ContextInterface $context
     * @param Cursor           $cursor
     */
    public function handleRemainingContents(ContextInterface $context, Cursor $cursor)
    {
        $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.
    }
}
    }
}


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 IndentedCode extends AbstractStringContainerBlock
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		public function canContain(AbstractBlock $block): bool
30		{
31		return false;
32		}
33
34		/**
35		* Whether this is a code block
36		*
37		* @return bool
38		*/
39	75	public function isCode(): bool
40		{
41	75	return true;
42		}
43
44	87	public function matchesNextLine(Cursor $cursor): bool
45		{
46	87	if ($cursor->isIndented()) {
47	42	$cursor->advanceBy(Cursor::INDENT_LEVEL, true);
48	66	} elseif ($cursor->isBlank()) {
49	54	$cursor->advanceToNextNonSpaceOrTab();
50		} else {
51	48	return false;
52		}
53
54	75	return true;
55		}
56
57	150	public function finalize(ContextInterface $context, int $endLineNumber)
58		{
59	150	parent::finalize($context, $endLineNumber);
60
61	150	$reversed = \array_reverse($this->strings->toArray(), true);
62	150	foreach ($reversed as $index => $line) {
63	150	if ($line === '' \|\| $line === "\n" \|\| \preg_match('/^(\n *)$/', $line)) {
64	39	unset($reversed[$index]);
65		} else {
66	150	break;
67		}
68		}
69	150	$fixed = \array_reverse($reversed);
70	150	$tmp = \implode("\n", $fixed);
71	150	if (\substr($tmp, -1) !== "\n") {
72	150	$tmp .= "\n";
73		}
74
75	150	$this->finalStringContents = $tmp;
76	150	}
77
78		/**
79		* @param ContextInterface $context
80		* @param Cursor $cursor
81		*/
82	147	public function handleRemainingContents(ContextInterface $context, Cursor $cursor)
83		{
84	147	$context->getTip()->addLine($cursor->getRemainder());
		0 ignored issues – show Bug introduced 2019-04-10 05:33 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
85	147	}
86		}
87

thephpleague / commonmark

Push — master ( fbf2a7...00045a )

src/Block/Element/IndentedCode.php (1 issue)

Showing only issues like (Show All)

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like