AnnotatedI18nRouteLoader::configureRoute() - Code Metrics - Inspection of "Allow symfony route annotations alongside I18nRout..." - frankdejonge/symfony-i18n-routing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 54e33b...7fdb39 )

by Frank

created 2018-02-06 12:06 UTC

AnnotatedI18nRouteLoader::configureRoute() A

↳ Parent: AnnotatedI18nRouteLoader

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	4
crap	1

<?php

namespace FrankDeJonge\SymfonyI18nRouting\Routing\Loader;

use Doctrine\Common\Annotations\Reader;
use FrankDeJonge\SymfonyI18nRouting\Routing\Annotation\I18nRoute;
use ReflectionClass;
use ReflectionMethod;
use Symfony\Component\Config\Resource\FileResource;
use Symfony\Component\Routing\Annotation\Route as SymfonyRoute;
use Symfony\Component\Routing\Loader\AnnotationClassLoader;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;
use function array_diff;
use function array_keys;
use function join;
use function var_dump;

class AnnotatedI18nRouteLoader extends AnnotationClassLoader
{
    protected $routeAnnotationClass = I18nRoute::class;

    public function __construct(Reader $reader)
    {
        parent::__construct($reader);
        $this->setRouteAnnotationClass(I18nRoute::class);
    }


    /**
     * Loads from annotations from a class.
     *
     * @param string      $class A class name
     * @param string|null $type  The resource type
     *
     * @return RouteCollection A RouteCollection instance
     *
     * @throws \InvalidArgumentException When route can't be parsed
     */
    public function load($class, $type = null)
    {
        if ( ! class_exists($class)) {
            throw new \InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
        }

        $class = new \ReflectionClass($class);
        if ($class->isAbstract()) {
            throw new \InvalidArgumentException(sprintf('Annotations from class "%s" cannot be read as it is abstract.', $class->getName()));

        }

        $globals = $this->getGlobals($class);

        $collection = new RouteCollection();
        $collection->addResource(new FileResource($class->getFileName()));

        foreach ($class->getMethods() as $method) {
            $this->defaultRouteIndex = 0;
            foreach ($this->reader->getMethodAnnotations($method) as $annot) {
                if ($annot instanceof SymfonyRoute || $annot instanceof I18nRoute) {
                    $this->addRoute($collection, $annot, $globals, $class, $method);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        if (0 === $collection->count() && $class->hasMethod('__invoke')) {
            $annot = $this->reader->getClassAnnotation($class, $this->routeAnnotationClass)
                ?: $this->reader->getClassAnnotation($class, SymfonyRoute::class);

            if ($annot != null) {
                $globals['path'] = '';
                $globals['name'] = '';
                $globals['locales'] = [];
                $this->addRoute($collection, $annot, $globals, $class, $class->getMethod('__invoke'));
            }
        }

        return $collection;
    }

    /**
     * @param RouteCollection  $collection
     * @param I18nRoute        $annotation
     * @param array            $globals
     * @param ReflectionClass  $class
     * @param ReflectionMethod $method
     */
    protected function addRoute(RouteCollection $collection, $annotation, $globals, ReflectionClass $class, ReflectionMethod $method)
    {
        $name = $annotation->getName();

        if (null === $name) {
            throw MissingRouteName::forAnnotation($class->name . '::' . $method->name);
        }

        $defaults = array_replace($globals['defaults'], $annotation->getDefaults());

        foreach ($method->getParameters() as $param) {
            if ( ! isset($defaults[$param->name]) && $param->isDefaultValueAvailable()) {
                $defaults[$param->name] = $param->getDefaultValue();
            }
        }

        $requirements = array_replace($globals['requirements'], $annotation->getRequirements());
        $options = array_replace($globals['options'], $annotation->getOptions());
        $schemes = array_merge($globals['schemes'], $annotation->getSchemes());
        $methods = array_merge($globals['methods'], $annotation->getMethods());
        $host = $annotation->getHost() ?: $globals['host'];
        $condition = $annotation->getCondition() ?: $globals['condition'];
        $path = $annotation->getPath();
        $locales = $annotation instanceof I18nRoute ? $annotation->getLocales() : [];

        $hasLocalizedPrefix = empty($globals['locales']) === false;
        $hasPrefix = $hasLocalizedPrefix || empty($globals['path']) === false;
        $isLocalized = ! empty($locales);
        $hasPathOrLocales = empty($path) === false || $isLocalized;

        if ($hasPrefix === false && $hasPathOrLocales === false) {
            throw MissingRoutePath::forAnnotation("{$class->name}::{$method->name}");
        }

        if ( ! $hasPathOrLocales) {
            if ($hasLocalizedPrefix) {

                foreach ($globals['locales'] as $locale => $localePath) {
                    $routeName = "{$name}.{$locale}";
                    $route = $this->createRoute($localePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                    $this->configureRoute($route, $class, $method, $annotation);
                    $route->setDefault('_locale', $locale);
                    $collection->add($routeName, $route);
                }
            } else {
                $route = $this->createRoute($globals['path'], $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                $this->configureRoute($route, $class, $method, $annotation);
                $collection->add($name, $route);
            }
        } elseif ( ! $hasPrefix) {
            if ($isLocalized) {

                foreach ($locales as $locale => $localePath) {
                    $routeName = "{$name}.{$locale}";
                    $route = $this->createRoute($localePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                    $this->configureRoute($route, $class, $method, $annotation);
                    $route->setDefault('_locale', $locale);
                    $collection->add($routeName, $route);
                }
            } else {
                $route = $this->createRoute($path, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                $this->configureRoute($route, $class, $method, $annotation);
                $collection->add($name, $route);
            }
        } else {
            if ($hasLocalizedPrefix) {
                if ($isLocalized) {
                    $missing = array_diff(array_keys($globals['locales']), array_keys($locales));

                    if ( ! empty($missing)) {
                        throw MissingRouteLocale::forClass($class, $method, join(' and ', $missing));
                    }

                    foreach ($locales as $locale => $localePath) {
                        if ( ! isset($globals['locales'][$locale])) {
                            throw MissingRouteLocale::forClass($class, $method, $locale);
                        }

                        $routePath = $globals['locales'][$locale] . $localePath;
                        $routeName = "{$name}.{$locale}";
                        $route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                        $this->configureRoute($route, $class, $method, $annotation);
                        $route->setDefault('_locale', $locale);
                        $collection->add($routeName, $route);
                    }
                } else {
                    foreach ($globals['locales'] as $locale => $localePrefix) {

                        $routeName = "{$name}.{$locale}";
                        $routePath = $localePrefix . $path;
                        $route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                        $this->configureRoute($route, $class, $method, $annotation);
                        $route->setDefault('_locale', $locale);
                        $collection->add($routeName, $route);
                    }
                }
            } else {
                if ($isLocalized) {
                    foreach ($locales as $locale => $localePath) {

                        $routePath = $globals['path'] . $localePath;
                        $routeName = "{$name}.{$locale}";
                        $route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                        $this->configureRoute($route, $class, $method, $annotation);
                        $route->setDefault('_locale', $locale);
                        $collection->add($routeName, $route);
                    }
                } else {
                    $routePath = $globals['path'] . $path;
                    $route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
                    $this->configureRoute($route, $class, $method, $annotation);
                    $collection->add($name, $route);
                }
            }
        }
    }

    /**
     * @inheritdoc
     */
    protected function getGlobals(ReflectionClass $class)
    {
        $globals = [
            'path'         => '',
            'locales'      => [],
            'requirements' => [],
            'options'      => [],
            'defaults'     => [],
            'schemes'      => [],
            'methods'      => [],
            'host'         => '',
            'condition'    => '',
        ];

        $annotation = $this->reader->getClassAnnotation($class, $this->routeAnnotationClass);

        if ( ! $annotation instanceof I18nRoute && ! $annotation instanceof SymfonyRoute) {
            return $globals;
        }
        if ($annotation instanceof I18nRoute) {
            $globals['locales'] = $annotation->getLocales();
        }
        if (null !== $annotation->getPath()) {
            $globals['path'] = $annotation->getPath();
        }
        if (null !== $annotation->getRequirements()) {
            $globals['requirements'] = $annotation->getRequirements();
        }
        if (null !== $annotation->getOptions()) {
            $globals['options'] = $annotation->getOptions();
        }
        if (null !== $annotation->getDefaults()) {
            $globals['defaults'] = $annotation->getDefaults();
        }
        if (null !== $annotation->getSchemes()) {
            $globals['schemes'] = $annotation->getSchemes();
        }
        if (null !== $annotation->getMethods()) {
            $globals['methods'] = $annotation->getMethods();
        }
        if (null !== $annotation->getHost()) {
            $globals['host'] = $annotation->getHost();
        }
        if (null !== $annotation->getCondition()) {
            $globals['condition'] = $annotation->getCondition();
        }

        return $globals;
    }

    protected function configureRoute(Route $route, ReflectionClass $class, ReflectionMethod $method, $annot)
    {
        $route->setDefault('_controller', $class->name . '::' . $method->getName());

    }
}


1			<?php
2
3			namespace FrankDeJonge\SymfonyI18nRouting\Routing\Loader;
4
5			use Doctrine\Common\Annotations\Reader;
6			use FrankDeJonge\SymfonyI18nRouting\Routing\Annotation\I18nRoute;
7			use ReflectionClass;
8			use ReflectionMethod;
9			use Symfony\Component\Config\Resource\FileResource;
10			use Symfony\Component\Routing\Annotation\Route as SymfonyRoute;
11			use Symfony\Component\Routing\Loader\AnnotationClassLoader;
12			use Symfony\Component\Routing\Route;
13			use Symfony\Component\Routing\RouteCollection;
14			use function array_diff;
15			use function array_keys;
16			use function join;
17			use function var_dump;
18
19			class AnnotatedI18nRouteLoader extends AnnotationClassLoader
20			{
21			protected $routeAnnotationClass = I18nRoute::class;
22
23	30		public function __construct(Reader $reader)
24			{
25	30		parent::__construct($reader);
26	30		$this->setRouteAnnotationClass(I18nRoute::class);
27	30		}
28
29
30			/**
31			* Loads from annotations from a class.
32			*
33			* @param string $class A class name
34			* @param string\|null $type The resource type
35			*
36			* @return RouteCollection A RouteCollection instance
37			*
38			* @throws \InvalidArgumentException When route can't be parsed
39			*/
40	30		public function load($class, $type = null)
41			{
42	30		if ( ! class_exists($class)) {
43	4		throw new \InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
44			}
45
46	26		$class = new \ReflectionClass($class);
47	26		if ($class->isAbstract()) {
48			throw new \InvalidArgumentException(sprintf('Annotations from class "%s" cannot be read as it is abstract.', $class->getName()));
			0 ignored issues – show Bug introduced 2018-02-06 12:08 UTC by Report Bug Copy Issue Report Consider using `$class->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
49			}
50
51	26		$globals = $this->getGlobals($class);
52
53	26		$collection = new RouteCollection();
54	26		$collection->addResource(new FileResource($class->getFileName()));
55
56	26		foreach ($class->getMethods() as $method) {
57	26		$this->defaultRouteIndex = 0;
58	26		foreach ($this->reader->getMethodAnnotations($method) as $annot) {
59	26		if ($annot instanceof SymfonyRoute \|\| $annot instanceof I18nRoute) {
60	26		$this->addRoute($collection, $annot, $globals, $class, $method);
			0 ignored issues – show Bug introduced 2018-02-06 12:08 UTC by Report Bug Copy Issue Report It seems like `$annot` can also be of type `object<Symfony\Component...uting\Annotation\Route>`; however, `FrankDeJonge\SymfonyI18n...RouteLoader::addRoute()` does only seem to accept `object<FrankDeJonge\Symf...g\Annotation\I18nRoute>`, 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...
61			}
62			}
63			}
64
65	18		if (0 === $collection->count() && $class->hasMethod('__invoke')) {
66			$annot = $this->reader->getClassAnnotation($class, $this->routeAnnotationClass)
67			?: $this->reader->getClassAnnotation($class, SymfonyRoute::class);
68
69			if ($annot != null) {
70			$globals['path'] = '';
71			$globals['name'] = '';
72			$globals['locales'] = [];
73			$this->addRoute($collection, $annot, $globals, $class, $class->getMethod('__invoke'));
74			}
75			}
76
77	18		return $collection;
78			}
79
80			/**
81			* @param RouteCollection $collection
82			* @param I18nRoute $annotation
83			* @param array $globals
84			* @param ReflectionClass $class
85			* @param ReflectionMethod $method
86			*/
87	26		protected function addRoute(RouteCollection $collection, $annotation, $globals, ReflectionClass $class, ReflectionMethod $method)
88			{
89	26		$name = $annotation->getName();
90
91	26		if (null === $name) {
92	2		throw MissingRouteName::forAnnotation($class->name . '::' . $method->name);
93			}
94
95	24		$defaults = array_replace($globals['defaults'], $annotation->getDefaults());
96
97	24		foreach ($method->getParameters() as $param) {
98	2		if ( ! isset($defaults[$param->name]) && $param->isDefaultValueAvailable()) {
99	2		$defaults[$param->name] = $param->getDefaultValue();
100			}
101			}
102
103	24		$requirements = array_replace($globals['requirements'], $annotation->getRequirements());
104	24		$options = array_replace($globals['options'], $annotation->getOptions());
105	24		$schemes = array_merge($globals['schemes'], $annotation->getSchemes());
106	24		$methods = array_merge($globals['methods'], $annotation->getMethods());
107	24		$host = $annotation->getHost() ?: $globals['host'];
108	24		$condition = $annotation->getCondition() ?: $globals['condition'];
109	24		$path = $annotation->getPath();
110	24		$locales = $annotation instanceof I18nRoute ? $annotation->getLocales() : [];
111
112	24		$hasLocalizedPrefix = empty($globals['locales']) === false;
113	24		$hasPrefix = $hasLocalizedPrefix \|\| empty($globals['path']) === false;
114	24		$isLocalized = ! empty($locales);
115	24		$hasPathOrLocales = empty($path) === false \|\| $isLocalized;
116
117	24		if ($hasPrefix === false && $hasPathOrLocales === false) {
118	2		throw MissingRoutePath::forAnnotation("{$class->name}::{$method->name}");
119			}
120
121	22		if ( ! $hasPathOrLocales) {
122	4	View Code Duplication	if ($hasLocalizedPrefix) {
			0 ignored issues – show Duplication introduced 2018-02-06 00:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123	2		foreach ($globals['locales'] as $locale => $localePath) {
124	2		$routeName = "{$name}.{$locale}";
125	2		$route = $this->createRoute($localePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
126	2		$this->configureRoute($route, $class, $method, $annotation);
127	2		$route->setDefault('_locale', $locale);
128	2		$collection->add($routeName, $route);
129			}
130			} else {
131	2		$route = $this->createRoute($globals['path'], $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
132	2		$this->configureRoute($route, $class, $method, $annotation);
133	4		$collection->add($name, $route);
134			}
135	18		} elseif ( ! $hasPrefix) {
136	6	View Code Duplication	if ($isLocalized) {
			0 ignored issues – show Duplication introduced 2018-02-06 00:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
137	2		foreach ($locales as $locale => $localePath) {
138	2		$routeName = "{$name}.{$locale}";
139	2		$route = $this->createRoute($localePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
140	2		$this->configureRoute($route, $class, $method, $annotation);
141	2		$route->setDefault('_locale', $locale);
142	2		$collection->add($routeName, $route);
143			}
144			} else {
145	4		$route = $this->createRoute($path, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
146	4		$this->configureRoute($route, $class, $method, $annotation);
147	6		$collection->add($name, $route);
148			}
149			} else {
150	12		if ($hasLocalizedPrefix) {
151	8		if ($isLocalized) {
152	6		$missing = array_diff(array_keys($globals['locales']), array_keys($locales));
153
154	6		if ( ! empty($missing)) {
155	2		throw MissingRouteLocale::forClass($class, $method, join(' and ', $missing));
156			}
157
158	4		foreach ($locales as $locale => $localePath) {
159	4		if ( ! isset($globals['locales'][$locale])) {
160	2		throw MissingRouteLocale::forClass($class, $method, $locale);
161			}
162
163	4		$routePath = $globals['locales'][$locale] . $localePath;
164	4		$routeName = "{$name}.{$locale}";
165	4		$route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
166	4		$this->configureRoute($route, $class, $method, $annotation);
167	4		$route->setDefault('_locale', $locale);
168	4		$collection->add($routeName, $route);
169			}
170			} else {
171	2	View Code Duplication	foreach ($globals['locales'] as $locale => $localePrefix) {
			0 ignored issues – show Duplication introduced 2018-02-06 00:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
172	2		$routeName = "{$name}.{$locale}";
173	2		$routePath = $localePrefix . $path;
174	2		$route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
175	2		$this->configureRoute($route, $class, $method, $annotation);
176	2		$route->setDefault('_locale', $locale);
177	4		$collection->add($routeName, $route);
178			}
179			}
180			} else {
181	4		if ($isLocalized) {
182	2	View Code Duplication	foreach ($locales as $locale => $localePath) {
			0 ignored issues – show Duplication introduced 2018-02-06 00:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
183	2		$routePath = $globals['path'] . $localePath;
184	2		$routeName = "{$name}.{$locale}";
185	2		$route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
186	2		$this->configureRoute($route, $class, $method, $annotation);
187	2		$route->setDefault('_locale', $locale);
188	2		$collection->add($routeName, $route);
189			}
190			} else {
191	2		$routePath = $globals['path'] . $path;
192	2		$route = $this->createRoute($routePath, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
193	2		$this->configureRoute($route, $class, $method, $annotation);
194	2		$collection->add($name, $route);
195			}
196			}
197			}
198	18		}
199
200			/**
201			* @inheritdoc
202			*/
203	26		protected function getGlobals(ReflectionClass $class)
204			{
205			$globals = [
206	26		'path' => '',
207			'locales' => [],
208			'requirements' => [],
209			'options' => [],
210			'defaults' => [],
211			'schemes' => [],
212			'methods' => [],
213			'host' => '',
214			'condition' => '',
215			];
216
217	26		$annotation = $this->reader->getClassAnnotation($class, $this->routeAnnotationClass);
218
219	26		if ( ! $annotation instanceof I18nRoute && ! $annotation instanceof SymfonyRoute) {
220	10		return $globals;
221			}
222	16		if ($annotation instanceof I18nRoute) {
223	16		$globals['locales'] = $annotation->getLocales();
224			}
225	16		if (null !== $annotation->getPath()) {
226	6		$globals['path'] = $annotation->getPath();
227			}
228	16		if (null !== $annotation->getRequirements()) {
229	16		$globals['requirements'] = $annotation->getRequirements();
230			}
231	16		if (null !== $annotation->getOptions()) {
232	16		$globals['options'] = $annotation->getOptions();
233			}
234	16		if (null !== $annotation->getDefaults()) {
235	16		$globals['defaults'] = $annotation->getDefaults();
236			}
237	16		if (null !== $annotation->getSchemes()) {
238	16		$globals['schemes'] = $annotation->getSchemes();
239			}
240	16		if (null !== $annotation->getMethods()) {
241	16		$globals['methods'] = $annotation->getMethods();
242			}
243	16		if (null !== $annotation->getHost()) {
244	2		$globals['host'] = $annotation->getHost();
245			}
246	16		if (null !== $annotation->getCondition()) {
247	2		$globals['condition'] = $annotation->getCondition();
248			}
249
250	16		return $globals;
251			}
252
253	20		protected function configureRoute(Route $route, ReflectionClass $class, ReflectionMethod $method, $annot)
254			{
255	20		$route->setDefault('_controller', $class->name . '::' . $method->getName());
			0 ignored issues – show Bug introduced 2018-02-06 00:23 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
256	20		}
257			}
258

frankdejonge / symfony-i18n-routing

Push — master ( 54e33b...7fdb39 )

AnnotatedI18nRouteLoader::configureRoute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like