chore: rectorization (#7)

* chore: rectorization * withPhpVersion(PhpVersion::PHP_83) * codingStyle * privatization * finish rector
rekalogika · Sep 16, 2024 · 5a38c3d · 5a38c3d
1 parent f1155a2
commit 5a38c3d
Show file tree

Hide file tree

Showing 22 changed files with 107 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@ vendor
 .phpunit.cache
 var
 .php-cs-fixer.cache
-tools
+tools
+rector.log
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.3.0
+
+* chore: php-cs-fixer run
+
 ## 1.2.0
 
 * feat: Supports ORM 3

diff --git a/Makefile b/Makefile
@@ -19,4 +19,9 @@ php-cs-fixer: tools/php-cs-fixer
 
 .PHONY: tools/php-cs-fixer
 tools/php-cs-fixer:
-	phive install php-cs-fixer
+	phive install php-cs-fixer
+
+.PHONY: rector
+rector:
+	$(PHP) vendor/bin/rector process > rector.log
+	make php-cs-fixer
diff --git a/composer.json b/composer.json
@@ -33,7 +33,8 @@
         "vimeo/psalm": "^5.26",
         "psalm/plugin-phpunit": "^0.18.4",
         "psalm/plugin-symfony": "^5.0",
-        "symfony/phpunit-bridge": "^6.0 || ^7.0"
+        "symfony/phpunit-bridge": "^6.0 || ^7.0",
+        "rector/rector": "^1.2"
     },
     "extra": {
         "branch-alias": {

diff --git a/rector.php b/rector.php
@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Identical\FlipTypeControlToUseExclusiveTypeRector;
+use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
+use Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector;
+use Rector\CodingStyle\Rector\Use_\SeparateMultiUseImportsRector;
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\Assign\RemoveUnusedVariableAssignRector;
+use Rector\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector;
+use Rector\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector;
+use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
+use Rector\Strict\Rector\Ternary\DisallowedShortTernaryRuleFixerRector;
+use Rector\ValueObject\PhpVersion;
+
+return RectorConfig::configure()
+    ->withPhpVersion(PhpVersion::PHP_84)
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/config',
+        __DIR__ . '/tests',
+    ])
+    ->withPreparedSets(
+        deadCode: true,
+        codeQuality: true,
+        codingStyle: true,
+        typeDeclarations: true,
+        privatization: true,
+        instanceOf: true,
+        strictBooleans: true,
+        symfonyCodeQuality: true,
+        doctrineCodeQuality: true,
+    )
+    ->withPhpSets(php81: true)
+    ->withRules([
+        AddOverrideAttributeToOverriddenMethodsRector::class,
+    ])
+    ->withSkip([
+        // static analysis tools don't like this
+        RemoveNonExistingVarAnnotationRector::class,
+
+        // static analysis tools don't like this
+        RemoveUnusedVariableAssignRector::class,
+
+        // cognitive burden to many people
+        SimplifyIfElseToTernaryRector::class,
+
+        // potential cognitive burden
+        FlipTypeControlToUseExclusiveTypeRector::class,
+
+        // results in too long variables
+        CatchExceptionNameMatchingTypeRector::class,
+
+        // makes code unreadable
+        DisallowedShortTernaryRuleFixerRector::class,
+
+        // unsafe
+        SeparateMultiUseImportsRector::class,
+
+        // incorrectly removes empty final __construct()
+        RemoveEmptyClassMethodRector::class,
+    ]);
diff --git a/src/AbstractAttributeReconstitutor.php b/src/AbstractAttributeReconstitutor.php
@@ -26,5 +26,6 @@ abstract class AbstractAttributeReconstitutor extends AbstractReconstitutor impl
 {
     use DirectPropertyAccessorAwareTrait;
 
+    #[\Override]
     abstract public static function getAttributeClass(): string;
 }
diff --git a/src/AbstractClassReconstitutor.php b/src/AbstractClassReconstitutor.php
@@ -26,5 +26,6 @@ abstract class AbstractClassReconstitutor extends AbstractReconstitutor implemen
 {
     use DirectPropertyAccessorAwareTrait;
 
+    #[\Override]
     abstract public static function getClass(): string;
 }
diff --git a/src/DependencyInjection/AttributeReconstitutorPass.php b/src/DependencyInjection/AttributeReconstitutorPass.php
@@ -23,6 +23,7 @@
 
 class AttributeReconstitutorPass implements CompilerPassInterface
 {
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         $reconstitutorResolver = $container
@@ -39,13 +40,13 @@ public function process(ContainerBuilder $container): void
          */
         $classMap = [];
 
-        foreach ($attributeReconstitutors as $id => $service) {
+        foreach (array_keys($attributeReconstitutors) as $id) {
             $definition = $container->getDefinition($id);
             $reconstitutorClass = $definition->getClass();
             \assert(\is_string($reconstitutorClass));
             \assert(class_exists($reconstitutorClass));
 
-            if (!$r = $container->getReflectionClass($reconstitutorClass)) {
+            if (($r = $container->getReflectionClass($reconstitutorClass)) === null) {
                 throw new \InvalidArgumentException(\sprintf('Class "%s" used for service "%s" cannot be found.', $reconstitutorClass, $id));
             }
 
@@ -60,7 +61,7 @@ public function process(ContainerBuilder $container): void
             $reconstitutorClass = $r->name;
             $targetClass = $reconstitutorClass::getAttributeClass();
 
-            if (!$r = $container->getReflectionClass($targetClass)) {
+            if (($r = $container->getReflectionClass($targetClass)) === null) {
                 throw new \InvalidArgumentException(\sprintf('Class "%s" used by reconstitutor "%s" cannot be found.', $targetClass, $reconstitutorClass));
             }
 

diff --git a/src/DependencyInjection/ClassReconstitutorPass.php b/src/DependencyInjection/ClassReconstitutorPass.php
@@ -23,6 +23,7 @@
 
 class ClassReconstitutorPass implements CompilerPassInterface
 {
+    #[\Override]
     public function process(ContainerBuilder $container): void
     {
         $reconstitutorResolver = $container
@@ -39,13 +40,13 @@ public function process(ContainerBuilder $container): void
          */
         $classMap = [];
 
-        foreach ($classReconstitutors as $id => $service) {
+        foreach (array_keys($classReconstitutors) as $id) {
             $definition = $container->getDefinition($id);
             $reconstitutorClass = $definition->getClass();
             \assert(\is_string($reconstitutorClass));
             \assert(class_exists($reconstitutorClass));
 
-            if (!$r = $container->getReflectionClass($reconstitutorClass)) {
+            if (($r = $container->getReflectionClass($reconstitutorClass)) === null) {
                 throw new \InvalidArgumentException(\sprintf('Class "%s" used for service "%s" cannot be found.', $reconstitutorClass, $id));
             }
 
@@ -56,7 +57,7 @@ public function process(ContainerBuilder $container): void
             $reconstitutorClass = $r->name;
             $targetClass = $reconstitutorClass::getClass();
 
-            if (!$r = $container->getReflectionClass($targetClass)) {
+            if (($r = $container->getReflectionClass($targetClass)) === null) {
                 throw new \InvalidArgumentException(\sprintf('Class "%s" used by reconstitutor "%s" cannot be found.', $targetClass, $reconstitutorClass));
             }
 

diff --git a/src/DependencyInjection/RekalogikaReconstitutorExtension.php b/src/DependencyInjection/RekalogikaReconstitutorExtension.php
@@ -26,6 +26,7 @@ class RekalogikaReconstitutorExtension extends Extension
     /**
      * @param array<array-key,mixed> $configs
      */
+    #[\Override]
     public function load(array $configs, ContainerBuilder $container): void
     {
         $env = $container->getParameter('kernel.environment');

diff --git a/src/Doctrine/DoctrineListener.php b/src/Doctrine/DoctrineListener.php
@@ -22,7 +22,7 @@
 
 class DoctrineListener
 {
-    public function __construct(private ReconstitutorProcessor $processor) {}
+    public function __construct(private readonly ReconstitutorProcessor $processor) {}
 
     public function prePersist(PrePersistEventArgs $args): void
     {

diff --git a/src/ReconstitutorProcessor.php b/src/ReconstitutorProcessor.php
@@ -21,7 +21,7 @@ final class ReconstitutorProcessor
     /**
      * @param iterable<ReconstitutorResolverInterface> $resolvers
      */
-    public function __construct(private iterable $resolvers) {}
+    public function __construct(private readonly iterable $resolvers) {}
 
     /**
      * @return iterable<array-key,ReconstitutorInterface<object>>

diff --git a/src/RekalogikaReconstitutorBundle.php b/src/RekalogikaReconstitutorBundle.php
@@ -20,6 +20,7 @@
 
 class RekalogikaReconstitutorBundle extends Bundle
 {
+    #[\Override]
     public function build(ContainerBuilder $container): void
     {
         parent::build($container);

diff --git a/src/Resolver/AttributeReconstitutorResolver.php b/src/Resolver/AttributeReconstitutorResolver.php
@@ -29,9 +29,10 @@ final class AttributeReconstitutorResolver implements ReconstitutorResolverInter
      */
     public function __construct(private array $classMap) {}
 
+    #[\Override]
     public function getReconstitutors(object $object): iterable
     {
-        $class = \get_class($object);
+        $class = $object::class;
 
         if (isset($this->cache[$class])) {
             return $this->cache[$class];

diff --git a/src/Resolver/ClassReconstitutorResolver.php b/src/Resolver/ClassReconstitutorResolver.php
@@ -26,10 +26,10 @@ public function __construct(private array $classMap) {}
     /**
      * @return array<array-key,class-string>
      */
-    private static function getAllClasses(object $object): array
+    private function getAllClasses(object $object): array
     {
         $classes = array_merge(
-            [\get_class($object)],
+            [$object::class],
             class_parents($object),
             class_implements($object),
         );
@@ -40,9 +40,10 @@ class_implements($object),
     /**
      * @return iterable<int,ClassReconstitutorInterface<object>>
      */
+    #[\Override]
     public function getReconstitutors(object $object): iterable
     {
-        $classes = self::getAllClasses($object);
+        $classes = $this->getAllClasses($object);
 
         $reconstitutors = [];
 

diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php
@@ -23,6 +23,7 @@ public function testServiceWiring(): void
     {
         $kernel = new ReconstitutorKernel();
         $kernel->boot();
+
         $container = $kernel->getContainer();
 
         $classReconstitutorResolver = $container

diff --git a/tests/Reconstitutor/AttributeReconstitutor.php b/tests/Reconstitutor/AttributeReconstitutor.php
@@ -20,6 +20,7 @@ class AttributeReconstitutor extends AbstractAttributeReconstitutor
 {
     use CommonTrait;
 
+    #[\Override]
     public static function getAttributeClass(): string
     {
         return StubAttribute::class;

diff --git a/tests/Reconstitutor/EntityReconstitutor.php b/tests/Reconstitutor/EntityReconstitutor.php
@@ -20,6 +20,7 @@
  */
 class EntityReconstitutor extends AbstractTestClassReconstitutor
 {
+    #[\Override]
     public static function getClass(): string
     {
         return Entity::class;

diff --git a/tests/Reconstitutor/InterfaceReconstitutor.php b/tests/Reconstitutor/InterfaceReconstitutor.php
@@ -20,6 +20,7 @@
  */
 class InterfaceReconstitutor extends AbstractTestClassReconstitutor
 {
+    #[\Override]
     public static function getClass(): string
     {
         return StubInterface::class;

diff --git a/tests/Reconstitutor/SuperclassReconstitutor.php b/tests/Reconstitutor/SuperclassReconstitutor.php
@@ -20,6 +20,7 @@
  */
 class SuperclassReconstitutor extends AbstractTestClassReconstitutor
 {
+    #[\Override]
     public static function getClass(): string
     {
         return AbstractStub::class;

diff --git a/tests/ReconstitutorKernel.php b/tests/ReconstitutorKernel.php
@@ -27,6 +27,7 @@ public function __construct()
         parent::__construct('test', true);
     }
 
+    #[\Override]
     public function registerBundles(): iterable
     {
         return [
@@ -35,5 +36,6 @@ public function registerBundles(): iterable
         ];
     }
 
+    #[\Override]
     public function registerContainerConfiguration(LoaderInterface $loader): void {}
 }
diff --git a/tests/ReconstitutorTest.php b/tests/ReconstitutorTest.php
@@ -26,10 +26,12 @@ class ReconstitutorTest extends TestCase
 {
     private ?ContainerInterface $container = null;
 
-    public function setUp(): void
+    #[\Override]
+    protected function setUp(): void
     {
         $kernel = new ReconstitutorKernel();
         $kernel->boot();
+
         $this->container = $kernel->getContainer();
     }