Merge pull request #41 from kayw-geek/feature/upgrade-php-parser

Support the `nikic/php-parser` to 5.x

.gitignore

@@ -12,3 +12,4 @@ testbench.yaml
 vendor
 node_modules
 .php-cs-fixer.cache
+.phpunit.cache

composer.json

@@ -18,7 +18,7 @@
     "require": {
         "php": "^8.2",
         "illuminate/contracts": "^10.0 || ^11.0",
-        "nikic/php-parser": "^4.15",
+        "nikic/php-parser": "^4.19.1 || ^5.0.2",
         "nunomaduro/termwind": "^1.15 || ^2.0",
         "spatie/laravel-package-tools": "^1.16",
         "thecodingmachine/safe": "^2.4"

phpstan-baseline.neon

@@ -10,7 +10,3 @@ parameters:
 			count: 1
 			path: src/Commands/SyncCommand.php
 
-		-
-			message: "#^Parameter \\#1 \\$value of function strval expects bool\\|float\\|int\\|resource\\|string\\|null, mixed given\\.$#"
-			count: 1
-			path: src/Support/PhpParser/EnvCallNodeVisitor.php

phpstan.neon.dist

@@ -10,3 +10,6 @@ parameters:
     checkModelProperties: true
     parallel:
             processTimeout: 300.0
+    stubFiles:
+        - stubs/Array_.stub
+        - stubs/ArrayItem.stub

src/EnvyServiceProvider.php

@@ -45,7 +45,7 @@ public function packageRegistered(): void
         $this->app->bind(
             FindsEnvironmentCalls::class,
             fn(Application $app) => $app->make(FindEnvironmentCalls::class, [
-                'parser' => (new ParserFactory())->create(ParserFactory::PREFER_PHP7),
+                'parser' => (new ParserFactory())->createForNewestSupportedVersion(),
             ])
         );
         $this->app->bind(ReadsEnvironmentFile::class, ReadEnvironmentFile::class);
@@ -65,7 +65,7 @@ public function packageRegistered(): void
         $this->app->bind(
             AddsEnvironmentVariablesToList::class,
             fn (Application $app) => $app->make(AddEnvironmentVariablesToList::class, [
-                'parser' => (new ParserFactory())->create(ParserFactory::PREFER_PHP7),
+                'parser' => (new ParserFactory())->createForNewestSupportedVersion(),
             ])
         );
         $this->app->bind(

src/Support/PhpParser/AppendEnvironmentVariablesNodeVisitor.php

@@ -6,6 +6,7 @@
 
 use Illuminate\Support\Collection;
 use PhpParser\Node;
+use PhpParser\Node\Expr\ArrayItem;
 use PhpParser\NodeVisitorAbstract;
 use Worksome\Envy\Support\EnvironmentVariable;
 
@@ -41,7 +42,9 @@ public function leaveNode(Node $node)
         }
 
         $this->updates->each(function (EnvironmentVariable $variable) use (&$node) {
-            $node->items[] = new Node\Expr\ArrayItem(new Node\Scalar\String_($variable->getKey()));
+            $item = new ArrayItem(new Node\Scalar\String_($variable->getKey()));
+
+            $node->items[] = $item;
         });
 
         $this->variablesWereAppended = true;

src/Support/PhpParser/EnvCallNodeVisitor.php

@@ -123,14 +123,24 @@ private function getComment(Node\Expr\FuncCall $node): string|null
             return null;
         }
 
-        /** @var array<int, Comment>|null $comments */
-        $comments = $previousNode->getAttribute('comments');
+        /** @var \PhpParser\Node\Expr\ArrayItem $parent */
+        $parent = $previousNode->getAttribute('parent');
 
-        if ($comments === null || count($comments) === 0) {
-            return null;
+        if ($parent->hasAttribute('comments')) {
+            /** @var list<Comment>|null $comments */
+            $comments = $parent->getAttribute('comments');
+
+            if ($comments === null || count($comments) === 0) {
+                return null;
+            }
+
+            /** @var string $comment */
+            $comment = $comments[0]->getReformattedText();
+
+            return $comment;
         }
 
-        return strval($comments[0]->getReformattedText());
+        return null;
     }
 
     private function print(Node $node): string
@@ -148,6 +158,8 @@ private function isBoolean(Node\Expr $providedDefault): bool
             return false;
         }
 
-        return in_array($providedDefault->name->parts[0], ['true', 'false'], true);
+        $name = $providedDefault->name->name ?? $providedDefault->name->getParts()[0];
+
+        return in_array($name, ['true', 'false'], true);
     }
 }

stubs/ArrayItem.stub

@@ -0,0 +1,11 @@
+<?php
+
+declare (strict_types=1);
+
+namespace PhpParser\Node\Expr;
+
+use PhpParser\Node\Expr;
+
+class ArrayItem
+{
+}

stubs/Array_.stub

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpParser\Node\Expr;
+
+use PhpParser\Node\ArrayItem;
+
+class Array_ {
+
+    /** @var \PhpParser\Node\Expr\ArrayItem[] $items */
+    public array $items;
+}

tests/Pest.php

@@ -13,7 +13,7 @@
 
 function defaultPhpParser(): Parser
 {
-    return (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
+    return (new ParserFactory())->createForNewestSupportedVersion();
 }
 
 function readEnvironmentFile(string $filePath = null): Collection

tests/Unit/Actions/AddEnvironmentVariablesToListTest.php

@@ -30,10 +30,15 @@
 
 it('performs no changes if the parser returns null', function (string $list) {
     $parser = new class() implements Parser {
-        public function parse(string $code, ErrorHandler $errorHandler = null)
+        public function parse(string $code, ?ErrorHandler $errorHandler = null): ?array
         {
             return null;
         }
+
+        public function getTokens(): array
+        {
+            return [];
+        }
     };
 
     $action = new AddEnvironmentVariablesToList($parser, new TestFinder());

tests/Unit/Actions/FindEnvironmentCallsTest.php

@@ -88,10 +88,15 @@ function (bool $excludeVariablesWithDefaults, int $expectedCount) {
 
 it('returns an empty collection if the parser returns null', function () {
     $parser = new class() implements Parser {
-        public function parse(string $code, ErrorHandler $errorHandler = null)
+        public function parse(string $code, ?ErrorHandler $errorHandler = null): ?array
         {
             return null;
         }
+
+        public function getTokens(): array
+        {
+            return [];
+        }
     };
 
     $action = new FindEnvironmentCalls($parser);