TemplateManager::resolveAndSetTemplatePathIfCan() - Code Metrics - Inspection of "Patch 1" - slawomirkania/class-generator-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

unknown

created 2017-04-24 11:35 UTC

TemplateManager::resolveAndSetTemplatePathIfCan() C

↳ Parent: TemplateManager

Complexity

Conditions	14
Paths	26

Size

Total Lines	46
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	46
rs	5.0744
c	0
b	0
f	0
cc	14
eloc	41
nc	26
nop	1

How to fix Complexity

<?php

namespace SimpleEntityGeneratorBundle\Lib;

use SimpleEntityGeneratorBundle\Lib\Interfaces\RenderableInterface;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\HttpKernel\Config\FileLocator;
use SimpleEntityGeneratorBundle\Lib\Items\ClassConstructorManager;
use SimpleEntityGeneratorBundle\Lib\Items\InterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\TestClassManager;
use SimpleEntityGeneratorBundle\Lib\Items\TestMethodManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterInterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanInterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\ClassManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodSetterManager;
use SimpleEntityGeneratorBundle\Lib\Items\MethodSetterInterfaceManager;
use SimpleEntityGeneratorBundle\Lib\Items\PropertyManager;

/**
 * @author Sławomir Kania <[email protected]>
 */
class TemplateManager
{

    /**
     * @var KernelInterface
     */
    private $kernel;

    /**
     * CONSTRUCT
     *
     * @param KernelInterface $kernel
     */
    public function __construct(KernelInterface $kernel)
    {
        $this->kernel = $kernel;
    }

    /**
     * @param RenderableInterface $item
     */
    public function loadAndSetTemplateOnItem(RenderableInterface $item)
    {
        $this->resolveAndSetTemplatePathIfCan($item);
        $template = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if (false === empty($item->getTemplate())) {
            $template = $item->getTemplate();
        } elseif (false === empty($item->getTemplatePath())) {
            $path = $this->getFileLocator()->locate("@".$item->getTemplatePath()); // may throw exception
            $template = $this->getFilesManager()->loadContentFromFile($path);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        } else {
            // default template
            $reflect = new \ReflectionClass($item);
            $paramName = $reflect->getShortName()."TemplatePath";

            if (false === $this->kernel->getContainer()->hasParameter($paramName)) {
                throw new \RuntimeException(sprintf("No parameter %s set", $paramName));
            }

            $path = $this->getFileLocator()->locate("@".$this->kernel->getContainer()->getParameter($paramName)); // may throw exception
            $template = $this->getFilesManager()->loadContentFromFile($path);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        $item->setTemplate($template);
    }

    /**
     * @return FilesManager
     */
    public function getFilesManager()
    {
        return $this->kernel->getContainer()->get("seg.files_manager");
    }

    /**
     * @return FileLocator
     */
    public function getFileLocator()
    {
        return $this->kernel->getContainer()->get("file_locator");
    }

    /**
     * @param RenderableInterface $item
     */
    protected function resolveAndSetTemplatePathIfCan(RenderableInterface $item)
    {
        $templatePath = "";
        switch (true) {
            case $item instanceof ClassManager:
                $templatePath = $item->getClassManagerTemplatePath();
                break;
            case $item instanceof PropertyManager:
                $templatePath = $item->getPropertyManagerTemplatePath();
                break;
            case $item instanceof ClassConstructorManager:
                $templatePath = $item->getClassManager()->getClassConstructorManagerTemplatePath();
                break;
            case $item instanceof InterfaceManager:
                $templatePath = $item->getClassManager()->getInterfaceManagerTemplatePath();
                break;
            case $item instanceof TestClassManager:
                $templatePath = $item->getClassManager()->getTestClassManagerTemplatePath();
                break;
            case $item instanceof TestMethodManager:
                $templatePath = $item->getMethod()->getProperty()->getTestClassMethodManagerTemplatePath();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                break;
            case $item instanceof MethodGetterManager:
                $templatePath = $item->getProperty()->getMethodGetterManagerTemplatePath();
                break;
            case $item instanceof MethodGetterInterfaceManager:
                $templatePath = $item->getProperty()->getMethodGetterInterfaceManagerTemplatePath();
                break;
            case $item instanceof MethodGetterBooleanManager:
                $templatePath = $item->getProperty()->getMethodGetterBooleanManagerTemplatePath();
                break;
            case $item instanceof MethodGetterBooleanInterfaceManager:
                $templatePath = $item->getProperty()->getMethodGetterBooleanInterfaceManageTemplatePath();
                break;
            case $item instanceof MethodSetterInterfaceManager:
                $templatePath = $item->getProperty()->getMethodSetterInterfaceManagerTemplatePath();
                break;
            case $item instanceof MethodSetterManager:
                $templatePath = $item->getProperty()->getMethodSetterManagerTemplatePath();
                break;
        }

        if (false === empty($templatePath)) {
            $item->setTemplatePath($templatePath);
        }
    }
}


1			<?php
2
3			namespace SimpleEntityGeneratorBundle\Lib;
4
5			use SimpleEntityGeneratorBundle\Lib\Interfaces\RenderableInterface;
6			use Symfony\Component\HttpKernel\KernelInterface;
7			use Symfony\Component\HttpKernel\Config\FileLocator;
8			use SimpleEntityGeneratorBundle\Lib\Items\ClassConstructorManager;
9			use SimpleEntityGeneratorBundle\Lib\Items\InterfaceManager;
10			use SimpleEntityGeneratorBundle\Lib\Items\TestClassManager;
11			use SimpleEntityGeneratorBundle\Lib\Items\TestMethodManager;
12			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterManager;
13			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterInterfaceManager;
14			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanManager;
15			use SimpleEntityGeneratorBundle\Lib\Items\MethodGetterBooleanInterfaceManager;
16			use SimpleEntityGeneratorBundle\Lib\Items\ClassManager;
17			use SimpleEntityGeneratorBundle\Lib\Items\MethodSetterManager;
18			use SimpleEntityGeneratorBundle\Lib\Items\MethodSetterInterfaceManager;
19			use SimpleEntityGeneratorBundle\Lib\Items\PropertyManager;
20
21			/**
22			* @author Sławomir Kania <[email protected]>
23			*/
24			class TemplateManager
25			{
26
27			/**
28			* @var KernelInterface
29			*/
30			private $kernel;
31
32			/**
33			* CONSTRUCT
34			*
35			* @param KernelInterface $kernel
36			*/
37			public function __construct(KernelInterface $kernel)
38			{
39			$this->kernel = $kernel;
40			}
41
42			/**
43			* @param RenderableInterface $item
44			*/
45			public function loadAndSetTemplateOnItem(RenderableInterface $item)
46			{
47			$this->resolveAndSetTemplatePathIfCan($item);
48			$template = null;
			0 ignored issues – show Unused Code introduced 2016-12-23 15:09 UTC by Report Bug Copy Issue Report `$template` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
49			if (false === empty($item->getTemplate())) {
50			$template = $item->getTemplate();
51			} elseif (false === empty($item->getTemplatePath())) {
52			$path = $this->getFileLocator()->locate("@".$item->getTemplatePath()); // may throw exception
53			$template = $this->getFilesManager()->loadContentFromFile($path);
			0 ignored issues – show Bug introduced 2017-04-24 11:43 UTC by Report Bug Copy Issue Report It seems like `$path` defined by `$this->getFileLocator()-...tem->getTemplatePath())` on line `52` can also be of type `array`; however, `SimpleEntityGeneratorBun...::loadContentFromFile()` 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...
54			} else {
55			// default template
56			$reflect = new \ReflectionClass($item);
57			$paramName = $reflect->getShortName()."TemplatePath";
58
59			if (false === $this->kernel->getContainer()->hasParameter($paramName)) {
60			throw new \RuntimeException(sprintf("No parameter %s set", $paramName));
61			}
62
63			$path = $this->getFileLocator()->locate("@".$this->kernel->getContainer()->getParameter($paramName)); // may throw exception
64			$template = $this->getFilesManager()->loadContentFromFile($path);
			0 ignored issues – show Bug introduced 2017-04-24 11:43 UTC by Report Bug Copy Issue Report It seems like `$path` defined by `$this->getFileLocator()-...tParameter($paramName))` on line `63` can also be of type `array`; however, `SimpleEntityGeneratorBun...::loadContentFromFile()` 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...
65			}
66
67			$item->setTemplate($template);
68			}
69
70			/**
71			* @return FilesManager
72			*/
73			public function getFilesManager()
74			{
75			return $this->kernel->getContainer()->get("seg.files_manager");
76			}
77
78			/**
79			* @return FileLocator
80			*/
81			public function getFileLocator()
82			{
83			return $this->kernel->getContainer()->get("file_locator");
84			}
85
86			/**
87			* @param RenderableInterface $item
88			*/
89			protected function resolveAndSetTemplatePathIfCan(RenderableInterface $item)
90			{
91			$templatePath = "";
92			switch (true) {
93			case $item instanceof ClassManager:
94			$templatePath = $item->getClassManagerTemplatePath();
95			break;
96			case $item instanceof PropertyManager:
97			$templatePath = $item->getPropertyManagerTemplatePath();
98			break;
99			case $item instanceof ClassConstructorManager:
100			$templatePath = $item->getClassManager()->getClassConstructorManagerTemplatePath();
101			break;
102			case $item instanceof InterfaceManager:
103			$templatePath = $item->getClassManager()->getInterfaceManagerTemplatePath();
104			break;
105			case $item instanceof TestClassManager:
106			$templatePath = $item->getClassManager()->getTestClassManagerTemplatePath();
107			break;
108			case $item instanceof TestMethodManager:
109			$templatePath = $item->getMethod()->getProperty()->getTestClassMethodManagerTemplatePath();
			0 ignored issues – show Bug introduced 2017-04-24 11:43 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `SimpleEntityGeneratorBun...Lib\Items\MethodManager` as the method `getProperty()` does only exist in the following sub-classes of `SimpleEntityGeneratorBun...Lib\Items\MethodManager`: `SimpleEntityGeneratorBun...ethodForPropertyManager`, `SimpleEntityGeneratorBun...BooleanInterfaceManager`, `SimpleEntityGeneratorBun...hodGetterBooleanManager`, `SimpleEntityGeneratorBun...dGetterInterfaceManager`, `SimpleEntityGeneratorBun...ems\MethodGetterManager`, `SimpleEntityGeneratorBun...dSetterInterfaceManager`, `SimpleEntityGeneratorBun...ems\MethodSetterManager`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
110			break;
111			case $item instanceof MethodGetterManager:
112			$templatePath = $item->getProperty()->getMethodGetterManagerTemplatePath();
113			break;
114			case $item instanceof MethodGetterInterfaceManager:
115			$templatePath = $item->getProperty()->getMethodGetterInterfaceManagerTemplatePath();
116			break;
117			case $item instanceof MethodGetterBooleanManager:
118			$templatePath = $item->getProperty()->getMethodGetterBooleanManagerTemplatePath();
119			break;
120			case $item instanceof MethodGetterBooleanInterfaceManager:
121			$templatePath = $item->getProperty()->getMethodGetterBooleanInterfaceManageTemplatePath();
122			break;
123			case $item instanceof MethodSetterInterfaceManager:
124			$templatePath = $item->getProperty()->getMethodSetterInterfaceManagerTemplatePath();
125			break;
126			case $item instanceof MethodSetterManager:
127			$templatePath = $item->getProperty()->getMethodSetterManagerTemplatePath();
128			break;
129			}
130
131			if (false === empty($templatePath)) {
132			$item->setTemplatePath($templatePath);
133			}
134			}
135			}
136

slawomirkania / class-generator-bundle

Pull Request — master (#14)

TemplateManager::resolveAndSetTemplatePathIfCan() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like