MarkdownRenderer::renderHeaders() - Code Metrics - Inspection of "bump" - hiqdev/chkipper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1b355d...2cadce )

by Andrii

created 2016-07-02 12:25 UTC

MarkdownRenderer::renderHeaders() A

↳ Parent: MarkdownRenderer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * Changelog keeper
 *
 * @link      https://github.com/hiqdev/chkipper
 * @package   chkipper
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\chkipper\history;

/**
 * Markdown history renderer.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class MarkdownRenderer extends AbstractRenderer
{
    public $indent = '    ';

    /**
     * {@inheritdoc}
     */
    public function render(History $history)
    {
        $this->setHistory($history);

        return $this->renderSparse([
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());
}
            $this->renderHeaders(),
            $this->renderTags(),
            $this->renderLinks(),
        ]);
    }

    public function renderHeaders()
    {
        return $this->renderText($this->getHistory()->getHeaders());
    }

    public function renderTags()
    {
        return $this->renderObjects('renderTag', $this->getHistory()->getTags(), true);
    }

    public function renderLinks()
    {
        return $this->renderObjects('renderLink', $this->getHistory()->getLinks());
    }

    public function renderObjects($method, $objects, $sparse = false)
    {
        $res = [];
        foreach ($objects as $key => $value) {
            $res[$key] = call_user_func([$this, $method], $value, $key);
        }

        return $this->renderText($res, $sparse);
    }

    public function renderSparse(array $lines)
    {
        $res = rtrim(implode("\n", $lines));

        return $res ? $res . "\n" : '';
    }

    public function renderText(array $lines, $sparse = false)
    {
        if (!$sparse) {
            foreach ($lines as &$line) {
                $line = rtrim($line);
            }
            $lines = array_filter($lines);
        }

        return $this->renderSparse($lines);
    }

    public function renderLink($href, $link)
    {
        return "[$link]: $href";
    }

    public function renderHeader($header)
    {
        return $header;
    }

    public function renderTag(Tag $tag)
    {
        return $this->renderSparse([
            $this->renderTagHead($tag),
            $this->renderObjects('renderNote', $tag->getNotes()),
        ]);
    }

    public function renderTagHead(Tag $tag)
    {
        $res = '## [' . $tag->getName() . ']';
        if ($tag->getDate()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $res .= ' - ' . $tag->getDate();
        }

        return $res . "\n";
    }

    public function renderNote(Note $note)
    {
        return $this->renderText([
            $this->renderNoteHead($note),
            $this->renderObjects('renderCommit', $note->getCommits()),
        ]);
    }

    public function renderNoteHead(Note $note)
    {
        return $note->getNote() ? '- ' . $note->getNote() : '';
    }

    public function renderCommit(Commit $commit)
    {
        return $this->renderText([
            $this->renderCommitHead($commit),
            $this->renderText($commit->getComments()),
        ]);
    }

    public function renderCommitHead(Commit $commit)
    {
        return $this->indent . '- [' . $commit->getHash() . '] ' . $commit->getLabel();
    }
}


1		<?php
2
3		/*
4		* Changelog keeper
5		*
6		* @link https://github.com/hiqdev/chkipper
7		* @package chkipper
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hiqdev\chkipper\history;
13
14		/**
15		* Markdown history renderer.
16		*
17		* @author Andrii Vasyliev <[email protected]>
18		*/
19		class MarkdownRenderer extends AbstractRenderer
20		{
21		public $indent = ' ';
22
23		/**
24		* {@inheritdoc}
25		*/
26	2	public function render(History $history)
27		{
28	2	$this->setHistory($history);
29
30	2	return $this->renderSparse([
		0 ignored issues – show Bug Best Practice introduced 2016-06-20 21:10 UTC by Report Bug Copy Issue Report The return type of `return $this->renderSpar...$this->renderLinks()));` (`string`) is incompatible with the return type declared by the abstract method `hiqdev\chkipper\history\AbstractRenderer::render` of type `hiqdev\chkipper\history\text`. 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...
31	2	$this->renderHeaders(),
32	2	$this->renderTags(),
33	2	$this->renderLinks(),
34		]);
35		}
36
37	2	public function renderHeaders()
38		{
39	2	return $this->renderText($this->getHistory()->getHeaders());
40		}
41
42	2	public function renderTags()
43		{
44	2	return $this->renderObjects('renderTag', $this->getHistory()->getTags(), true);
45		}
46
47	2	public function renderLinks()
48		{
49	2	return $this->renderObjects('renderLink', $this->getHistory()->getLinks());
50		}
51
52	2	public function renderObjects($method, $objects, $sparse = false)
53		{
54	2	$res = [];
55	2	foreach ($objects as $key => $value) {
56	2	$res[$key] = call_user_func([$this, $method], $value, $key);
57		}
58
59	2	return $this->renderText($res, $sparse);
60		}
61
62	2	public function renderSparse(array $lines)
63		{
64	2	$res = rtrim(implode("\n", $lines));
65
66	2	return $res ? $res . "\n" : '';
67		}
68
69	2	public function renderText(array $lines, $sparse = false)
70		{
71	2	if (!$sparse) {
72	2	foreach ($lines as &$line) {
73	2	$line = rtrim($line);
74		}
75	2	$lines = array_filter($lines);
76		}
77
78	2	return $this->renderSparse($lines);
79		}
80
81	2	public function renderLink($href, $link)
82		{
83	2	return "[$link]: $href";
84		}
85
86		public function renderHeader($header)
87		{
88		return $header;
89		}
90
91	2	public function renderTag(Tag $tag)
92		{
93	2	return $this->renderSparse([
94	2	$this->renderTagHead($tag),
95	2	$this->renderObjects('renderNote', $tag->getNotes()),
96		]);
97		}
98
99	2	public function renderTagHead(Tag $tag)
100		{
101	2	$res = '## [' . $tag->getName() . ']';
102	2	if ($tag->getDate()) {
		0 ignored issues – show Bug Best Practice introduced 2016-06-17 13:44 UTC by Report Bug Copy Issue Report The expression `$tag->getDate()` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
103	2	$res .= ' - ' . $tag->getDate();
104		}
105
106	2	return $res . "\n";
107		}
108
109	2	public function renderNote(Note $note)
110		{
111	2	return $this->renderText([
112	2	$this->renderNoteHead($note),
113	2	$this->renderObjects('renderCommit', $note->getCommits()),
114		]);
115		}
116
117	2	public function renderNoteHead(Note $note)
118		{
119	2	return $note->getNote() ? '- ' . $note->getNote() : '';
120		}
121
122	2	public function renderCommit(Commit $commit)
123		{
124	2	return $this->renderText([
125	2	$this->renderCommitHead($commit),
126	2	$this->renderText($commit->getComments()),
127		]);
128		}
129
130	2	public function renderCommitHead(Commit $commit)
131		{
132	2	return $this->indent . '- [' . $commit->getHash() . '] ' . $commit->getLabel();
133		}
134		}
135

hiqdev / chkipper

Push — master ( 1b355d...2cadce )

MarkdownRenderer::renderHeaders() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like