refactor: PHPStan bump to level 6 (#2259)

* PHPStan bump to level 6 * set checkGenericClassInNonGenericObjectType: false * PHPStan level 6 typehints (src) * add void return type to tests * rewrite dataProviders to return Generator * exclude more test fixtures * PHPStan level 6 (tests) * Apply suggestions from code review Co-authored-by: Dominic Luidold <DominicLuidold@users.noreply.github.com> * fix breaking changes to RenderOpenApi class --------- Co-authored-by: Dominic Luidold <DominicLuidold@users.noreply.github.com>
nelmio · Apr 15, 2024 · 38682dd · 38682dd
1 parent 4b40eec
commit 38682dd
Show file tree

Hide file tree

Showing 95 changed files with 1,266 additions and 875 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,5 +1,20 @@
 parameters:
 	ignoreErrors:
+		-
+			message: "#^Property Nelmio\\\\ApiDocBundle\\\\Annotation\\\\Model\\:\\:\\$_required type has no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Annotation/Model.php
+
+		-
+			message: "#^Property Nelmio\\\\ApiDocBundle\\\\Annotation\\\\Security\\:\\:\\$_required type has no value type specified in iterable type array\\.$#"
+			count: 1
+			path: src/Annotation/Security.php
+
+		-
+			message: "#^Only booleans are allowed in an if condition, mixed given\\.$#"
+			count: 1
+			path: src/Describer/ExternalDocDescriber.php
+
 		-
 			message: "#^Method Nelmio\\\\ApiDocBundle\\\\PropertyDescriber\\\\PropertyDescriberInterface\\:\\:describe\\(\\) invoked with 5 parameters, 2\\-3 required\\.$#"
 			count: 1
@@ -50,6 +65,11 @@ parameters:
 			count: 1
 			path: src/Render/Html/HtmlOpenApiRenderer.php
 
+		-
+			message: "#^Parameter \\$twig of method Nelmio\\\\ApiDocBundle\\\\Render\\\\Html\\\\HtmlOpenApiRenderer\\:\\:__construct\\(\\) has invalid type Twig_Environment\\.$#"
+			count: 1
+			path: src/Render/Html/HtmlOpenApiRenderer.php
+
 		-
 			message: "#^Property Nelmio\\\\ApiDocBundle\\\\Render\\\\Html\\\\HtmlOpenApiRenderer\\:\\:\\$twig has unknown class Twig_Environment as its type\\.$#"
 			count: 1

diff --git a/phpstan.dist.neon b/phpstan.dist.neon
@@ -7,14 +7,15 @@ includes:
     - vendor/phpstan/phpstan-strict-rules/rules.neon
 
 parameters:
-    level: 5
+    level: 6
     paths:
         - src
         - tests
     excludePaths:
         - tests/Functional/Entity/*
         - tests/Functional/EntityExcluded/*
         - tests/Functional/Controller/*
+        - tests/ModelDescriber/Annotations/Fixture/*
     dynamicConstantNames:
         - Symfony\Component\HttpKernel\Kernel::VERSION
         - Symfony\Component\HttpKernel\Kernel::VERSION_ID
@@ -28,3 +29,6 @@ parameters:
     universalObjectCratesClasses:
         - OpenApi\Context
     treatPhpDocTypesAsCertain: false
+    checkGenericClassInNonGenericObjectType: false
+    ignoreErrors:
+        - '#^Property class@anonymous/tests/.* has no type specified.$#'
diff --git a/src/Annotation/Areas.php b/src/Annotation/Areas.php
@@ -18,7 +18,7 @@
 final class Areas
 {
     /** @var string[] */
-    private $areas;
+    private array $areas;
 
     /**
      * @param string[]|array{value: string[]} $properties

diff --git a/src/Annotation/Model.php b/src/Annotation/Model.php
@@ -33,25 +33,22 @@ final class Model extends Attachable
         Parameter::class,
     ];
 
-    /**
-     * @var string
-     */
-    public $type;
+    public string $type;
 
     /**
-     * @var string[]
+     * @var string[]|null
      */
-    public $groups;
+    public ?array $groups;
 
     /**
-     * @var mixed[]
+     * @var mixed[]|null
      */
-    public $options;
+    public ?array $options;
 
     /**
      * @var array<string, mixed>
      */
-    public $serializationContext;
+    public array $serializationContext;
 
     /**
      * @param mixed[]              $properties

diff --git a/src/Annotation/Security.php b/src/Annotation/Security.php
@@ -26,16 +26,17 @@ class Security extends AbstractAnnotation
 
     public static $_required = ['name'];
 
-    /**
-     * @var string
-     */
-    public $name;
+    public ?string $name;
 
     /**
      * @var string[]
      */
-    public $scopes = [];
+    public array $scopes = [];
 
+    /**
+     * @param array<string, mixed> $properties
+     * @param string[]             $scopes
+     */
     public function __construct(
         array $properties = [],
         ?string $name = null,

diff --git a/src/ApiDocGenerator.php b/src/ApiDocGenerator.php
@@ -69,17 +69,23 @@ public function __construct($describers, $modelDescribers, ?CacheItemPoolInterfa
         $this->generator = $generator ?? new Generator($this->logger);
     }
 
-    public function setAlternativeNames(array $alternativeNames)
+    /**
+     * @param string[] $alternativeNames
+     */
+    public function setAlternativeNames(array $alternativeNames): void
     {
         $this->alternativeNames = $alternativeNames;
     }
 
-    public function setMediaTypes(array $mediaTypes)
+    /**
+     * @param string[] $mediaTypes
+     */
+    public function setMediaTypes(array $mediaTypes): void
     {
         $this->mediaTypes = $mediaTypes;
     }
 
-    public function setOpenApiVersion(?string $openApiVersion)
+    public function setOpenApiVersion(?string $openApiVersion): void
     {
         $this->openApiVersion = $openApiVersion;
     }

diff --git a/src/Command/DumpCommand.php b/src/Command/DumpCommand.php
@@ -20,10 +20,7 @@
 
 class DumpCommand extends Command
 {
-    /**
-     * @var RenderOpenApi
-     */
-    private $renderOpenApi;
+    private RenderOpenApi $renderOpenApi;
 
     /**
      * @var mixed[]

diff --git a/src/Controller/DocumentationController.php b/src/Controller/DocumentationController.php
@@ -19,17 +19,14 @@
 
 final class DocumentationController
 {
-    /**
-     * @var RenderOpenApi
-     */
-    private $renderOpenApi;
+    private RenderOpenApi $renderOpenApi;
 
     public function __construct(RenderOpenApi $renderOpenApi)
     {
         $this->renderOpenApi = $renderOpenApi;
     }
 
-    public function __invoke(Request $request, $area = 'default')
+    public function __invoke(Request $request, string $area = 'default'): JsonResponse
     {
         try {
             return JsonResponse::fromJsonString(

diff --git a/src/Controller/SwaggerUiController.php b/src/Controller/SwaggerUiController.php
@@ -20,23 +20,17 @@
 
 final class SwaggerUiController
 {
-    /**
-     * @var RenderOpenApi
-     */
-    private $renderOpenApi;
+    private RenderOpenApi $renderOpenApi;
 
-    /**
-     * @var string
-     */
-    private $uiRenderer;
+    private string $uiRenderer;
 
     public function __construct(RenderOpenApi $renderOpenApi, string $uiRenderer)
     {
         $this->renderOpenApi = $renderOpenApi;
         $this->uiRenderer = $uiRenderer;
     }
 
-    public function __invoke(Request $request, $area = 'default')
+    public function __invoke(Request $request, string $area = 'default'): Response
     {
         try {
             $response = new Response(

diff --git a/src/Controller/YamlDocumentationController.php b/src/Controller/YamlDocumentationController.php
@@ -18,17 +18,14 @@
 
 final class YamlDocumentationController
 {
-    /**
-     * @var RenderOpenApi
-     */
-    private $renderOpenApi;
+    private RenderOpenApi $renderOpenApi;
 
     public function __construct(RenderOpenApi $renderOpenApi)
     {
         $this->renderOpenApi = $renderOpenApi;
     }
 
-    public function __invoke(Request $request, $area = 'default')
+    public function __invoke(Request $request, string $area = 'default'): Response
     {
         try {
             $response = new Response(

diff --git a/src/DependencyInjection/NelmioApiDocExtension.php b/src/DependencyInjection/NelmioApiDocExtension.php
@@ -281,6 +281,11 @@ public function load(array $configs, ContainerBuilder $container): void
         }
     }
 
+    /**
+     * @param array<int, mixed> $names
+     *
+     * @return array<string, mixed>
+     */
     private function findNameAliases(array $names, string $area): array
     {
         $nameAliases = array_filter($names, function (array $aliasInfo) use ($area) {

diff --git a/src/Describer/DefaultDescriber.php b/src/Describer/DefaultDescriber.php
@@ -22,7 +22,7 @@
  */
 final class DefaultDescriber implements DescriberInterface
 {
-    public function describe(OA\OpenApi $api)
+    public function describe(OA\OpenApi $api): void
     {
         // Info
         /** @var OA\Info $info */

diff --git a/src/Describer/DescriberInterface.php b/src/Describer/DescriberInterface.php
@@ -15,5 +15,8 @@
 
 interface DescriberInterface
 {
+    /**
+     * @return void
+     */
     public function describe(OpenApi $api);
 }
diff --git a/src/Describer/ExternalDocDescriber.php b/src/Describer/ExternalDocDescriber.php
@@ -16,19 +16,25 @@
 
 class ExternalDocDescriber implements DescriberInterface
 {
+    /**
+     * @var array<string, mixed>|callable
+     */
     private $externalDoc;
 
-    private $overwrite;
+    private bool $overwrite;
 
     /**
-     * @param array|callable $externalDoc
+     * @param array<string, mixed>|callable $externalDoc
      */
     public function __construct($externalDoc, bool $overwrite = false)
     {
         $this->externalDoc = $externalDoc;
         $this->overwrite = $overwrite;
     }
 
+    /**
+     * @return void
+     */
     public function describe(OA\OpenApi $api)
     {
         $externalDoc = $this->getExternalDoc();
@@ -38,6 +44,9 @@ public function describe(OA\OpenApi $api)
         }
     }
 
+    /**
+     * @return mixed The external doc
+     */
     private function getExternalDoc()
     {
         if (is_callable($this->externalDoc)) {

diff --git a/src/Describer/ModelRegistryAwareInterface.php b/src/Describer/ModelRegistryAwareInterface.php
@@ -15,5 +15,8 @@
 
 interface ModelRegistryAwareInterface
 {
+    /**
+     * @return void
+     */
     public function setModelRegistry(ModelRegistry $modelRegistry);
 }
diff --git a/src/Describer/ModelRegistryAwareTrait.php b/src/Describer/ModelRegistryAwareTrait.php
@@ -15,11 +15,11 @@
 
 trait ModelRegistryAwareTrait
 {
+    private ModelRegistry $modelRegistry;
+
     /**
-     * @var ModelRegistry
+     * @return void
      */
-    private $modelRegistry;
-
     public function setModelRegistry(ModelRegistry $modelRegistry)
     {
         $this->modelRegistry = $modelRegistry;

diff --git a/src/Describer/OpenApiPhpDescriber.php b/src/Describer/OpenApiPhpDescriber.php
@@ -31,14 +31,11 @@ final class OpenApiPhpDescriber
 {
     use SetsContextTrait;
 
-    private $routeCollection;
-    private $controllerReflector;
+    private RouteCollection $routeCollection;
+    private ControllerReflector $controllerReflector;
 
-    /**
-     * @var Reader|null
-     */
-    private $annotationReader;
-    private $logger;
+    private ?Reader $annotationReader;
+    private LoggerInterface $logger;
 
     public function __construct(RouteCollection $routeCollection, ControllerReflector $controllerReflector, ?Reader $annotationReader, LoggerInterface $logger, bool $overwrite = false)
     {
@@ -52,7 +49,7 @@ public function __construct(RouteCollection $routeCollection, ControllerReflecto
         $this->logger = $logger;
     }
 
-    public function describe(OA\OpenApi $api)
+    public function describe(OA\OpenApi $api): void
     {
         $classAnnotations = [];
 
@@ -200,6 +197,9 @@ private function getMethodsToParse(): \Generator
         }
     }
 
+    /**
+     * @return string[]
+     */
     private function getSupportedHttpMethods(Route $route): array
     {
         $allMethods = Util::OPERATIONS;
@@ -223,7 +223,7 @@ private function normalizePath(string $path): string
     }
 
     /**
-     * @param \ReflectionClass|\ReflectionMethod $reflection
+     * @param \ReflectionClass<object>|\ReflectionMethod $reflection
      *
      * @return OA\AbstractAnnotation[]
      */