MarkdownEngine - Code Metrics - Inspection of "Merge pull request #121 for v0.2.1" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7b9015...c5b311 )

by Vladimir

created 2020-07-04 02:09 UTC

MarkdownEngine A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

84.21%

Importance

Changes

Metric	Value
wmc	15
lcom	1
cbo	5
dl	0
loc	109
ccs	32
cts	38
cp	0.8421
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Size	Complexity
A	__construct()	7	1
A	parse()	6	1
A	blockHeader()	11	2
A	blockSetextHeader()	19	3
A	blockFencedCodeComplete()	13	3
A	inlineImage()	13	2
A	slugifyHeader()	4	1
A	getTemplateTag()	4	1
A	getExtensions()	8	1

<?php

/**
 * @copyright 2018 Vladimir Jimenez
 * @license   https://github.com/stakx-io/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\MarkupEngine;

use __;
use allejo\stakx\Manager\AssetManager;
use allejo\stakx\Markup\AssetHandlerTrait;
use allejo\stakx\Markup\SyntaxHighlighterTrait;
use allejo\stakx\RuntimeStatus;
use allejo\stakx\Service;
use Highlight\Highlighter;

class MarkdownEngine extends \ParsedownExtra implements MarkupEngineInterface
{
    use AssetHandlerTrait;
    use SyntaxHighlighterTrait;

    public function __construct(AssetManager $assetManager)
    {
        parent::__construct();

        $this->highlighter = new Highlighter();
        $this->assetManager = $assetManager;
    }

    public function parse($text, $contentItem = null)
    {
        $this->contentItem = $contentItem;

        return parent::parse($text);
    }

    protected function blockHeader($Line)
    {
        $Block = parent::blockHeader($Line);

        if (isset($Block['element']['text']))
        {
            $Block['element']['attributes']['id'] = $this->slugifyHeader($Block);
        }

        return $Block;
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());
}
    }

    protected function blockSetextHeader($Line, array $Block = null)

    {
        // @TODO Remove this `@` operator in an update to Parsedown and ParsedownExtra
        //   https://wiki.php.net/rfc/notice-for-non-valid-array-container
        //   https://github.com/erusev/parsedown-extra/issues/134
        $Block = @parent::blockSetextHeader($Line, $Block);


        if (isset($Block['element']['name']))
        {
            $element = $Block['element']['name'];

            if (in_array($element, ['h1', 'h2', 'h3', 'h4', 'h5', 'h6']))
            {
                $Block['element']['attributes']['id'] = $this->slugifyHeader($Block);
            }
        }

        return $Block;
    }

    protected function blockFencedCodeComplete($block)

    {
        // The class has a `language-` prefix, remove this to get the language
        if (isset($block['element']['text']['attributes']) && Service::hasRunTimeFlag(RuntimeStatus::USING_HIGHLIGHTER))
        {
            $cssClass = $block['element']['text']['attributes']['class'];
            $block['markup'] = $this->highlightCode($cssClass, $block['element']['text']['text']);

            return $block;
        }

        return parent::blockFencedCodeComplete($block);
    }

    protected function inlineImage($Excerpt)
    {
        $imageBlock = parent::inlineImage($Excerpt);

        if ($imageBlock !== null)
        {
            $imageSrc = trim($imageBlock['element']['attributes']['src']);

            $this->registerAsset($imageSrc);
        }

        return $imageBlock;
    }

    private function slugifyHeader($Block)
    {
        return __::slug($Block['element']['text']);
    }

    ///
    // MarkupEngine Implementation
    ///

    /**
     * {@inheritdoc}
     */
    public function getTemplateTag()
    {
        return 'markdown';
    }

    /**
     * {@inheritdoc}
     */
    public function getExtensions()
    {
        return [
            'md',
            'mdown',
            'markdown',
        ];
    }
}


1		<?php
2
3		/**
4		* @copyright 2018 Vladimir Jimenez
5		* @license https://github.com/stakx-io/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\MarkupEngine;
9
10		use __;
11		use allejo\stakx\Manager\AssetManager;
12		use allejo\stakx\Markup\AssetHandlerTrait;
13		use allejo\stakx\Markup\SyntaxHighlighterTrait;
14		use allejo\stakx\RuntimeStatus;
15		use allejo\stakx\Service;
16		use Highlight\Highlighter;
17
18		class MarkdownEngine extends \ParsedownExtra implements MarkupEngineInterface
19		{
20		use AssetHandlerTrait;
21		use SyntaxHighlighterTrait;
22
23	91	public function __construct(AssetManager $assetManager)
24		{
25	91	parent::__construct();
26
27	91	$this->highlighter = new Highlighter();
28	91	$this->assetManager = $assetManager;
29	91	}
30
31	20	public function parse($text, $contentItem = null)
32		{
33	20	$this->contentItem = $contentItem;
34
35	20	return parent::parse($text);
36		}
37
38	11	protected function blockHeader($Line)
39		{
40	11	$Block = parent::blockHeader($Line);
41
42	11	if (isset($Block['element']['text']))
43		{
44	11	$Block['element']['attributes']['id'] = $this->slugifyHeader($Block);
45		}
46
47	11	return $Block;
		0 ignored issues – show Bug Best Practice introduced 2017-06-26 02:02 UTC by Report Bug Copy Issue Report The return type of `return $Block;` (`array<string,array<string,string\|null>>`) is incompatible with the return type of the parent method `ParsedownExtra::blockHeader` of type `array<string,array<string,string>>`. 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...
48		}
49
50	3	protected function blockSetextHeader($Line, array $Block = null)
		0 ignored issues – show Documentation introduced 2019-12-29 23:04 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
51		{
52		// @TODO Remove this `@` operator in an update to Parsedown and ParsedownExtra
53		// https://wiki.php.net/rfc/notice-for-non-valid-array-container
54		// https://github.com/erusev/parsedown-extra/issues/134
55	3	$Block = @parent::blockSetextHeader($Line, $Block);
		0 ignored issues – show Coding Style introduced 2017-06-26 02:02 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$Block`. This often makes code more readable. Loading history...
56
57	3	if (isset($Block['element']['name']))
58		{
59	1	$element = $Block['element']['name'];
60
61	1	if (in_array($element, ['h1', 'h2', 'h3', 'h4', 'h5', 'h6']))
62		{
63	1	$Block['element']['attributes']['id'] = $this->slugifyHeader($Block);
64		}
65		}
66
67	3	return $Block;
68		}
69
70	7	protected function blockFencedCodeComplete($block)
		0 ignored issues – show Documentation introduced 2017-10-01 22:57 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
71		{
72		// The class has a `language-` prefix, remove this to get the language
73	7	if (isset($block['element']['text']['attributes']) && Service::hasRunTimeFlag(RuntimeStatus::USING_HIGHLIGHTER))
74		{
75	6	$cssClass = $block['element']['text']['attributes']['class'];
76	6	$block['markup'] = $this->highlightCode($cssClass, $block['element']['text']['text']);
77
78	5	return $block;
79		}
80
81	1	return parent::blockFencedCodeComplete($block);
82		}
83
84		protected function inlineImage($Excerpt)
85		{
86		$imageBlock = parent::inlineImage($Excerpt);
87
88		if ($imageBlock !== null)
89		{
90		$imageSrc = trim($imageBlock['element']['attributes']['src']);
91
92		$this->registerAsset($imageSrc);
93		}
94
95		return $imageBlock;
96		}
97
98	11	private function slugifyHeader($Block)
99		{
100	11	return __::slug($Block['element']['text']);
101		}
102
103		///
104		// MarkupEngine Implementation
105		///
106
107		/**
108		* {@inheritdoc}
109		*/
110	76	public function getTemplateTag()
111		{
112	76	return 'markdown';
113		}
114
115		/**
116		* {@inheritdoc}
117		*/
118	76	public function getExtensions()
119		{
120		return [
121	76	'md',
122		'mdown',
123		'markdown',
124		];
125		}
126		}
127

stakx-io / stakx

Push — master ( 7b9015...c5b311 )

MarkdownEngine A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Duplication Side-by-Side

Filter issues like