Handle more PHPStan type edge-cases (#487)

thecodingmachine · Dec 2, 2024 · a6a57ba · a6a57ba
1 parent 078219f
commit a6a57ba
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 17 deletions.
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -84,9 +84,6 @@ jobs:
       - name: "Run static code analysis with phpstan/phpstan in generator/ directory"
         run: "composer phpstan"
         working-directory: "generator"
-      - name: "Run static code analysis with rector/rector in generator/ directory"
-        run: "composer rector --dry-run"
-        working-directory: "generator"
 
   generated_tests:
     name: "Generated Tests"

diff --git a/generator/src/GenerateCommand.php b/generator/src/GenerateCommand.php
@@ -111,9 +111,9 @@ private function runCsFix(OutputInterface $output): void
         $process->setTimeout(600);
         $process->run(function ($type, $buffer) use ($output) {
             if (Process::ERR === $type) {
-                echo $output->write('<error>'.$buffer.'</error>');
+                $output->write('<error>'.$buffer.'</error>');
             } else {
-                echo $output->write($buffer);
+                $output->write($buffer);
             }
         });
     }

diff --git a/generator/src/Method.php b/generator/src/Method.php
@@ -177,7 +177,7 @@ private function removeString(string $string, string $search): string
     private function getStringForXPath(string $xpath): string
     {
         $paragraphs = $this->rootEntity->xpath($xpath);
-        if ($paragraphs === false) {
+        if ($paragraphs === false || $paragraphs === null) {
             throw new \RuntimeException('Error while performing Xpath request.');
         }
         $str = '';

diff --git a/generator/src/PhpStanFunctions/PhpStanType.php b/generator/src/PhpStanFunctions/PhpStanType.php
@@ -59,29 +59,49 @@ public function __construct(string $data, bool $writeOnly = false)
         /** @var int $count */
         $count = \count($returnTypes);
         if ($count === 0) {
-            throw new \RuntimeException('Error when trying to extract parameter type');
+            $returnType = '';
         }
         foreach ($returnTypes as &$returnType) {
             $pos = \strpos($returnType, '?');
             if ($pos !== false) {
                 $nullable = true;
                 $returnType = \str_replace('?', '', $returnType);
             }
-            //remove the parenthesis only if we are not dealing with a callable
-            if (\strpos($returnType, 'callable') === false) {
+            // remove the parenthesis only if we are not dealing with a callable
+            if (!str_contains($returnType, 'callable')) {
                 $returnType = \str_replace(['(', ')'], '', $returnType);
             }
-            //here we deal with some weird phpstan typings
-            if ($returnType === 'non-empty-string') {
+
+            // here we deal with some weird phpstan typings
+            if (str_contains($returnType, 'non-falsy-string')) {
                 $returnType = 'string';
-            } elseif ($returnType === 'positive-int') {
+            }
+
+            if (str_contains($returnType, 'non-empty-string')) {
+                $returnType = 'string';
+            }
+
+            if (str_contains($returnType, '__stringAndStringable')) {
+                $returnType = 'string';
+            }
+
+            if ($returnType === 'positive-int') {
                 $returnType = 'int';
             } elseif (is_numeric($returnType)) {
                 $returnType = 'int';
             }
-            if (\strpos($returnType, 'list<') !== false) {
+            if (str_contains($returnType, 'list<')) {
                 $returnType = \str_replace('list', 'array', $returnType);
             }
+
+            if (str_contains($returnType, 'int<')) {
+                $returnType = 'int';
+            }
+
+            if (\preg_match('/__benevolent\<(.*)\>/', $returnType, $regs)) {
+                $returnType = $regs[1];
+            }
+
             $returnType = Type::toRootNamespace($returnType);
         }
         $this->types = array_unique($returnTypes);
@@ -114,7 +134,7 @@ public function getSignatureType(?int $errorType = null): string
         $falsable = $errorType === Method::FALSY_TYPE ? false : $this->falsable;
         $types = $this->types;
         //no typehint exists for thoses cases
-        if (\array_intersect(self::NO_SIGNATURE_TYPES, $types)) {
+        if (\array_intersect(self::NO_SIGNATURE_TYPES, $types) !== []) {
             return '';
         }
 
@@ -135,12 +155,14 @@ public function getSignatureType(?int $errorType = null): string
         //if there are several distinct types, no typehint (we use distinct in case doc block contains several times the same type, for example array<int>|array<string>)
         if (count(array_unique($types)) > 1) {
             return '';
-        } elseif (\in_array('void', $types) || (count($types) === 0 && !$nullable && !$falsable)) {
+        }
+
+        if (\in_array('void', $types) || ($types === [] && !$nullable && !$falsable)) {
             return 'void';
         }
 
 
-        $finalType = $types[0];
+        $finalType = $types[0] ?? '';
         if ($finalType === 'bool' && !$nullable && $errorType === Method::FALSY_TYPE) {
             // If the function only returns a boolean, since false is for error, true is for success.
             // Let's replace this with a "void".

diff --git a/generator/tests/PhpStanFunctions/PhpStanTypeTest.php b/generator/tests/PhpStanFunctions/PhpStanTypeTest.php
@@ -112,7 +112,11 @@ public function testVoid(): void
     {
         $param = new PhpStanType('');
         $this->assertEquals('', $param->getDocBlockType());
-        $this->assertEquals('', $param->getSignatureType());
+		if (PHP_VERSION_ID >= 80200) {
+        	$this->assertEquals('void', $param->getSignatureType());
+		} else {
+        	$this->assertEquals('', $param->getSignatureType());
+		}
 
         $param = new PhpStanType('void');
         $this->assertEquals('void', $param->getDocBlockType());