StartController::includeMainConfig() - Code Metrics - Inspection of "updated travis config: build + 7.1, - 5.5" - hiqdev/hidev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 897567...887f9d )

by Andrii

created 2017-03-30 11:12 UTC

StartController::includeMainConfig() A

↳ Parent: StartController

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	4
cts	5
cp	0.8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0
crap	2.032

<?php
/**
 * Automation tool mixed with code generator for easier continuous development.
 *
 * @link      https://github.com/hiqdev/hidev
 * @package   hidev
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hidev\controllers;

use hidev\base\File;
use Yii;
use yii\base\InvalidParamException;
use yii\helpers\ArrayHelper;

/**
 * Start goal.
 * Chdirs to the project's root directory and loads dependencies and configs.
 */
class StartController extends CommonController
{
    /**
     * @var string absolute path to the project root directory
     */
    protected $_rootDir;

    /**
     * @var bool hidev already started flag
     */
    public static $started = false;

    /**
     * Make action.
     */
    public function actionMake()
    {
        self::$started = true;
        $this->getRootDir();
        $this->includeMainConfig();
        $this->addAliases();
        $this->addAutoloader();
        $this->requireAll();
        $this->includeAll();
        $this->loadConfig();
        $this->includeMainConfig();
    }

    public function includeMainConfig()
    {
        $this->takeConfig()->includeConfig('.hidev/config.yml');
        if (file_exists('.hidev/config-local.yml')) {
            $this->takeConfig()->includeConfig('.hidev/config-local.yml');
        }
    }

    public function addAutoloader()
    {
        $autoloader = Yii::getAlias('@root/vendor/autoload.php');
        if (file_exists($autoloader)) {
            spl_autoload_unregister(['Yii', 'autoload']);
            require $autoloader;
            spl_autoload_register(['Yii', 'autoload'], true, true);
        }
    }

    /**
     * Update action.
     * @return int exit code
     */
    public function actionUpdate()
    {
        if (file_exists('.hidev/composer.json')) {
            return $this->passthru('composer', ['update', '-d', '.hidev', '--prefer-source', '--ansi']);
        }
    }

    /**
     * Adds aliases:
     * - @root alias to current project root dir
     * - current package namespace for it could be used from hidev.
     */
    public function addAliases()
    {
        Yii::setAlias('@root', $this->getRootDir());
        $config = $this->takeConfig()->rawItem('package');
        $alias  = isset($config['namespace']) ? strtr($config['namespace'], '\\', '/') : '';
        if ($alias && !Yii::getAlias('@' . $alias, false)) {
            $srcdir = Yii::getAlias('@root/' . ($config['src'] ?: 'src'));
            Yii::setAlias($alias, $srcdir);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }
        $aliases = $this->takeConfig()->rawItem('aliases');
        if (!empty($aliases) && is_array($aliases)) {
            foreach ($aliases as $alias => $path) {
                if (!$this->hasAlias($alias)) {
                    Yii::setAlias($alias, $path);
                }
            }
        }
    }

    public function hasAlias($alias, $exact = true)

    {
        $pos = strpos($alias, '/');

        return $pos === false ? isset(Yii::$aliases[$alias]) : isset(Yii::$aliases[substr($alias, 0, $pos)][$alias]);
    }

    /**
     * Require all configured requires.
     */
    protected function requireAll()
    {
        $plugins = $this->takeConfig()->rawItem('plugins');
        $vendors = [];
        if ($plugins) {
            $file = File::create('.hidev/composer.json');
            $data = ArrayHelper::merge($file->load(), ['require' => $plugins]);
            if ($file->save($data) || !is_dir('.hidev/vendor')) {
                $this->runAction('update');
            }
            $vendors[] = '.hidev/vendor';
        } elseif ($this->needsComposerInstall()) {
            if ($this->passthru('composer', ['install', '--ansi'])) {
                throw new InvalidParamException('Failed initialize project with composer install');
            }
        }
        if (file_exists('vendor/hiqdev/composer-config-plugin-output/hidev.php')) {
            $vendors[] = 'vendor';
        }
        if (!empty($vendors)) {
            foreach (array_unique($vendors) as $dir) {
                $this->module->loadExtraVendor($dir);
            }
        }
    }

    public function needsComposerInstall()
    {
        if (file_exists('vendor')) {
            return false;
        }
        if (!file_exists('composer.json')) {
            return false;
        }
        $data = File::create('composer.json')->load();
        foreach (['require', 'require-dev'] as $key) {
            if (isset($data[$key])) {
                foreach ($data[$key] as $package => $version) {
                    list(, $name) = explode('/', $package);
                    if (strncmp($name, 'hidev-', 6) === 0) {
                        return true;
                    }
                }
            }
        }

        return false;
    }

    /**
     * Include all configs.
     */
    public function includeAll()
    {
        $still = true;
        while ($still) {
            $still = false;
            $include = $this->takeConfig()->rawItem('include');
            if ($include) {
                foreach ($include as $path) {
                    $still = $still || $this->takeConfig()->includeConfig($path);
                }
            }
        }
    }

    /**
     * Load project's config if configured.
     */
    public function loadConfig()
    {
        $path = $this->takeConfig()->rawItem('config');
        if ($path) {
            $this->module->loadExtraConfig($path);
        }
    }

    public function setRootDir($value)
    {
        $this->_rootDir = $value;
    }

    public function getRootDir()
    {
        if ($this->_rootDir === null) {
            $this->_rootDir = $this->findRootDir();
        }

        return $this->_rootDir;
    }

    /**
     * Chdirs to project's root by looking for config file in the current directory and up.
     * @throws InvalidParamException when failed to find
     * @return string path to the root directory of hidev project
     */
    protected function findRootDir()
    {
        $configDir = '.hidev';
        for ($i = 0; $i < 9; ++$i) {
            if (is_dir($configDir)) {
                return getcwd();
            }
            chdir('..');
        }
        throw new InvalidParamException("Not a hidev project (or any of the parent directories).\nUse `hidev init` to initialize hidev project.");
    }

    public function buildRootPath($subpath)
    {
        return $this->getRootDir() . DIRECTORY_SEPARATOR . $subpath;
    }
}


1		<?php
2		/**
3		* Automation tool mixed with code generator for easier continuous development.
4		*
5		* @link https://github.com/hiqdev/hidev
6		* @package hidev
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hidev\controllers;
12
13		use hidev\base\File;
14		use Yii;
15		use yii\base\InvalidParamException;
16		use yii\helpers\ArrayHelper;
17
18		/**
19		* Start goal.
20		* Chdirs to the project's root directory and loads dependencies and configs.
21		*/
22		class StartController extends CommonController
23		{
24		/**
25		* @var string absolute path to the project root directory
26		*/
27		protected $_rootDir;
28
29		/**
30		* @var bool hidev already started flag
31		*/
32		public static $started = false;
33
34		/**
35		* Make action.
36		*/
37	2	public function actionMake()
38		{
39	2	self::$started = true;
40	2	$this->getRootDir();
41	2	$this->includeMainConfig();
42	2	$this->addAliases();
43	2	$this->addAutoloader();
44	2	$this->requireAll();
45	2	$this->includeAll();
46	2	$this->loadConfig();
47	2	$this->includeMainConfig();
48	2	}
49
50	2	public function includeMainConfig()
51		{
52	2	$this->takeConfig()->includeConfig('.hidev/config.yml');
53	2	if (file_exists('.hidev/config-local.yml')) {
54		$this->takeConfig()->includeConfig('.hidev/config-local.yml');
55		}
56	2	}
57
58	2	public function addAutoloader()
59		{
60	2	$autoloader = Yii::getAlias('@root/vendor/autoload.php');
61	2	if (file_exists($autoloader)) {
62		spl_autoload_unregister(['Yii', 'autoload']);
63		require $autoloader;
64		spl_autoload_register(['Yii', 'autoload'], true, true);
65		}
66	2	}
67
68		/**
69		* Update action.
70		* @return int exit code
71		*/
72		public function actionUpdate()
73		{
74		if (file_exists('.hidev/composer.json')) {
75		return $this->passthru('composer', ['update', '-d', '.hidev', '--prefer-source', '--ansi']);
76		}
77		}
78
79		/**
80		* Adds aliases:
81		* - @root alias to current project root dir
82		* - current package namespace for it could be used from hidev.
83		*/
84	2	public function addAliases()
85		{
86	2	Yii::setAlias('@root', $this->getRootDir());
87	2	$config = $this->takeConfig()->rawItem('package');
88	2	$alias = isset($config['namespace']) ? strtr($config['namespace'], '\\', '/') : '';
89	2	if ($alias && !Yii::getAlias('@' . $alias, false)) {
90		$srcdir = Yii::getAlias('@root/' . ($config['src'] ?: 'src'));
91		Yii::setAlias($alias, $srcdir);
		0 ignored issues – show Bug introduced 2016-05-06 07:50 UTC by Report Bug Copy Issue Report It seems like `$srcdir` defined by `\Yii::getAlias('@root/' ...onfig['src'] ?: 'src'))` on line `90` can also be of type `boolean`; however, `yii\BaseYii::setAlias()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
92		}
93	2	$aliases = $this->takeConfig()->rawItem('aliases');
94	2	if (!empty($aliases) && is_array($aliases)) {
95	2	foreach ($aliases as $alias => $path) {
96	2	if (!$this->hasAlias($alias)) {
97		Yii::setAlias($alias, $path);
98		}
99		}
100		}
101	2	}
102
103	2	public function hasAlias($alias, $exact = true)
		0 ignored issues – show Unused Code introduced 2016-05-16 15:35 UTC by Report Bug Copy Issue Report The parameter `$exact` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
104		{
105	2	$pos = strpos($alias, '/');
106
107	2	return $pos === false ? isset(Yii::$aliases[$alias]) : isset(Yii::$aliases[substr($alias, 0, $pos)][$alias]);
108		}
109
110		/**
111		* Require all configured requires.
112		*/
113	2	protected function requireAll()
114		{
115	2	$plugins = $this->takeConfig()->rawItem('plugins');
116	2	$vendors = [];
117	2	if ($plugins) {
118		$file = File::create('.hidev/composer.json');
119		$data = ArrayHelper::merge($file->load(), ['require' => $plugins]);
120		if ($file->save($data) \|\| !is_dir('.hidev/vendor')) {
121		$this->runAction('update');
122		}
123		$vendors[] = '.hidev/vendor';
124	2	} elseif ($this->needsComposerInstall()) {
125		if ($this->passthru('composer', ['install', '--ansi'])) {
126		throw new InvalidParamException('Failed initialize project with composer install');
127		}
128		}
129	2	if (file_exists('vendor/hiqdev/composer-config-plugin-output/hidev.php')) {
130		$vendors[] = 'vendor';
131		}
132	2	if (!empty($vendors)) {
133		foreach (array_unique($vendors) as $dir) {
134		$this->module->loadExtraVendor($dir);
135		}
136		}
137	2	}
138
139	2	public function needsComposerInstall()
140		{
141	2	if (file_exists('vendor')) {
142		return false;
143		}
144	2	if (!file_exists('composer.json')) {
145	2	return false;
146		}
147		$data = File::create('composer.json')->load();
148		foreach (['require', 'require-dev'] as $key) {
149		if (isset($data[$key])) {
150		foreach ($data[$key] as $package => $version) {
151		list(, $name) = explode('/', $package);
152		if (strncmp($name, 'hidev-', 6) === 0) {
153		return true;
154		}
155		}
156		}
157		}
158
159		return false;
160		}
161
162		/**
163		* Include all configs.
164		*/
165	2	public function includeAll()
166		{
167	2	$still = true;
168	2	while ($still) {
169	2	$still = false;
170	2	$include = $this->takeConfig()->rawItem('include');
171	2	if ($include) {
172		foreach ($include as $path) {
173		$still = $still \|\| $this->takeConfig()->includeConfig($path);
174		}
175		}
176		}
177	2	}
178
179		/**
180		* Load project's config if configured.
181		*/
182	2	public function loadConfig()
183		{
184	2	$path = $this->takeConfig()->rawItem('config');
185	2	if ($path) {
186	2	$this->module->loadExtraConfig($path);
187		}
188	2	}
189
190		public function setRootDir($value)
191		{
192		$this->_rootDir = $value;
193		}
194
195	2	public function getRootDir()
196		{
197	2	if ($this->_rootDir === null) {
198	2	$this->_rootDir = $this->findRootDir();
199		}
200
201	2	return $this->_rootDir;
202		}
203
204		/**
205		* Chdirs to project's root by looking for config file in the current directory and up.
206		* @throws InvalidParamException when failed to find
207		* @return string path to the root directory of hidev project
208		*/
209	2	protected function findRootDir()
210		{
211	2	$configDir = '.hidev';
212	2	for ($i = 0; $i < 9; ++$i) {
213	2	if (is_dir($configDir)) {
214	2	return getcwd();
215		}
216		chdir('..');
217		}
218		throw new InvalidParamException("Not a hidev project (or any of the parent directories).\nUse `hidev init` to initialize hidev project.");
219		}
220
221		public function buildRootPath($subpath)
222		{
223		return $this->getRootDir() . DIRECTORY_SEPARATOR . $subpath;
224		}
225		}
226

hiqdev / hidev

Push — master ( 897567...887f9d )

StartController::includeMainConfig() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like