#274: Applied code quality tools

Author: raymondschouten

composer.json

@@ -14,15 +14,15 @@
     },
     "require-dev": {
         "doctrine/orm": "^2.7",
-        "friendsofphp/php-cs-fixer": "^3.58",
+        "friendsofphp/php-cs-fixer": "^3.93",
         "maglnet/composer-require-checker": "^4.17",
-        "phpstan/extension-installer": "^1.3",
-        "phpstan/phpstan": "^1.11",
-        "phpstan/phpstan-doctrine": "^1.4",
-        "phpstan/phpstan-phpunit": "^1.4",
-        "phpstan/phpstan-symfony": "^1.4",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-doctrine": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0",
         "phpunit/phpunit": "^10.5",
-        "rector/rector": "^1.1"
+        "rector/rector": "^2.3"
     },
     "suggest": {
         "darkwebdesign/symfony-addon-pack": "All Symfony add-ons bundled together",

phpstan.dist.neon

@@ -4,3 +4,5 @@ parameters:
     paths:
         - 'src'
         - 'tests'
+
+    treatPhpDocTypesAsCertain: false

rector.php

@@ -3,16 +3,17 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-use Rector\Set\ValueObject\LevelSetList;
 
 return RectorConfig::configure()
     ->withPaths([
         __DIR__ . '/src',
         __DIR__ . '/tests',
     ])
-    ->withSets([
-        LevelSetList::UP_TO_PHP_82,
-    ])
-    ->withImportNames(
-        importShortClasses: false,
-    );
+    ->withPhpSets()
+    ->withAttributesSets()
+    ->withPreparedSets(phpunitCodeQuality: true, doctrineCodeQuality: true, symfonyCodeQuality: true, symfonyConfigs: true)
+    ->withComposerBased(doctrine: true, phpunit: true, symfony: true)
+    ->withImportNames(importShortClasses: false, removeUnusedImports: true)
+    ->withTypeCoverageLevel(0)
+    ->withDeadCodeLevel(0)
+    ->withCodeQualityLevel(0);

src/BooleanToValueTransformer.php

@@ -29,7 +29,7 @@
 /**
  * @template R of string|int|float|bool
  *
- * @template-implements DataTransformerInterface<bool, R>
+ * @implements DataTransformerInterface<bool, R>
  *
  * @author Raymond Schouten
  *

src/EntityToIdentifierTransformer.php

@@ -40,7 +40,7 @@
  * @template T of object
  * @template R of mixed
  *
- * @template-implements DataTransformerInterface<T, R>
+ * @implements DataTransformerInterface<T, R>
  *
  * @author Raymond Schouten
  *
@@ -52,6 +52,7 @@ class EntityToIdentifierTransformer implements DataTransformerInterface
     private readonly string $className;
     /** @var ObjectRepository<T> */
     private readonly ObjectRepository $repository;
+    /** @var ClassMetadata<T> */
     private readonly ClassMetadata $metadata;
 
     /**

tests/BooleanToValueTransformerTest.php

@@ -33,7 +33,7 @@
  * @internal
  */
 #[CoversClass(BooleanToValueTransformer::class)]
-class BooleanToValueTransformerTest extends TestCase
+final class BooleanToValueTransformerTest extends TestCase
 {
     #[DataProvider('providerTrueFalseValue')]
     public function testTransform(mixed $trueValue, mixed $falseValue): void
@@ -125,46 +125,40 @@ public function testReverseTransformInvalidValue(mixed $trueValue, mixed $falseV
     }
 
     /**
-     * @return array<string, array{mixed, mixed}>
+     * @return \Iterator<string, array{mixed, mixed}>
      */
-    public static function providerTrueFalseValue(): array
+    public static function providerTrueFalseValue(): \Iterator
     {
-        return [
-            'true/false' => [true, false],
-            'yes/no' => ['yes', 'no'],
-            'on/off' => ['on', 'off'],
-            '1/0' => ['1', '0'],
-            '1/2' => [1, 2],
-            '1.3/2.7' => [1.3, 2.7],
-        ];
+        yield 'true/false' => [true, false];
+        yield 'yes/no' => ['yes', 'no'];
+        yield 'on/off' => ['on', 'off'];
+        yield '1/0' => ['1', '0'];
+        yield '1/2' => [1, 2];
+        yield '1.3/2.7' => [1.3, 2.7];
     }
 
     /**
-     * @return array<string, array{mixed}>
+     * @return \Iterator<string, array{mixed}>
      */
-    public static function providerNoBool(): array
+    public static function providerNoBool(): \Iterator
     {
-        return [
-            'int' => [1],
-            'float' => [1.2],
-            'string' => ['foo'],
-            'array' => [['foo', 'bar']],
-            'object' => [new \stdClass()],
-            'resource' => [tmpfile()],
-            'callable' => [function () {}],
-        ];
+        yield 'int' => [1];
+        yield 'float' => [1.2];
+        yield 'string' => ['foo'];
+        yield 'array' => [['foo', 'bar']];
+        yield 'object' => [new \stdClass()];
+        yield 'resource' => [tmpfile()];
+        yield 'callable' => [function (): void {}];
     }
 
     /**
-     * @return array<string, array{mixed}>
+     * @return \Iterator<string, array{mixed}>
      */
-    public static function providerNoScalar(): array
+    public static function providerNoScalar(): \Iterator
     {
-        return [
-            'array' => [['foo', 'bar']],
-            'object' => [new \stdClass()],
-            'resource' => [tmpfile()],
-            'callable' => [function () {}],
-        ];
+        yield 'array' => [['foo', 'bar']];
+        yield 'object' => [new \stdClass()];
+        yield 'resource' => [tmpfile()];
+        yield 'callable' => [function (): void {}];
     }
 }

tests/EntityToIdentifierTransformerTest.php

@@ -40,7 +40,7 @@
  * @internal
  */
 #[CoversClass(EntityToIdentifierTransformer::class)]
-class EntityToIdentifierTransformerTest extends TestCase
+final class EntityToIdentifierTransformerTest extends TestCase
 {
     private City $entity;
     /** @var class-string<City|AbstractPerson|Employee> */
@@ -52,8 +52,6 @@ class EntityToIdentifierTransformerTest extends TestCase
     private ObjectManager $entityManager;
     /** @var ObjectRepository<City>&MockObject */
     private ObjectRepository $repository;
-    /** @var ClassMetadata&MockObject */
-    private ClassMetadata $metadata;
 
     protected function setUp(): void
     {
@@ -66,13 +64,13 @@ protected function setUp(): void
 
         $this->entityManager = $this->createMock(ObjectManager::class);
         $this->repository = $this->createMock(ObjectRepository::class);
-        $this->metadata = $this->createMock(ClassMetadata::class);
+        $metadata = $this->createMock(ClassMetadata::class);
 
         $this->entityManager->method('getRepository')->willReturn($this->repository);
-        $this->entityManager->method('getClassMetadata')->willReturn($this->metadata);
+        $this->entityManager->method('getClassMetadata')->willReturn($metadata);
 
-        $this->metadata->method('getName')->willReturnCallback($this->getClassName(...));
-        $this->metadata->method('getIdentifierValues')->willReturnCallback($this->getIdentifier(...));
+        $metadata->method('getName')->willReturnCallback($this->getClassName(...));
+        $metadata->method('getIdentifierValues')->willReturnCallback($this->getIdentifier(...));
     }
 
     public function getClassName(): string
@@ -100,7 +98,7 @@ public function testTransform(): void
     public function testTransformAlias(): void
     {
         /** @var class-string<City> $className */
-        $className = 'AppBundle:City';
+        $className = 'AppBundle:City'; // @phpstan-ignore varTag.nativeType
 
         $transformer = new EntityToIdentifierTransformer($this->entityManager, $className);
 
@@ -222,31 +220,27 @@ public function testReverseTransformEntityNotFound(): void
     }
 
     /**
-     * @return array<string, array{mixed}>
+     * @return \Iterator<string, array{mixed}>
      */
-    public static function providerNoObject(): array
+    public static function providerNoObject(): \Iterator
     {
-        return [
-            'bool' => [true],
-            'int' => [1],
-            'float' => [1.2],
-            'string' => ['foo'],
-            'array' => [['foo', 'bar']],
-            'resource' => [tmpfile()],
-            'callable' => [function () {}],
-        ];
+        yield 'bool' => [true];
+        yield 'int' => [1];
+        yield 'float' => [1.2];
+        yield 'string' => ['foo'];
+        yield 'array' => [['foo', 'bar']];
+        yield 'resource' => [tmpfile()];
+        yield 'callable' => [function (): void {}];
     }
 
     /**
-     * @return array<string, array{mixed}>
+     * @return \Iterator<string, array{mixed}>
      */
-    public static function providerNoScalar(): array
-    {
-        return [
-            'array' => [['foo', 'bar']],
-            'object' => [new \stdClass()],
-            'resource' => [tmpfile()],
-            'callable' => [function () {}],
-        ];
+    public static function providerNoScalar(): \Iterator
+    {
+        yield 'array' => [['foo', 'bar']];
+        yield 'object' => [new \stdClass()];
+        yield 'resource' => [tmpfile()];
+        yield 'callable' => [function (): void {}];
     }
 }