fix: lint (#393)

api-platform · Mar 26, 2024 · f4b3e32 · f4b3e32
1 parent 825d80e
commit f4b3e32
Show file tree

Hide file tree

Showing 32 changed files with 62 additions and 45 deletions.
diff --git a/api/src/Command/BooksImportCommand.php b/api/src/Command/BooksImportCommand.php
@@ -84,7 +84,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $io->progressFinish();
 
-        $output->write($this->serializer->serialize($data, 'json', [JsonEncode::OPTIONS => JSON_PRETTY_PRINT]));
+        $output->write($this->serializer->serialize($data, 'json', [JsonEncode::OPTIONS => \JSON_PRETTY_PRINT]));
 
         return Command::SUCCESS;
     }

diff --git a/api/src/DataFixtures/Story/DefaultStory.php b/api/src/DataFixtures/Story/DefaultStory.php
@@ -14,7 +14,9 @@
 
 final class DefaultStory extends Story
 {
-    public function __construct(private readonly DecoderInterface $decoder) {}
+    public function __construct(private readonly DecoderInterface $decoder)
+    {
+    }
 
     public function build(): void
     {

diff --git a/api/src/Doctrine/Orm/Extension/BookmarkQueryCollectionExtension.php b/api/src/Doctrine/Orm/Extension/BookmarkQueryCollectionExtension.php
@@ -16,9 +16,11 @@
  */
 final readonly class BookmarkQueryCollectionExtension implements QueryCollectionExtensionInterface
 {
-    public function __construct(private Security $security) {}
+    public function __construct(private Security $security)
+    {
+    }
 
-    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, Operation $operation = null, array $context = []): void
+    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
     {
         if (
             Bookmark::class !== $resourceClass

diff --git a/api/src/Doctrine/Orm/Filter/NameFilter.php b/api/src/Doctrine/Orm/Filter/NameFilter.php
@@ -31,7 +31,7 @@ public function getDescription(string $resourceClass): array
     /**
      * @param string|null $value
      */
-    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, Operation $operation = null, array $context = []): void
+    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, ?Operation $operation = null, array $context = []): void
     {
         if ('name' !== $property) {
             return;

diff --git a/api/src/Entity/User.php b/api/src/Entity/User.php
@@ -101,7 +101,9 @@ public function getId(): ?Uuid
         return $this->id;
     }
 
-    public function eraseCredentials(): void {}
+    public function eraseCredentials(): void
+    {
+    }
 
     /**
      * @return array<int, string>

diff --git a/api/src/Security/Core/UserProvider.php b/api/src/Security/Core/UserProvider.php
@@ -17,7 +17,9 @@
  */
 final readonly class UserProvider implements AttributesBasedUserProviderInterface
 {
-    public function __construct(private ManagerRegistry $registry, private UserRepository $repository) {}
+    public function __construct(private ManagerRegistry $registry, private UserRepository $repository)
+    {
+    }
 
     public function refreshUser(UserInterface $user): UserInterface
     {

diff --git a/api/src/Serializer/BookNormalizer.php b/api/src/Serializer/BookNormalizer.php
@@ -24,12 +24,13 @@ public function __construct(
         private RouterInterface $router,
         #[Autowire(service: ReviewRepository::class)]
         private ObjectRepository $repository
-    ) {}
+    ) {
+    }
 
     /**
      * @param Book $object
      */
-    public function normalize(mixed $object, string $format = null, array $context = []): array
+    public function normalize(mixed $object, ?string $format = null, array $context = []): array
     {
         $object->reviews = $this->router->generate('_api_/books/{bookId}/reviews{._format}_get_collection', [
             'bookId' => $object->getId(),
@@ -39,7 +40,7 @@ public function normalize(mixed $object, string $format = null, array $context =
         return $this->normalizer->normalize($object, $format, [self::class => true] + $context);
     }
 
-    public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
+    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
     {
         return $data instanceof Book && !isset($context[self::class]);
     }

diff --git a/api/src/Serializer/IriTransformerNormalizer.php b/api/src/Serializer/IriTransformerNormalizer.php
@@ -21,9 +21,10 @@ final class IriTransformerNormalizer implements NormalizerInterface, NormalizerA
     public function __construct(
         private readonly IriConverterInterface $iriConverter,
         private readonly OperationMetadataFactoryInterface $operationMetadataFactory
-    ) {}
+    ) {
+    }
 
-    public function normalize(mixed $object, string $format = null, array $context = []): array
+    public function normalize(mixed $object, ?string $format = null, array $context = []): array
     {
         /** @var array $data */
         $data = $this->normalizer->normalize($object, $format, $context + [self::class => true]);
@@ -54,7 +55,7 @@ public function normalize(mixed $object, string $format = null, array $context =
         return $data;
     }
 
-    public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
+    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
     {
         return \is_object($data)
             && !is_iterable($data)

diff --git a/api/src/State/Processor/BookPersistProcessor.php b/api/src/State/Processor/BookPersistProcessor.php
@@ -29,7 +29,8 @@ public function __construct(
         private ProcessorInterface $mercureProcessor,
         private HttpClientInterface $client,
         private DecoderInterface $decoder
-    ) {}
+    ) {
+    }
 
     /**
      * @param Book $data

diff --git a/api/src/State/Processor/BookRemoveProcessor.php b/api/src/State/Processor/BookRemoveProcessor.php
@@ -29,7 +29,8 @@ public function __construct(
         private ProcessorInterface $mercureProcessor,
         private ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
         private IriConverterInterface $iriConverter
-    ) {}
+    ) {
+    }
 
     /**
      * @param Book $data

diff --git a/api/src/State/Processor/BookmarkPersistProcessor.php b/api/src/State/Processor/BookmarkPersistProcessor.php
@@ -25,7 +25,8 @@ public function __construct(
         private ProcessorInterface $persistProcessor,
         private Security $security,
         private ClockInterface $clock
-    ) {}
+    ) {
+    }
 
     /**
      * @param Bookmark $data

diff --git a/api/src/State/Processor/MercureProcessor.php b/api/src/State/Processor/MercureProcessor.php
@@ -31,7 +31,8 @@ public function __construct(
         private ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
         #[Autowire('%api_platform.formats%')]
         private array $formats
-    ) {}
+    ) {
+    }
 
     /**
      * @param array{item_uri_template?: string, topics?: array, mercure_data?: string} $context

diff --git a/api/src/State/Processor/ReviewPersistProcessor.php b/api/src/State/Processor/ReviewPersistProcessor.php
@@ -29,7 +29,8 @@ public function __construct(
         private ProcessorInterface $mercureProcessor,
         private Security $security,
         private ClockInterface $clock
-    ) {}
+    ) {
+    }
 
     /**
      * @param Review $data

diff --git a/api/src/State/Processor/ReviewRemoveProcessor.php b/api/src/State/Processor/ReviewRemoveProcessor.php
@@ -29,7 +29,8 @@ public function __construct(
         private ProcessorInterface $mercureProcessor,
         private ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
         private IriConverterInterface $iriConverter
-    ) {}
+    ) {
+    }
 
     /**
      * @param Review $data

diff --git a/api/src/Validator/UniqueUserBook.php b/api/src/Validator/UniqueUserBook.php
@@ -11,7 +11,7 @@ final class UniqueUserBook extends Constraint
 {
     public string $message = 'The book is already related to the current user.';
 
-    public function __construct(array $options = null, string $message = null, array $groups = null, mixed $payload = null)
+    public function __construct(?array $options = null, ?string $message = null, ?array $groups = null, mixed $payload = null)
     {
         parent::__construct($options ?? [], $groups, $payload);
 

diff --git a/api/src/Validator/UniqueUserBookValidator.php b/api/src/Validator/UniqueUserBookValidator.php
@@ -23,7 +23,8 @@ public function __construct(
         private readonly Security $security,
         private readonly ManagerRegistry $registry,
         private readonly PropertyAccessorInterface $propertyAccessor
-    ) {}
+    ) {
+    }
 
     /**
      * @param Bookmark|Review|null $value

diff --git a/api/tests/Api/Admin/BookTest.php b/api/tests/Api/Admin/BookTest.php
@@ -15,12 +15,12 @@
 use App\Tests\Api\Trait\SecurityTrait;
 use App\Tests\Api\Trait\SerializerTrait;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Mercure\Update;
 use Zenstruck\Foundry\FactoryCollection;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
-use PHPUnit\Framework\Attributes\Test;
 
 final class BookTest extends ApiTestCase
 {
@@ -63,7 +63,7 @@ public function asNonAdminUserICannotGetACollectionOfBooks(int $expectedCode, st
 
     #[Test]
     #[DataProvider(methodName: 'getUrls')]
-    public function asAdminUserICanGetACollectionOfBooks(FactoryCollection $factory, string $url, int $hydraTotalItems, int $itemsPerPage = null): void
+    public function asAdminUserICanGetACollectionOfBooks(FactoryCollection $factory, string $url, int $hydraTotalItems, ?int $itemsPerPage = null): void
     {
         // Cannot use Factory as data provider because BookFactory has a service dependency
         $factory->create();
@@ -315,11 +315,11 @@ public static function getInvalidData(): iterable
             [
                 '@type' => 'ConstraintViolationList',
                 'hydra:title' => 'An error occurred',
-                'hydra:description' => 'condition: This value should be of type '.BookCondition::class.'.',
+                'hydra:description' => 'condition: This value should be of type ' . BookCondition::class . '.',
                 'violations' => [
                     [
                         'propertyPath' => 'condition',
-                        'hint' => 'The data must belong to a backed enumeration of type '.BookCondition::class,
+                        'hint' => 'The data must belong to a backed enumeration of type ' . BookCondition::class,
                     ],
                 ],
             ],
@@ -333,11 +333,11 @@ public static function getInvalidData(): iterable
             [
                 '@type' => 'ConstraintViolationList',
                 'hydra:title' => 'An error occurred',
-                'hydra:description' => 'condition: This value should be of type '.BookCondition::class.'.',
+                'hydra:description' => 'condition: This value should be of type ' . BookCondition::class . '.',
                 'violations' => [
                     [
                         'propertyPath' => 'condition',
-                        'hint' => 'The data must belong to a backed enumeration of type '.BookCondition::class,
+                        'hint' => 'The data must belong to a backed enumeration of type ' . BookCondition::class,
                     ],
                 ],
             ],

diff --git a/api/tests/Api/Admin/ReviewTest.php b/api/tests/Api/Admin/ReviewTest.php
@@ -16,12 +16,12 @@
 use App\Tests\Api\Trait\SecurityTrait;
 use App\Tests\Api\Trait\SerializerTrait;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Mercure\Update;
 use Zenstruck\Foundry\FactoryCollection;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
-use PHPUnit\Framework\Attributes\Test;
 
 final class ReviewTest extends ApiTestCase
 {
@@ -64,7 +64,7 @@ public function asNonAdminUserICannotGetACollectionOfReviews(int $expectedCode,
 
     #[Test]
     #[DataProvider(methodName: 'getAdminUrls')]
-    public function asAdminUserICanGetACollectionOfReviews(FactoryCollection $factory, callable|string $url, int $hydraTotalItems, int $itemsPerPage = null): void
+    public function asAdminUserICanGetACollectionOfReviews(FactoryCollection $factory, callable|string $url, int $hydraTotalItems, ?int $itemsPerPage = null): void
     {
         $factory->create();
 

diff --git a/api/tests/Api/Admin/UserTest.php b/api/tests/Api/Admin/UserTest.php
@@ -11,11 +11,11 @@
 use App\Tests\Api\Admin\Trait\UsersDataProviderTrait;
 use App\Tests\Api\Trait\SecurityTrait;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use Symfony\Component\Uid\Uuid;
 use Zenstruck\Foundry\FactoryCollection;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
-use PHPUnit\Framework\Attributes\Test;
 
 final class UserTest extends ApiTestCase
 {
@@ -57,7 +57,7 @@ public function asNonAdminUserICannotGetACollectionOfUsers(int $expectedCode, st
 
     #[Test]
     #[DataProvider(methodName: 'getAdminUrls')]
-    public function asAdminUserICanGetACollectionOfUsers(FactoryCollection $factory, callable|string $url, int $hydraTotalItems, int $itemsPerPage = null): void
+    public function asAdminUserICanGetACollectionOfUsers(FactoryCollection $factory, callable|string $url, int $hydraTotalItems, ?int $itemsPerPage = null): void
     {
         $factory->create();
 

diff --git a/api/tests/Api/BookTest.php b/api/tests/Api/BookTest.php
@@ -10,11 +10,11 @@
 use App\DataFixtures\Factory\ReviewFactory;
 use App\Enum\BookCondition;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use Symfony\Component\HttpFoundation\Response;
 use Zenstruck\Foundry\FactoryCollection;
 use Zenstruck\Foundry\Test\Factories;
 use Zenstruck\Foundry\Test\ResetDatabase;
-use PHPUnit\Framework\Attributes\Test;
 
 final class BookTest extends ApiTestCase
 {

diff --git a/api/tests/Api/BookmarkTest.php b/api/tests/Api/BookmarkTest.php
@@ -128,11 +128,11 @@ public function asAUserICannotCreateABookmarkWithInvalidData(): void
         self::assertJsonContains([
             '@type' => 'ConstraintViolationList',
             'hydra:title' => 'An error occurred',
-            'hydra:description' => 'book: This value should be of type '.Book::class.'.',
+            'hydra:description' => 'book: This value should be of type ' . Book::class . '.',
             'violations' => [
                 [
                     'propertyPath' => 'book',
-                    'hint' => 'Item not found for "/books/'.$uuid.'".',
+                    'hint' => 'Item not found for "/books/' . $uuid . '".',
                 ],
             ],
         ]);

diff --git a/api/tests/Api/Trait/SerializerTrait.php b/api/tests/Api/Trait/SerializerTrait.php
@@ -19,7 +19,7 @@ public static function serialize(mixed $data, string $format, array $context = [
         static::fail('A client must have Serializer enabled to make serialization. Did you forget to require symfony/serializer?');
     }
 
-    public static function getOperationNormalizationContext(string $resourceClass, string $operationName = null): array
+    public static function getOperationNormalizationContext(string $resourceClass, ?string $operationName = null): array
     {
         if ($resourceMetadataFactoryCollection = static::getContainer()->get('api_platform.metadata.resource.metadata_collection_factory')) {
             $operation = $resourceMetadataFactoryCollection->create($resourceClass)->getOperation($operationName);

diff --git a/api/tests/Doctrine/Orm/Extension/BookmarkQueryCollectionExtensionTest.php b/api/tests/Doctrine/Orm/Extension/BookmarkQueryCollectionExtensionTest.php
@@ -9,11 +9,11 @@
 use App\Doctrine\Orm\Extension\BookmarkQueryCollectionExtension;
 use App\Entity\Bookmark;
 use Doctrine\ORM\QueryBuilder;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\SecurityBundle\Security;
 use Symfony\Component\Security\Core\User\UserInterface;
-use PHPUnit\Framework\Attributes\Test;
 
 final class BookmarkQueryCollectionExtensionTest extends TestCase
 {

diff --git a/api/tests/Security/Core/UserProviderTest.php b/api/tests/Security/Core/UserProviderTest.php
@@ -10,12 +10,12 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Uid\Uuid;
-use PHPUnit\Framework\Attributes\Test;
 
 final class UserProviderTest extends TestCase
 {

diff --git a/api/tests/Serializer/BookNormalizerTest.php b/api/tests/Serializer/BookNormalizerTest.php
@@ -8,12 +8,12 @@
 use App\Enum\BookCondition;
 use App\Repository\ReviewRepository;
 use App\Serializer\BookNormalizer;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Uid\Uuid;
-use PHPUnit\Framework\Attributes\Test;
 
 final class BookNormalizerTest extends TestCase
 {

diff --git a/api/tests/Serializer/IriTransformerNormalizerTest.php b/api/tests/Serializer/IriTransformerNormalizerTest.php
@@ -10,10 +10,10 @@
 use ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface;
 use App\Serializer\IriTransformerNormalizer;
 use Doctrine\Common\Collections\ArrayCollection;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
-use PHPUnit\Framework\Attributes\Test;
 
 final class IriTransformerNormalizerTest extends TestCase
 {

diff --git a/api/tests/State/Processor/BookPersistProcessorTest.php b/api/tests/State/Processor/BookPersistProcessorTest.php
@@ -8,13 +8,13 @@
 use ApiPlatform\State\ProcessorInterface;
 use App\Entity\Book;
 use App\State\Processor\BookPersistProcessor;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Serializer\Encoder\DecoderInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
-use PHPUnit\Framework\Attributes\Test;
 
 final class BookPersistProcessorTest extends TestCase
 {