refactor: Use friendsofphp/php-cs-fixer instead of squizlabs/php_code…

…sniffer (#22)
roadiz · Nov 6, 2024 · bc95777 · bc95777
1 parent 345f409
commit bc95777
Show file tree

Hide file tree

Showing 27 changed files with 54 additions and 137 deletions.
diff --git a/.github/workflows/run-test.yml b/.github/workflows/run-test.yml
@@ -35,7 +35,5 @@ jobs:
                       ${{ runner.os }}-php-${{ matrix.php-version }}-
             - name: Install Dependencies
               run: composer install --no-scripts --no-ansi --no-interaction --no-progress
-            - name: Run PHP Code Sniffer
-              run: vendor/bin/phpcs -p ./src
             - name: Run PHPStan
               run: vendor/bin/phpstan analyse --no-progress -c phpstan.neon
diff --git a/.gitignore b/.gitignore
@@ -118,9 +118,5 @@ modules.xml
 /lib/
 /.data/
 
-###> squizlabs/php_codesniffer ###
-/.phpcs-cache
-/phpcs.xml
-###< squizlabs/php_codesniffer ###
 /report.txt
 /composer.lock
diff --git a/Makefile b/Makefile
diff --git a/composer.json b/composer.json
@@ -35,8 +35,7 @@
         "roadiz/doc-generator": "2.4.x-dev",
         "roadiz/entity-generator": "2.4.x-dev",
         "roadiz/jwt": "2.4.x-dev",
-        "roadiz/random": "2.4.x-dev",
-        "squizlabs/php_codesniffer": "^3.5"
+        "roadiz/random": "2.4.x-dev"
     },
     "config": {
         "optimize-autoloader": true,

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
diff --git a/src/Console/PurgeUserValidationTokenCommand.php b/src/Console/PurgeUserValidationTokenCommand.php
@@ -13,7 +13,7 @@
 
 final class PurgeUserValidationTokenCommand extends Command
 {
-    public function __construct(private readonly ManagerRegistry $managerRegistry, string $name = null)
+    public function __construct(private readonly ManagerRegistry $managerRegistry, ?string $name = null)
     {
         parent::__construct($name);
     }
@@ -32,6 +32,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $count = $this->managerRegistry->getRepository(UserValidationToken::class)->deleteAllExpired();
 
         $io->success(sprintf('%d expired user validation token(s) were deleted.', $count));
+
         return 0;
     }
 }
diff --git a/src/DependencyInjection/Compiler/DoctrineMigrationCompilerPass.php b/src/DependencyInjection/Compiler/DoctrineMigrationCompilerPass.php
@@ -4,15 +4,11 @@
 
 namespace RZ\Roadiz\UserBundle\DependencyInjection\Compiler;
 
-use RuntimeException;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 class DoctrineMigrationCompilerPass implements CompilerPassInterface
 {
-    /**
-     * @inheritDoc
-     */
     public function process(ContainerBuilder $container): void
     {
         if ($container->hasDefinition('doctrine.migrations.configuration')) {
@@ -27,13 +23,13 @@ public function process(ContainerBuilder $container): void
 
     private function checkIfBundleRelativePath(string $path, ContainerBuilder $container): string
     {
-        if (isset($path[0]) && $path[0] === '@') {
-            $pathParts  = explode('/', $path);
+        if (isset($path[0]) && '@' === $path[0]) {
+            $pathParts = explode('/', $path);
             $bundleName = \mb_substr($pathParts[0], 1);
 
             $bundlePath = $this->getBundlePath($bundleName, $container);
 
-            return $bundlePath . \mb_substr($path, \mb_strlen('@' . $bundleName));
+            return $bundlePath.\mb_substr($path, \mb_strlen('@'.$bundleName));
         }
 
         return $path;
@@ -44,14 +40,8 @@ private function getBundlePath(string $bundleName, ContainerBuilder $container):
         $bundleMetadata = $container->getParameter('kernel.bundles_metadata');
         assert(is_array($bundleMetadata));
 
-        if (! isset($bundleMetadata[$bundleName])) {
-            throw new RuntimeException(
-                sprintf(
-                    'The bundle "%s" has not been registered, available bundles: %s',
-                    $bundleName,
-                    implode(', ', array_keys($bundleMetadata))
-                )
-            );
+        if (!isset($bundleMetadata[$bundleName])) {
+            throw new \RuntimeException(sprintf('The bundle "%s" has not been registered, available bundles: %s', $bundleName, implode(', ', array_keys($bundleMetadata))));
         }
 
         return $bundleMetadata[$bundleName]['path'];

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -58,6 +58,7 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->scalarNode('email_validated_role_name')
             ->defaultValue('ROLE_EMAIL_VALIDATED')
             ->end();
+
         return $builder;
     }
 }
diff --git a/src/DependencyInjection/RoadizUserExtension.php b/src/DependencyInjection/RoadizUserExtension.php
@@ -11,12 +11,9 @@
 
 class RoadizUserExtension extends Extension
 {
-    /**
-     * @inheritDoc
-     */
     public function load(array $configs, ContainerBuilder $container): void
     {
-        $loader = new YamlFileLoader($container, new FileLocator(dirname(__DIR__) . '/../config'));
+        $loader = new YamlFileLoader($container, new FileLocator(dirname(__DIR__).'/../config'));
         $loader->load('services.yaml');
 
         $configuration = new Configuration();

diff --git a/src/Entity/UserMetadata.php b/src/Entity/UserMetadata.php
@@ -23,57 +23,39 @@ class UserMetadata
     #[ORM\Column(name: 'metadata', type: 'json', nullable: true)]
     private ?array $metadata = [];
 
-    /**
-     * @return int|null
-     */
     public function getId(): ?int
     {
         return $this->id;
     }
 
-    /**
-     * @param int $id
-     * @return UserMetadata
-     */
     public function setId(int $id): UserMetadata
     {
         $this->id = $id;
+
         return $this;
     }
 
-    /**
-     * @return User|null
-     */
     public function getUser(): ?User
     {
         return $this->user;
     }
 
-    /**
-     * @param  User|null $user
-     * @return UserMetadata
-     */
     public function setUser(?User $user): UserMetadata
     {
         $this->user = $user;
+
         return $this;
     }
 
-    /**
-     * @return array|null
-     */
     public function getMetadata(): ?array
     {
         return $this->metadata;
     }
 
-    /**
-     * @param  array|null $metadata
-     * @return UserMetadata
-     */
     public function setMetadata(?array $metadata): UserMetadata
     {
         $this->metadata = $metadata;
+
         return $this;
     }
 }
diff --git a/src/Entity/UserValidationToken.php b/src/Entity/UserValidationToken.php
@@ -33,76 +33,51 @@ class UserValidationToken
     #[ORM\Column(name: 'token_valid_until', type: 'datetime', unique: false, nullable: true)]
     private ?\DateTime $tokenValidUntil = null;
 
-    /**
-     * @return int
-     */
     public function getId(): int
     {
         return $this->id;
     }
 
-    /**
-     * @param int $id
-     * @return UserValidationToken
-     */
     public function setId(int $id): UserValidationToken
     {
         $this->id = $id;
+
         return $this;
     }
 
-
-    /**
-     * @return UserInterface|null
-     */
     public function getUser(): ?UserInterface
     {
         return $this->user;
     }
 
-    /**
-     * @param  UserInterface|null $user
-     * @return UserValidationToken
-     */
     public function setUser(?UserInterface $user): UserValidationToken
     {
         $this->user = $user;
+
         return $this;
     }
 
-    /**
-     * @return string
-     */
     public function getToken(): string
     {
         return $this->token;
     }
 
-    /**
-     * @param  string $token
-     * @return UserValidationToken
-     */
     public function setToken(string $token): UserValidationToken
     {
         $this->token = $token;
+
         return $this;
     }
 
-    /**
-     * @return \DateTime|null
-     */
     public function getTokenValidUntil(): ?\DateTime
     {
         return $this->tokenValidUntil;
     }
 
-    /**
-     * @param  \DateTime|null $tokenValidUntil
-     * @return UserValidationToken
-     */
     public function setTokenValidUntil(?\DateTime $tokenValidUntil): UserValidationToken
     {
         $this->tokenValidUntil = $tokenValidUntil;
+
         return $this;
     }
 }
diff --git a/src/EventSubscriber/PasswordlessAuthenticationSuccessEventSubscriber.php b/src/EventSubscriber/PasswordlessAuthenticationSuccessEventSubscriber.php
@@ -24,9 +24,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public static function getSubscribedEvents(): array
     {
         return [

diff --git a/src/EventSubscriber/PasswordlessUserSignedUpSubscriber.php b/src/EventSubscriber/PasswordlessUserSignedUpSubscriber.php
@@ -11,17 +11,14 @@
 final readonly class PasswordlessUserSignedUpSubscriber implements EventSubscriberInterface
 {
     public function __construct(
-        private UserValidationTokenManagerInterface $userValidationTokenManager
+        private UserValidationTokenManagerInterface $userValidationTokenManager,
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public static function getSubscribedEvents(): array
     {
         return [
-            PasswordlessUserSignedUp::class => 'onUserSignedUp'
+            PasswordlessUserSignedUp::class => 'onUserSignedUp',
         ];
     }
 

diff --git a/src/EventSubscriber/UserSignedUpSubscriber.php b/src/EventSubscriber/UserSignedUpSubscriber.php
@@ -11,17 +11,14 @@
 final class UserSignedUpSubscriber implements EventSubscriberInterface
 {
     public function __construct(
-        private readonly UserValidationTokenManagerInterface $userValidationTokenManager
+        private readonly UserValidationTokenManagerInterface $userValidationTokenManager,
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public static function getSubscribedEvents(): array
     {
         return [
-            UserSignedUp::class => 'onUserSignedUp'
+            UserSignedUp::class => 'onUserSignedUp',
         ];
     }
 

diff --git a/src/Manager/UserMetadataManager.php b/src/Manager/UserMetadataManager.php
@@ -24,6 +24,7 @@ public function createMetadataForUser(User $user): UserMetadata
         $userMetadata = new UserMetadata();
         $userMetadata->setUser($user);
         $this->managerRegistry->getManager()->persist($userMetadata);
+
         return $userMetadata;
     }
 }
diff --git a/src/Manager/UserMetadataManagerInterface.php b/src/Manager/UserMetadataManagerInterface.php
@@ -10,5 +10,6 @@
 interface UserMetadataManagerInterface
 {
     public function getMetadataForUser(User $user): ?UserMetadata;
+
     public function createMetadataForUser(User $user): UserMetadata;
 }
diff --git a/src/Manager/UserValidationTokenManager.php b/src/Manager/UserValidationTokenManager.php
@@ -30,7 +30,7 @@ public function __construct(
         private RoleHierarchyInterface $roleHierarchy,
         private string $emailValidatedRoleName,
         private int $userValidationExpiresIn,
-        private string $userValidationUrl
+        private string $userValidationUrl,
     ) {
     }
 
@@ -54,17 +54,18 @@ public function createForUser(UserInterface $user, bool $sendEmail = true): User
         if ($sendEmail) {
             $this->sendUserValidationEmail($existingValidationToken);
         }
+
         return $existingValidationToken;
     }
 
     public function isUserEmailValidated(UserInterface $user): bool
     {
         $reachableRoles = $this->roleHierarchy->getReachableRoleNames($user->getRoles());
-        return \in_array($this->emailValidatedRoleName, $reachableRoles) ||
-            \in_array('ROLE_SUPER_ADMIN', $reachableRoles) ||
-            \in_array('ROLE_SUPERADMIN', $reachableRoles);
-    }
 
+        return \in_array($this->emailValidatedRoleName, $reachableRoles)
+            || \in_array('ROLE_SUPER_ADMIN', $reachableRoles)
+            || \in_array('ROLE_SUPERADMIN', $reachableRoles);
+    }
 
     private function sendUserValidationEmail(UserValidationToken $userValidationToken): void
     {
@@ -92,7 +93,7 @@ private function sendUserValidationEmail(UserValidationToken $userValidationToke
                 UrlGeneratorInterface::ABSOLUTE_URL
             );
         } catch (RouteNotFoundException $exception) {
-            $validationLink = $this->userValidationUrl . '?' . http_build_query(
+            $validationLink = $this->userValidationUrl.'?'.http_build_query(
                 [
                     'token' => $userValidationToken->getToken(),
                     '_locale' => $user->getLocale(),

diff --git a/src/Manager/UserValidationTokenManagerInterface.php b/src/Manager/UserValidationTokenManagerInterface.php
@@ -10,5 +10,6 @@
 interface UserValidationTokenManagerInterface
 {
     public function createForUser(UserInterface $user, bool $sendEmail = true): UserValidationToken;
+
     public function isUserEmailValidated(UserInterface $user): bool;
 }
diff --git a/src/Repository/UserValidationTokenRepository.php b/src/Repository/UserValidationTokenRepository.php
@@ -22,6 +22,7 @@ public function deleteAllExpired(): int
     public function findOneByValidToken(string $token): ?UserValidationToken
     {
         $qb = $this->createQueryBuilder('t');
+
         return $qb->andWhere($qb->expr()->eq('t.token', ':token'))
             ->andWhere($qb->expr()->gte('t.tokenValidUntil', ':now'))
             ->setParameter('token', $token)