add support for nikic/php-parser 5.x

pestphp · Jun 24, 2024 · 1b5421d · 1b5421d
1 parent 4b668fd
commit 1b5421d
Show file tree

Hide file tree

Showing 23 changed files with 277 additions and 51 deletions.
diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
     },
     "require": {
         "php": "^8.1",
-        "nikic/php-parser": "^4.19.1",
+        "nikic/php-parser": "^4.19.1|^v5.0.2",
         "pestphp/pest-plugin": "^v2.1.1",
         "psr/simple-cache": "^3.0"
     },

diff --git a/src/Mutation.php b/src/Mutation.php
@@ -5,10 +5,10 @@
 namespace Pest\Mutate;
 
 use Pest\Exceptions\ShouldNotHappen;
+use Pest\Mutate\Support\PhpParserFactory;
 use PhpParser\Node;
 use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\ClassMethod;
-use PhpParser\ParserFactory;
 use PhpParser\PrettyPrinter\Standard;
 use SebastianBergmann\Diff\Differ;
 use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder;
@@ -51,8 +51,12 @@ public static function create(
         $modifiedSourcePath = self::TMP_FOLDER.DIRECTORY_SEPARATOR.hash('xxh3', $modifiedSource);
         file_put_contents($modifiedSourcePath, $modifiedSource);
 
-        $orignalAst = (new ParserFactory)->create(ParserFactory::PREFER_PHP7)->parse($file->getContents());
-        $newlyRenderedOriginalSource = (new Standard())->prettyPrintFile($orignalAst); // @phpstan-ignore-line
+        $parser = PhpParserFactory::make();
+        $orignalAst = $parser->parse($file->getContents());
+
+        assert($orignalAst !== null);
+
+        $newlyRenderedOriginalSource = (new Standard())->prettyPrintFile($orignalAst);
 
         $endLine = $originalNode->getEndLine();
 

diff --git a/src/Mutators/Number/DecrementFloat.php b/src/Mutators/Number/DecrementFloat.php
@@ -7,6 +7,7 @@
 use Pest\Mutate\Mutators\Abstract\AbstractMutator;
 use PhpParser\Node;
 use PhpParser\Node\Scalar\DNumber;
+use PhpParser\Node\Scalar\Float_;
 
 class DecrementFloat extends AbstractMutator
 {
@@ -21,12 +22,15 @@ class DecrementFloat extends AbstractMutator
 
     public static function nodesToHandle(): array
     {
-        return [DNumber::class];
+        return [
+            DNumber::class,
+            Float_::class,
+        ];
     }
 
     public static function mutate(Node $node): Node
     {
-        /** @var Node\Scalar\LNumber $node */
+        /** @var Node\Scalar\LNumber|Node\Scalar\Float_ $node */
         $node->value--;
 
         return $node;

diff --git a/src/Mutators/Number/DecrementInteger.php b/src/Mutators/Number/DecrementInteger.php
@@ -7,6 +7,7 @@
 use Pest\Mutate\Mutators\Abstract\AbstractMutator;
 use PhpParser\Node;
 use PhpParser\Node\Expr\UnaryMinus;
+use PhpParser\Node\Scalar\Int_;
 use PhpParser\Node\Scalar\LNumber;
 use PhpParser\Node\Stmt\DeclareDeclare;
 
@@ -23,7 +24,10 @@ class DecrementInteger extends AbstractMutator
 
     public static function nodesToHandle(): array
     {
-        return [LNumber::class];
+        return [
+            LNumber::class,
+            Int_::class,
+        ];
     }
 
     public static function can(Node $node): bool
@@ -39,7 +43,7 @@ public static function can(Node $node): bool
 
     public static function mutate(Node $node): Node
     {
-        /** @var Node\Scalar\LNumber $node */
+        /** @var Node\Scalar\LNumber|Node\Scalar\Int_ $node */
         $node->value -= $node->getAttribute('parent') instanceof UnaryMinus ? -1 : 1;
 
         return $node;

diff --git a/src/Mutators/Number/IncrementFloat.php b/src/Mutators/Number/IncrementFloat.php
@@ -7,6 +7,7 @@
 use Pest\Mutate\Mutators\Abstract\AbstractMutator;
 use PhpParser\Node;
 use PhpParser\Node\Scalar\DNumber;
+use PhpParser\Node\Scalar\Float_;
 
 class IncrementFloat extends AbstractMutator
 {
@@ -21,12 +22,15 @@ class IncrementFloat extends AbstractMutator
 
     public static function nodesToHandle(): array
     {
-        return [DNumber::class];
+        return [
+            DNumber::class,
+            Float_::class,
+        ];
     }
 
     public static function mutate(Node $node): Node
     {
-        /** @var Node\Scalar\LNumber $node */
+        /** @var Node\Scalar\LNumber|Node\Scalar\Float_ $node */
         $node->value++;
 
         return $node;

diff --git a/src/Mutators/Number/IncrementInteger.php b/src/Mutators/Number/IncrementInteger.php
@@ -7,6 +7,7 @@
 use Pest\Mutate\Mutators\Abstract\AbstractMutator;
 use PhpParser\Node;
 use PhpParser\Node\Expr\UnaryMinus;
+use PhpParser\Node\Scalar\Int_;
 use PhpParser\Node\Scalar\LNumber;
 use PhpParser\Node\Stmt\DeclareDeclare;
 
@@ -23,7 +24,10 @@ class IncrementInteger extends AbstractMutator
 
     public static function nodesToHandle(): array
     {
-        return [LNumber::class];
+        return [
+            LNumber::class,
+            Int_::class,
+        ];
     }
 
     public static function can(Node $node): bool
@@ -39,7 +43,7 @@ public static function can(Node $node): bool
 
     public static function mutate(Node $node): Node
     {
-        /** @var Node\Scalar\LNumber $node */
+        /** @var Node\Scalar\LNumber|Node\Scalar\Int_ $node */
         $node->value += $node->getAttribute('parent') instanceof UnaryMinus ? -1 : 1;
 
         return $node;

diff --git a/src/Mutators/Removal/RemoveArrayItem.php b/src/Mutators/Removal/RemoveArrayItem.php
@@ -24,7 +24,10 @@ class RemoveArrayItem extends AbstractMutator
 
     public static function nodesToHandle(): array
     {
-        return [ArrayItem::class];
+        return [
+            ArrayItem::class,
+            Node\ArrayItem::class,
+        ];
     }
 
     public static function mutate(Node $node): int

diff --git a/src/Mutators/Return/AlwaysReturnNull.php b/src/Mutators/Return/AlwaysReturnNull.php
@@ -44,7 +44,7 @@ public static function can(Node $node): bool
             return false;
         }
 
-        if ($node->expr instanceof ConstFetch && $node->expr->name->parts[0] === 'null') {
+        if ($node->expr instanceof ConstFetch && $node->expr->name->getParts()[0] === 'null') {
             return false;
         }
 

diff --git a/src/Support/MutationGenerator.php b/src/Support/MutationGenerator.php
@@ -12,7 +12,6 @@
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitorAbstract;
 use PhpParser\Parser;
-use PhpParser\ParserFactory;
 use Symfony\Component\Finder\SplFileInfo;
 
 class MutationGenerator
@@ -56,7 +55,7 @@ public function generate(
             }
         }
 
-        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $parser = PhpParserFactory::make();
 
         $mutators = $this->filterMutators($mutators, $contents, $parser);
 
@@ -82,7 +81,11 @@ public function generate(
                         trackMutation: $this->trackMutation(...),
                     ));
 
-                    $modifiedAst = $traverser->traverse($parser->parse($contents)); // @phpstan-ignore-line
+                    $stmts = $parser->parse($contents);
+
+                    assert($stmts !== null);
+
+                    $modifiedAst = $traverser->traverse($stmts);
 
                     if (! $this->hasMutated()) {
                         break;

diff --git a/src/Support/PhpParserFactory.php b/src/Support/PhpParserFactory.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Mutate\Support;
+
+use PhpParser\Parser;
+use PhpParser\ParserFactory;
+
+class PhpParserFactory
+{
+    public static function make(): Parser
+    {
+        if (self::version() === 4) {
+            return (new ParserFactory)->create(ParserFactory::PREFER_PHP7); // @phpstan-ignore-line
+        }
+
+        return (new ParserFactory)->createForNewestSupportedVersion();
+    }
+
+    public static function version(): int
+    {
+        return method_exists(ParserFactory::class, 'create') ? 4 : 5;
+    }
+}
diff --git a/....pest/snapshots/Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file.snap b/....pest/snapshots/Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file.snap
@@ -5,15 +5,15 @@ namespace Tests\Fixtures\Classes;
 
 class AgeHelper
 {
-    public static function isAdult(int $age) : bool
+    public static function isAdult(int $age): bool
     {
         return $age > 18;
     }
-    public static function isSenior(int $age) : bool
+    public static function isSenior(int $age): bool
     {
         return $age >= 65;
     }
-    public static function isImmature(int $age) : bool
+    public static function isImmature(int $age): bool
     {
         return $age < 18;
     }

diff --git a/...st/snapshots/Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file__2.snap b/...st/snapshots/Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file__2.snap
@@ -5,15 +5,15 @@ namespace Tests\Fixtures\Classes;
 
 class AgeHelper
 {
-    public static function isAdult(int $age) : bool
+    public static function isAdult(int $age): bool
     {
         return $age >= 18;
     }
-    public static function isSenior(int $age) : bool
+    public static function isSenior(int $age): bool
     {
         return $age > 65;
     }
-    public static function isImmature(int $age) : bool
+    public static function isImmature(int $age): bool
     {
         return $age < 18;
     }

diff --git a/...st/snapshots/Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file__3.snap b/...st/snapshots/Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file__3.snap
@@ -5,15 +5,15 @@ namespace Tests\Fixtures\Classes;
 
 class AgeHelper
 {
-    public static function isAdult(int $age) : bool
+    public static function isAdult(int $age): bool
     {
         return $age >= 18;
     }
-    public static function isSenior(int $age) : bool
+    public static function isSenior(int $age): bool
     {
         return $age >= 65;
     }
-    public static function isImmature(int $age) : bool
+    public static function isImmature(int $age): bool
     {
         return $age <= 18;
     }

diff --git a/.../Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file_with_v4_parser.snap b/.../Unit/MutationGeneratorTest/it_generates_mutations_for_the_given_file_with_v4_parser.snap
@@ -0,0 +1,20 @@
+<?php
+
+declare (strict_types=1);
+namespace Tests\Fixtures\Classes;
+
+class AgeHelper
+{
+    public static function isAdult(int $age) : bool
+    {
+        return $age > 18;
+    }
+    public static function isSenior(int $age) : bool
+    {
+        return $age >= 65;
+    }
+    public static function isImmature(int $age) : bool
+    {
+        return $age < 18;
+    }
+}
diff --git a/...it/MutationGeneratorTest/it_generates_mutations_for_the_given_file_with_v4_parser__2.snap b/...it/MutationGeneratorTest/it_generates_mutations_for_the_given_file_with_v4_parser__2.snap
@@ -0,0 +1,20 @@
+<?php
+
+declare (strict_types=1);
+namespace Tests\Fixtures\Classes;
+
+class AgeHelper
+{
+    public static function isAdult(int $age) : bool
+    {
+        return $age >= 18;
+    }
+    public static function isSenior(int $age) : bool
+    {
+        return $age > 65;
+    }
+    public static function isImmature(int $age) : bool
+    {
+        return $age < 18;
+    }
+}
diff --git a/...it/MutationGeneratorTest/it_generates_mutations_for_the_given_file_with_v4_parser__3.snap b/...it/MutationGeneratorTest/it_generates_mutations_for_the_given_file_with_v4_parser__3.snap
@@ -0,0 +1,20 @@
+<?php
+
+declare (strict_types=1);
+namespace Tests\Fixtures\Classes;
+
+class AgeHelper
+{
+    public static function isAdult(int $age) : bool
+    {
+        return $age >= 18;
+    }
+    public static function isSenior(int $age) : bool
+    {
+        return $age >= 65;
+    }
+    public static function isImmature(int $age) : bool
+    {
+        return $age <= 18;
+    }
+}
diff --git a/tests/Helpers.php b/tests/Helpers.php
@@ -3,14 +3,14 @@
 declare(strict_types=1);
 
 use Pest\Mutate\Factories\NodeTraverserFactory;
+use Pest\Mutate\Support\PhpParserFactory;
 use PhpParser\Node;
 use PhpParser\NodeVisitorAbstract;
-use PhpParser\ParserFactory;
 use PhpParser\PrettyPrinter\Standard;
 
 function mutateCode(string $mutator, string $code): string
 {
-    $stmts = (new ParserFactory)->create(ParserFactory::PREFER_PHP7)->parse($code);
+    $stmts = PhpParserFactory::make()->parse($code);
 
     $mutationCount = 0;