Add compatibility with php8.2

Also fix some warnings after running phpunit/php-cs-fixer/phpstan
php-kafka · Oct 9, 2023 · faa5e14 · faa5e14
1 parent 77007b6
commit faa5e14
Show file tree

Hide file tree

Showing 30 changed files with 129 additions and 108 deletions.
diff --git a/composer.json b/composer.json
@@ -9,14 +9,15 @@
   "license": "MIT",
   "require": {
     "ext-json": "*",
-    "flix-tech/avro-php": "^3.0|^4.0",
+    "flix-tech/avro-php": "^3.0|^4.0|^5.0",
     "symfony/console": "^4.3|^5.1|^6.0",
     "nikic/php-parser": "^4.13",
     "pimple/pimple": "^3.5"
   },
   "require-dev": {
-    "friendsofphp/php-cs-fixer": "^2.15",
-    "infection/infection": "^0.25",
+    "friendsofphp/php-cs-fixer": "^2.19|^3.15",
+    "infection/infection": "^0.25|^0.27",
+    "composer/xdebug-handler": "^2.0|^3.0",
     "phpstan/phpstan": "^1.2",
     "phpunit/phpunit": "^9.3",
     "rregeer/phpunit-coverage-check": "^0.3",

diff --git a/docker/dev/php/Dockerfile b/docker/dev/php/Dockerfile
@@ -1,4 +1,4 @@
-FROM php:7.4-cli-alpine3.15
+FROM php:8.2-cli-alpine3.16
 
 ARG HOST_USER_ID
 ARG HOST_USER

diff --git a/example/classes/SomeOtherTestClass.php b/example/classes/SomeOtherTestClass.php
@@ -6,5 +6,4 @@
 
 class SomeOtherTestClass
 {
-
 }
diff --git a/example/classes/SomeTestClass.php b/example/classes/SomeTestClass.php
@@ -9,7 +9,6 @@
 
 class SomeTestClass extends SomeBaseClass
 {
-
     /**
      * @var string
      */

diff --git a/example/classes/SomeTestInterface.php b/example/classes/SomeTestInterface.php
@@ -4,5 +4,4 @@
 
 interface SomeTestInterface
 {
-
 }
diff --git a/example/classes/Wonderland/Wonderland.php b/example/classes/Wonderland/Wonderland.php
@@ -6,5 +6,4 @@
 
 class Wonderland
 {
-
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,4 +1,11 @@
 parameters:
     level: 8
     paths: [ src ]
-    checkGenericClassInNonGenericObjectType: false
+    checkGenericClassInNonGenericObjectType: false
+    excludePaths:
+        - vendor
+    ignoreErrors:
+        # Disable error in class for example of generation
+        -
+            message: '#Property PhpKafka\\PhpAvroSchemaGenerator\\Example\\SomeTestClass::\$string is unused.#'
+            path: example/classes/SomeTestClass.php
diff --git a/src/Optimizer/FullNameOptimizer.php b/src/Optimizer/FullNameOptimizer.php
@@ -127,8 +127,8 @@ private function removeNamespaceFromString(string $currentNamespace, $data)
         $currentNameSpacePaths = explode('.', $currentNamespace);
         $dataNameSpacePaths = explode('.', $data);
 
-        foreach ($dataNameSpacePaths as $idx => $dataNameSpacePath) {
-            if ($currentNameSpacePaths[$idx] === $dataNameSpacePath) {
+        foreach ($currentNameSpacePaths as $idx => $currentNameSpacePath) {
+            if ($currentNameSpacePath === $dataNameSpacePaths[$idx]) {
                 unset($dataNameSpacePaths[$idx]);
             } else {
                 break;

diff --git a/src/Parser/ClassParser.php b/src/Parser/ClassParser.php
@@ -61,7 +61,7 @@ public function getClassName(): ?string
     }
 
     /**
-     * @return string|null
+     * @return class-string|null
      */
     public function getParentClassName(): ?string
     {
@@ -74,14 +74,14 @@ public function getParentClassName(): ?string
                 foreach ($statement->stmts as $nsStatement) {
                     if ($nsStatement instanceof Class_) {
                         if (null !== $nsStatement->extends) {
-                            return implode('\\', $nsStatement->extends->parts);
+                            return $this->buildClassName($nsStatement->extends->getParts());
                         }
                     }
                 }
             } else {
                 if ($statement instanceof Class_) {
                     if (null !== $statement->extends) {
-                        return implode('\\', $statement->extends->parts);
+                        return $this->buildClassName($statement->extends->getParts());
                     }
                 }
             }
@@ -90,6 +90,9 @@ public function getParentClassName(): ?string
         return null;
     }
 
+    /**
+     * @return class-string[]
+     */
     public function getUsedClasses(): array
     {
         $usedClasses = [];
@@ -104,8 +107,8 @@ public function getUsedClasses(): array
                     if ($nStatement instanceof Use_) {
                         /** @var UseUse $use */
                         foreach ($nStatement->uses as $use) {
-                            $className = $use->name->parts[array_key_last($use->name->parts)];
-                            $usedClasses[$className] = implode('\\', $use->name->parts);
+                            $className = $use->name->getParts()[array_key_last($use->name->getParts())];
+                            $usedClasses[$className] = $this->buildClassName($use->name->getParts());
                         }
                     }
                 }
@@ -115,6 +118,18 @@ public function getUsedClasses(): array
         return $usedClasses;
     }
 
+    /**
+     * @param string[] $parts
+     * @return class-string
+     */
+    public function buildClassName(array $parts): string
+    {
+        /** @var class-string $classname */
+        $classname = implode('\\', $parts);
+
+        return $classname;
+    }
+
     /**
      * @return string
      */
@@ -196,16 +211,15 @@ private function getAllClassProperties(Class_ $class, array $properties): array
      */
     private function getParentClassStatements(): ?array
     {
-        /** @var class-string[] $usedClasses */
         $usedClasses = $this->getUsedClasses();
         $parentClass = $this->getParentClassName();
 
         if (null === $parentClass) {
             return [];
         }
 
-        if (null !== $usedClasses[$this->getParentClassName()]) {
-            $parentClass = $usedClasses[$this->getParentClassName()];
+        if (array_key_exists($parentClass, $usedClasses) && null !== $usedClasses[$parentClass]) {
+            $parentClass = $usedClasses[$parentClass];
         }
 
         $rc = new ReflectionClass($parentClass);

diff --git a/src/Registry/SchemaRegistry.php b/src/Registry/SchemaRegistry.php
@@ -135,12 +135,13 @@ private function registerSchemaFile(\SplFileInfo $fileInfo): void
         }
 
         $schemaData = json_decode($fileContent, true, JSON_THROW_ON_ERROR);
-        $namespace = (string) $schemaData['namespace'];
 
         if (null === $schemaData) {
             throw new SchemaRegistryException(sprintf(SchemaRegistryException::FILE_INVALID, $fileName));
         }
 
+        $namespace = array_key_exists("namespace", $schemaData) ? (string) $schemaData['namespace'] : '';
+
         $template = (new SchemaTemplate())
             ->withFilename($fileInfo->getBasename())
             ->withSchemaDefinition($fileContent)

diff --git a/tests/Integration/Parser/ClassParserTest.php b/tests/Integration/Parser/ClassParserTest.php
@@ -12,45 +12,45 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * @covers PhpKafka\PhpAvroSchemaGenerator\Parser\ClassParser
+ * @covers \PhpKafka\PhpAvroSchemaGenerator\Parser\ClassParser
  */
 class ClassParserTest extends TestCase
 {
-    public function testGetClassName()
+    public function testGetClassName(): void
     {
         $filePath = __DIR__ . '/../../../example/classes/SomeTestClass.php';
         $propertyParser = new ClassPropertyParser(new DocCommentParser());
         $parser = new ClassParser((new ParserFactory())->create(ParserFactory::PREFER_PHP7), $propertyParser);
-        $parser->setCode(file_get_contents($filePath));
+        $parser->setCode((string) file_get_contents($filePath));
         self::assertEquals('SomeTestClass', $parser->getClassName());
         self::assertEquals('SomeTestClass', $parser->getClassName());
     }
 
-    public function testGetClassNameForInterface()
+    public function testGetClassNameForInterface(): void
     {
         $filePath = __DIR__ . '/../../../example/classes/SomeTestInterface.php';
         $propertyParser = new ClassPropertyParser(new DocCommentParser());
         $parser = new ClassParser((new ParserFactory())->create(ParserFactory::PREFER_PHP7), $propertyParser);
-        $parser->setCode(file_get_contents($filePath));
+        $parser->setCode((string) file_get_contents($filePath));
         self::assertNull($parser->getClassName());
     }
 
-    public function testGetNamespace()
+    public function testGetNamespace(): void
     {
         $filePath = __DIR__ . '/../../../example/classes/SomeTestClass.php';
         $propertyParser = new ClassPropertyParser(new DocCommentParser());
         $parser = new ClassParser((new ParserFactory())->create(ParserFactory::PREFER_PHP7), $propertyParser);
-        $parser->setCode(file_get_contents($filePath));
+        $parser->setCode((string) file_get_contents($filePath));
         self::assertEquals('PhpKafka\\PhpAvroSchemaGenerator\\Example', $parser->getNamespace());
         self::assertEquals('PhpKafka\\PhpAvroSchemaGenerator\\Example', $parser->getNamespace());
     }
 
-    public function testGetProperties()
+    public function testGetProperties(): void
     {
         $filePath = __DIR__ . '/../../../example/classes/SomeTestClass.php';
         $propertyParser = new ClassPropertyParser(new DocCommentParser());
         $parser = new ClassParser((new ParserFactory())->create(ParserFactory::PREFER_PHP7), $propertyParser);
-        $parser->setCode(file_get_contents($filePath));
+        $parser->setCode((string) file_get_contents($filePath));
         $properties = $parser->getProperties();
         self::assertCount(16, $properties);
 
@@ -65,7 +65,7 @@ public function testClassAndNamespaceAreNullWithNoCode(): void
         $parser = new ClassParser((new ParserFactory())->create(ParserFactory::PREFER_PHP7), $propertyParser);
         $refObject = new \ReflectionObject($parser);
         $refProperty = $refObject->getProperty('statements');
-        $refProperty->setAccessible( true );
+        $refProperty->setAccessible(true);
         $refProperty->setValue($parser, null);
         self::assertNull($parser->getClassName());
         self::assertNull($parser->getNamespace());

diff --git a/tests/Integration/Parser/DocCommentParserTest.php b/tests/Integration/Parser/DocCommentParserTest.php
@@ -8,7 +8,7 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * @covers PhpKafka\PhpAvroSchemaGenerator\Parser\DocCommentParser
+ * @covers \PhpKafka\PhpAvroSchemaGenerator\Parser\DocCommentParser
  */
 class DocCommentParserTest extends TestCase
 {
@@ -23,9 +23,9 @@ public function testParseDoc(): void
         self::assertEquals(
             [
                 'var' => 'string',
-                'function-description' =>''
+                'function-description' => ''
             ],
             $result
         );
     }
-}
+}
diff --git a/tests/Integration/Registry/ClassRegistryTest.php b/tests/Integration/Registry/ClassRegistryTest.php
@@ -18,11 +18,11 @@
 use SplFileInfo;
 
 /**
- * @covers PhpKafka\PhpAvroSchemaGenerator\Registry\ClassRegistry
+ * @covers \PhpKafka\PhpAvroSchemaGenerator\Registry\ClassRegistry
  */
 class ClassRegistryTest extends TestCase
 {
-    public function testClassDirectory()
+    public function testClassDirectory(): void
     {
         $propertyParser = new ClassPropertyParser(new DocCommentParser());
         $parser = new ClassParser((new ParserFactory())->create(ParserFactory::PREFER_PHP7), $propertyParser);
@@ -34,7 +34,7 @@ public function testClassDirectory()
         self::assertEquals(['/tmp' => 1], $result->getClassDirectories());
     }
 
-    public function testLoad()
+    public function testLoad(): void
     {
         $classDir = __DIR__ . '/../../../example/classes';
 
@@ -54,7 +54,7 @@ public function testLoad()
         }
     }
 
-    public function testRegisterSchemaFileThatDoesntExist()
+    public function testRegisterSchemaFileThatDoesntExist(): void
     {
         $fileInfo = new SplFileInfo('somenonexistingfile');
         $propertyParser = new ClassPropertyParser(new DocCommentParser());
@@ -71,7 +71,7 @@ public function testRegisterSchemaFileThatDoesntExist()
         $method->invokeArgs($registry, [$fileInfo]);
     }
 
-    public function testRegisterSchemaFileThatIsNotReadable()
+    public function testRegisterSchemaFileThatIsNotReadable(): void
     {
         touch('testfile');
         chmod('testfile', 222);

diff --git a/tests/Integration/Registry/SchemaRegistryTest.php b/tests/Integration/Registry/SchemaRegistryTest.php
@@ -11,11 +11,11 @@
 use SplFileInfo;
 
 /**
- * @covers PhpKafka\PhpAvroSchemaGenerator\Registry\SchemaRegistry
+ * @covers \PhpKafka\PhpAvroSchemaGenerator\Registry\SchemaRegistry
  */
 class SchemaRegistryTest extends TestCase
 {
-    public function testSchemaDirectories()
+    public function testSchemaDirectories(): void
     {
         $registry = new SchemaRegistry();
         $result = $registry->addSchemaTemplateDirectory('/tmp');
@@ -24,7 +24,7 @@ public function testSchemaDirectories()
         self::assertEquals(['/tmp' => 1], $result->getSchemaDirectories());
     }
 
-    public function testLoad()
+    public function testLoad(): void
     {
         $schemaIds = [
             'Book',
@@ -49,10 +49,12 @@ public function testLoad()
 
         $expectedNames = ['CD', 'Collection', 'Page', 'Library'];
 
-        self::assertSame(sort($expectedNames), sort($registry->getSchemaNamesPerNamespace('com.example')));
+        $actualNamespaces = $registry->getSchemaNamesPerNamespace('com.example');
+
+        self::assertSame(sort($expectedNames), sort($actualNamespaces));
     }
 
-    public function testGetRootSchemas()
+    public function testGetRootSchemas(): void
     {
         $schemaDir = __DIR__ . '/../../../example/schemaTemplates';
         $registry = (new SchemaRegistry())->addSchemaTemplateDirectory($schemaDir)->load();
@@ -66,14 +68,14 @@ public function testGetRootSchemas()
         }
     }
 
-    public function testGetSchemaByIdNotExisting()
+    public function testGetSchemaByIdNotExisting(): void
     {
         $registry = new SchemaRegistry();
 
         self::assertNull($registry->getSchemaById('test'));
     }
 
-    public function testGetSchemaById()
+    public function testGetSchemaById(): void
     {
         $template = $this->getMockForAbstractClass(SchemaTemplateInterface::class);
 
@@ -87,7 +89,7 @@ public function testGetSchemaById()
         self::assertEquals($template, $registry->getSchemaById('test'));
     }
 
-    public function testRegisterSchemaFileThatDoesntExist()
+    public function testRegisterSchemaFileThatDoesntExist(): void
     {
         $fileInfo = new SplFileInfo('somenonexistingfile');
         $registry = new SchemaRegistry();
@@ -101,7 +103,7 @@ public function testRegisterSchemaFileThatDoesntExist()
         $method->invokeArgs($registry, [$fileInfo]);
     }
 
-    public function testRegisterSchemaFileThatIsNotReadable()
+    public function testRegisterSchemaFileThatIsNotReadable(): void
     {
         touch('testfile');
         chmod('testfile', 222);
@@ -125,7 +127,7 @@ public function testRegisterSchemaFileThatIsNotReadable()
         }
     }
 
-    public function testRegisterSchemaWithInvalidContent()
+    public function testRegisterSchemaWithInvalidContent(): void
     {
         touch('testfile');
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,6 @@ @@
     class SomeTestClass extends SomeBaseClass
     {
         /**
          * @var string
          */
@@ Expand Down @@