hidev\readme\components\Readme

Complexity

Total Complexity

35

Size/Duplication

Total Lines	182
Duplicated Lines	0 %

Test Coverage

Coverage

8.82%

Importance

Changes	3
Bugs	1	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	save()	0	4	3
A	renderText()	0	5	2
A	setSections()	0	3	1
A	renderH1()	0	3	1
A	renderBadges()	0	19	6
A	renderBold()	0	5	1
A	getTwig()	0	7	2
A	renderSections()	0	11	3
A	getTemplate()	0	3	1
A	getSections()	0	7	2
A	getCharset()	0	3	3
A	getSection()	0	10	3
A	renderH2()	0	3	1
A	renderH3()	0	3	1
A	renderH()	0	3	1
A	renderSection()	0	8	3
A	renderBadge()	0	5	1

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

namespace hidev\readme\components;

use hidev\helpers\FileHelper;
use hidev\helpers\Helper;
use Yii;

/**
 * README generation component.
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class Readme extends \hidev\base\Component
{
    /**
     * @var \Twig\Environment
     */
    protected $_twig;

    /**
     * @var array list of sections to render
     */
    protected $_sections;

    public $knownBadges = [];

    public $badges;

    public $forceRewrite = false;

    public function save($path, $type)
    {
        if ($this->forceRewrite || !file_exists($path)) {
            FileHelper::write($path, $this->render($this->getTemplate($type)));
        }
    }

    public function getTemplate($type)
    {
        return 'readme-' . $type;
    }

    /**
     * Get charset.
     * @return string
     */
    public function getCharset()
    {
        return (isset(Yii::$app->charset) ? Yii::$app->charset : null) ?: mb_internal_encoding();

The expression return IssetNode ? Yii::app->charset : null ?: mb_internal_encoding() also could return the type boolean which is incompatible with the documented return type string.

    }

    public function renderH($title, $prefix)
    {
        return $prefix . ' ' . $title . "\n";
    }

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

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

    public function renderH3($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("@root/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)
    {
        $tpl = '@hidev/views/' . Helper::file2template($file);
        try {
            $res = $this->render($tpl);
        } catch (\Exception $e) {
            $res = '';
        }

        return $res ?: $default;
    }

    /**
     * Set sections list.
     * @param array $value
     */
    public function setSections($value)
    {
        $this->_sections = (array) $value;
    }

    /**
     * Returns sections list. Returns default list if not set.
     * @return array
     */
    public function getSections()
    {
        if (empty($this->_sections)) {
            $this->_sections = ['Requirements', 'Installation', 'Idea', 'Configuration', 'Basic Usage', 'Usage', 'Support', 'Disclaimer', 'License', 'Acknowledgements', 'Acknowledgments'];
        }

        return array_unique($this->_sections);
    }

    /**
     * Render all configured sections.
     * @return string
     */
    public function renderSections($sections = null)
    {
        if ($sections === null) {
            $sections = $this->getSections();
        }
        $res = '';
        foreach ($sections as $section) {
            $res .= $this->renderSection($section);
        }

        return $res;
    }

    /**
     * Render all configured badges.
     * @return string
     */
    public function renderBadges()
    {
        $badges = $this->badges;
        if (!$badges) {
            return '';
        }
        $pm = $this->take('package')->getPackageManager();

The assignment to $pm is dead and can be removed.

        $res = '';
        foreach ($badges as $badge => $tpl) {
            if (!$tpl) {
                $tpl = $this->knownBadges[$badge];
            }
            if ($tpl === 'disabled') {
                continue;
            }
            $res .= $this->renderBadge($tpl) . "\n";
        }

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

    /**
     * Render badge by given template.
     * @param string $template string to render
     * @return string
     */
    public function renderBadge($template)
    {
        $tpl = $this->getTwig()->createTemplate($template);

        return $tpl->render(['app' => Yii::$app]);
    }

    /**
     * Twig getter.
     * @return \Twig\Environment
     */
    public function getTwig()
    {
        if ($this->_twig === null) {
            $this->_twig = new \Twig\Environment(new \Twig\Loader\ArrayLoader());
        }

        return $this->_twig;
    }
}