hidev\goals\DefaultGoal

Complexity

Total Complexity

40

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	6
Bugs	0	Features	1

23 Methods

Rating	Name	Duplication	Size	Complexity
A	getFileType()	0	4	1
A	setFileType()	0	4	1
A	setDeps()	0	8	3
A	getDeps()	0	4	1
A	actionDeps()	0	13	4
A	runRequest()	0	4	2
B	runRequests()	0	16	5
A	isDone()	0	10	2
A	markDone()	0	4	3
A	actionPerform()	0	5	1
A	actionLoad()	0	4	1
A	actionSave()	0	4	1
A	actionMake()	0	4	1
A	runAction()	0	10	2
A	runActions()	0	11	3
A	isNotOk()	0	4	2
A	options()	0	4	1
A	passthru()	0	4	1
A	getRobo()	0	4	1
A	getConfig()	0	4	1
A	getPackage()	0	4	1
A	getVendor()	0	4	1
A	getVcs()	0	5	1

<?php

/*
 * Task runner, code generator and build tool for easier continuos integration
 *
 * @link      https://github.com/hiqdev/hidev
 * @package   hidev
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2016, HiQDev (http://hiqdev.com/)
 */

namespace hidev\goals;

use hidev\helpers\Helper;
use Yii;

/**
 * Default Goal.
 */
class DefaultGoal extends BaseGoal
{
    public $goalName;

    public $done = [];

    protected $_fileType = null;

    public function getFileType()
    {
        return $this->_fileType;
    }

    public function setFileType($type)
    {
        $this->_fileType = $type;
    }

    public function setDeps($deps)
    {
        $res = $this->getDeps();
        foreach (Helper::ksplit($deps) as $d => $e) {
            $res[is_int($d) ? $e : $d] = $e;
        }
        $this->setItem('deps', $res);
    }

    public function getDeps()
    {
        return Helper::ksplit($this->rawItem('deps'));
    }

    public function actionDeps()
    {
        foreach ($this->getDeps() as $name => $enabled) {
            if ($enabled) {
                $res = $this->module->runRequest($name);
                if (static::isNotOk($res)) {
                    return $res;
                }
            }
        }

        return 0;
    }

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

    /**
     * Runs array of requests. Stops on failure and returns exit code.
     * @param null|string|array $requests
     */
    public function runRequests($requests)
    {
        if (is_string($requests)) {
            $requests = [$requests];
        } elseif (!is_array($requests)) {
            return 0;
        }
        foreach ($requests as $request) {
            $res = $this->runRequest($request);
            if (static::isNotOk($res)) {
                return $res;
            }
        }

        return 0;
    }

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

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

    {
        if ($this->done[$action]) {
            Yii::trace("Already done: $this->goalName/$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;
    }

    public function actionPerform($name = null, $path = null)
    {
        Yii::trace("Started: $this->goalName");
        return $this->runActions('deps, make');
    }

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

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

    public function actionMake()
    {
        return $this->runActions('load, save');
    }

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

        return $result;
    }

    public function runActions($actions)
    {
        foreach (Helper::ksplit($actions) as $action) {
            $res = $this->runAction($action);
            if (static::isNotOk($res)) {
                return $res;
            }
        }

        return 0;
    }

    public static function isNotOk($res)
    {
        return is_object($res) ? $res->exitStatus : $res;
    }

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

    /**
     * Runs given binary with given arguments.
     * @param string $name
     * @param string $args
     * @return int exit code
     */
    public function passthru($name, $args = '')
    {
        return Yii::$app->get('binaries')->passthru($name, $args);
    }

    public function getRobo()
    {
        return Yii::$app->get('robo');
    }

    public function getConfig()
    {
        return Yii::$app->get('config');
    }

    public function getPackage()
    {
        return $this->getConfig()->get('package');
    }

    public function getVendor()
    {
        return $this->getConfig()->get('vendor');
    }

    public function getVcs()
    {
        /// TODO determine VCS
        return $this->getConfig()->get('git');
    }
}