RestResourceLoader::__construct() - Code Metrics - Inspection of "Merging targetClass with type" - dontdrinkandroot/rest-bundle.php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — standalone ( 8da518...787e4c )

by Philip

created 2017-02-28 15:38 UTC

RestResourceLoader::__construct() A

↳ Parent: RestResourceLoader

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

namespace Dontdrinkandroot\RestBundle\Routing;

use Doctrine\Common\Util\Inflector;
use Dontdrinkandroot\RestBundle\Metadata\ClassMetadata;
use Dontdrinkandroot\RestBundle\Metadata\PropertyMetadata;
use Metadata\MetadataFactoryInterface;
use Symfony\Component\Config\FileLocatorInterface;
use Symfony\Component\Config\Loader\Loader;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

class RestResourceLoader extends Loader
{
    /**
     * @var FileLocatorInterface
     */
    private $fileLocator;

    /**
     * @var MetadataFactoryInterface
     */
    private $metadataFactory;

    public function __construct(FileLocatorInterface $fileLocator, MetadataFactoryInterface $metadataFactory)
    {
        $this->fileLocator = $fileLocator;
        $this->metadataFactory = $metadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function load($resource, $type = null)
    {
        $locatedResource = $this->fileLocator->locate($resource);
        $files = [];
        if (is_dir($locatedResource)) {
            $finder = new Finder();
            foreach ($finder->in($locatedResource)->name('*.php')->files() as $file) {
                /** @var SplFileInfo $file */
                $files[] = $file->getRealPath();
            }
        } else {
            $files[] = $locatedResource;
        }

        $routes = new RouteCollection();
        foreach ($files as $file) {
            $class = $this->findClass($file);
            if (false === $class) {
                throw new \Exception(sprintf('Couldn\'t find class for %s', $file));
            }
            /** @var ClassMetadata $classMetadata */
            $classMetadata = $this->metadataFactory->getMetadataForClass($class);
            if ($classMetadata->isRestResource()) {

                $methods = $classMetadata->getMethods();
                $namePrefix = $this->getNamePrefix($classMetadata);
                $pathPrefix = $this->getPathPrefix($classMetadata);
                $controller = $this->getController($classMetadata);

                $defaults = [
                    '_entityClass' => $class,
                    '_format'      => 'json'
                ];

                if (null !== $classMetadata->getService()) {
                    $defaults['_service'] = $classMetadata->getService();
                }

                if (in_array('LIST', $methods)) {
                    $listRoute = new Route($pathPrefix);
                    $listRoute->setMethods(Request::METHOD_GET);
                    $listRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':list']));
                    $routes->add($namePrefix . '.list', $listRoute);
                }

                if (in_array('POST', $methods)) {
                    $postRoute = new Route($pathPrefix);
                    $postRoute->setMethods(Request::METHOD_POST);
                    $postRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':post']));
                    $routes->add($namePrefix . '.post', $postRoute);
                }

                if (in_array('GET', $methods)) {
                    $getRoute = new Route($pathPrefix . '/{id}');
                    $getRoute->setMethods(Request::METHOD_GET);
                    $getRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':get']));
                    $routes->add($namePrefix . '.get', $getRoute);
                }

                if (in_array('PUT', $methods)) {
                    $putRoute = new Route($pathPrefix . '/{id}');
                    $putRoute->setMethods(Request::METHOD_PUT);
                    $putRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':put']));
                    $routes->add($namePrefix . '.put', $putRoute);
                }

                if (in_array('DELETE', $methods)) {
                    $deleteRoute = new Route($pathPrefix . '/{id}');
                    $deleteRoute->setMethods(Request::METHOD_DELETE);
                    $deleteRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':delete']));
                    $routes->add($namePrefix . '.delete', $deleteRoute);
                }

                /** @var PropertyMetadata $propertyMetadata */
                foreach ($classMetadata->propertyMetadata as $propertyMetadata) {
                    if ($propertyMetadata->isSubResource()) {
                        $subResourcePath = strtolower($propertyMetadata->name);
                        if (null !== $propertyMetadata->getSubResourcePath()) {
                            $subResourcePath = $propertyMetadata->getSubResourcePath();
                        }
                        $subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath;
                        $subResourceRoute = new Route($subResourceFullPath);
                        $subResourceRoute->setMethods(Request::METHOD_GET);
                        $subResourceRoute->setDefaults(
                            array_merge(
                                $defaults,
                                [
                                    '_controller'  => $controller . ':listSubresource',
                                    '_subresource' => $propertyMetadata->name,
                                ]
                            )
                        );
                        $routes->add($namePrefix . '.' . $propertyMetadata->name . '.list', $subResourceRoute);

                        $postRight = $propertyMetadata->getSubResourcePostRight();
                        if (null !== $postRight) {
                            $subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath;
                            $subResourceRoute = new Route($subResourceFullPath);
                            $subResourceRoute->setMethods(Request::METHOD_POST);
                            $subResourceRoute->setDefaults(
                                array_merge(
                                    $defaults,
                                    [
                                        '_controller'  => $controller . ':postSubresource',
                                        '_subresource' => $propertyMetadata->name,
                                    ]
                                )
                            );
                            $routes->add($namePrefix . '.' . $propertyMetadata->name . '.post', $subResourceRoute);
                        }

                        $putRight = $propertyMetadata->getSubResourcePutRight();
                        if (null !== $putRight) {
                            $subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath . '/{subId}';
                            $subResourceRoute = new Route($subResourceFullPath);
                            $subResourceRoute->setMethods(Request::METHOD_PUT);
                            $subResourceRoute->setDefaults(
                                array_merge(
                                    $defaults,
                                    [
                                        '_controller'  => $controller . ':putSubresource',
                                        '_subresource' => $propertyMetadata->name,
                                    ]
                                )
                            );
                            $routes->add($namePrefix . '.' . $propertyMetadata->name . '.put', $subResourceRoute);
                        }

                        $deleteRight = $propertyMetadata->getSubResourceDeleteRight();
                        if (null !== $deleteRight) {
                            $subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath . '/{subId}';
                            $subResourceRoute = new Route($subResourceFullPath);
                            $subResourceRoute->setMethods(Request::METHOD_DELETE);
                            $subResourceRoute->setDefaults(
                                array_merge(
                                    $defaults,
                                    [
                                        '_controller'  => $controller . ':deleteSubresource',
                                        '_subresource' => $propertyMetadata->name,
                                    ]
                                )
                            );
                            $routes->add($namePrefix . '.' . $propertyMetadata->name . '.delete', $subResourceRoute);
                        }
                    }
                }
            }
        }

        return $routes;
    }

    /**
     * Taken from {@see AnnotationFileLoader}
     * TODO: Evaluate if there is a library method or extract.
     *
     * @param $file
     *
     * @return bool|string
     */
    protected function findClass($file)
    {
        $class = false;
        $namespace = false;
        $tokens = token_get_all(file_get_contents($file));
        for ($i = 0; isset($tokens[$i]); ++$i) {
            $token = $tokens[$i];

            if (!isset($token[1])) {
                continue;
            }

            if (true === $class && T_STRING === $token[0]) {
                return $namespace . '\\' . $token[1];
            }

            if (true === $namespace && T_STRING === $token[0]) {
                $namespace = $token[1];
                while (isset($tokens[++$i][1]) && in_array($tokens[$i][0], array(T_NS_SEPARATOR, T_STRING))) {
                    $namespace .= $tokens[$i][1];
                }
                $token = $tokens[$i];
            }

            if (T_CLASS === $token[0]) {
                $class = true;
            }

            if (T_NAMESPACE === $token[0]) {
                $namespace = true;
            }
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function supports($resource, $type = null)
    {
        return 'ddr_rest' === $type;
    }

    /**
     * @param ClassMetadata $classMetadata
     *
     * @return string
     */
    private function getNamePrefix(ClassMetadata $classMetadata)
    {
        if (null !== $classMetadata->getNamePrefix()) {
            return $classMetadata->getNamePrefix();
        }

        return Inflector::tableize($classMetadata->reflection->getShortName());
    }

    /**
     * @param ClassMetadata $classMetadata
     *
     * @return string
     */
    private function getPathPrefix(ClassMetadata $classMetadata)
    {
        if (null !== $classMetadata->getPathPrefix()) {
            return $classMetadata->getPathPrefix();
        }

        return Inflector::pluralize(strtolower($classMetadata->reflection->getShortName()));
    }

    /**
     * @param ClassMetadata $classMetadata
     *
     * @return string
     */
    protected function getController(ClassMetadata $classMetadata)
    {
        $controller = 'DdrRestBundle:RestResource';
        if (null !== $classMetadata->getController()) {
            $controller = $classMetadata->getController();
        }

        return $controller;
    }
}


1		<?php
2
3		namespace Dontdrinkandroot\RestBundle\Routing;
4
5		use Doctrine\Common\Util\Inflector;
6		use Dontdrinkandroot\RestBundle\Metadata\ClassMetadata;
7		use Dontdrinkandroot\RestBundle\Metadata\PropertyMetadata;
8		use Metadata\MetadataFactoryInterface;
9		use Symfony\Component\Config\FileLocatorInterface;
10		use Symfony\Component\Config\Loader\Loader;
11		use Symfony\Component\Finder\Finder;
12		use Symfony\Component\Finder\SplFileInfo;
13		use Symfony\Component\HttpFoundation\Request;
14		use Symfony\Component\Routing\Route;
15		use Symfony\Component\Routing\RouteCollection;
16
17		class RestResourceLoader extends Loader
18		{
19		/**
20		* @var FileLocatorInterface
21		*/
22		private $fileLocator;
23
24		/**
25		* @var MetadataFactoryInterface
26		*/
27		private $metadataFactory;
28
29	4	public function __construct(FileLocatorInterface $fileLocator, MetadataFactoryInterface $metadataFactory)
30		{
31	4	$this->fileLocator = $fileLocator;
32	4	$this->metadataFactory = $metadataFactory;
33	4	}
34
35		/**
36		* {@inheritdoc}
37		*/
38	4	public function load($resource, $type = null)
39		{
40	4	$locatedResource = $this->fileLocator->locate($resource);
41	4	$files = [];
42	4	if (is_dir($locatedResource)) {
43	2	$finder = new Finder();
44	2	foreach ($finder->in($locatedResource)->name('*.php')->files() as $file) {
45		/** @var SplFileInfo $file */
46	2	$files[] = $file->getRealPath();
47		}
48		} else {
49	2	$files[] = $locatedResource;
50		}
51
52	4	$routes = new RouteCollection();
53	4	foreach ($files as $file) {
54	4	$class = $this->findClass($file);
55	4	if (false === $class) {
56		throw new \Exception(sprintf('Couldn\'t find class for %s', $file));
57		}
58		/** @var ClassMetadata $classMetadata */
59	4	$classMetadata = $this->metadataFactory->getMetadataForClass($class);
60	4	if ($classMetadata->isRestResource()) {
61
62	4	$methods = $classMetadata->getMethods();
63	4	$namePrefix = $this->getNamePrefix($classMetadata);
64	4	$pathPrefix = $this->getPathPrefix($classMetadata);
65	4	$controller = $this->getController($classMetadata);
66
67		$defaults = [
68	4	'_entityClass' => $class,
69	4	'_format' => 'json'
70		];
71
72	4	if (null !== $classMetadata->getService()) {
73	2	$defaults['_service'] = $classMetadata->getService();
74		}
75
76	4	if (in_array('LIST', $methods)) {
77	4	$listRoute = new Route($pathPrefix);
78	4	$listRoute->setMethods(Request::METHOD_GET);
79	4	$listRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':list']));
80	4	$routes->add($namePrefix . '.list', $listRoute);
81		}
82
83	4	if (in_array('POST', $methods)) {
84	4	$postRoute = new Route($pathPrefix);
85	4	$postRoute->setMethods(Request::METHOD_POST);
86	4	$postRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':post']));
87	4	$routes->add($namePrefix . '.post', $postRoute);
88		}
89
90	4	if (in_array('GET', $methods)) {
91	4	$getRoute = new Route($pathPrefix . '/{id}');
92	4	$getRoute->setMethods(Request::METHOD_GET);
93	4	$getRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':get']));
94	4	$routes->add($namePrefix . '.get', $getRoute);
95		}
96
97	4	if (in_array('PUT', $methods)) {
98	4	$putRoute = new Route($pathPrefix . '/{id}');
99	4	$putRoute->setMethods(Request::METHOD_PUT);
100	4	$putRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':put']));
101	4	$routes->add($namePrefix . '.put', $putRoute);
102		}
103
104	4	if (in_array('DELETE', $methods)) {
105	4	$deleteRoute = new Route($pathPrefix . '/{id}');
106	4	$deleteRoute->setMethods(Request::METHOD_DELETE);
107	4	$deleteRoute->setDefaults(array_merge($defaults, ['_controller' => $controller . ':delete']));
108	4	$routes->add($namePrefix . '.delete', $deleteRoute);
109		}
110
111		/** @var PropertyMetadata $propertyMetadata */
112	4	foreach ($classMetadata->propertyMetadata as $propertyMetadata) {
113	4	if ($propertyMetadata->isSubResource()) {
114	2	$subResourcePath = strtolower($propertyMetadata->name);
115	2	if (null !== $propertyMetadata->getSubResourcePath()) {
116		$subResourcePath = $propertyMetadata->getSubResourcePath();
117		}
118	2	$subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath;
119	2	$subResourceRoute = new Route($subResourceFullPath);
120	2	$subResourceRoute->setMethods(Request::METHOD_GET);
121	2	$subResourceRoute->setDefaults(
122		array_merge(
123		$defaults,
124		[
125	2	'_controller' => $controller . ':listSubresource',
126	2	'_subresource' => $propertyMetadata->name,
127		]
128		)
129		);
130	2	$routes->add($namePrefix . '.' . $propertyMetadata->name . '.list', $subResourceRoute);
131
132	2	$postRight = $propertyMetadata->getSubResourcePostRight();
133	2	if (null !== $postRight) {
134	2	$subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath;
135	2	$subResourceRoute = new Route($subResourceFullPath);
136	2	$subResourceRoute->setMethods(Request::METHOD_POST);
137	2	$subResourceRoute->setDefaults(
138		array_merge(
139		$defaults,
140		[
141	2	'_controller' => $controller . ':postSubresource',
142	2	'_subresource' => $propertyMetadata->name,
143		]
144		)
145		);
146	2	$routes->add($namePrefix . '.' . $propertyMetadata->name . '.post', $subResourceRoute);
147		}
148
149	2	$putRight = $propertyMetadata->getSubResourcePutRight();
150	2	if (null !== $putRight) {
151	2	$subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath . '/{subId}';
152	2	$subResourceRoute = new Route($subResourceFullPath);
153	2	$subResourceRoute->setMethods(Request::METHOD_PUT);
154	2	$subResourceRoute->setDefaults(
155		array_merge(
156		$defaults,
157		[
158	2	'_controller' => $controller . ':putSubresource',
159	2	'_subresource' => $propertyMetadata->name,
160		]
161		)
162		);
163	2	$routes->add($namePrefix . '.' . $propertyMetadata->name . '.put', $subResourceRoute);
164		}
165
166	2	$deleteRight = $propertyMetadata->getSubResourceDeleteRight();
167	2	if (null !== $deleteRight) {
168	2	$subResourceFullPath = $pathPrefix . '/{id}/' . $subResourcePath . '/{subId}';
169	2	$subResourceRoute = new Route($subResourceFullPath);
170	2	$subResourceRoute->setMethods(Request::METHOD_DELETE);
171	2	$subResourceRoute->setDefaults(
172		array_merge(
173		$defaults,
174		[
175	2	'_controller' => $controller . ':deleteSubresource',
176	2	'_subresource' => $propertyMetadata->name,
177		]
178		)
179		);
180	4	$routes->add($namePrefix . '.' . $propertyMetadata->name . '.delete', $subResourceRoute);
181		}
182		}
183		}
184		}
185		}
186
187	4	return $routes;
188		}
189
190		/**
191		* Taken from {@see AnnotationFileLoader}
192		* TODO: Evaluate if there is a library method or extract.
193		*
194		* @param $file
195		*
196		* @return bool\|string
197		*/
198	4	protected function findClass($file)
199		{
200	4	$class = false;
201	4	$namespace = false;
202	4	$tokens = token_get_all(file_get_contents($file));
203	4	for ($i = 0; isset($tokens[$i]); ++$i) {
204	4	$token = $tokens[$i];
205
206	4	if (!isset($token[1])) {
207	4	continue;
208		}
209
210	4	if (true === $class && T_STRING === $token[0]) {
211	4	return $namespace . '\\' . $token[1];
212		}
213
214	4	if (true === $namespace && T_STRING === $token[0]) {
215	4	$namespace = $token[1];
216	4	while (isset($tokens[++$i][1]) && in_array($tokens[$i][0], array(T_NS_SEPARATOR, T_STRING))) {
217	4	$namespace .= $tokens[$i][1];
218		}
219	4	$token = $tokens[$i];
220		}
221
222	4	if (T_CLASS === $token[0]) {
223	4	$class = true;
224		}
225
226	4	if (T_NAMESPACE === $token[0]) {
227	4	$namespace = true;
228		}
229		}
230
231		return false;
232		}
233
234		/**
235		* {@inheritdoc}
236		*/
237	4	public function supports($resource, $type = null)
238		{
239	4	return 'ddr_rest' === $type;
240		}
241
242		/**
243		* @param ClassMetadata $classMetadata
244		*
245		* @return string
246		*/
247	4	private function getNamePrefix(ClassMetadata $classMetadata)
248		{
249	4	if (null !== $classMetadata->getNamePrefix()) {
250		return $classMetadata->getNamePrefix();
251		}
252
253	4	return Inflector::tableize($classMetadata->reflection->getShortName());
254		}
255
256		/**
257		* @param ClassMetadata $classMetadata
258		*
259		* @return string
260		*/
261	4	private function getPathPrefix(ClassMetadata $classMetadata)
262		{
263	4	if (null !== $classMetadata->getPathPrefix()) {
264	2	return $classMetadata->getPathPrefix();
265		}
266
267	4	return Inflector::pluralize(strtolower($classMetadata->reflection->getShortName()));
268		}
269
270		/**
271		* @param ClassMetadata $classMetadata
272		*
273		* @return string
274		*/
275	4	protected function getController(ClassMetadata $classMetadata)
276		{
277	4	$controller = 'DdrRestBundle:RestResource';
278	4	if (null !== $classMetadata->getController()) {
279		$controller = $classMetadata->getController();
280		}
281
282	4	return $controller;
283		}
284		}
285

dontdrinkandroot / rest-bundle.php

Push — standalone ( 8da518...787e4c )

RestResourceLoader::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like