Spiechu\SymfonyCommonsBundle\Service\SchemaValidator\SchemaFilesExistenceChecker

Complexity

Total Complexity

15

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

75%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
C	checkControllerResponseSchemaValidatorFiles()	0	35	7
A	checkResponseSchema()	0	14	4
A	createExceptionFromCorruptedFiles()	0	10	2
A	getAnnotationReader()	0	4	1

<?php

declare(strict_types=1);

namespace Spiechu\SymfonyCommonsBundle\Service\SchemaValidator;

use Doctrine\Common\Annotations\Reader;
use Spiechu\SymfonyCommonsBundle\Annotation\Controller\ControllerAnnotationExtractorTrait;
use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException;
use Symfony\Component\Config\FileLocatorInterface;
use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
use Symfony\Component\Routing\RouterInterface;
use Spiechu\SymfonyCommonsBundle\Annotation\Controller\ResponseSchemaValidator;
use Symfony\Component\HttpFoundation\Request;

class SchemaFilesExistenceChecker
{
    use ControllerAnnotationExtractorTrait;

    /**
     * @var Reader
     */
    protected $reader;

    /**
     * @var RouterInterface
     */
    protected $router;

    /**
     * @var ControllerResolverInterface
     */
    protected $controllerResolver;

    /**
     * @var FileLocatorInterface
     */
    protected $fileLocator;

    /**
     * @param Reader $reader
     * @param RouterInterface $router
     * @param ControllerResolverInterface $controllerResolver
     * @param FileLocatorInterface $fileLocator
     */
    public function __construct(
        Reader $reader,
        RouterInterface $router,
        ControllerResolverInterface $controllerResolver,
        FileLocatorInterface $fileLocator
    ) {
        $this->reader = $reader;
        $this->router = $router;
        $this->controllerResolver = $controllerResolver;
        $this->fileLocator = $fileLocator;
    }

    /**
     * @throws \LogicException If any of controllers can't be found by controller resolver
     * @throws \RuntimeException When any of defined schema files in ResponseSchemaValidator not exist
     */
    public function checkControllerResponseSchemaValidatorFiles(): void
    {
        $corruptedFiles = [];

        foreach ($this->router->getRouteCollection()->all() as $route) {
            $controllerAttribute = $route->getDefault('_controller');
            $resolvedController = $this->controllerResolver->getController(new Request(
                [],
                [],
                [
                    '_controller' => $controllerAttribute,
                ]
            ));

            if (!\is_callable($resolvedController)) {
                continue;
            }

            $annotation = $this->getMethodAnnotationFromController($resolvedController, ResponseSchemaValidator::class);
            if (!$annotation instanceof ResponseSchemaValidator) {
                continue;
            }

            if ($checkError = $this->checkResponseSchema($annotation->getSchemas())) {
                if (!array_key_exists($routePath = $route->getPath(), $corruptedFiles)) {
                    $corruptedFiles[$routePath] = [];
                }
                $corruptedFiles[$routePath][] = $checkError;
            }
        }

        if ($corruptedFiles) {

The expression $corruptedFiles of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            throw $this->createExceptionFromCorruptedFiles($corruptedFiles);
        }
    }

    /**
     * @param array $schemas
     * @return null|string
     */
    protected function checkResponseSchema(array $schemas): ?string
    {
        foreach ($schemas as $schema) {
            foreach ($schema as $schemaLocation) {
                try {
                    $this->fileLocator->locate($schemaLocation);
                } catch (FileLocatorFileNotFoundException $e) {
                    return $schemaLocation;
                }
            }
        }

        return null;
    }

    /**
     * @param array $corruptedFiles
     * @return \RuntimeException
     */
    protected function createExceptionFromCorruptedFiles(array $corruptedFiles): \RuntimeException
    {
        $routePaths = [];

        foreach ($corruptedFiles as $routePath => $files) {
            $routePaths[] = sprintf('%s[%s]', $routePath, implode(', ', $files));
        }

        return new \RuntimeException(sprintf('Non existing response schema files set: "%s"', implode(', ', $routePaths)));
    }

    /**
     * {@inheritdoc}
     */
    protected function getAnnotationReader(): Reader
    {
        return $this->reader;
    }
}