TaskRunnerFactory::getTasksConfig() - Code Metrics - webcreate/conveyor - Measure and Improve Code Quality continuously with Scrutinizer

TaskRunnerFactory::getTasksConfig() A
last analyzed 2016-12-08 12:42 UTC

↳ Parent: TaskRunnerFactory

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	0
cts	12
cp	0
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	3
nop	2
crap	12

<?php

/*
 * This file is part of the Conveyor package.
 *
 * (c) Jeroen Fiege <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webcreate\Conveyor\Factory;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Webcreate\Conveyor\Config\YamlConfig;
use Webcreate\Conveyor\IO\IOInterface;
use Webcreate\Conveyor\Task\TaskRunner;

class TaskRunnerFactory
{
    /**
     * @param  string                   $taskConfigPath path to the tasks configuration in the conveyor.yml config
     * @param  TaskFactory              $taskFactory
     * @param  YamlConfig               $config
     * @param  IOInterface              $io
     * @param  EventDispatcherInterface $dispatcher
     * @return TaskRunner
     */
    public static function get($taskConfigPath, TaskFactory $taskFactory, YamlConfig $config, IOInterface $io, EventDispatcherInterface $dispatcher = null)

    {
        $_config = $config->getConfig();

        $taskRunner = new TaskRunner($io, $dispatcher);

        foreach ((array) self::getTasksConfig($_config, $taskConfigPath) as $t => $taskConfig) {
            $task = $taskFactory->get($taskConfig['type'], $taskConfig);
            $taskRunner->addTask($task);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        return $taskRunner;
    }

    /**
     * @param  array  $config
     * @param  string $taskConfigPath
     * @return array
     */
    protected static function getTasksConfig(array $config, $taskConfigPath)
    {
        $path = explode('.', $taskConfigPath);

        $currentConfig = $config;

        foreach ($path as $p => $_path) {
            if (!isset($currentConfig[$_path])) {
                return array();
            }

            $currentConfig = $currentConfig[$_path];
        }

        return $currentConfig;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Conveyor package.
5			*
6			* (c) Jeroen Fiege <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Webcreate\Conveyor\Factory;
13
14			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
15			use Webcreate\Conveyor\Config\YamlConfig;
16			use Webcreate\Conveyor\IO\IOInterface;
17			use Webcreate\Conveyor\Task\TaskRunner;
18
19			class TaskRunnerFactory
20			{
21			/**
22			* @param string $taskConfigPath path to the tasks configuration in the conveyor.yml config
23			* @param TaskFactory $taskFactory
24			* @param YamlConfig $config
25			* @param IOInterface $io
26			* @param EventDispatcherInterface $dispatcher
27			* @return TaskRunner
28			*/
29			public static function get($taskConfigPath, TaskFactory $taskFactory, YamlConfig $config, IOInterface $io, EventDispatcherInterface $dispatcher = null)
			0 ignored issues – show Comprehensibility introduced 2016-02-05 09:59 UTC by Report Bug Copy Issue Report Avoid variables with short names like $io. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
30			{
31			$_config = $config->getConfig();
32
33			$taskRunner = new TaskRunner($io, $dispatcher);
34
35			foreach ((array) self::getTasksConfig($_config, $taskConfigPath) as $t => $taskConfig) {
36			$task = $taskFactory->get($taskConfig['type'], $taskConfig);
37			$taskRunner->addTask($task);
			0 ignored issues – show Bug introduced 2016-02-05 09:59 UTC by Report Bug Copy Issue Report It seems like `$task` defined by `$taskFactory->get($taskC...g['type'], $taskConfig)` on line `36` can be `null`; however, `Webcreate\Conveyor\Task\TaskRunner::addTask()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
38			}
39
40			return $taskRunner;
41			}
42
43			/**
44			* @param array $config
45			* @param string $taskConfigPath
46			* @return array
47			*/
48			protected static function getTasksConfig(array $config, $taskConfigPath)
49			{
50			$path = explode('.', $taskConfigPath);
51
52			$currentConfig = $config;
53
54			foreach ($path as $p => $_path) {
55			if (!isset($currentConfig[$_path])) {
56			return array();
57			}
58
59			$currentConfig = $currentConfig[$_path];
60			}
61
62			return $currentConfig;
63			}
64			}
65

webcreate / conveyor

TaskRunnerFactory::getTasksConfig() A last analyzed 2016-12-08 12:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

TaskRunnerFactory::getTasksConfig() A
last analyzed 2016-12-08 12:42 UTC