AnnotationDirectoryLoader::findAnnotations() - Code Metrics - Inspection of "release/v2.0.0" - sunrise-php/http-router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#32)

by Anatoly

created 2019-11-18 22:26 UTC

AnnotationDirectoryLoader::findAnnotations() A

↳ Parent: AnnotationDirectoryLoader

Complexity

Conditions	3
Paths	3

Size

Total Lines	22
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	12
nc	3
nop	1
dl	0
loc	22
ccs	13
cts	13
cp	1
crap	3
rs	9.8666
c	0
b	0
f	0

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Fenric <[email protected]>
 * @copyright Copyright (c) 2018, Anatoly Fenric
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-router
 */

namespace Sunrise\Http\Router\Loader;

/**
 * Import classes
 */
use Doctrine\Common\Annotations\SimpleAnnotationReader;
use Psr\Container\ContainerInterface;
use Sunrise\Http\Router\Annotation\Route as AnnotationRoute;
use Sunrise\Http\Router\Route as BaseRoute;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use ReflectionClass;
use RegexIterator;

/**
 * Import functions
 */
use function array_diff;
use function get_declared_classes;
use function iterator_to_array;
use function usort;

/**
 * AnnotationDirectoryLoader
 */
class AnnotationDirectoryLoader implements LoaderInterface
{

    /**
     * @var SimpleAnnotationReader
     */
    private $annotationReader;

    /**
     * @var null|ContainerInterface
     */
    private $container;

    /**
     * Constructor of the class
     */
    public function __construct()
    {
        $this->annotationReader = new SimpleAnnotationReader();
        $this->annotationReader->addNamespace('Sunrise\Http\Router\Annotation');
    }

    /**
     * Gets the loader container
     *
     * @return null|ContainerInterface
     */
    public function getContainer() : ?ContainerInterface
    {
        return $this->container;
    }

    /**
     * Sets the given container to the loader
     *
     * @param ContainerInterface $container
     *
     * @return void
     */
    public function setContainer(ContainerInterface $container) : void
    {
        $this->container = $container;
    }

    /**
     * {@inheritDoc}
     */
    public function load($destination) : array
    {
        $annotations = $this->findAnnotations($destination);

        $routes = [];
        foreach ($annotations as $annotation) {
            $routes[] = new BaseRoute(
                $annotation->name,
                $annotation->path,
                $annotation->methods,
                $this->initClass($annotation->source),
                $this->initClasses(...$annotation->middlewares),
                $annotation->attributes
            );
        }

        return $routes;
    }

    /**
     * Finds annotations in the given destination
     *
     * @param string $destination
     *
     * @return object[]
     */
    private function findAnnotations(string $destination) : array
    {
        $classes = $this->findClasses($destination);

        $annotations = [];
        foreach ($classes as $class) {
            $annotation = $this->annotationReader->getClassAnnotation(
                new ReflectionClass($class),
                AnnotationRoute::class
            );

            if ($annotation) {
                $annotation->source = $class;
                $annotations[] = $annotation;
            }
        }

        usort($annotations, function ($a, $b) {
            return $b->priority <=> $a->priority;
        });

        return $annotations;
    }

    /**
     * Finds classes in the given destination
     *
     * @param string $destination
     *
     * @return string[]
     */
    private function findClasses(string $destination) : array
    {
        $files = $this->findFiles($destination);
        $declared = get_declared_classes();

        foreach ($files as $file) {
            require_once $file->getRealPath();
        }

        return array_diff(get_declared_classes(), $declared);
    }

    /**
     * Finds files in the given destination
     *
     * @param string $destination
     *
     * @return string[]
     */
    private function findFiles(string $destination) : array
    {
        $directory = new RecursiveDirectoryIterator($destination);
        $iterator = new RecursiveIteratorIterator($directory);
        $files = new RegexIterator($iterator, '/\.php$/');

        return iterator_to_array($files);
    }

    /**
     * Initializes the given class
     *
     * @param string $class
     *
     * @return object
     */
    private function initClass(string $class)
    {
        if ($this->container && $this->container->has($class)) {
            return $this->container->get($class);
        }

        return new $class;
    }

    /**
     * Initializes the given classes
     *
     * @param string ...$classes
     *
     * @return object[]
     */
    private function initClasses(string ...$classes) : array
    {
        foreach ($classes as &$class) {
            $class = $this->initClass($class);
        }

        return $classes;

    }
}


1		<?php declare(strict_types=1);
2
3		/**
4		* It's free open-source software released under the MIT License.
5		*
6		* @author Anatoly Fenric <[email protected]>
7		* @copyright Copyright (c) 2018, Anatoly Fenric
8		* @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
9		* @link https://github.com/sunrise-php/http-router
10		*/
11
12		namespace Sunrise\Http\Router\Loader;
13
14		/**
15		* Import classes
16		*/
17		use Doctrine\Common\Annotations\SimpleAnnotationReader;
18		use Psr\Container\ContainerInterface;
19		use Sunrise\Http\Router\Annotation\Route as AnnotationRoute;
20		use Sunrise\Http\Router\Route as BaseRoute;
21		use RecursiveDirectoryIterator;
22		use RecursiveIteratorIterator;
23		use ReflectionClass;
24		use RegexIterator;
25
26		/**
27		* Import functions
28		*/
29		use function array_diff;
30		use function get_declared_classes;
31		use function iterator_to_array;
32		use function usort;
33
34		/**
35		* AnnotationDirectoryLoader
36		*/
37		class AnnotationDirectoryLoader implements LoaderInterface
38		{
39
40		/**
41		* @var SimpleAnnotationReader
42		*/
43		private $annotationReader;
44
45		/**
46		* @var null\|ContainerInterface
47		*/
48		private $container;
49
50		/**
51		* Constructor of the class
52		*/
53	20	public function __construct()
54		{
55	20	$this->annotationReader = new SimpleAnnotationReader();
56	20	$this->annotationReader->addNamespace('Sunrise\Http\Router\Annotation');
57	20	}
58
59		/**
60		* Gets the loader container
61		*
62		* @return null\|ContainerInterface
63		*/
64	1	public function getContainer() : ?ContainerInterface
65		{
66	1	return $this->container;
67		}
68
69		/**
70		* Sets the given container to the loader
71		*
72		* @param ContainerInterface $container
73		*
74		* @return void
75		*/
76	2	public function setContainer(ContainerInterface $container) : void
77		{
78	2	$this->container = $container;
79	2	}
80
81		/**
82		* {@inheritDoc}
83		*/
84	18	public function load($destination) : array
85		{
86	18	$annotations = $this->findAnnotations($destination);
87
88	2	$routes = [];
89	2	foreach ($annotations as $annotation) {
90	2	$routes[] = new BaseRoute(
91	2	$annotation->name,
92	2	$annotation->path,
93	2	$annotation->methods,
94	2	$this->initClass($annotation->source),
95	2	$this->initClasses(...$annotation->middlewares),
96	2	$annotation->attributes
97		);
98		}
99
100	2	return $routes;
101		}
102
103		/**
104		* Finds annotations in the given destination
105		*
106		* @param string $destination
107		*
108		* @return object[]
109		*/
110	18	private function findAnnotations(string $destination) : array
111		{
112	18	$classes = $this->findClasses($destination);
113
114	18	$annotations = [];
115	18	foreach ($classes as $class) {
116	18	$annotation = $this->annotationReader->getClassAnnotation(
117	18	new ReflectionClass($class),
118	18	AnnotationRoute::class
119		);
120
121	3	if ($annotation) {
122	2	$annotation->source = $class;
123	3	$annotations[] = $annotation;
124		}
125		}
126
127		usort($annotations, function ($a, $b) {
128	1	return $b->priority <=> $a->priority;
129	2	});
130
131	2	return $annotations;
132		}
133
134		/**
135		* Finds classes in the given destination
136		*
137		* @param string $destination
138		*
139		* @return string[]
140		*/
141	18	private function findClasses(string $destination) : array
142		{
143	18	$files = $this->findFiles($destination);
144	18	$declared = get_declared_classes();
145
146	18	foreach ($files as $file) {
147	18	require_once $file->getRealPath();
148		}
149
150	18	return array_diff(get_declared_classes(), $declared);
151		}
152
153		/**
154		* Finds files in the given destination
155		*
156		* @param string $destination
157		*
158		* @return string[]
159		*/
160	18	private function findFiles(string $destination) : array
161		{
162	18	$directory = new RecursiveDirectoryIterator($destination);
163	18	$iterator = new RecursiveIteratorIterator($directory);
164	18	$files = new RegexIterator($iterator, '/\.php$/');
165
166	18	return iterator_to_array($files);
167		}
168
169		/**
170		* Initializes the given class
171		*
172		* @param string $class
173		*
174		* @return object
175		*/
176	2	private function initClass(string $class)
177		{
178	2	if ($this->container && $this->container->has($class)) {
179	1	return $this->container->get($class);
180		}
181
182	2	return new $class;
183		}
184
185		/**
186		* Initializes the given classes
187		*
188		* @param string ...$classes
189		*
190		* @return object[]
191		*/
192	2	private function initClasses(string ...$classes) : array
193		{
194	2	foreach ($classes as &$class) {
195	2	$class = $this->initClass($class);
196		}
197
198	2	return $classes;
		0 ignored issues – show Bug Best Practice introduced 2019-11-18 22:28 UTC by Report Bug Copy Issue Report The expression `return $classes` returns the type `array<integer,string>` which is incompatible with the documented return type `array<mixed,object>`. Loading history...
199		}
200		}
201

sunrise-php / http-router

Pull Request — master (#32)

AnnotationDirectoryLoader::findAnnotations() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like