Build/rector

.github/workflows/ci.yml

@@ -65,6 +65,9 @@ jobs:
     - name: Validate monorepo
       run: vendor/bin/monorepo-builder validate
 
+    # - name: Rector
+    #   run: vendor/bin/rector process --no-progress-bar --no-diffs --dry-run --no-ansi
+
     - name: Load fixtures
       run: make fixtures
 

.gitignore

@@ -3,4 +3,5 @@ vendor
 .phpunit.cache
 tools
 .php-cs-fixer.cache
-.vscode
+.vscode
+rector.log

Makefile

@@ -27,6 +27,11 @@ phpunit:
 lint:
 	$(PHP) tests/bin/console lint:container
 
+.PHONY: rector
+rector:
+	$(PHP) vendor/bin/rector process > rector.log
+	make php-cs-fixer
+
 .PHONY: php-cs-fixer
 php-cs-fixer: tools/php-cs-fixer
 	$(PHP) $< fix --config=.php-cs-fixer.dist.php --verbose --allow-risky=yes
@@ -74,4 +79,4 @@ sqlite:
 
 .PHONY: dump
 dump:
-	$(PHP) tests/bin/console server:dump
+	$(PHP) tests/bin/console server:dump

composer.json

@@ -63,6 +63,7 @@
         "psalm/plugin-symfony": "^5.1",
         "psr/log": "^2.0 || ^3.0",
         "ramsey/uuid": "^4.7",
+        "rector/rector": "^1.2",
         "rekalogika/doctrine-collections-decorator": "^2.3",
         "symfony/asset": "^6.4 || ^7.0",
         "symfony/asset-mapper": "^6.4 || ^7.0",

packages/rekapager-api-platform/src/Implementation/ApiPageUrlGenerator.php

@@ -25,8 +25,8 @@ class ApiPageUrlGenerator implements PageUrlGeneratorInterface
 
     public function __construct(
         string $iri,
-        private string $pageParameterName,
-        private int $urlGenerationStrategy,
+        private readonly string $pageParameterName,
+        private readonly int $urlGenerationStrategy,
     ) {
         $this->parsed = IriHelper::parseIri($iri, $this->pageParameterName);
     }

packages/rekapager-api-platform/src/Implementation/RekapagerExtension.php

@@ -36,11 +36,11 @@
  * @template T of object
  * @implements QueryResultCollectionExtensionInterface<T>
  */
-final class RekapagerExtension implements QueryResultCollectionExtensionInterface
+final readonly class RekapagerExtension implements QueryResultCollectionExtensionInterface
 {
     public function __construct(
-        private readonly PagerFactory $pagerFactory,
-        private readonly Pagination $pagination,
+        private PagerFactory $pagerFactory,
+        private Pagination $pagination,
     ) {
     }
 
@@ -91,8 +91,7 @@ public function getResult(
         array $context = []
     ): iterable {
         $pageable = new KeysetPageable(new QueryBuilderAdapter($queryBuilder));
-        $pager = $this->pagerFactory->createPager($pageable, $operation, $context);
 
-        return $pager;
+        return $this->pagerFactory->createPager($pageable, $operation, $context);
     }
 }

packages/rekapager-api-platform/src/Implementation/RekapagerOpenApiFactoryDecorator.php

@@ -21,13 +21,12 @@
 class RekapagerOpenApiFactoryDecorator implements OpenApiFactoryInterface
 {
     public function __construct(
-        private OpenApiFactoryInterface $decorated,
+        private readonly OpenApiFactoryInterface $decorated,
     ) {
     }
 
     /**
      * @param array<array-key,mixed> $context
-     * @return OpenApi
      */
     public function __invoke(array $context = []): OpenApi
     {

packages/rekapager-api-platform/src/Util/IriHelper.php

@@ -75,7 +75,8 @@ public static function createIri(array $parts, array $parameters, ?string $pageP
             } else {
                 $scheme = 'http';
             }
-            $url .= UrlGeneratorInterface::NET_PATH === $urlGenerationStrategy ? '//' : "$scheme://";
+
+            $url .= UrlGeneratorInterface::NET_PATH === $urlGenerationStrategy ? '//' : $scheme . '://';
 
             if (isset($parts['user'])) {
                 $url .= $parts['user'];

packages/rekapager-bundle/src/PagerFactory.php

@@ -120,7 +120,9 @@ public function createPager(
 
         try {
             /** @psalm-suppress NoValue */
-            foreach ($pager->getCurrentPage() as $i);
+            foreach ($pager->getCurrentPage() as $i) {
+                // noop
+            }
         } catch (ContractsOutOfBoundsException $e) {
             throw new OutOfBoundsException($e, $pager, $options);
         }
@@ -142,9 +144,7 @@ private function getPageIdentifier(
             return null;
         }
 
-        $pageIdentifier = $this->pageIdentifierEncoderResolver
+        return $this->pageIdentifierEncoderResolver
             ->decode($pageable, $pageIdentifier);
-
-        return $pageIdentifier;
     }
 }

packages/rekapager-bundle/src/Twig/RekapagerRuntime.php

@@ -26,7 +26,6 @@ public function __construct(
     /**
      * @param PagerInterface<array-key,mixed> $pager
      * @param int<0,max>|null $proximity
-     * @return string
      */
     public function renderPager(
         PagerInterface $pager,

packages/rekapager-core/src/Batch/BatchProcess.php

@@ -33,7 +33,6 @@ final class BatchProcess
 
     /**
      * @param PageableInterface<TKey,T> $pageable
-     * @param PageIdentifierEncoderResolverInterface $pageableIdentifierResolver
      * @param BatchProcessorInterface<TKey,T> $batchProcessor
      */
     public function __construct(

packages/rekapager-core/src/Batch/BatchProcessorDecorator.php

@@ -31,7 +31,7 @@ abstract class BatchProcessorDecorator implements BatchProcessorInterface
     /**
      * @param BatchProcessorInterface<TKey,T> $decorated
      */
-    public function __construct(private BatchProcessorInterface $decorated)
+    public function __construct(private readonly BatchProcessorInterface $decorated)
     {
     }
 

packages/rekapager-core/src/Batch/Event/AfterPageEvent.php

@@ -19,13 +19,13 @@
  * @template TKey of array-key
  * @template T
  */
-final class AfterPageEvent
+final readonly class AfterPageEvent
 {
     /**
      * @param BeforePageEvent<TKey,T> $beforePageEvent
      */
     public function __construct(
-        private readonly BeforePageEvent $beforePageEvent,
+        private BeforePageEvent $beforePageEvent,
     ) {
     }
 

packages/rekapager-core/src/Batch/Event/AfterProcessEvent.php

@@ -19,13 +19,13 @@
  * @template TKey of array-key
  * @template T
  */
-final class AfterProcessEvent
+final readonly class AfterProcessEvent
 {
     /**
      * @param PageableInterface<TKey,T> $pageable
      */
     public function __construct(
-        private readonly PageableInterface $pageable,
+        private PageableInterface $pageable,
     ) {
     }
 

packages/rekapager-core/src/Batch/Event/BeforePageEvent.php

@@ -19,15 +19,14 @@
  * @template TKey of array-key
  * @template T
  */
-final class BeforePageEvent
+final readonly class BeforePageEvent
 {
     /**
      * @param PageInterface<TKey,T> $page
-     * @param string $encodedPageIdentifier
      */
     public function __construct(
-        private readonly PageInterface $page,
-        private readonly string $encodedPageIdentifier,
+        private PageInterface $page,
+        private string $encodedPageIdentifier,
     ) {
     }
 

packages/rekapager-core/src/Batch/Event/BeforeProcessEvent.php

@@ -19,14 +19,14 @@
  * @template TKey of array-key
  * @template T
  */
-final class BeforeProcessEvent
+final readonly class BeforeProcessEvent
 {
     /**
      * @param PageableInterface<TKey,T> $pageable
      */
     public function __construct(
-        private readonly PageableInterface $pageable,
-        private readonly ?string $startPageIdentifier,
+        private PageableInterface $pageable,
+        private ?string $startPageIdentifier,
     ) {
     }
 

packages/rekapager-core/src/Batch/Event/InterruptEvent.php

@@ -19,14 +19,14 @@
  * @template TKey of array-key
  * @template T
  */
-final class InterruptEvent
+final readonly class InterruptEvent
 {
     /**
      * @param PageableInterface<TKey,T> $pageable
      */
     public function __construct(
-        private readonly PageableInterface $pageable,
-        private readonly ?string $nextPageIdentifier,
+        private PageableInterface $pageable,
+        private ?string $nextPageIdentifier,
     ) {
     }
 

packages/rekapager-core/src/Batch/Event/ItemEvent.php

@@ -17,15 +17,15 @@
  * @template TKey of array-key
  * @template T
  */
-final class ItemEvent
+final readonly class ItemEvent
 {
     /**
      * @param TKey $key
      * @param T $item
      */
     public function __construct(
-        private readonly int|string $key,
-        private readonly mixed $item,
+        private int|string $key,
+        private mixed $item,
     ) {
     }
 

packages/rekapager-core/src/Batch/Event/TimeLimitEvent.php

@@ -19,14 +19,14 @@
  * @template TKey of array-key
  * @template T
  */
-final class TimeLimitEvent
+final readonly class TimeLimitEvent
 {
     /**
      * @param PageableInterface<TKey,T> $pageable
      */
     public function __construct(
-        private readonly PageableInterface $pageable,
-        private readonly ?string $nextPageIdentifier,
+        private PageableInterface $pageable,
+        private ?string $nextPageIdentifier,
     ) {
     }
 

packages/rekapager-core/src/Batch/Implementation/DefaultBatchProcessFactory.php

@@ -19,10 +19,10 @@
 use Rekalogika\Rekapager\Batch\BatchProcessorInterface;
 use Rekalogika\Rekapager\Contracts\PageIdentifierEncoderResolverInterface;
 
-final class DefaultBatchProcessFactory implements BatchProcessFactoryInterface
+final readonly class DefaultBatchProcessFactory implements BatchProcessFactoryInterface
 {
     public function __construct(
-        private readonly PageIdentifierEncoderResolverInterface $pageableIdentifierResolver,
+        private PageIdentifierEncoderResolverInterface $pageableIdentifierResolver,
     ) {
     }
 

packages/rekapager-core/src/Implementation/PageIdentifierEncoderResolver.php

@@ -21,7 +21,7 @@
 class PageIdentifierEncoderResolver implements PageIdentifierEncoderResolverInterface
 {
     public function __construct(
-        private PageIdentifierEncoderLocatorInterface $locator
+        private readonly PageIdentifierEncoderLocatorInterface $locator
     ) {
     }
 

packages/rekapager-core/src/Pager/Internal/NullPageDecorator.php

@@ -25,13 +25,13 @@
  * @implements \IteratorAggregate<TKey,T>
  * @internal
  */
-final class NullPageDecorator implements NullPageInterface, \IteratorAggregate
+final readonly class NullPageDecorator implements NullPageInterface, \IteratorAggregate
 {
     /**
      * @param PageInterface<TKey,T> $page
      */
     public function __construct(
-        private readonly PageInterface $page,
+        private PageInterface $page,
     ) {
     }
 
@@ -47,7 +47,7 @@ public function getPageNumber(): ?int
 
     public function withPageNumber(?int $pageNumber): static
     {
-        return new static($this->page->withPageNumber($pageNumber));
+        return new self($this->page->withPageNumber($pageNumber));
     }
 
     public function getPageable(): PageableInterface

packages/rekapager-core/src/Pager/Internal/PagerItem.php

@@ -29,7 +29,7 @@
  *
  * @internal
  */
-final class PagerItem implements PagerItemInterface, \IteratorAggregate
+final readonly class PagerItem implements PagerItemInterface, \IteratorAggregate
 {
     private int|null|NullPageNumber $pageNumber;
 

packages/rekapager-core/src/Pager/Internal/PagerUrlGeneratorInterface.php

@@ -24,7 +24,6 @@ interface PagerUrlGeneratorInterface
      * @template TKey of array-key
      * @template T
      * @param PageInterface<TKey,T> $page
-     * @return string|null
      */
     public function generateUrl(PageInterface $page): ?string;
 }