ParagraphParser::getReferences() - Code Metrics - Inspection of "Refactor the parser implementation" - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — refactor-parsing ( adbb6b...fbe6de )

by Colin

created 2020-05-03 14:10 UTC

ParagraphParser::getReferences() A

↳ Parent: ParagraphParser

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]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace League\CommonMark\Parser\Block;

use League\CommonMark\Node\Block\AbstractBlock;
use League\CommonMark\Node\Block\Paragraph;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\InlineParserEngineInterface;
use League\CommonMark\Reference\ReferenceInterface;
use League\CommonMark\Reference\ReferenceParser;

final class ParagraphParser extends AbstractBlockContinueParser
{
    /** @var Paragraph */
    private $block;

    /** @var ReferenceParser */
    private $referenceParser;

    public function __construct()
    {
        $this->block = new Paragraph();
        $this->referenceParser = new ReferenceParser();
    }

    public function canHaveLazyContinuationLines(): bool
    {
        return true;
    }

    /**
     * @return Paragraph
     */
    public function getBlock(): AbstractBlock
    {
        return $this->block;
    }

    public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
    {
        if ($cursor->isBlank()) {
            return BlockContinue::none();
        }

        return BlockContinue::at($cursor);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function addLine(string $line): void
    {
        $this->referenceParser->parse($line);
    }

    public function closeBlock(): void
    {
        if ($this->referenceParser->hasReferences() && $this->referenceParser->getParagraphContent() === '') {
            $this->block->detach();
        }
    }

    public function parseInlines(InlineParserEngineInterface $inlineParser): void
    {
        $content = $this->getContentString();
        if ($content !== '') {
            $inlineParser->parse($content, $this->block);
        }
    }

    public function getContentString(): string
    {
        return $this->referenceParser->getParagraphContent();
    }

    /**
     * @return ReferenceInterface[]
     */
    public function getReferences(): iterable
    {
        return $this->referenceParser->getReferences();
    }
}


1		<?php
2
3		/*
4		* This file is part of the league/commonmark package.
5		*
6		* (c) Colin O'Dell <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace League\CommonMark\Parser\Block;
13
14		use League\CommonMark\Node\Block\AbstractBlock;
15		use League\CommonMark\Node\Block\Paragraph;
16		use League\CommonMark\Parser\Cursor;
17		use League\CommonMark\Parser\InlineParserEngineInterface;
18		use League\CommonMark\Reference\ReferenceInterface;
19		use League\CommonMark\Reference\ReferenceParser;
20
21		final class ParagraphParser extends AbstractBlockContinueParser
22		{
23		/** @var Paragraph */
24		private $block;
25
26		/** @var ReferenceParser */
27		private $referenceParser;
28
29	2130	public function __construct()
30		{
31	2130	$this->block = new Paragraph();
32	2130	$this->referenceParser = new ReferenceParser();
33	2130	}
34
35	36	public function canHaveLazyContinuationLines(): bool
36		{
37	36	return true;
38		}
39
40		/**
41		* @return Paragraph
42		*/
43	2130	public function getBlock(): AbstractBlock
44		{
45	2130	return $this->block;
46		}
47
48	882	public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
49		{
50	882	if ($cursor->isBlank()) {
51	504	return BlockContinue::none();
52		}
53
54	489	return BlockContinue::at($cursor);
		0 ignored issues – show Bug Best Practice introduced 2020-05-03 01:47 UTC by Report Bug Copy Issue Report The return type of `return \League\CommonMar...kContinue::at($cursor);` (`self`) is incompatible with the return type declared by the interface `League\CommonMark\Parser...rInterface::tryContinue` of type `League\CommonMark\Parser\Block\BlockContinue\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
55		}
56
57	2130	public function addLine(string $line): void
58		{
59	2130	$this->referenceParser->parse($line);
60	2130	}
61
62	2028	public function closeBlock(): void
63		{
64	2028	if ($this->referenceParser->hasReferences() && $this->referenceParser->getParagraphContent() === '') {
65	222	$this->block->detach();
66		}
67	2028	}
68
69	2028	public function parseInlines(InlineParserEngineInterface $inlineParser): void
70		{
71	2028	$content = $this->getContentString();
72	2028	if ($content !== '') {
73	2022	$inlineParser->parse($content, $this->block);
74		}
75	2028	}
76
77	2130	public function getContentString(): string
78		{
79	2130	return $this->referenceParser->getParagraphContent();
80		}
81
82		/**
83		* @return ReferenceInterface[]
84		*/
85	2130	public function getReferences(): iterable
86		{
87	2130	return $this->referenceParser->getReferences();
88		}
89		}
90

thephpleague / commonmark

Push — refactor-parsing ( adbb6b...fbe6de )

ParagraphParser::getReferences() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like