SkeletonProvider - Code Metrics - Inspection of "Fetch: check project skeleton instead of PDO drive..." - Kunstmaan/skylab - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#118)

unknown

created 2016-01-12 14:43 UTC

SkeletonProvider A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
wmc	23
c	3
b	1
f	0
lcom	1
cbo	4
dl	0
loc	127
rs	10

8 Methods

Rating	Name	Size	Complexity
A	register()	5	1
A	resolveDependencies()	13	4
A	findSkeleton()	12	3
A	listSkeletons()	6	2
A	hasSkeleton()	4	2
A	applySkeleton()	13	3
A	getSkeletons()	8	2
B	skeletonLoop()	19	6

<?php

namespace Kunstmaan\Skylab\Provider;

use Cilex\Application;
use Kunstmaan\Skylab\Skeleton\AbstractSkeleton;
use Kunstmaan\Skylab\Utility\DependencySolver;
use RuntimeException;

/**
 * SkeletonProvider
 */
class SkeletonProvider extends AbstractProvider
{

    /**
     * Registers services on the given app.
     *
     * @param Application $app An Application instance
     */
    public function register(Application $app)
    {
        $app['skeleton'] = $this;
        $this->app = $app;
    }

    /**
     * @param \ArrayObject $project The project
     * @param AbstractSkeleton $skeleton The skeleton
     * @return bool
     */
    public function hasSkeleton(\ArrayObject $project, AbstractSkeleton $skeleton)
    {
        return isset($project["skeletons"]) && array_key_exists($skeleton->getName(), $project["skeletons"]);
    }


    /**
     * @param \ArrayObject     $project  The project
     * @param AbstractSkeleton $skeleton The skeleton
     */
    public function applySkeleton(\ArrayObject $project, AbstractSkeleton $skeleton)
    {
        $dependencies = new DependencySolver();
        $this->resolveDependencies($skeleton, $dependencies);
        foreach ($dependencies->getLoadOrder() as $theSkeletonName) {
            $theSkeleton = $this->findSkeleton($theSkeletonName);
            if (!$this->hasSkeleton($project, $theSkeleton)) {
                $this->dialogProvider->logTask("Running skeleton create for " . $theSkeleton->getName());
                $theSkeleton->create($project);
                $project["skeletons"][$theSkeleton->getName()] = $theSkeleton->getName();
            }
        }
    }

    /**
     * @param  AbstractSkeleton                           $theSkeleton
     * @param  \Kunstmaan\Skylab\Utility\DependencySolver $dependencies
     * @return \ArrayObject

     */
    private function resolveDependencies(AbstractSkeleton $theSkeleton, DependencySolver $dependencies)
    {
        if (!$dependencies->itemExists($theSkeleton->getName())) {
            $skeletonDeps = $theSkeleton->dependsOn();
            $dependencies->add($theSkeleton->getName(), $skeletonDeps);
            foreach ($skeletonDeps as $skeletonDependencyName) {
                $aSkeleton = $this->findSkeleton($skeletonDependencyName);
                if ($aSkeleton) {
                    $this->resolveDependencies($aSkeleton, $dependencies);
                }
            }
        }
    }

    /**
     * @param  string                $skeletonname
     * @return AbstractSkeleton
     * @throws \RuntimeException
     */
    public function findSkeleton($skeletonname)
    {
        if (isset($this->app["config"]["skeletons"][$skeletonname])) {
            $skeleton = $this->app["config"]["skeletons"][$skeletonname];
            if ($skeleton === false) {
                return false;
            } else {
                return new $skeleton($this->app);
            }
        }
        throw new RuntimeException("Skeleton " . $skeletonname . " not found!");
    }

    /**
     * @return void
     */
    public function listSkeletons()
    {
        foreach (array_keys($this->app["config"]["skeletons"]) as $name) {
            $this->dialogProvider->logTask($name);
        }
    }

    /**
     * @return array
     */
    public function getSkeletons()
    {
        foreach (array_keys($this->app["config"]["skeletons"]) as $name) {
            $skeletons[] = $name;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }

        return $skeletons;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * @param \Closure $callback
     * @param \ArrayObject $skeletons

     */
    public function skeletonLoop($callback, \ArrayObject $skeletons = null)
    {
        if (!$skeletons) {
            $skeletons = new \ArrayObject(array_keys($this->app["config"]["skeletons"]));
        }
        $dependencies = new DependencySolver();
        foreach ($skeletons as $skeleton) {
            $theSkeleton = $this->findSkeleton($skeleton);
            if ($theSkeleton) {
                $this->resolveDependencies($theSkeleton, $dependencies);
            }
        }
        foreach ($dependencies->getLoadOrder() as $skeletonName) {
            $skeleton = $this->findSkeleton($skeletonName);
            if ($skeleton) {
                $callback($skeleton);
            }
        }
    }

}


1			<?php
2
3			namespace Kunstmaan\Skylab\Provider;
4
5			use Cilex\Application;
6			use Kunstmaan\Skylab\Skeleton\AbstractSkeleton;
7			use Kunstmaan\Skylab\Utility\DependencySolver;
8			use RuntimeException;
9
10			/**
11			* SkeletonProvider
12			*/
13			class SkeletonProvider extends AbstractProvider
14			{
15
16			/**
17			* Registers services on the given app.
18			*
19			* @param Application $app An Application instance
20			*/
21			public function register(Application $app)
22			{
23			$app['skeleton'] = $this;
24			$this->app = $app;
25			}
26
27			/**
28			* @param \ArrayObject $project The project
29			* @param AbstractSkeleton $skeleton The skeleton
30			* @return bool
31			*/
32			public function hasSkeleton(\ArrayObject $project, AbstractSkeleton $skeleton)
33			{
34			return isset($project["skeletons"]) && array_key_exists($skeleton->getName(), $project["skeletons"]);
35			}
36
37
38			/**
39			* @param \ArrayObject $project The project
40			* @param AbstractSkeleton $skeleton The skeleton
41			*/
42			public function applySkeleton(\ArrayObject $project, AbstractSkeleton $skeleton)
43			{
44			$dependencies = new DependencySolver();
45			$this->resolveDependencies($skeleton, $dependencies);
46			foreach ($dependencies->getLoadOrder() as $theSkeletonName) {
47			$theSkeleton = $this->findSkeleton($theSkeletonName);
48			if (!$this->hasSkeleton($project, $theSkeleton)) {
49			$this->dialogProvider->logTask("Running skeleton create for " . $theSkeleton->getName());
50			$theSkeleton->create($project);
51			$project["skeletons"][$theSkeleton->getName()] = $theSkeleton->getName();
52			}
53			}
54			}
55
56			/**
57			* @param AbstractSkeleton $theSkeleton
58			* @param \Kunstmaan\Skylab\Utility\DependencySolver $dependencies
59			* @return \ArrayObject
			0 ignored issues – show Documentation introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report Should the return type not be `\ArrayObject\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
60			*/
61			private function resolveDependencies(AbstractSkeleton $theSkeleton, DependencySolver $dependencies)
62			{
63			if (!$dependencies->itemExists($theSkeleton->getName())) {
64			$skeletonDeps = $theSkeleton->dependsOn();
65			$dependencies->add($theSkeleton->getName(), $skeletonDeps);
66			foreach ($skeletonDeps as $skeletonDependencyName) {
67			$aSkeleton = $this->findSkeleton($skeletonDependencyName);
68			if ($aSkeleton) {
69			$this->resolveDependencies($aSkeleton, $dependencies);
70			}
71			}
72			}
73			}
74
75			/**
76			* @param string $skeletonname
77			* @return AbstractSkeleton
78			* @throws \RuntimeException
79			*/
80			public function findSkeleton($skeletonname)
81			{
82			if (isset($this->app["config"]["skeletons"][$skeletonname])) {
83			$skeleton = $this->app["config"]["skeletons"][$skeletonname];
84			if ($skeleton === false) {
85			return false;
86			} else {
87			return new $skeleton($this->app);
88			}
89			}
90			throw new RuntimeException("Skeleton " . $skeletonname . " not found!");
91			}
92
93			/**
94			* @return void
95			*/
96			public function listSkeletons()
97			{
98			foreach (array_keys($this->app["config"]["skeletons"]) as $name) {
99			$this->dialogProvider->logTask($name);
100			}
101			}
102
103			/**
104			* @return array
105			*/
106			public function getSkeletons()
107			{
108			foreach (array_keys($this->app["config"]["skeletons"]) as $name) {
109			$skeletons[] = $name;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-12 14:48 UTC by Report Bug Copy Issue Report `$skeletons` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$skeletons = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
110			}
111
112			return $skeletons;
			0 ignored issues – show Bug introduced 2016-01-12 14:48 UTC by Report Bug Copy Issue Report The variable `$skeletons` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
113			}
114
115			/**
116			* @param \Closure $callback
117			* @param \ArrayObject $skeletons
			0 ignored issues – show Documentation introduced 2015-11-23 11:12 UTC by Report Bug Copy Issue Report Should the type for parameter `$skeletons` not be `null\|\ArrayObject`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
118			*/
119			public function skeletonLoop($callback, \ArrayObject $skeletons = null)
120			{
121			if (!$skeletons) {
122			$skeletons = new \ArrayObject(array_keys($this->app["config"]["skeletons"]));
123			}
124			$dependencies = new DependencySolver();
125			foreach ($skeletons as $skeleton) {
126			$theSkeleton = $this->findSkeleton($skeleton);
127			if ($theSkeleton) {
128			$this->resolveDependencies($theSkeleton, $dependencies);
129			}
130			}
131			foreach ($dependencies->getLoadOrder() as $skeletonName) {
132			$skeleton = $this->findSkeleton($skeletonName);
133			if ($skeleton) {
134			$callback($skeleton);
135			}
136			}
137			}
138
139			}
140

Kunstmaan / skylab

GitHub Access Token became invalid

Pull Request — master (#118)

SkeletonProvider A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like