hidev\controllers\AbstractController

Complexity

Total Complexity

49

Size/Duplication

Total Lines	263
Duplicated Lines	9.89 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	takeGoal()	0	4	1
A	takeConfig()	0	4	1
A	takeVendor()	0	4	1
A	takePackage()	0	4	1
A	takeVcs()	0	4	1
A	options()	0	4	1
A	perform()	0	4	1
A	actionBefore()	0	4	1
A	actionMake()	0	4	1
A	actionAfter()	0	4	1
A	actionLoad()	0	4	1
A	actionSave()	0	4	1
A	setBefore()	0	4	1
A	getBefore()	0	4	1
A	setMake()	0	4	1
A	getMake()	0	4	1
A	setAfter()	0	4	1
A	getAfter()	0	4	1
B	normalizeTasks()	0	14	6
A	runRequests()	13	13	4
A	runRequest()	0	4	2
A	isNotOk()	0	4	2
A	isOk()	0	4	1
A	runActions()	13	13	4
A	runAction()	0	10	2
A	isDone()	0	10	2
A	markDone()	0	4	3
A	passthru()	0	4	1
A	exec()	0	4	1
A	execCode()	0	4	1
A	readline()	0	4	1
A	readpassword()	0	10	1

<?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\helpers\Helper;
use Yii;
use yii\console\Response;

/**
 * Abstract controller.
 */
abstract class AbstractController extends \hidev\base\Controller
{
    protected $_before = [];
    protected $_after  = [];
    protected $_make   = ['load', 'save'];

    /**
     * @var array list of performed actions
     */
    protected $_done = [];

    /**
     * {@inheritdoc}
     */
    public function options($actionId)
    {
        return array_merge(parent::options($actionId), array_keys(Helper::getPublicVars(get_called_class())));
    }

    public function perform($action = 'make')
    {
        return $this->runActions(['before', $action, 'after']);
    }

    public function actionBefore()
    {
        return $this->runRequests($this->getBefore());
    }

    /**
     * @return int|Response exit code
     */
    public function actionMake()
    {
        return $this->runActions($this->getMake());
    }

    public function actionAfter()
    {
        return $this->runRequests($this->getAfter());
    }

    public function actionLoad()
    {
        Yii::trace("Loading nothing for '$this->id'");
    }

    public function actionSave()
    {
        Yii::trace("Saving nothing for '$this->id'");
    }

    public function setBefore($requests)
    {
        $this->_before = array_merge($this->getBefore(), $this->normalizeTasks($requests));
    }

    public function getBefore()
    {
        return $this->_before;
    }

    public function setMake($requests)
    {
        $this->_make = array_merge($this->getMake(), $this->normalizeTasks($requests));
    }

    public function getMake()
    {
        return $this->_make;
    }

    public function setAfter($requests)
    {
        $this->_after = array_merge($this->getAfter(), $this->normalizeTasks($requests));
    }

    public function getAfter()
    {
        return $this->_after;
    }

    public function normalizeTasks($tasks)
    {
        if (!$tasks) {
            return [];
        } elseif (!is_array($tasks)) {
            $tasks = [(string) $tasks => 1];
        }
        $res = [];
        foreach ($tasks as $dep => $enabled) {
            $res[(string) (is_int($dep) ? $enabled : $dep)] = (bool) (is_int($dep) ? 1 : $enabled);
        }

        return $res;
    }

    /**
     * Runs array of requests. Stops on failure and returns exit code.
     * @param null|string|array $requests
     * @return int|Response exit code
     */
    public function runRequests($requests)

This method seems to be duplicated in your project.

    {
        foreach ($this->normalizeTasks($requests) as $request => $enabled) {
            if ($enabled) {
                $res = $this->runRequest($request);
                if (static::isNotOk($res)) {
                    return $res;
                }
            }
        }

        return 0;
    }

    public function runRequest($request)
    {
        return $request === null ? null : $this->module->runRequest($request);
    }

    /**
     * Is response NOT Ok.
     * @param Response|int $res
     * @return bool
     */
    public static function isNotOk($res)
    {
        return is_object($res) ? $res->exitStatus : $res;
    }

    /**
     * Is response Ok.
     * @param Response|int $res
     * @return bool
     */
    public static function isOk($res)
    {
        return !static::isNotOk($res);
    }

    /**
     * Runs list of actions.
     * TODO: think to redo with runRequests.
     * @param null|string|array $actions
     * @return int|Response exit code
     */
    public function runActions($actions)

This method seems to be duplicated in your project.

    {
        foreach ($this->normalizeTasks($actions) as $action => $enabled) {
            if ($enabled) {
                $res = $this->runAction($action);
                if (static::isNotOk($res)) {
                    return $res;
                }
            }
        }

        return 0;
    }

    public function runAction($id, $params = [])
    {
        if ($this->isDone($id)) {
            return;
        }
        $result = parent::runAction($id, $params);
        $this->markDone($id);

        return $result;
    }

    public function isDone($action, $timestamp = null)

The parameter $timestamp is not used and could be removed.

    {
        if (isset($this->_done[$action])) {
            Yii::trace("Already done: '$this->id/$action'");

            return true;
        }

        return false;
    }

    /**
     * Mark action as already done.
     *
     * @param string $action action id
     * @param int $time microtime when action was done, false for action was not done
     */
    public function markDone($action, $time = null)
    {
        $this->_done[$action] = ($time === null || $time === true) ? microtime(1) : $time;
    }

    /**
     * Runs given binary with given arguments. Returns exit code.
     * @param string $name
     * @param array|string $args
     * @return int exit code
     */
    public function passthru($name, $args = [])
    {
        return $this->takeGoal('binaries')->passthruBinary($name, $args);
    }

    /**
     * Runs given binary with given arguments. Returns stdout array.
     * @param string $name
     * @param string $args
     * @param bool $returnExitCode, default false

There is no parameter named $returnExitCode,. Did you maybe mean $returnExitCode?

     * @return array|int stdout or exitcode
     */
    public function exec($name, $args = '', $returnExitCode = false)
    {
        return $this->takeGoal('binaries')->execBinary($name, $args, $returnExitCode);
    }

    public function execCode($name, $args = '')
    {
        return $this->takeGoal('binaries')->execBinary($name, $args, true);
    }

    public function readline($prompt)
    {
        return readline($prompt);
    }

    public function readpassword($prompt)
    {
        echo $prompt;
        system('stty -echo');
        $password = rtrim(fgets(STDIN), PHP_EOL);
        system('stty echo');
        echo "\n";

        return $password;
    }

    public function takeGoal($id)
    {
        return $this->module->get('config')->getGoal($id);
    }

    public function takeConfig()
    {
        return $this->module->get('config');
    }

    public function takeVendor()
    {
        return $this->takeGoal('vendor');
    }

    public function takePackage()
    {
        return $this->takeGoal('package');
    }

    public function takeVcs()
    {
        return $this->takeConfig()->getVcs();
    }
}