Config::setChangelog() - Code Metrics - Inspection of "version bump to 0.2.0" - hiqdev/chkipper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5bb4f6...c375b5 )

by Andrii

created 2017-02-19 12:44 UTC

Config::setChangelog() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

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

namespace hiqdev\chkipper\components;

use hiqdev\chkipper\lib\ConfigInterface;
use Yii;
use yii\base\BootstrapInterface;
use yii\base\Component;
use yii\helpers\ArrayHelper;
use yii\helpers\Json;

/**
 * Config class.
 * Loads and holds configuration.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class Config extends Component implements BootstrapInterface, ConfigInterface
{
    protected $_name;

    protected $_authors = [];

    public $configFile = 'chkipper.json';

    public $historyFile = 'history.md';

    protected $_changelog = [
        'file'   => 'CHANGELOG',
        'format' => 'markdown',
    ];

    protected $_history = [
        'file'   => 'history',
        'format' => 'markdown',
    ];

    public function bootstrap($app)
    {
        if (is_file($this->configFile)) {
            $json = file_get_contents($this->configFile);
            $data = Json::decode($json);
            Yii::configure($this, $data);
        }
    }

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

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

    public function setChangelog(array $options)
    {
        $this->_changelog = array_merge($this->_changelog, $options);
    }

    public function getChangelog($key = null)
    {
        if ($key === null) {
            return $this->_changelog;
        }

        return isset($this->_changelog[$key]) ? $this->_changelog[$key] : null;
    }

    public function getDest($dest = null, $key = null)
    {
        if ($dest === 'changelog') {
            return $this->getChangelog($key);
        }
        if ($dest === 'history') {
            return $this->getHistory($key);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }
    }

    public function setAuthors(array $authors)
    {
        $this->_authors = $authors;
    }

    public function getAuthors()
    {
        return $this->_authors;
    }


    protected $_options = [
        'markdown' => [
            'extension' => 'md',
            'changelog' => [
                'rendererClass' => \hiqdev\chkipper\lib\changelog\MarkdownRenderer::class,
                'parserClass' => \hiqdev\chkipper\lib\changelog\MarkdownParser::class,
            ],
        ],
        'keepachangelog' => [
            'extension' => 'md',
            'changelog' => [
                'rendererClass' => \hiqdev\chkipper\lib\changelog\KeepAChangelogRenderer::class,
            ],
        ],
    ];

    public function setOptions(array $options)
    {
        $this->_options = ArrayHelper::merge($this->_options, $options);
    }

    public function getOptions()
    {
        return $this->_options;
    }

    public function getOption($key, $dest = null, $format = null)
    {
        if ($format === null) {
            $format = strtolower($this->getDest($dest, 'format'));
        }
        if (empty($this->_options[$format])) {
            throw new InvalidConfigException("wrong format '$format' for '$dest'");
        }
        $options = $this->_options[$format];

        if (isset($options[$dest][$key])) {
            return $options[$dest][$key];
        }
        if (!isset($options[$key])) {
            throw new InvalidConfigException("wrong option '$key' for '$dest'");
        }

        return $options[$key];
    }

    public function createChangelogRenderer()
    {
        $class = $this->getOption('rendererClass', 'changelog');

        return Yii::createObject($class);
    }

    public function getChangelogFile()
    {
        $file = $this->getChangelog('file');
        $extension = $this->getOption('extension', 'changelog');
        if ($extension) {
            $file .= '.' . $extension;
        }

        return $file;
    }
}


1			<?php
2			/**
3			* Changelog keeper
4			*
5			* @link https://github.com/hiqdev/chkipper
6			* @package chkipper
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hiqdev\chkipper\components;
12
13			use hiqdev\chkipper\lib\ConfigInterface;
14			use Yii;
15			use yii\base\BootstrapInterface;
16			use yii\base\Component;
17			use yii\helpers\ArrayHelper;
18			use yii\helpers\Json;
19
20			/**
21			* Config class.
22			* Loads and holds configuration.
23			*
24			* @author Andrii Vasyliev <[email protected]>
25			*/
26			class Config extends Component implements BootstrapInterface, ConfigInterface
27			{
28			protected $_name;
29
30			protected $_authors = [];
31
32			public $configFile = 'chkipper.json';
33
34			public $historyFile = 'history.md';
35
36			protected $_changelog = [
37			'file' => 'CHANGELOG',
38			'format' => 'markdown',
39			];
40
41			protected $_history = [
42			'file' => 'history',
43			'format' => 'markdown',
44			];
45
46			public function bootstrap($app)
47			{
48			if (is_file($this->configFile)) {
49			$json = file_get_contents($this->configFile);
50			$data = Json::decode($json);
51			Yii::configure($this, $data);
52			}
53			}
54
55			public function setName($name)
56			{
57			$this->_name = $name;
58			}
59
60			public function getName()
61			{
62			return $this->_name;
63			}
64
65			public function setChangelog(array $options)
66			{
67			$this->_changelog = array_merge($this->_changelog, $options);
68			}
69
70			public function getChangelog($key = null)
71			{
72			if ($key === null) {
73			return $this->_changelog;
74			}
75
76			return isset($this->_changelog[$key]) ? $this->_changelog[$key] : null;
77			}
78
79			public function getDest($dest = null, $key = null)
80			{
81			if ($dest === 'changelog') {
82			return $this->getChangelog($key);
83			}
84			if ($dest === 'history') {
85			return $this->getHistory($key);
			0 ignored issues – show Documentation Bug introduced 2017-02-19 12:47 UTC by Report Bug Copy Issue Report The method `getHistory` does not exist on `object<hiqdev\chkipper\components\Config>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
86			}
87			}
88
89			public function setAuthors(array $authors)
90			{
91			$this->_authors = $authors;
92			}
93
94			public function getAuthors()
95			{
96			return $this->_authors;
97			}
98
99
100			protected $_options = [
101			'markdown' => [
102			'extension' => 'md',
103			'changelog' => [
104			'rendererClass' => \hiqdev\chkipper\lib\changelog\MarkdownRenderer::class,
105			'parserClass' => \hiqdev\chkipper\lib\changelog\MarkdownParser::class,
106			],
107			],
108			'keepachangelog' => [
109			'extension' => 'md',
110			'changelog' => [
111			'rendererClass' => \hiqdev\chkipper\lib\changelog\KeepAChangelogRenderer::class,
112			],
113			],
114			];
115
116			public function setOptions(array $options)
117			{
118			$this->_options = ArrayHelper::merge($this->_options, $options);
119			}
120
121			public function getOptions()
122			{
123			return $this->_options;
124			}
125
126			public function getOption($key, $dest = null, $format = null)
127			{
128			if ($format === null) {
129			$format = strtolower($this->getDest($dest, 'format'));
130			}
131			if (empty($this->_options[$format])) {
132			throw new InvalidConfigException("wrong format '$format' for '$dest'");
133			}
134			$options = $this->_options[$format];
135
136			if (isset($options[$dest][$key])) {
137			return $options[$dest][$key];
138			}
139			if (!isset($options[$key])) {
140			throw new InvalidConfigException("wrong option '$key' for '$dest'");
141			}
142
143			return $options[$key];
144			}
145
146			public function createChangelogRenderer()
147			{
148			$class = $this->getOption('rendererClass', 'changelog');
149
150			return Yii::createObject($class);
151			}
152
153			public function getChangelogFile()
154			{
155			$file = $this->getChangelog('file');
156			$extension = $this->getOption('extension', 'changelog');
157			if ($extension) {
158			$file .= '.' . $extension;
159			}
160
161			return $file;
162			}
163			}
164

hiqdev / chkipper

Push — master ( 5bb4f6...c375b5 )

Config::setChangelog() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like