Support php 8.4 (#447)

* adds php 8.4 to build test matrix
* runs static checks in the build matrix only on php 7.4 to avoid getting different results based on the tool and/or php version
* updates our custom NameResolver (which has the capability to parse docblocks) to latest version

Author: micheleorselli

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
+        php-versions: [ '7.4', '8.0', '8.1', '8.2', '8.3', '8.4' ]
         coverage-driver: [ 'pcov' ]
 
     steps:
@@ -43,10 +43,12 @@ jobs:
       run: composer install --prefer-dist
 
     - name: Coding Standard Checks
+      if: ${{ matrix.php-versions  == '7.4' }}
       run: PHP_CS_FIXER_IGNORE_ENV=1 ./bin/php-cs-fixer fix --dry-run -v
 
     - name: Static Analysis
-      run: ./bin/psalm.phar
+      if: ${{ matrix.php-versions  == '7.4' }}
+      run: ./bin/psalm.phar --no-cache
 
     - name: Test
       run: ./bin/phpunit -d memory_limit=-1 --coverage-clover clover.xml
@@ -58,7 +60,7 @@ jobs:
         token: ${{ secrets.CODECOV_TOKEN }}
 
   phar:
-    runs-on: "ubuntu-20.04"
+    runs-on: "ubuntu-22.04"
     needs: build
     steps:
       - uses: actions/checkout@v3
@@ -95,8 +97,7 @@ jobs:
     runs-on: "ubuntu-22.04"
     strategy:
       matrix:
-        php-versions: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
-
+        php-versions: [ '7.4', '8.0', '8.1', '8.2', '8.3', '8.4' ]
     steps:
       - name: Install PHP
         uses: shivammathur/setup-php@v2

Makefile

@@ -33,15 +33,15 @@ coverage: ## it launches coverage
 	phpdbg -qrr ./bin/phpunit --coverage-html build/coverage
 
 csfix: ## it launches cs fix
-	bin/php-cs-fixer fix -v
+	PHP_CS_FIXER_IGNORE_ENV=1 bin/php-cs-fixer fix -v
 
 psalm: ## it launches psalm
 	bin/psalm.phar
 
 build: ## it launches all the build
 	composer install
 	PHP_CS_FIXER_IGNORE_ENV=1 bin/php-cs-fixer fix -v
-	bin/psalm
+	bin/psalm.phar --no-cache
 	bin/phpunit
 
 sfbuild: ## it launches all the build

composer.json

@@ -28,7 +28,7 @@
         "symfony/event-dispatcher": "^3.0|^4.0|^5.0|^6.0|^7.0",
         "symfony/console": "^3.0|^4.0|^5.0|^6.0|^7.0",
         "symfony/polyfill-php80": "^1.20",
-        "nikic/php-parser": "~4",
+        "nikic/php-parser": "~5",
         "webmozart/assert": "^1.9",
         "ext-json": "*",
         "phpstan/phpdoc-parser": "^1.2",
@@ -60,4 +60,4 @@
     "bin": [
         "bin-stub/phparkitect"
     ]
-}
+}

src/Analyzer/FileParser.php

@@ -1,14 +1,15 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Arkitect\Analyzer;
 
 use Arkitect\CLI\TargetPhpVersion;
 use Arkitect\Rules\ParsingError;
 use PhpParser\ErrorHandler\Collecting;
-use PhpParser\Lexer\Emulative;
 use PhpParser\NodeTraverser;
 use PhpParser\ParserFactory;
+use PhpParser\PhpVersion;
 
 class FileParser implements Parser
 {
@@ -33,12 +34,7 @@ public function __construct(
         $this->fileVisitor = $fileVisitor;
         $this->parsingErrors = [];
 
-        $lexer = new Emulative([
-            'usedAttributes' => ['comments', 'startLine', 'endLine', 'startTokenPos', 'endTokenPos'],
-            'phpVersion' => $targetPhpVersion->get() ?? phpversion(),
-        ]);
-
-        $this->parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7, $lexer);
+        $this->parser = (new ParserFactory())->createForVersion(PhpVersion::fromString($targetPhpVersion->get() ?? phpversion()));
         $this->traverser = $traverser;
         $this->traverser->addVisitor($nameResolver);
         $this->traverser->addVisitor($this->fileVisitor);

src/Analyzer/NameResolver.php

@@ -27,13 +27,13 @@
 class NameResolver extends NodeVisitorAbstract
 {
     /** @var NameContext Naming context */
-    protected $nameContext;
+    protected NameContext $nameContext;
 
     /** @var bool Whether to preserve original names */
-    protected $preserveOriginalNames;
+    protected bool $preserveOriginalNames;
 
     /** @var bool Whether to replace resolved nodes in place, or to add resolvedNode attributes */
-    protected $replaceNodes;
+    protected bool $replaceNodes;
 
     /** @var bool Whether to parse DocBlock Custom Annotations */
     protected $parseCustomAnnotations;
@@ -55,8 +55,8 @@ class NameResolver extends NodeVisitorAbstract
      *    namespacedName attribute, as usual.)
      *  * parseCustomAnnotations (default true): Whether to parse DocBlock Custom Annotations.
      *
-     * @param ErrorHandler|null $errorHandler Error handler
-     * @param array             $options      Options
+     * @param ErrorHandler|null                                                                       $errorHandler Error handler
+     * @param array{preserveOriginalNames?: bool, replaceNodes?: bool, parseCustomAnnotations?: bool} $options      Options
      */
     public function __construct(?ErrorHandler $errorHandler = null, array $options = [])
     {
@@ -79,7 +79,7 @@ public function getNameContext(): NameContext
         return $this->nameContext;
     }
 
-    public function beforeTraverse(array $nodes)
+    public function beforeTraverse(array $nodes): ?array
     {
         $this->nameContext->startNamespace();
 
@@ -110,6 +110,8 @@ public function enterNode(Node $node)
             $this->resolveAttrGroups($node);
             if (null !== $node->name) {
                 $this->addNamespacedName($node);
+            } else {
+                $node->namespacedName = null;
             }
         } elseif ($node instanceof Stmt\Interface_) {
             foreach ($node->extends as &$interface) {
@@ -134,7 +136,8 @@ public function enterNode(Node $node)
             $this->resolveSignature($node);
             $this->resolveAttrGroups($node);
             $this->addNamespacedName($node);
-        } elseif ($node instanceof Stmt\ClassMethod
+        } elseif (
+            $node instanceof Stmt\ClassMethod
             || $node instanceof Expr\Closure
             || $node instanceof Expr\ArrowFunction
         ) {
@@ -183,15 +186,25 @@ public function enterNode(Node $node)
                     }
                 }
             }
+        } elseif ($node instanceof Node\PropertyHook) {
+            foreach ($node->params as $param) {
+                $param->type = $this->resolveType($param->type);
+                $this->resolveAttrGroups($param);
+            }
+            $this->resolveAttrGroups($node);
         } elseif ($node instanceof Stmt\Const_) {
             foreach ($node->consts as $const) {
                 $this->addNamespacedName($const);
             }
         } elseif ($node instanceof Stmt\ClassConst) {
+            if (null !== $node->type) {
+                $node->type = $this->resolveType($node->type);
+            }
             $this->resolveAttrGroups($node);
         } elseif ($node instanceof Stmt\EnumCase) {
             $this->resolveAttrGroups($node);
-        } elseif ($node instanceof Expr\StaticCall
+        } elseif (
+            $node instanceof Expr\StaticCall
             || $node instanceof Expr\StaticPropertyFetch
             || $node instanceof Expr\ClassConstFetch
             || $node instanceof Expr\New_
@@ -234,8 +247,8 @@ public function enterNode(Node $node)
     /**
      * Resolve name, according to name resolver options.
      *
-     * @param Name $name Function or constant name to resolve
-     * @param int  $type One of Stmt\Use_::TYPE_*
+     * @param Name              $name Function or constant name to resolve
+     * @param Stmt\Use_::TYPE_* $type One of Stmt\Use_::TYPE_*
      *
      * @return Name Resolved name, or original name with attribute
      */
@@ -307,10 +320,15 @@ protected function resolveAttrGroups(Node $node): void
         }
     }
 
-    private function addAlias(Stmt\UseUse $use, int $type, ?Name $prefix = null): void
+    /**
+     * @param Stmt\Use_::TYPE_* $type
+     * @param ?Name             $prefix
+     *
+     * @psalm-suppress PossiblyNullArgument
+     */
+    private function addAlias(Node\UseItem $use, int $type, ?Name $prefix = null): void
     {
         // Add prefix for group uses
-        /** @var Name $name */
         $name = $prefix ? Name::concat($prefix, $use->name) : $use->name;
         // Type is determined either by individual element or whole use declaration
         $type |= $use->type;
@@ -364,10 +382,15 @@ private function resolveSignature($node): void
      * @psalm-suppress MissingParamType
      * @psalm-suppress PossiblyNullArgument
      * @psalm-suppress MissingReturnType
+     * @psalm-suppress InvalidReturnStatement
+     *
+     * @template T of Node\Identifier|Name|Node\ComplexType|null
+     *
+     * @param T $node
      *
-     * @param mixed $node
+     * @return T
      */
-    private function resolveType($node)
+    private function resolveType(?Node $node): ?Node
     {
         if ($node instanceof Name) {
             return $this->resolveClassName($node);

src/CLI/TargetPhpVersion.php

@@ -14,6 +14,7 @@ class TargetPhpVersion
         '8.1',
         '8.2',
         '8.3',
+        '8.4',
     ];
 
     /** @var string|null */

tests/Unit/Analyzer/FileVisitorTest.php

@@ -1343,4 +1343,38 @@ enum IntEnum: int
 EOF
         ];
     }
+
+    /**
+     * @requires PHP >= 8.4
+     */
+    public function test_it_parse_property_hooks(): void
+    {
+        $code = <<< 'EOF'
+<?php
+namespace App\Foo;
+
+class User {
+    private string $firstName;
+    private string $lastName;
+
+    public function __construct(string $firstName, string $lastName) {
+        $this->firstName = $firstName;
+        $this->lastName = $lastName;
+    }
+
+    public string $fullName {
+        get => $this->firstName . ' ' . $this->lastName;
+        set {[$this->firstName, $this->lastName] = explode(' ', $value, 2);}
+    }
+}
+EOF;
+
+        /** @var FileParser $fp */
+        $fp = FileParserFactory::createFileParser(TargetPhpVersion::create('8.4'));
+        $fp->parse($code, 'relativePathName');
+
+        $cd = $fp->getClassDescriptions();
+
+        $this->assertInstanceOf(ClassDescription::class, $cd[0]);
+    }
 }