minor #1127 update php-cs-fixer ruleset for php8 (jrushlow)

weaverryan · weaverryan · commit 580fed5d0d6b · 2022-05-23T08:41:25.000-04:00
This PR was squashed before being merged into the 1.0-dev branch. Discussion ---------- update php-cs-fixer ruleset for php8 - adds the PHP 8 && PHPUnit 8.4 migration rulesets - forces trailing commas in multiline parameter lists to improve diff readability. e.g. ```php public function __construct( private int $number, private string $word, ) ``` I also added trailing line commas in multiline _argument_ lists and then reverted the commit. See commit 352f951 If this we _should_ keep multiline trailing commas for args - I'll drop the commit that reverts it. Thoughts `@weaverryan` `@OskarStark` `@wouterj` ? Commits ------- 697071d update php-cs-fixer ruleset for php8
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -15,7 +15,8 @@
 
 return (new PhpCsFixer\Config())
     ->setRules(array(
-        '@PHPUnit75Migration:risky' => true,
+        '@PHP80Migration' => true,
+        '@PHPUnit84Migration:risky' => true,
         '@Symfony' => true,
         '@Symfony:risky' => true,
         'header_comment' => [
@@ -30,6 +31,12 @@
         ],
         'protected_to_private' => false,
         'semicolon_after_instruction' => false,
+        'trailing_comma_in_multiline' => [
+            'elements' => [
+                'arrays',
+                'parameters'
+            ],
+        ]
     ))
     ->setRiskyAllowed(true)
     ->setFinder($finder)
diff --git a/src/Doctrine/EntityDetails.php b/src/Doctrine/EntityDetails.php
@@ -22,7 +22,7 @@
 final class EntityDetails
 {
     public function __construct(
-        private ClassMetadata|LegacyClassMetadata $metadata
+        private ClassMetadata|LegacyClassMetadata $metadata,
     ) {
     }
 
diff --git a/src/Doctrine/EntityRegenerator.php b/src/Doctrine/EntityRegenerator.php
@@ -30,7 +30,7 @@ public function __construct(
         private FileManager $fileManager,
         private Generator $generator,
         private EntityClassGenerator $entityClassGenerator,
-        private bool $overwrite
+        private bool $overwrite,
     ) {
     }
 
@@ -92,7 +92,7 @@ public function regenerateEntities(string $classOrNamespace): void
             foreach ($classMetadata->fieldMappings as $fieldName => $mapping) {
                 // skip embedded fields
                 if (false !== strpos($fieldName, '.')) {
-                    list($fieldName, $embeddedFiledName) = explode('.', $fieldName);
+                    [$fieldName, $embeddedFiledName] = explode('.', $fieldName);
 
                     $operations[$embeddedClasses[$fieldName]]->addEntityField($embeddedFiledName, $mapping);
 
diff --git a/src/Doctrine/EntityRelation.php b/src/Doctrine/EntityRelation.php
@@ -31,7 +31,7 @@ final class EntityRelation
     public function __construct(
         private string $type,
         private string $owningClass,
-        private string $inverseClass
+        private string $inverseClass,
     ) {
         if (!\in_array($type, self::getValidRelationTypes())) {
             throw new \Exception(sprintf('Invalid relation type "%s"', $type));
diff --git a/src/FileManager.php b/src/FileManager.php
@@ -38,7 +38,7 @@ public function __construct(
         AutoloaderUtil $autoloaderUtil,
         MakerFileLinkFormatter $makerFileLinkFormatter,
         string $rootDirectory,
-        string $twigDefaultPath = null
+        string $twigDefaultPath = null,
     ) {
         // move FileManagerTest stuff
         // update EntityRegeneratorTest to mock the autoloader
diff --git a/src/GeneratorTwigHelper.php b/src/GeneratorTwigHelper.php
@@ -68,19 +68,19 @@ public function getHeadPrintCode($title): string
     {
         if ($this->fileManager->fileExists($this->fileManager->getPathForTemplate('base.html.twig'))) {
             return <<<TWIG
-{% extends 'base.html.twig' %}
+                {% extends 'base.html.twig' %}
 
-{% block title %}$title{% endblock %}
+                {% block title %}$title{% endblock %}
 
-TWIG;
+                TWIG;
         }
 
         return <<<HTML
-<!DOCTYPE html>
+            <!DOCTYPE html>
 
-<title>$title</title>
+            <title>$title</title>
 
-HTML;
+            HTML;
     }
 
     public function getFileLink($path, $text = null, $line = 0): string
diff --git a/src/Maker/MakeAuthenticator.php b/src/Maker/MakeAuthenticator.php
@@ -70,7 +70,7 @@ public function __construct(
         private SecurityConfigUpdater $configUpdater,
         private Generator $generator,
         private DoctrineHelper $doctrineHelper,
-        private SecurityControllerBuilder $securityControllerBuilder
+        private SecurityControllerBuilder $securityControllerBuilder,
     ) {
     }
 
diff --git a/src/Maker/MakeEntity.php b/src/Maker/MakeEntity.php
@@ -55,7 +55,7 @@ public function __construct(
         string $projectDirectory = null,
         Generator $generator = null,
         EntityClassGenerator $entityClassGenerator = null,
-        PhpCompatUtil $phpCompatUtil = null
+        PhpCompatUtil $phpCompatUtil = null,
     ) {
         if (null !== $projectDirectory) {
             @trigger_error('The $projectDirectory constructor argument is no longer used since 1.41.0', \E_USER_DEPRECATED);
diff --git a/src/Maker/MakeRegistrationForm.php b/src/Maker/MakeRegistrationForm.php
@@ -86,7 +86,7 @@ public function __construct(
         private FileManager $fileManager,
         private FormTypeRenderer $formTypeRenderer,
         private RouterInterface $router,
-        private DoctrineHelper $doctrineHelper
+        private DoctrineHelper $doctrineHelper,
     ) {
     }
 
@@ -537,33 +537,33 @@ private function generateFormClass(ClassNameDetails $userClassDetails, Generator
             'agreeTerms' => [
                 'type' => CheckboxType::class,
                 'options_code' => <<<EOF
-                'mapped' => false,
-                'constraints' => [
-                    new IsTrue([
-                        'message' => 'You should agree to our terms.',
-                    ]),
-                ],
-EOF
+                                    'mapped' => false,
+                                    'constraints' => [
+                                        new IsTrue([
+                                            'message' => 'You should agree to our terms.',
+                                        ]),
+                                    ],
+                    EOF
             ],
             'plainPassword' => [
                 'type' => PasswordType::class,
                 'options_code' => <<<EOF
-                // instead of being set onto the object directly,
-                // this is read and encoded in the controller
-                'mapped' => false,
-                'attr' => ['autocomplete' => 'new-password'],
-                'constraints' => [
-                    new NotBlank([
-                        'message' => 'Please enter a password',
-                    ]),
-                    new Length([
-                        'min' => 6,
-                        'minMessage' => 'Your password should be at least {{ limit }} characters',
-                        // max length allowed by Symfony for security reasons
-                        'max' => 4096,
-                    ]),
-                ],
-EOF
+                                    // instead of being set onto the object directly,
+                                    // this is read and encoded in the controller
+                                    'mapped' => false,
+                                    'attr' => ['autocomplete' => 'new-password'],
+                                    'constraints' => [
+                                        new NotBlank([
+                                            'message' => 'Please enter a password',
+                                        ]),
+                                        new Length([
+                                            'min' => 6,
+                                            'minMessage' => 'Your password should be at least {{ limit }} characters',
+                                            // max length allowed by Symfony for security reasons
+                                            'max' => 4096,
+                                        ]),
+                                    ],
+                    EOF
             ],
         ];
 
diff --git a/src/Maker/MakeResetPassword.php b/src/Maker/MakeResetPassword.php
@@ -88,7 +88,7 @@ class MakeResetPassword extends AbstractMaker
     public function __construct(
         private FileManager $fileManager,
         private DoctrineHelper $doctrineHelper,
-        private EntityClassGenerator $entityClassGenerator
+        private EntityClassGenerator $entityClassGenerator,
     ) {
     }
 
@@ -421,10 +421,10 @@ private function generateRequestEntity(Generator $generator, ClassNameDetails $r
             (new Param('selector'))->setType('string')->getNode(),
             (new Param('hashedToken'))->setType('string')->getNode(),
         ], <<<'CODE'
-<?php
-$this->user = $user;
-$this->initialize($expiresAt, $selector, $hashedToken);
-CODE
+            <?php
+            $this->user = $user;
+            $this->initialize($expiresAt, $selector, $hashedToken);
+            CODE
         );
 
         $manipulator->addManyToOneRelation((new RelationManyToOne())
@@ -466,9 +466,9 @@ private function generateRequestEntity(Generator $generator, ClassNameDetails $r
             (new Param('selector'))->setType('string')->getNode(),
             (new Param('hashedToken'))->setType('string')->getNode(),
         ], <<<'CODE'
-<?php
-return new ResetPasswordRequest($user, $expiresAt, $selector, $hashedToken);
-CODE
+            <?php
+            return new ResetPasswordRequest($user, $expiresAt, $selector, $hashedToken);
+            CODE
         );
 
         $this->fileManager->dumpFile($pathRequestRepository, $manipulator->getSourceCode());
diff --git a/src/Maker/MakeUser.php b/src/Maker/MakeUser.php
@@ -53,7 +53,7 @@ public function __construct(
         private UserClassBuilder $userClassBuilder,
         private SecurityConfigUpdater $configUpdater,
         private EntityClassGenerator $entityClassGenerator,
-        private DoctrineHelper $doctrineHelper
+        private DoctrineHelper $doctrineHelper,
     ) {
     }
 
diff --git a/src/Renderer/FormTypeRenderer.php b/src/Renderer/FormTypeRenderer.php
@@ -36,7 +36,7 @@ public function render(ClassNameDetails $formClassDetails, array $formFields, Cl
         $fieldTypeUseStatements = [];
         $fields = [];
         foreach ($formFields as $name => $fieldTypeOptions) {
-            $fieldTypeOptions = $fieldTypeOptions ?? ['type' => null, 'options_code' => null];
+            $fieldTypeOptions ??= ['type' => null, 'options_code' => null];
 
             if (isset($fieldTypeOptions['type'])) {
                 $fieldTypeUseStatements[] = $fieldTypeOptions['type'];
diff --git a/src/Security/SecurityConfigUpdater.php b/src/Security/SecurityConfigUpdater.php
@@ -26,7 +26,7 @@ final class SecurityConfigUpdater
     private ?YamlSourceManipulator $manipulator;
 
     public function __construct(
-        private ?Logger $ysmLogger = null
+        private ?Logger $ysmLogger = null,
     ) {
     }
 
diff --git a/src/Security/SecurityControllerBuilder.php b/src/Security/SecurityControllerBuilder.php
@@ -23,7 +23,7 @@
 final class SecurityControllerBuilder
 {
     public function __construct(
-        private PhpCompatUtil $phpCompatUtil
+        private PhpCompatUtil $phpCompatUtil,
     ) {
     }
 
@@ -42,32 +42,32 @@ public function addLoginMethod(ClassSourceManipulator $manipulator): void
         );
 
         $manipulator->addMethodBody($loginMethodBuilder, <<<'CODE'
-<?php
-// if ($this->getUser()) {
-//     return $this->redirectToRoute('target_path');
-// }
-CODE
+            <?php
+            // if ($this->getUser()) {
+            //     return $this->redirectToRoute('target_path');
+            // }
+            CODE
         );
         $loginMethodBuilder->addStmt($manipulator->createMethodLevelBlankLine());
         $manipulator->addMethodBody($loginMethodBuilder, <<<'CODE'
-<?php
-// get the login error if there is one
-$error = $authenticationUtils->getLastAuthenticationError();
-// last username entered by the user
-$lastUsername = $authenticationUtils->getLastUsername();
-CODE
+            <?php
+            // get the login error if there is one
+            $error = $authenticationUtils->getLastAuthenticationError();
+            // last username entered by the user
+            $lastUsername = $authenticationUtils->getLastUsername();
+            CODE
         );
         $loginMethodBuilder->addStmt($manipulator->createMethodLevelBlankLine());
         $manipulator->addMethodBody($loginMethodBuilder, <<<'CODE'
-<?php
-return $this->render(
-    'security/login.html.twig',
-    [
-        'last_username' => $lastUsername,
-        'error' => $error,
-    ]
-);
-CODE
+            <?php
+            return $this->render(
+                'security/login.html.twig',
+                [
+                    'last_username' => $lastUsername,
+                    'error' => $error,
+                ]
+            );
+            CODE
         );
         $manipulator->addMethodBuilder($loginMethodBuilder);
     }
@@ -80,9 +80,9 @@ public function addLogoutMethod(ClassSourceManipulator $manipulator): void
 
         $manipulator->addUseStatementIfNecessary(Route::class);
         $manipulator->addMethodBody($logoutMethodBuilder, <<<'CODE'
-<?php
-throw new \LogicException('This method can be blank - it will be intercepted by the logout key on your firewall.');
-CODE
+            <?php
+            throw new \LogicException('This method can be blank - it will be intercepted by the logout key on your firewall.');
+            CODE
         );
         $manipulator->addMethodBuilder($logoutMethodBuilder);
     }
diff --git a/src/Test/MakerTestCase.php b/src/Test/MakerTestCase.php
@@ -106,7 +106,7 @@ private function getMakerInstance(string $makerClass): MakerInterface
         }
 
         // a cheap way to guess the service id
-        $serviceId = $serviceId ?? sprintf('maker.maker.%s', Str::asSnakeCase((new \ReflectionClass($makerClass))->getShortName()));
+        $serviceId ??= sprintf('maker.maker.%s', Str::asSnakeCase((new \ReflectionClass($makerClass))->getShortName()));
 
         return $this->kernel->getContainer()->get($serviceId);
     }
diff --git a/src/Util/AutoloaderUtil.php b/src/Util/AutoloaderUtil.php
@@ -21,7 +21,7 @@
 class AutoloaderUtil
 {
     public function __construct(
-        private ComposerAutoloaderFinder $autoloaderFinder
+        private ComposerAutoloaderFinder $autoloaderFinder,
     ) {
     }
 
diff --git a/src/Util/ClassDetails.php b/src/Util/ClassDetails.php
@@ -17,7 +17,7 @@
 final class ClassDetails
 {
     public function __construct(
-        private string $fullClassName
+        private string $fullClassName,
     ) {
     }
 
diff --git a/src/Util/ClassNameDetails.php b/src/Util/ClassNameDetails.php
@@ -18,7 +18,7 @@ final class ClassNameDetails
     public function __construct(
         private string $fullClassName,
         private string $namespacePrefix,
-        private ?string $suffix = null
+        private ?string $suffix = null,
     ) {
         $this->namespacePrefix = trim($namespacePrefix, '\\');
     }
diff --git a/src/Util/ClassNameValue.php b/src/Util/ClassNameValue.php
@@ -20,7 +20,7 @@ final class ClassNameValue
 {
     public function __construct(
         private string $typeHint,
-        private string $fullClassName
+        private string $fullClassName,
     ) {
     }
 
diff --git a/src/Util/UseStatementGenerator.php b/src/Util/UseStatementGenerator.php
@@ -29,7 +29,7 @@ final class UseStatementGenerator implements \Stringable
      * @param string[]|array<string, string> $classesToBeImported
      */
     public function __construct(
-        private array $classesToBeImported
+        private array $classesToBeImported,
     ) {
     }
 
diff --git a/src/Util/YamlSourceManipulator.php b/src/Util/YamlSourceManipulator.php
@@ -49,7 +49,7 @@ class YamlSourceManipulator
     private $arrayTypeForDepths = [];
 
     public function __construct(
-        private string $contents
+        private string $contents,
     ) {
         $this->currentData = Yaml::parse($contents);
 
@@ -966,7 +966,7 @@ private function log(string $message, $includeContent = false)
         }
 
         $context = [
-            'key' => isset($this->currentPath[$this->depth]) ? $this->currentPath[$this->depth] : 'n/a',
+            'key' => $this->currentPath[$this->depth] ?? 'n/a',
             'depth' => $this->depth,
             'position' => $this->currentPosition,
             'indentation' => $this->indentationForDepths[$this->depth],
diff --git a/tests/DependencyBuilderTest.php b/tests/DependencyBuilderTest.php
diff --git a/tests/Maker/MakeMessageTest.php b/tests/Maker/MakeMessageTest.php
diff --git a/tests/Util/ClassSourceManipulatorTest.php b/tests/Util/ClassSourceManipulatorTest.php
diff --git a/tests/Util/ComposeFileManipulatorTest.php b/tests/Util/ComposeFileManipulatorTest.php
diff --git a/tests/Util/UseStatementGeneratorTest.php b/tests/Util/UseStatementGeneratorTest.php
diff --git a/tests/Util/YamlSourceManipulatorTest.php b/tests/Util/YamlSourceManipulatorTest.php

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`final class EntityDetails`
`23`	`23`	`{`
`24`	`24`	`public function __construct(`
`25`		`- private ClassMetadata\|LegacyClassMetadata $metadata`
	`25`	`+ private ClassMetadata\|LegacyClassMetadata $metadata,`
`26`	`26`	`) {`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public function __construct(`
`70`	`70`	`private SecurityConfigUpdater $configUpdater,`
`71`	`71`	`private Generator $generator,`
`72`	`72`	`private DoctrineHelper $doctrineHelper,`
`73`		`- private SecurityControllerBuilder $securityControllerBuilder`
	`73`	`+ private SecurityControllerBuilder $securityControllerBuilder,`
`74`	`74`	`) {`
`75`	`75`	`}`
`76`	`76`