Add support for array generics as required by PHPStan.

Author: fa-dis

custom-standards/Flyeralarm/Sniffs/Docblock/ReturnTypeSniff.php

@@ -58,22 +58,13 @@ public function process(File $phpcsFile, $stackPtr)
         $tokens = $phpcsFile->getTokens();
         $returnTypePtr = $this->getDocReturnTypePtr($phpcsFile, $stackPtr);
         $returnTypeString = $tokens[$returnTypePtr]['content'];
-        $returnTypes = explode('|', $returnTypeString);
-
-        foreach ($returnTypes as $returnType) {
-            $returnType = trim($returnType);
-            if (in_array($returnType, $this->returnTypeScalarWhitelist, true)) {
-                continue;
-            }
-            if (in_array($returnType, $this->returnTypeClassWhitelist, true)) {
-                continue;
-            }
-            if ($this->isStartingWithUppercaseLetter($returnType)) {
-                continue;
-            }
 
+        try {
+            $this->checkReturnTypeShape($returnTypeString);
+        }
+        catch (\InvalidArgumentException $exception) {
             $phpcsFile->addError(
-                sprintf('Return type "%s" is discouraged', $returnType),
+                $exception->getMessage(),
                 $returnTypePtr,
                 'ProhibitedReturnType'
             );
@@ -145,4 +136,50 @@ private function isStartingWithUppercaseLetter($singleCharacter)
 
         return false;
     }
+
+    /**
+     * @param string $subject The return type string to check.
+     * @return void
+     */
+    private function checkReturnTypeShape(string $subject)
+    {
+        preg_match_all('#(?<separator>\s*\|\s*)?(?<atom>[^<>\|]+)(?<generic><(?<nested>.*)>)?#', $subject, $matches);
+
+        if (implode('', $matches[0]) !== $subject) {
+            throw new \InvalidArgumentException('Invalid structure in return type "' . $subject . '"');
+        }
+
+        if (strpos($matches['separator'][0], '|') !== false) {
+            throw new \InvalidArgumentException('Missing return type in first alternative of type "' . $subject . '"');
+        }
+
+        foreach ($matches['nested'] as $index => $match) {
+            if (!empty($matches['generic'][$index])) {
+                if (trim($matches['atom'][$index]) !== 'array') {
+                    throw new \InvalidArgumentException('Unexpected generic specification in type "' . $matches[0][$index] . '"');
+                }
+
+                $match = trim($match);
+                if ($match === '') {
+                    throw new \InvalidArgumentException('Generic specification may not be empty in type "' . $matches[0][$index] . '"');
+                }
+
+                $this->checkReturnTypeShape($match);
+            }
+
+            // Check if atom is in whitelist.
+            $returnType = trim($matches['atom'][$index]);
+            if (in_array($returnType, $this->returnTypeScalarWhitelist, true)) {
+                continue;
+            }
+            if (in_array($returnType, $this->returnTypeClassWhitelist, true)) {
+                continue;
+            }
+            if ($this->isStartingWithUppercaseLetter($returnType)) {
+                continue;
+            }
+
+            throw new \InvalidArgumentException('Return type "' . $returnType . '" is discouraged');
+        }
+    }
 }

tests/rules/doc/allowed/ReturnTypeArrayGenerics.php

@@ -0,0 +1,50 @@
+<?php
+
+// @expectedPass
+
+namespace flyeralarm\Test;
+
+class FooTest
+{
+    /**
+     * @return array
+     */
+    public function testArray()
+    {
+    }
+
+    /**
+     * @return array<string>
+     */
+    public function testWithGeneric()
+    {
+    }
+
+    /**
+     * @return array<string | int>
+     */
+    public function testWithAlternativeInside()
+    {
+    }
+
+    /**
+     * @return int | array<array<string>>
+     */
+    public function testWithAlternativeOutside()
+    {
+    }
+
+    /**
+     * @return array<array<string>> | null
+     */
+    public function testWithAlternativeAtTheEnd()
+    {
+    }
+
+    /**
+     * @return int | array<string | array<string>>
+     */
+    public function testWithMultipleAlternatives()
+    {
+    }
+}

tests/rules/doc/not-allowed/EmptyAlternativeInReturnTypeInDocComment.php

@@ -0,0 +1,14 @@
+<?php
+
+// @expectedError Missing return type in first alternative of type "| string"
+
+class EmptyAlternativeInReturnTypeInDocComment
+{
+    /**
+     * @return | string
+     */
+    public function foo()
+    {
+        return true;
+    }
+}

tests/rules/doc/not-allowed/EmptyGenericReturnTypeInDocComment.php

@@ -0,0 +1,14 @@
+<?php
+
+// @expectedError Generic specification may not be empty in type "array<>"
+
+class EmptyGenericReturnTypeInDocComment
+{
+    /**
+     * @return array<>
+     */
+    public function foo()
+    {
+        return true;
+    }
+}

tests/rules/doc/not-allowed/InvalidStructureInReturnTypeInDocComment.php

@@ -0,0 +1,14 @@
+<?php
+
+// @expectedError Invalid structure in return type "array<int"
+
+class InvalidStructureInReturnTypeInDocComment
+{
+    /**
+     * @return array<int
+     */
+    public function foo()
+    {
+        return true;
+    }
+}

tests/rules/doc/not-allowed/MissingAlternativeSeparatorInReturnTypeInDocComment.php

@@ -0,0 +1,14 @@
+<?php
+
+// @expectedError Return type "array int" is discouraged
+
+class MissingAlternativeSeparatorInReturnTypeInDocComment
+{
+    /**
+     * @return array int
+     */
+    public function foo()
+    {
+        return true;
+    }
+}

tests/rules/doc/not-allowed/UnknownGenericReturnTypeInDocComment.php

@@ -0,0 +1,14 @@
+<?php
+
+// @expectedError Unexpected generic specification in type "int<array>"
+
+class UnknownGenericReturnTypeInDocComment
+{
+    /**
+     * @return int<array>
+     */
+    public function foo()
+    {
+        return true;
+    }
+}

tests/rules/doc/not-allowed/UnknownGenericSubReturnTypeInDocComment.php

@@ -0,0 +1,14 @@
+<?php
+
+// @expectedError Return type "foo" is discouraged
+
+class UnknownGenericSubReturnTypeInDocComment
+{
+    /**
+     * @return array<foo>
+     */
+    public function foo()
+    {
+        return true;
+    }
+}