⬆️ Update symplify easy coding standard (#3568)

* ⬆️ update ECS to version 12

* ⬆️ apply ECS configuration

* ⬆️ enable tests on branch

* fix mixed return type

* ➕ Add PHP 8.4 polyfill and use it

* disable branch CI

* configure space betweeb class element

* apply configuration

* clean commented code

* revert return type for union type

* Add missing break statement

* Resolve PR comments

* Remove slevomat/coding-standard library

* Remove no longer needed error_reporting config

* Revert ClassAttributesSeparationFixer property spacing

---------

Co-authored-by: Bob van de Vijver <[email protected]>

Author: macintoshplus

.gitignore

@@ -84,4 +84,3 @@ compose.override.yaml
 /.phpunit.result.cache
 /.phpunit.cache
 ###< phpunit/phpunit ###
-

composer.json

@@ -62,6 +62,7 @@
         "symfony/monolog-bundle": "^3.7",
         "symfony/password-hasher": "^5.4",
         "symfony/polyfill-php72": "^1.23",
+        "symfony/polyfill-php84": "^1.31",
         "symfony/security-bundle": "^5.4",
         "symfony/security-csrf": "^5.4",
         "symfony/serializer": "^5.4",
@@ -112,7 +113,7 @@
         "se/selenium-server-standalone": "^3.141",
         "symfony/browser-kit": "^5.4",
         "symfony/css-selector": "^5.4",
-        "symplify/easy-coding-standard": "^10.0"
+        "symplify/easy-coding-standard": "^12.5"
     },
     "config": {
         "preferred-install": {
@@ -123,8 +124,7 @@
             "composer/package-versions-deprecated": true,
             "drupol/composer-packages": true,
             "symfony/flex": true,
-            "php-http/discovery": true,
-            "dealerdirect/phpcodesniffer-composer-installer": false
+            "php-http/discovery": true
         }
     },
     "extra": {

ecs.php

@@ -8,10 +8,9 @@
 use PhpCsFixer\Fixer\ArrayNotation\NoWhitespaceBeforeCommaInArrayFixer;
 use PhpCsFixer\Fixer\ArrayNotation\WhitespaceAfterCommaInArrayFixer;
 use PhpCsFixer\Fixer\Basic\BracesFixer;
-use PhpCsFixer\Fixer\Basic\Psr0Fixer;
-use PhpCsFixer\Fixer\Basic\Psr4Fixer;
 use PhpCsFixer\Fixer\CastNotation\LowercaseCastFixer;
 use PhpCsFixer\Fixer\CastNotation\ShortScalarCastFixer;
+use PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer;
 use PhpCsFixer\Fixer\ClassNotation\FinalInternalClassFixer;
 use PhpCsFixer\Fixer\ClassNotation\NoBlankLinesAfterClassOpeningFixer;
 use PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer;
@@ -39,32 +38,21 @@
 use PhpCsFixer\Fixer\PhpUnit\PhpUnitMethodCasingFixer;
 use PhpCsFixer\Fixer\Semicolon\NoSinglelineWhitespaceBeforeSemicolonsFixer;
 use PhpCsFixer\Fixer\Whitespace\NoTrailingWhitespaceFixer;
-use SlevomatCodingStandard\Sniffs\ControlStructures\DisallowYodaComparisonSniff;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer;
 use Symplify\CodingStandard\Fixer\ArrayNotation\StandaloneLineInMultilineArrayFixer;
-use Symplify\CodingStandard\Fixer\Commenting\RemoveSuperfluousDocBlockWhitespaceFixer;
+use Symplify\CodingStandard\Fixer\Commenting\RemoveUselessDefaultCommentFixer;
 use Symplify\CodingStandard\Fixer\Strict\BlankLineAfterStrictTypesFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 
-// Suppress `Notice:`s in ECS 8.x This is probably fixed in the 9.x versions,
-// but we can't update to that version, because it's PHP > 7.3 only.
-// See: https://github.com/bolt/core/issues/2519
-error_reporting(error_reporting() & ~E_NOTICE);
-
-return static function (ECSConfig $ecsConfig): void {
-    $parameters = $ecsConfig->parameters();
-
-    $parameters->set('sets', ['clean-code', 'common', 'php70', 'php71', 'psr12', 'symfony', 'symfony-risky']);
-
-    $parameters->set('paths', [
+return ECSConfig::configure()
+    ->withPaths([
         __DIR__ . '/src',
         __DIR__ . '/ecs.php',
-    ]);
-
-    $parameters->set('cache_directory', 'var/cache/ecs');
-
-    $parameters->set('skip', [
+    ])
+    ->withCache('var/cache/ecs')
+    ->withPreparedSets(psr12: true, common: true, cleanCode: true)
+    ->withSkip([
         OrderedClassElementsFixer::class => null,
         YodaStyleFixer::class => null,
         IncrementStyleFixer::class => null,
@@ -76,82 +64,64 @@
         UnaryOperatorSpacesFixer::class => null,
         ArrayOpenerAndCloserNewlineFixer::class => null,
         ArrayListItemNewlineFixer::class => null,
-    ]);
-
-    $services = $ecsConfig->services();
-
-    $services->set(StandaloneLineInMultilineArrayFixer::class);
-
-    $services->set(BlankLineAfterStrictTypesFixer::class);
-
-    $services->set(ConcatSpaceFixer::class)
-        ->call('configure', [['spacing' => 'one']]);
-
-    $services->set(RemoveSuperfluousDocBlockWhitespaceFixer::class);
-
-    $services->set(PhpUnitMethodCasingFixer::class);
-
-    $services->set(FinalInternalClassFixer::class);
-
-    $services->set(MbStrFunctionsFixer::class);
-
-    $services->set(Psr0Fixer::class);
-
-    $services->set(Psr4Fixer::class);
-
-    $services->set(LowercaseCastFixer::class);
-
-    $services->set(ShortScalarCastFixer::class);
-
-    $services->set(BlankLineAfterOpeningTagFixer::class);
-
-    $services->set(NoLeadingImportSlashFixer::class);
-
-    $services->set(OrderedImportsFixer::class)
-        ->call('configure', [[
+    ])
+    ->withRules([
+        StandaloneLineInMultilineArrayFixer::class,
+        BlankLineAfterStrictTypesFixer::class,
+        RemoveUselessDefaultCommentFixer::class,
+        PhpUnitMethodCasingFixer::class,
+        FinalInternalClassFixer::class,
+        MbStrFunctionsFixer::class,
+        LowercaseCastFixer::class,
+        ShortScalarCastFixer::class,
+        BlankLineAfterOpeningTagFixer::class,
+        NoLeadingImportSlashFixer::class,
+        NewWithBracesFixer::class,
+        NoBlankLinesAfterClassOpeningFixer::class,
+        TernaryOperatorSpacesFixer::class,
+        ReturnTypeDeclarationFixer::class,
+        NoTrailingWhitespaceFixer::class,
+        NoSinglelineWhitespaceBeforeSemicolonsFixer::class,
+        NoWhitespaceBeforeCommaInArrayFixer::class,
+        WhitespaceAfterCommaInArrayFixer::class,
+        FullyQualifiedStrictTypesFixer::class,
+    ])
+    ->withConfiguredRule(PhpdocToReturnTypeFixer::class, ['union_types' => false])
+    ->withConfiguredRule(NoSuperfluousPhpdocTagsFixer::class, ['remove_inheritdoc' => false])
+    ->withConfiguredRule(
+        ConcatSpaceFixer::class,
+        ['spacing' => 'one']
+    )
+    ->withConfiguredRule(
+        OrderedImportsFixer::class,
+        [
             'imports_order' => ['class', 'const', 'function'],
-        ]]);
-
-    $services->set(DeclareEqualNormalizeFixer::class)
-        ->call('configure', [['space' => 'none']]);
-
-    $services->set(NewWithBracesFixer::class);
-
-    $services->set(BracesFixer::class)
-        ->call('configure', [[
+        ]
+    )
+    ->withConfiguredRule(
+        DeclareEqualNormalizeFixer::class,
+        ['space' => 'none']
+    )
+    ->withConfiguredRule(
+        BracesFixer::class,
+        [
             'allow_single_line_closure' => false,
             'position_after_functions_and_oop_constructs' => 'next',
             'position_after_control_structures' => 'same',
             'position_after_anonymous_constructs' => 'same',
-        ]]);
-
-    $services->set(NoBlankLinesAfterClassOpeningFixer::class);
-
-    $services->set(VisibilityRequiredFixer::class)
-        ->call('configure', [[
+        ]
+    )
+    ->withConfiguredRule(
+        VisibilityRequiredFixer::class,
+        [
             'elements' => ['const', 'method', 'property'],
-        ]]);
-
-    $services->set(TernaryOperatorSpacesFixer::class);
-
-    $services->set(ReturnTypeDeclarationFixer::class);
-
-    $services->set(NoTrailingWhitespaceFixer::class);
-
-    $services->set(NoSinglelineWhitespaceBeforeSemicolonsFixer::class);
-
-    $services->set(NoWhitespaceBeforeCommaInArrayFixer::class);
-
-    $services->set(WhitespaceAfterCommaInArrayFixer::class);
-
-    $services->set(PhpdocToReturnTypeFixer::class);
-
-    $services->set(FullyQualifiedStrictTypesFixer::class);
-
-    $services->set(NoSuperfluousPhpdocTagsFixer::class);
-
-    $services->set(PhpdocLineSpanFixer::class)
-        ->call('configure', [['property' => 'single']]);
-
-    $services->set(DisallowYodaComparisonSniff::class);
-};
+        ]
+    )
+    ->withConfiguredRule(
+        PhpdocLineSpanFixer::class,
+        ['property' => 'single']
+    )
+    ->withConfiguredRule(
+        ClassAttributesSeparationFixer::class,
+        ['elements' => ['property' => 'none', 'method' => 'one', 'const' => 'none']]
+    );

src/Api/Extensions/ContentExtension.php

@@ -11,7 +11,6 @@
 use Bolt\Entity\Content;
 use Bolt\Entity\Field;
 use Bolt\Enum\Statuses;
-use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\ORM\QueryBuilder;
 use Tightenco\Collect\Support\Collection;
 

src/Cache/CachingTrait.php

@@ -106,7 +106,7 @@ private function getTags(string $contentTypeSlug): array
     {
         $tags = explode(',', $contentTypeSlug);
 
-        $tags = array_map(function($t) {
+        $tags = array_map(function ($t) {
             return preg_replace('/[^\pL\d,]+/u', '', $t);
         }, $tags);
 

src/Cache/ContentToArrayCacher.php

@@ -18,4 +18,4 @@ protected function contentToArray(Content $content, string $locale = ''): array
 
         return $this->execute([parent::class, __FUNCTION__], [$content, $locale]);
     }
-}
+}

src/Canonical.php

@@ -147,7 +147,7 @@ public function getScheme(): string
      */
     public function setScheme(string $scheme): void
     {
-        $this->scheme = trim($scheme, ':/');
+        $this->scheme = mb_trim($scheme, ':/');
     }
 
     public function getPort(): ?int

src/Collection/DeepCollection.php

@@ -28,7 +28,7 @@ public function isKeyEmpty($key): bool
         return $this->has($key) && (
             ($this->get($key) instanceof Collection && $this->get($key)->isEmpty())
             || empty($this->get($key))
-            );
+        );
     }
 
     public function isKeyNotEmpty($key): bool

src/Command/ExtensionsConfigureCommand.php

@@ -173,11 +173,13 @@ private function getExtensionServicesPath(string $path = '*'): string
 
     private function getExtensionConfigPath(string $namespace, string $name): string
     {
-        return sprintf('%s/config/extensions/%s%s%s.yaml',
+        return sprintf(
+            '%s/config/extensions/%s%s%s.yaml',
             $this->projectDir,
             $namespace,
             (! empty($name) ? '-' : ''),
-            $name);
+            $name
+        );
     }
 
     private function getPackagePath(BaseExtension $package): string

src/Command/ResetPasswordCommand.php

@@ -38,9 +38,12 @@ class ResetPasswordCommand extends Command
     /** @var UserRepository */
     private $userRepository;
 
-    public function __construct(EntityManagerInterface $em, UserPasswordHasherInterface $passwordHasher,
-                                UserRepository $userRepository, ValidatorInterface $validator)
-    {
+    public function __construct(
+        EntityManagerInterface $em,
+        UserPasswordHasherInterface $passwordHasher,
+        UserRepository $userRepository,
+        ValidatorInterface $validator
+    ) {
         parent::__construct();
 
         $this->entityManager = $em;
@@ -62,7 +65,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io = new SymfonyStyle($input, $output);
         $username = $input->getArgument('username');
 
-        /** @var User|null */
+        /** @var User|null $user */
         $user = $this->userRepository->findOneBy(['username' => $username]);
 
         if ($user === null) {