Migrate to php 8.4 and get rid of laminas-file

compositephp · compositephp · commit 45bb6d8add45 · 2024-12-24T09:22:48.000Z
diff --git a/composer.json b/composer.json
@@ -16,8 +16,8 @@
         "compositephp/db": "^0.4.0",
         "nette/php-generator": "^4.0",
         "symfony/console": "2 - 6",
-        "laminas/laminas-file": "^2.12",
-        "doctrine/inflector": "^2.0"
+        "doctrine/inflector": "^2.0",
+        "nikic/php-parser": "^5.3"
     },
     "require-dev": {
         "phpunit/phpunit": "^10.1",
diff --git a/phpunit.xml b/phpunit.xml
@@ -3,6 +3,11 @@
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" bootstrap="tests/bootstrap.php"
          executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" failOnRisky="true" failOnWarning="true"
          colors="true" cacheDirectory=".phpunit.cache" requireCoverageMetadata="false"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnPhpunitDeprecations="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
          beStrictAboutCoverageMetadata="true">
     <testsuites>
         <testsuite name="default">
diff --git a/src/Commands/MigrateCommand.php b/src/Commands/MigrateCommand.php
@@ -5,13 +5,13 @@
 use Composer\Autoload\ClassLoader;
 use Composite\DB\Attributes\Table;
 use Composite\Sync\Attributes\SkipMigration;
+use Composite\Sync\Helpers\ClassFileLocator;
 use Composite\Sync\Helpers\ConsoleLogger;
 use Composite\Sync\Migration\MigrationsManager;
 use Composite\Sync\Helpers\CommandHelper;
 use Composite\DB\TableConfig;
 use Composite\Entity\AbstractEntity;
 use Composite\Entity\Exceptions\EntityException;
-use Laminas\File\ClassFileLocator;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -108,29 +108,24 @@ private function findAllEntities(): array
         }
 
         foreach ($dirs as $dir) {
-            $locator = new ClassFileLocator($dir);
-            foreach ($locator as $file) {
-                foreach ($file->getClasses() as $class) {
-                    if (!is_subclass_of($class, AbstractEntity::class)) {
-                        continue;
-                    }
-                    $schema = $class::schema();
-                    if ($schema->getFirstAttributeByClass(SkipMigration::class)) {
-                        continue;
-                    }
-                    if (!$schema->getFirstAttributeByClass(Table::class)) {
-                        continue;
-                    }
-                    try {
-                        $tableConfig = TableConfig::fromEntitySchema($schema);
-                    } catch (EntityException) {
-                        continue;
-                    }
-                    if ($onlyConnectionName && $tableConfig->connectionName !== $onlyConnectionName) {
-                        continue;
-                    }
-                    $result[] = $class;
+            $locator = new ClassFileLocator();
+            foreach ($locator->findClasses($dir, AbstractEntity::class) as $class) {
+                $schema = $class::schema();
+                if ($schema->getFirstAttributeByClass(SkipMigration::class)) {
+                    continue;
+                }
+                if (!$schema->getFirstAttributeByClass(Table::class)) {
+                    continue;
+                }
+                try {
+                    $tableConfig = TableConfig::fromEntitySchema($schema);
+                } catch (EntityException) {
+                    continue;
+                }
+                if ($onlyConnectionName && $tableConfig->connectionName !== $onlyConnectionName) {
+                    continue;
                 }
+                $result[] = $class;
             }
         }
         return $result;
diff --git a/src/Helpers/ClassFileLocator.php b/src/Helpers/ClassFileLocator.php
@@ -0,0 +1,76 @@
+<?php declare(strict_types=1);
+
+namespace Composite\Sync\Helpers;
+
+use PhpParser\Error;
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor\NameResolver;
+use PhpParser\NodeVisitorAbstract;
+use PhpParser\ParserFactory;
+
+class ClassFileLocator extends NodeVisitorAbstract
+{
+    /** @var array<class-string> */
+    private array $classes;
+
+    /** @var class-string */
+    private string $parentClass;
+
+    public function enterNode(Node $node): void
+    {
+        if ($node instanceof Node\Stmt\Class_) {
+            if (!$node->namespacedName) {
+                return;
+            }
+            if ($this->getParentClassName($node) !== $this->parentClass) {
+                return;
+            }
+            $this->classes[] = $node->namespacedName->toString();
+        }
+    }
+
+    /**
+     * @template T
+     * @param class-string<T> $parentClass
+     * @return array<class-string<T>>
+     */
+    public function findClasses(string $directory, string $parentClass): array
+    {
+        $this->parentClass = $parentClass;
+        $this->classes = [];
+
+        $parser = (new ParserFactory)->createForHostVersion();
+        $traverser = new NodeTraverser();
+
+        $traverser->addVisitor(new NameResolver());
+        $traverser->addVisitor($this);
+
+        $rii = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($directory));
+        foreach ($rii as $file) {
+            if (!$file->isDir() && pathinfo($file->getFilename(), PATHINFO_EXTENSION) === 'php') {
+                $code = file_get_contents($file->getPathname());
+
+                try {
+                    $stmts = $parser->parse($code);
+                    if ($stmts !== null) {
+                        $traverser->traverse($stmts);
+                    }
+                } catch (Error) {}
+            }
+        }
+        return $this->classes;
+    }
+
+    private function getParentClassName(Node\Stmt\Class_ $classNode): ?string
+    {
+        if (!$extendsNode = $classNode->extends) {
+            return null;
+        }
+        if (!$extendsNode instanceof FullyQualified) {
+            return null;
+        }
+        return $extendsNode->toString();
+    }
+}
diff --git a/tests/Generator/CachedTableClassBuilderTest.php b/tests/Generator/CachedTableClassBuilderTest.php
@@ -5,12 +5,11 @@
 use Composite\Sync\Generator\CachedTableClassBuilder;
 use Composite\Sync\Tests\TestStand\Entities\TestAutoincrementEntity;
 use Composite\Sync\Tests\TestStand\Entities\TestCompositeEntity;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class CachedTableClassBuilderTest extends \PHPUnit\Framework\TestCase
 {
-    /**
-     * @dataProvider classBuilder_dataProvider
-     */
+    #[DataProvider('classBuilder_dataProvider')]
     public function test_getFileContent(string $tableClassName, string $entityClassName, $expectedOutput)
     {
         $classBuilder = new CachedTableClassBuilder(
diff --git a/tests/Generator/EnumClassBuilderTest.php b/tests/Generator/EnumClassBuilderTest.php
@@ -3,12 +3,11 @@
 namespace Composite\Sync\Tests\Generator;
 
 use Composite\Sync\Generator\EnumClassBuilder;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class EnumClassBuilderTest extends \PHPUnit\Framework\TestCase
 {
-    /**
-     * @dataProvider enumClassBuilder_dataProvider
-     */
+    #[DataProvider('enumClassBuilder_dataProvider')]
     public function test_getFileContent($enumClassName, $cases, $expectedOutput)
     {
         $enumClassBuilder = new EnumClassBuilder($enumClassName, $cases);
diff --git a/tests/Generator/MySQLEntityClassBuilderTest.php b/tests/Generator/MySQLEntityClassBuilderTest.php
@@ -5,12 +5,11 @@
 use Composite\Sync\Generator\EntityClassBuilder;
 use Composite\Sync\Generator\EnumClassBuilder;
 use Composite\Sync\Providers\MySQL\MySQLParser;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class MySQLEntityClassBuilderTest extends \PHPUnit\Framework\TestCase
 {
-    /**
-     * @dataProvider sql_dataProvider
-     */
+    #[DataProvider('sql_dataProvider')]
     public function test_generate(
         string $tableName,
         string $sqlQuery,
diff --git a/tests/Generator/PostgresEntityClassBuilderTest.php b/tests/Generator/PostgresEntityClassBuilderTest.php
@@ -6,15 +6,14 @@
 use Composite\Sync\Generator\EntityClassBuilder;
 use Composite\Sync\Generator\EnumClassBuilder;
 use Composite\Sync\Providers\PostgreSQL\PgSQLParser;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class PostgresEntityClassBuilderTest extends \PHPUnit\Framework\TestCase
 {
     const CONNECTION_NAME = 'postgres';
     const TABLE_NAME = 'test_table';
 
-    /**
-     * @dataProvider sql_dataProvider
-     */
+    #[DataProvider('sql_dataProvider')]
     public function test_generate(
         array $initQueries,
         string $entityClass,
diff --git a/tests/Generator/SQLiteEntityClassBuilderTest.php b/tests/Generator/SQLiteEntityClassBuilderTest.php
@@ -6,15 +6,14 @@
 use Composite\Sync\Generator\EntityClassBuilder;
 use Composite\Sync\Generator\EnumClassBuilder;
 use Composite\Sync\Providers\SQLite\SQLiteParser;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class SQLiteEntityClassBuilderTest extends \PHPUnit\Framework\TestCase
 {
     const CONNECTION_NAME = 'sqlite';
     const TABLE_NAME = 'test_table';
 
-    /**
-     * @dataProvider sql_dataProvider
-     */
+    #[DataProvider('sql_dataProvider')]
     public function test_generate(
         array $initQueries,
         string $entityClass,
diff --git a/tests/Generator/TableClassBuilderTest.php b/tests/Generator/TableClassBuilderTest.php
@@ -5,12 +5,11 @@
 use Composite\Sync\Generator\TableClassBuilder;
 use Composite\Sync\Tests\TestStand\Entities\TestAutoincrementEntity;
 use Composite\Sync\Tests\TestStand\Entities\TestCompositeEntity;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class TableClassBuilderTest extends \PHPUnit\Framework\TestCase
 {
-    /**
-     * @dataProvider classBuilder_dataProvider
-     */
+    #[DataProvider('classBuilder_dataProvider')]
     public function test_getFileContent(string $tableClassName, string $entityClassName, $expectedOutput)
     {
         $classBuilder = new TableClassBuilder(
diff --git a/tests/Helpers/ClassHelperTest.php b/tests/Helpers/ClassHelperTest.php
@@ -3,13 +3,12 @@
 namespace Composite\Sync\Tests\Helpers;
 
 use Composite\Sync\Helpers\ClassHelper;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class ClassHelperTest extends TestCase
 {
-    /**
-     * @dataProvider extractNamespace_dataProvider
-     */
+    #[DataProvider('extractNamespace_dataProvider')]
     public function test_extractNamespace(string $name, string $expected): void
     {
         $result = ClassHelper::extractNamespace($name);
@@ -25,9 +24,7 @@ public static function extractNamespace_dataProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider extractShortName_dataProvider
-     */
+    #[DataProvider('extractShortName_dataProvider')]
     public function test_extractShortName(string $name, string $expected): void
     {
         $result = ClassHelper::extractShortName($name);
@@ -43,9 +40,7 @@ public static function extractShortName_dataProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider normalizeString_dataProvider
-     */
+    #[DataProvider('normalizeString_dataProvider')]
     public function test_normalizeString(string $input, string $expected): void
     {
         $result = ClassHelper::normalizeString($input);
diff --git a/tests/Migration/MigrationClassBuilderTest.php b/tests/Migration/MigrationClassBuilderTest.php
@@ -3,12 +3,11 @@
 namespace Composite\Sync\Tests\Migration;
 
 use Composite\Sync\Migration\MigrationClassBuilder;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class MigrationClassBuilderTest extends \PHPUnit\Framework\TestCase
 {
-    /**
-     * @dataProvider migrationName_dataProvider
-     */
+    #[DataProvider('migrationName_dataProvider')]
     public function test_buildMigrationName(string $connectionName, array $summaryParts, array $upQueries, array $downQueries, string $expectedResult)
     {
         $builder = new MigrationClassBuilder(
diff --git a/tests/Migration/MigrationManagerTest.php b/tests/Migration/MigrationManagerTest.php
@@ -11,12 +11,11 @@
 use Composite\Sync\Tests\TestStand\Entities\TestMigrationEntityV2;
 use Composite\Sync\Tests\TestStand\Tables\TestMySQLTable;
 use Doctrine\DBAL\Exception\TableNotFoundException;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class MigrationManagerTest extends \PHPUnit\Framework\TestCase
 {
-    /**
-     * @dataProvider migrationName_dataProvider
-     */
+    #[DataProvider('migrationName_dataProvider')]
     public function test_buildMigrationName(string $connectionName, array $summaryParts, string $expectedResult)
     {
         $migrationName = MigrationsManager::buildMigrationName($connectionName, $summaryParts);
@@ -58,9 +57,7 @@ public static function flow_dataProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider flow_dataProvider
-     */
+    #[DataProvider('flow_dataProvider')]
     public function test_flow(string $connectionName): void
     {
         $this->cleanVersionTable($connectionName);
diff --git a/tests/Providers/MySQL/MySQLColumnTest.php b/tests/Providers/MySQL/MySQLColumnTest.php
@@ -2,9 +2,10 @@
 
 namespace Composite\Sync\Tests\Providers\MySQL;
 
+use Composite\Sync\Helpers\SQLParser;
 use Composite\Sync\Providers\MySQL\MySQLColumn;
 use Composite\Sync\Providers\MySQL\MySQLColumnType;
-use iamcal\SQLParser;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 final class MySQLColumnTest extends \PHPUnit\Framework\TestCase
 {
@@ -610,9 +611,7 @@ public static function sqlColumn_DataProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider sqlColumn_DataProvider
-     */
+    #[DataProvider('sqlColumn_DataProvider')]
     public function test_parseSQLColumn(string $sql, MySQLColumn $expected): void
     {
         $tableSQL = "CREATE TABLE Test ($sql)";
diff --git a/tests/Providers/MySQL/MySQLComparatorTest.php b/tests/Providers/MySQL/MySQLComparatorTest.php
@@ -5,6 +5,7 @@
 use Composite\DB\Traits\SoftDelete;
 use Composite\DB\Traits\UpdatedAt;
 use Composite\Sync\Attributes\SkipMigration;
+use PHPUnit\Framework\Attributes\DataProvider;
 use Composite\DB\Attributes\{PrimaryKey, Table};
 use Composite\Sync\Providers\MySQL\MySQLComparator;
 use Composite\Sync\Providers\MySQL\MySQLIndex;
@@ -608,9 +609,7 @@ public function __construct(
         ];
     }
 
-    /**
-     * @dataProvider run_dataProvider
-     */
+    #[DataProvider('run_dataProvider')]
     public function test_run(
         AbstractEntity $entity,
         ?string $sql,
diff --git a/tests/Providers/MySQL/MySQLIndexTest.php b/tests/Providers/MySQL/MySQLIndexTest.php
diff --git a/tests/TestStand/Entities/TestAutoincrementEntity.php b/tests/TestStand/Entities/TestAutoincrementEntity.php

Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,11 @@`
`5`	`5`	`use Composite\Sync\Generator\CachedTableClassBuilder;`
`6`	`6`	`use Composite\Sync\Tests\TestStand\Entities\TestAutoincrementEntity;`
`7`	`7`	`use Composite\Sync\Tests\TestStand\Entities\TestCompositeEntity;`
	`8`	`+use PHPUnit\Framework\Attributes\DataProvider;`
`8`	`9`
`9`	`10`	`final class CachedTableClassBuilderTest extends \PHPUnit\Framework\TestCase`
`10`	`11`	`{`
`11`		`- /**`
`12`		`- * @dataProvider classBuilder_dataProvider`
`13`		`- */`
	`12`	`+ #[DataProvider('classBuilder_dataProvider')]`
`14`	`13`	`public function test_getFileContent(string $tableClassName, string $entityClassName, $expectedOutput)`
`15`	`14`	`{`
`16`	`15`	`$classBuilder = new CachedTableClassBuilder(`
Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,11 @@`
`3`	`3`	`namespace Composite\Sync\Tests\Generator;`
`4`	`4`
`5`	`5`	`use Composite\Sync\Generator\EnumClassBuilder;`
	`6`	`+use PHPUnit\Framework\Attributes\DataProvider;`
`6`	`7`
`7`	`8`	`final class EnumClassBuilderTest extends \PHPUnit\Framework\TestCase`
`8`	`9`	`{`
`9`		`- /**`
`10`		`- * @dataProvider enumClassBuilder_dataProvider`
`11`		`- */`
	`10`	`+ #[DataProvider('enumClassBuilder_dataProvider')]`
`12`	`11`	`public function test_getFileContent($enumClassName, $cases, $expectedOutput)`
`13`	`12`	`{`
`14`	`13`	`$enumClassBuilder = new EnumClassBuilder($enumClassName, $cases);`
Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,11 @@`
`5`	`5`	`use Composite\Sync\Generator\TableClassBuilder;`
`6`	`6`	`use Composite\Sync\Tests\TestStand\Entities\TestAutoincrementEntity;`
`7`	`7`	`use Composite\Sync\Tests\TestStand\Entities\TestCompositeEntity;`
	`8`	`+use PHPUnit\Framework\Attributes\DataProvider;`
`8`	`9`
`9`	`10`	`final class TableClassBuilderTest extends \PHPUnit\Framework\TestCase`
`10`	`11`	`{`
`11`		`- /**`
`12`		`- * @dataProvider classBuilder_dataProvider`
`13`		`- */`
	`12`	`+ #[DataProvider('classBuilder_dataProvider')]`
`14`	`13`	`public function test_getFileContent(string $tableClassName, string $entityClassName, $expectedOutput)`
`15`	`14`	`{`
`16`	`15`	`$classBuilder = new TableClassBuilder(`