feat(rector): Add rector checks

ragusa87 · May 25, 2024 · c1b9a6e · c1b9a6e
1 parent 9fd3f20
commit c1b9a6e
Show file tree

Hide file tree

Showing 11 changed files with 119 additions and 29 deletions.
diff --git a/composer.json b/composer.json
@@ -119,13 +119,22 @@
             "Composer\\Config::disableProcessTimeout",
             "env XDEBUG_MODE=off ./vendor/bin/php-cs-fixer fix ./src -vv --verbose  --config=.php-cs-fixer.dist.php"
         ],
+        "test-rector": [
+            "Composer\\Config::disableProcessTimeout",
+            "env XDEBUG_MODE=off ./vendor/bin/rector --dry-run"
+        ],
+        "rector": [
+            "Composer\\Config::disableProcessTimeout",
+            "env XDEBUG_MODE=off ./vendor/bin/rector"
+        ],
         "test-phpunit": [
             "Composer\\Config::disableProcessTimeout",
             "env XDEBUG_MODE=off ./vendor/bin/phpunit --colors=always"
         ],
         "test": [
             "@test-phpcs",
             "@test-phpstan",
+            "@test-rector",
             "mkdir -p data",
             "rm -f data/database.sqlite",
             "touch data/database.sqlite",
@@ -158,6 +167,7 @@
         "phpstan/phpstan-strict-rules": "^1.0",
         "phpstan/phpstan-symfony": "^1.2",
         "phpunit/phpunit": "^9.5",
+        "rector/rector": "^1.1",
         "roave/security-advisories": "dev-latest",
         "symfony/browser-kit": "^6.2",
         "symfony/css-selector": "^6.2",

diff --git a/composer.lock b/composer.lock
diff --git a/rector.php b/rector.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/config',
+        __DIR__ . '/public',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withRules([
+        AddVoidReturnTypeWhereNoReturnRector::class,
+    ])
+    ->withImportNames(true, true, false, true)
+    ->withSkip([
+        '**/config/bundles.php',
+    ]);
diff --git a/src/Command/BooksExtractCoverCommand.php b/src/Command/BooksExtractCoverCommand.php
@@ -2,7 +2,6 @@
 
 namespace App\Command;
 
-use App\Entity\Book;
 use App\Repository\BookRepository;
 use App\Service\BookFileSystemManager;
 use Doctrine\ORM\EntityManagerInterface;

diff --git a/src/Controller/AbstractController.php b/src/Controller/AbstractController.php
@@ -6,6 +6,7 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController as BaseAbstractController;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpFoundation\Response;
+use Twig\Environment;
 
 abstract class AbstractController extends BaseAbstractController
 {
@@ -19,7 +20,7 @@ private function prefixView(string $view): string
                 return $view;
             }
             $twig = $this->container->get('twig');
-            if (!$twig instanceof \Twig\Environment) {
+            if (!$twig instanceof Environment) {
                 return $view;
             }
             if ($twig->getLoader()->exists($theme.'/'.$view)) {
@@ -44,7 +45,7 @@ private function doRenderView(string $view, ?string $block, array $parameters, s
         }
 
         $twig = $this->container->get('twig');
-        if (!$twig instanceof \Twig\Environment) {
+        if (!$twig instanceof Environment) {
             return $view;
         }
 

diff --git a/src/Form/BookFilterType.php b/src/Form/BookFilterType.php
@@ -6,7 +6,11 @@
 use App\Entity\User;
 use Doctrine\ORM\QueryBuilder;
 use Symfony\Component\Form\AbstractType;
-use Symfony\Component\Form\Extension\Core\Type;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\Extension\Core\Type\HiddenType;
+use Symfony\Component\Form\Extension\Core\Type\SearchType;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Routing\RouterInterface;
@@ -23,7 +27,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder->setMethod('GET');
 
-        $builder->add('title', Type\SearchType::class, [
+        $builder->add('title', SearchType::class, [
             'required' => false,
             'target_callback' => function (QueryBuilder $qb, ?string $searchValue): void {
                 if ($searchValue !== null) {
@@ -33,7 +37,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('serieIndexGTE', Type\SearchType::class, [
+        $builder->add('serieIndexGTE', SearchType::class, [
             'required' => false,
             'mapped' => false,
             'label' => 'Index >=',
@@ -45,7 +49,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('serieIndexLTE', Type\SearchType::class, [
+        $builder->add('serieIndexLTE', SearchType::class, [
             'required' => false,
             'mapped' => false,
             'label' => 'Index <=',
@@ -57,7 +61,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('authors', Type\TextType::class, [
+        $builder->add('authors', TextType::class, [
             'autocomplete' => true,
             'tom_select_options' => [
                 'create' => false,
@@ -82,7 +86,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('authorsNot', Type\TextType::class, [
+        $builder->add('authorsNot', TextType::class, [
             'autocomplete' => true,
             'tom_select_options' => [
                 'create' => false,
@@ -108,7 +112,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('tags', Type\TextType::class, [
+        $builder->add('tags', TextType::class, [
             'autocomplete' => true,
             'tom_select_options' => [
                 'create' => false,
@@ -137,7 +141,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('serie', Type\TextType::class, [
+        $builder->add('serie', TextType::class, [
             'autocomplete' => true,
             'tom_select_options' => [
                 'create' => false,
@@ -166,7 +170,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('publisher', Type\TextType::class, [
+        $builder->add('publisher', TextType::class, [
             'autocomplete' => true,
             'tom_select_options' => [
                 'create' => false,
@@ -195,7 +199,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('read', Type\ChoiceType::class, [
+        $builder->add('read', ChoiceType::class, [
             'choices' => [
                 'Any' => '',
                 'Read' => 'read',
@@ -215,7 +219,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('extension', Type\ChoiceType::class, [
+        $builder->add('extension', ChoiceType::class, [
             'choices' => [
                 'Any' => '',
                 'epub' => 'epub',
@@ -233,7 +237,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('age', Type\ChoiceType::class, [
+        $builder->add('age', ChoiceType::class, [
             'choices' => User::AGE_CATEGORIES + ['Not set' => 'null'],
             'required' => false,
             'mapped' => false,
@@ -249,7 +253,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('favorite', Type\ChoiceType::class, [
+        $builder->add('favorite', ChoiceType::class, [
             'choices' => [
                 'Any' => '',
                 'Favorite' => 'favorite',
@@ -269,7 +273,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('verified', Type\ChoiceType::class, [
+        $builder->add('verified', ChoiceType::class, [
             'choices' => [
                 'Any' => '',
                 'Verified' => 'verified',
@@ -289,7 +293,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('picture', Type\ChoiceType::class, [
+        $builder->add('picture', ChoiceType::class, [
             'choices' => [
                 'Any' => '',
                 'Has picture' => 'with',
@@ -309,7 +313,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('orderBy', Type\ChoiceType::class, [
+        $builder->add('orderBy', ChoiceType::class, [
             'choices' => [
                 'created (ASC)' => 'created-asc',
                 'created (DESC)' => 'created-desc',
@@ -346,14 +350,14 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             },
         ]);
 
-        $builder->add('displayMode', Type\HiddenType::class, [
+        $builder->add('displayMode', HiddenType::class, [
             'data' => 'list',
             'mapped' => false,
             'target_callback' => function (QueryBuilder $qb, ?string $orderByValue): void {
             },
         ]);
 
-        $builder->add('submit', Type\SubmitType::class, [
+        $builder->add('submit', SubmitType::class, [
             'label' => 'Filter',
             'attr' => [
                 'class' => 'btn btn-primary',

diff --git a/src/Repository/ShelfRepository.php b/src/Repository/ShelfRepository.php
@@ -4,6 +4,7 @@
 
 use App\Entity\Kobo;
 use App\Entity\Shelf;
+use App\Kobo\SyncToken;
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 use Doctrine\ORM\NonUniqueResultException;
 use Doctrine\Persistence\ManagerRegistry;
@@ -83,10 +84,10 @@ public function findByKoboAndName(Kobo $kobo, mixed $name): ?Shelf
 
     /**
      * @param Kobo $kobo
-     * @param \App\Kobo\SyncToken $syncToken
+     * @param SyncToken $syncToken
      * @return array<Shelf>
      */
-    public function getShelvesToSync(Kobo $kobo, \App\Kobo\SyncToken $syncToken): array
+    public function getShelvesToSync(Kobo $kobo, SyncToken $syncToken): array
     {
         $qb = $this->createQueryBuilder('shelf')
             ->select('shelf')

diff --git a/tests/Contraints/JSONIsValidSyncResponse.php b/tests/Contraints/JSONIsValidSyncResponse.php
@@ -2,7 +2,6 @@
 
 namespace App\Tests\Contraints;
 
-use PHPUnit\Framework\Constraint\ArrayHasKey;
 use PHPUnit\Framework\Constraint\Constraint;
 use PHPUnit\Framework\Constraint\IsIdentical;
 

diff --git a/tests/Controller/AbstractKoboControllerTest.php b/tests/Controller/AbstractKoboControllerTest.php
@@ -5,10 +5,8 @@
 use App\DataFixtures\BookFixture;
 use App\Entity\Book;
 use App\Entity\Kobo;
-use App\Entity\User;
 use App\Service\BookFileSystemManager;
 use Doctrine\ORM\EntityManagerInterface;
-use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Bundle\SecurityBundle\Security;

diff --git a/tests/Controller/KoboTagControllerTest.php b/tests/Controller/KoboTagControllerTest.php
@@ -4,7 +4,6 @@
 
 use App\DataFixtures\ShelfFixture;
 use App\Entity\Shelf;
-use Doctrine\ORM\EntityManager;
 
 class KoboTagControllerTest  extends AbstractKoboControllerTest
 {

diff --git a/tests/Kobo/Request/ReadingStateDeserializeTest.php b/tests/Kobo/Request/ReadingStateDeserializeTest.php
@@ -3,7 +3,6 @@
 namespace App\Tests\Kobo\Request;
 
 use App\Kobo\Request\Bookmark;
-use App\Kobo\Request\ReadingState;
 use App\Kobo\Request\ReadingStates;
 use App\Kobo\Request\ReadingStateStatusInfo;
 use JMS\Serializer\SerializerInterface;