ReadmeController::renderSection() - Code Metrics - Inspection of "version bump to 0.3.3" - hiqdev/hidev-readme - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9cee9f...a7493f )

by Andrii

created 2016-04-14 07:44 UTC

ReadmeController::renderSection() A

↳ Parent: ReadmeController

Complexity

Conditions	3
Paths	4

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
ccs	0
cts	6
cp	0
rs	9.6666
cc	3
eloc	6
nc	4
nop	2
crap	12

<?php

/*
 * README plugin for HiDev
 *
 * @link      https://github.com/hiqdev/hidev-readme
 * @package   hidev-readme
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hidev\readme\controllers;

use hidev\helpers\Helper;
use Yii;

/**
 * Goal for README.
 */
class ReadmeController extends \hidev\controllers\TemplateController
{
    protected $_twig;

    public function getCharset()
    {
        return Yii::$app->charset ?: mb_internal_encoding();
    }

    public function renderH($title, $char)
    {
        $res = $title . "\n";
        $res .= str_repeat($char, mb_strlen($title, $this->getCharset()));

        return $res . "\n";
    }

    public function renderH1($title)
    {
        return $this->renderH($title, '=');
    }

    public function renderH2($title)
    {
        return $this->renderH($title, '-');
    }

    public function renderText($text)
    {
        $text = trim($text);

        return $text ? "\n$text\n" : '';
    }

    public function renderBold($text)
    {
        $text = trim($text);

        return $this->renderText('**' . $text . '**');
    }

    public function renderSection($section, $default = null)
    {
        $file = 'readme/' . str_replace(' ', '', $section);
        $path = Yii::getAlias("@prjdir/docs/$file.md");
        $text = file_exists($path) ? file_get_contents($path) : $this->getSection($file, $default);
        $text = trim($text);

        return $text ? "\n## $section\n\n$text\n" : '';
    }

    public function getSection($file, $default = null)
    {
        $view = Yii::$app->getView();
        $tpl = Helper::file2template($file);
        try {
            $res = $view->render($tpl, ['config' => $this->takeConfig()]);
        } catch (\Exception $e) {
            $res = '';
        }

        return $res ?: $default;
    }

    public function getSections()
    {
        return $this->sections ?: ['Requirements', 'Installation', 'Idea', 'Configuration', 'Basic Usage', 'Usage', 'Support', 'License', 'Acknowledgments'];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    public function renderSections($sections = null)
    {
        if ($sections === null) {
            $sections = $this->getSections();
        }
        $res = '';
        foreach ($sections as $section) {
            $res .= $this->renderSection($section);
        }

        return $res;
    }

    public function renderBadges()
    {
        $badges = $this->badges;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (!$badges) {
            return '';
        }
        $pm = $this->takeGoal('package')->getPackageManager();
        if (!$pm || !$pm->getConfiguration()->getRequire()) {
            unset($badges['versioneye.dependencies']);
        }
        $res = '';
        foreach ($badges as $badge => $tpl) {
            if (!$tpl) {
                $tpl = $this->markdownBadges[$badge];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }
            if ($tpl === 'disabled') {
                continue;
            }
            $res .= $this->renderBadge($tpl) . "\n";
        }

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

    public function renderBadge($tpl)
    {
        return $this->getTwig()->render($tpl, ['config' => $this->takeConfig()]);
    }

    public function getTwig()
    {
        if ($this->_twig === null) {
            $this->_twig = new \Twig_Environment(new \Twig_Loader_String());

        }

        return $this->_twig;
    }
}


1		<?php
2
3		/*
4		* README plugin for HiDev
5		*
6		* @link https://github.com/hiqdev/hidev-readme
7		* @package hidev-readme
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hidev\readme\controllers;
13
14		use hidev\helpers\Helper;
15		use Yii;
16
17		/**
18		* Goal for README.
19		*/
20		class ReadmeController extends \hidev\controllers\TemplateController
21		{
22		protected $_twig;
23
24	2	public function getCharset()
25		{
26	2	return Yii::$app->charset ?: mb_internal_encoding();
27		}
28
29	2	public function renderH($title, $char)
30		{
31	2	$res = $title . "\n";
32	2	$res .= str_repeat($char, mb_strlen($title, $this->getCharset()));
33
34	2	return $res . "\n";
35		}
36
37	1	public function renderH1($title)
38		{
39	1	return $this->renderH($title, '=');
40		}
41
42	1	public function renderH2($title)
43		{
44	1	return $this->renderH($title, '-');
45		}
46
47		public function renderText($text)
48		{
49		$text = trim($text);
50
51		return $text ? "\n$text\n" : '';
52		}
53
54		public function renderBold($text)
55		{
56		$text = trim($text);
57
58		return $this->renderText('' . $text . '');
59		}
60
61		public function renderSection($section, $default = null)
62		{
63		$file = 'readme/' . str_replace(' ', '', $section);
64		$path = Yii::getAlias("@prjdir/docs/$file.md");
65		$text = file_exists($path) ? file_get_contents($path) : $this->getSection($file, $default);
66		$text = trim($text);
67
68		return $text ? "\n## $section\n\n$text\n" : '';
69		}
70
71		public function getSection($file, $default = null)
72		{
73		$view = Yii::$app->getView();
74		$tpl = Helper::file2template($file);
75		try {
76		$res = $view->render($tpl, ['config' => $this->takeConfig()]);
77		} catch (\Exception $e) {
78		$res = '';
79		}
80
81		return $res ?: $default;
82		}
83
84		public function getSections()
85		{
86		return $this->sections ?: ['Requirements', 'Installation', 'Idea', 'Configuration', 'Basic Usage', 'Usage', 'Support', 'License', 'Acknowledgments'];
		0 ignored issues – show Documentation introduced 2016-01-14 15:20 UTC by Report Bug Copy Issue Report The property `sections` does not exist on `object<hidev\readme\controllers\ReadmeController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
87		}
88
89		public function renderSections($sections = null)
90		{
91		if ($sections === null) {
92		$sections = $this->getSections();
93		}
94		$res = '';
95		foreach ($sections as $section) {
96		$res .= $this->renderSection($section);
97		}
98
99		return $res;
100		}
101
102		public function renderBadges()
103		{
104		$badges = $this->badges;
		0 ignored issues – show Documentation introduced 2016-01-14 15:20 UTC by Report Bug Copy Issue Report The property `badges` does not exist on `object<hidev\readme\controllers\ReadmeController>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
105		if (!$badges) {
106		return '';
107		}
108		$pm = $this->takeGoal('package')->getPackageManager();
109		if (!$pm \|\| !$pm->getConfiguration()->getRequire()) {
110		unset($badges['versioneye.dependencies']);
111		}
112		$res = '';
113		foreach ($badges as $badge => $tpl) {
114		if (!$tpl) {
115		$tpl = $this->markdownBadges[$badge];
		0 ignored issues – show Documentation introduced 2016-01-14 15:20 UTC by Report Bug Copy Issue Report The property `markdownBadges` does not exist on `object<hidev\readme\controllers\ReadmeController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
116		}
117		if ($tpl === 'disabled') {
118		continue;
119		}
120		$res .= $this->renderBadge($tpl) . "\n";
121		}
122
123		return $res ? "\n$res" : '';
124		}
125
126		public function renderBadge($tpl)
127		{
128		return $this->getTwig()->render($tpl, ['config' => $this->takeConfig()]);
129		}
130
131		public function getTwig()
132		{
133		if ($this->_twig === null) {
134		$this->_twig = new \Twig_Environment(new \Twig_Loader_String());
		0 ignored issues – show Deprecated Code introduced 2016-01-14 15:20 UTC by Report Bug Copy Issue Report The class `Twig_Loader_String` has been deprecated with message: since 1.18.1 (to be removed in 2.0) This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
135		}
136
137		return $this->_twig;
138		}
139		}
140

hiqdev / hidev-readme

Push — master ( 9cee9f...a7493f )

ReadmeController::renderSection() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like