Merge pull request #1 from fruitcake/phpstan-level6

Bump to Phpstan level6

Author: barryvdh

composer.json

@@ -32,7 +32,7 @@
     },
     "scripts": {
         "test": "phpunit",
-        "analyse": "phpstan analyse src tests --level=4",
+        "analyse": "phpstan analyse src tests --level=6",
         "check-style": "phpcs -p --standard=PSR12 --exclude=Generic.Files.LineLength --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests",
         "fix-style": "phpcbf -p --standard=PSR12 --exclude=Generic.Files.LineLength --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests"
     },

src/CorsService.php

@@ -16,15 +16,51 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * @phpstan-type CorsInputOptions array{
+ *  'allowedOrigins'?: array{string}|array{},
+ *  'allowedOriginsPatterns'?: array{string}|array{},
+ *  'supportsCredentials'?: bool,
+ *  'allowedHeaders'?: array{string}|array{},
+ *  'allowedMethods'?: array{string}|array{},
+ *  'exposedHeaders'?: array{string}|array{},
+ *  'maxAge'?: int|bool|null,
+ *  'allowed_origins'?: array{string}|array{},
+ *  'allowed_origins_patterns'?: array{string}|array{},
+ *  'supports_credentials'?: bool,
+ *  'allowed_headers'?: array{string}|array{},
+ *  'allowed_methods'?: array{string}|array{},
+ *  'exposed_headers'?: array{string}|array{},
+ *  'max_age'?: int|bool|null
+ * }
+ *
+ * @phpstan-type CorsNormalizedOptions array{
+ *  'allowedOrigins': array{string}|array{}|true,
+ *  'allowedOriginsPatterns': array{string}|array{},
+ *  'supportsCredentials': bool,
+ *  'allowedHeaders': array{string}|array{}|bool,
+ *  'allowedMethods': array{string}|array{}|bool,
+ *  'exposedHeaders': array{string}|array{},
+ *  'maxAge': int|bool|null
+ * }
+ */
 class CorsService
 {
+    /** @var CorsNormalizedOptions */
     private $options;
 
+    /**
+     * @param CorsInputOptions $options
+     */
     public function __construct(array $options = [])
     {
         $this->options = $this->normalizeOptions($options);
     }
 
+    /**
+     * @param CorsInputOptions $options
+     * @return CorsNormalizedOptions
+     */
     private function normalizeOptions(array $options = []): array
     {
         $aliases = [
@@ -191,7 +227,7 @@ public function addActualRequestHeaders(Response $response, Request $request): R
         return $response;
     }
 
-    private function configureAllowedOrigin(Response $response, Request $request)
+    private function configureAllowedOrigin(Response $response, Request $request): void
     {
         if ($this->options['allowedOrigins'] === true && !$this->options['supportsCredentials']) {
             // Safe+cacheable, allow everything
@@ -211,14 +247,14 @@ private function configureAllowedOrigin(Response $response, Request $request)
 
     private function isSingleOriginAllowed(): bool
     {
-        if ($this->options['allowedOrigins'] === true || !empty($this->options['allowedOriginsPatterns'])) {
+        if ($this->options['allowedOrigins'] === true || count($this->options['allowedOriginsPatterns']) > 0) {
             return false;
         }
 
         return count($this->options['allowedOrigins']) === 1;
     }
 
-    private function configureAllowedMethods(Response $response, Request $request)
+    private function configureAllowedMethods(Response $response, Request $request): void
     {
         if ($this->options['allowedMethods'] === true) {
             $allowMethods = strtoupper($request->headers->get('Access-Control-Request-Method'));
@@ -230,7 +266,7 @@ private function configureAllowedMethods(Response $response, Request $request)
         $response->headers->set('Access-Control-Allow-Methods', $allowMethods);
     }
 
-    private function configureAllowedHeaders(Response $response, Request $request)
+    private function configureAllowedHeaders(Response $response, Request $request): void
     {
         if ($this->options['allowedHeaders'] === true) {
             $allowHeaders = $request->headers->get('Access-Control-Request-Headers');
@@ -241,28 +277,28 @@ private function configureAllowedHeaders(Response $response, Request $request)
         $response->headers->set('Access-Control-Allow-Headers', $allowHeaders);
     }
 
-    private function configureAllowCredentials(Response $response, Request $request)
+    private function configureAllowCredentials(Response $response, Request $request): void
     {
         if ($this->options['supportsCredentials']) {
             $response->headers->set('Access-Control-Allow-Credentials', 'true');
         }
     }
 
-    private function configureExposedHeaders(Response $response, Request $request)
+    private function configureExposedHeaders(Response $response, Request $request): void
     {
         if ($this->options['exposedHeaders']) {
             $response->headers->set('Access-Control-Expose-Headers', implode(', ', $this->options['exposedHeaders']));
         }
     }
 
-    private function configureMaxAge(Response $response, Request $request)
+    private function configureMaxAge(Response $response, Request $request): void
     {
         if ($this->options['maxAge'] !== null) {
-            $response->headers->set('Access-Control-Max-Age', (int) $this->options['maxAge']);
+            $response->headers->set('Access-Control-Max-Age', (string) $this->options['maxAge']);
         }
     }
 
-    public function varyHeader(Response $response, $header): Response
+    public function varyHeader(Response $response, string $header): Response
     {
         if (!$response->headers->has('Vary')) {
             $response->headers->set('Vary', $header);

tests/CorsServiceTest.php

@@ -21,7 +21,7 @@ class CorsServiceTest extends TestCase
     /**
      * @test
      */
-    public function itCanHaveOptions()
+    public function itCanHaveOptions(): void
     {
         $service = new CorsService([
             'allowedOrigins' => ['localhost']
@@ -34,7 +34,7 @@ public function itCanHaveOptions()
     /**
      * @test
      */
-    public function itCanHaveNoOptions()
+    public function itCanHaveNoOptions(): void
     {
         $service = new CorsService();
         $this->assertInstanceOf(CorsService::class, $service);
@@ -44,7 +44,7 @@ public function itCanHaveNoOptions()
     /**
      * @test
      */
-    public function itCanHaveEmptyOptions()
+    public function itCanHaveEmptyOptions(): void
     {
         $service = new CorsService([]);
         $this->assertInstanceOf(CorsService::class, $service);
@@ -54,27 +54,29 @@ public function itCanHaveEmptyOptions()
     /**
      * @test
      */
-    public function itThrowsExceptionOnInvalidExposedHeaders()
+    public function itThrowsExceptionOnInvalidExposedHeaders(): void
     {
         $this->expectException(InvalidOptionException::class);
 
+        /** @phpstan-ignore-next-line */
         $service = new CorsService(['exposedHeaders' => true]);
     }
 
     /**
      * @test
      */
-    public function itThrowsExceptionOnInvalidOriginsArray()
+    public function itThrowsExceptionOnInvalidOriginsArray(): void
     {
         $this->expectException(InvalidOptionException::class);
 
+        /** @phpstan-ignore-next-line */
         $service = new CorsService(['allowedOrigins' => 'string']);
     }
 
     /**
      * @test
      */
-    public function itNormalizesWildcardOrigins()
+    public function itNormalizesWildcardOrigins(): void
     {
         $origins = ['*'];
 
@@ -87,7 +89,7 @@ public function itNormalizesWildcardOrigins()
     /**
      * @test
      */
-    public function itConvertsWildcardOriginPatterns()
+    public function itConvertsWildcardOriginPatterns(): void
     {
         $service = new CorsService(['allowedOrigins' => ['*.mydomain.com']]);
         $this->assertInstanceOf(CorsService::class, $service);
@@ -99,7 +101,7 @@ public function itConvertsWildcardOriginPatterns()
     /**
      * @test
      */
-    public function itNormalizesUnderscoreOptions()
+    public function itNormalizesUnderscoreOptions(): void
     {
         $origins = ['localhost'];
 
@@ -109,7 +111,11 @@ public function itNormalizesUnderscoreOptions()
         $this->assertEquals($origins, $this->getOptionsFromService($service)['allowedOrigins']);
     }
 
-    private function getOptionsFromService(CorsService $service)
+    /**
+     * @param CorsService $service
+     * @return array<mixed>
+     */
+    private function getOptionsFromService(CorsService $service): array
     {
         $reflected = new \ReflectionClass($service);