Add StandaloneLinePlainConstructorParamFixer to spaces set

packages/coding-standard/src/Fixer/Spacing/StandaloneLinePlainConstructorParamFixer.php

@@ -0,0 +1,163 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\CodingStandard\Fixer\Spacing;
+
+use Override;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\CT;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+use SplFileInfo;
+use Symplify\CodingStandard\Fixer\AbstractSymplifyFixer;
+use Symplify\CodingStandard\TokenAnalyzer\Naming\MethodNameResolver;
+use Symplify\CodingStandard\TokenAnalyzer\ParamNewliner;
+
+/**
+ * Every parameter of a constructor without promoted properties must be on a standalone line.
+ *
+ * Constructors with promoted properties are handled by @see StandaloneLinePromotedPropertyFixer, so both rules can
+ * be used side by side without processing the same constructor twice.
+ *
+ * @see \Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer\StandaloneLinePlainConstructorParamFixerTest
+ */
+final class StandaloneLinePlainConstructorParamFixer extends AbstractSymplifyFixer
+{
+    private const string ERROR_MESSAGE = 'Constructor param should be on a standalone line to ease git diffs on new dependency';
+
+    /**
+     * @var int[]
+     */
+    private const array PROMOTION_KINDS = [
+        CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PUBLIC,
+        CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PROTECTED,
+        CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PRIVATE,
+    ];
+
+    public function __construct(
+        private readonly ParamNewliner $paramNewliner,
+        private readonly MethodNameResolver $methodNameResolver
+    ) {
+    }
+
+    /**
+     * Must run before
+     *
+     * @see \PhpCsFixer\Fixer\Basic\BracesFixer::getPriority()
+     */
+    #[Override]
+    public function getPriority(): int
+    {
+        return 40;
+    }
+
+    public function getDefinition(): FixerDefinitionInterface
+    {
+        return new FixerDefinition(self::ERROR_MESSAGE, [new CodeSample(
+            <<<'CODE_SAMPLE'
+final class SomeController
+{
+    public function __construct(FormModel $formModel, SubmissionModel $submissionModel)
+    {
+    }
+}
+CODE_SAMPLE
+        )]);
+    }
+
+    /**
+     * @param Tokens<Token> $tokens
+     */
+    public function isCandidate(Tokens $tokens): bool
+    {
+        return $tokens->isTokenKindFound(T_FUNCTION);
+    }
+
+    /**
+     * @param Tokens<Token> $tokens
+     */
+    public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
+    {
+        // from the bottom up, as adding tokens shifts every position after them
+        for ($position = count($tokens) - 1; $position >= 0; --$position) {
+            /** @var Token $token */
+            $token = $tokens[$position];
+
+            if (! $token->isGivenKind(T_FUNCTION)) {
+                continue;
+            }
+
+            if (! $this->methodNameResolver->isMethodName($tokens, $position, '__construct')) {
+                continue;
+            }
+
+            $paramBracketPosition = $this->resolveOpenBracketPosition($tokens, $position);
+            if ($paramBracketPosition === null) {
+                continue;
+            }
+
+            if (! $this->hasParams($tokens, $paramBracketPosition)) {
+                continue;
+            }
+
+            if ($this->hasPromotedProperty($tokens, $paramBracketPosition)) {
+                continue;
+            }
+
+            $this->paramNewliner->processFunction($tokens, $position);
+        }
+    }
+
+    /**
+     * @param Tokens<Token> $tokens
+     */
+    private function resolveOpenBracketPosition(Tokens $tokens, int $position): ?int
+    {
+        $namePosition = $tokens->getNextMeaningfulToken($position);
+        if ($namePosition === null) {
+            return null;
+        }
+
+        return $tokens->getNextMeaningfulToken($namePosition);
+    }
+
+    /**
+     * An empty parameter list would be broken into an empty line between the brackets.
+     *
+     * @param Tokens<Token> $tokens
+     */
+    private function hasParams(Tokens $tokens, int $openBracketPosition): bool
+    {
+        $firstParamPosition = $tokens->getNextMeaningfulToken($openBracketPosition);
+        if ($firstParamPosition === null) {
+            return false;
+        }
+
+        /** @var Token $firstParamToken */
+        $firstParamToken = $tokens[$firstParamPosition];
+
+        return $firstParamToken->getContent() !== ')';
+    }
+
+    /**
+     * @param Tokens<Token> $tokens
+     */
+    private function hasPromotedProperty(Tokens $tokens, int $openBracketPosition): bool
+    {
+        $closeBracketPosition = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openBracketPosition);
+
+        for ($index = $openBracketPosition + 1; $index < $closeBracketPosition; ++$index) {
+            /** @var Token $token */
+            $token = $tokens[$index];
+
+            if ($token->isGivenKind(self::PROMOTION_KINDS)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

packages/coding-standard/src/TokenRunner/Exception/TokenNotFoundException.php

@@ -8,8 +8,9 @@
 
 final class TokenNotFoundException extends Exception
 {
-    public function __construct(int $position)
-    {
+    public function __construct(
+        int $position
+    ) {
         $message = sprintf('Token on position %d was not found', $position);
 
         parent::__construct($message);

packages/coding-standard/tests/Fixer/Spacing/StandaloneLinePlainConstructorParamFixer/Fixture/plain_params.php.inc

@@ -0,0 +1,29 @@
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer\Fixture;
+
+final class PlainParams
+{
+    public function __construct(CorePermissions $security, Translator $translator, RouterInterface $router)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer\Fixture;
+
+final class PlainParams
+{
+    public function __construct(
+        CorePermissions $security,
+        Translator $translator,
+        RouterInterface $router
+    )
+    {
+    }
+}
+
+?>

packages/coding-standard/tests/Fixer/Spacing/StandaloneLinePlainConstructorParamFixer/Fixture/skip_empty_params.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer\Fixture;
+
+final class SkipEmptyParams
+{
+    public function __construct()
+    {
+    }
+}

packages/coding-standard/tests/Fixer/Spacing/StandaloneLinePlainConstructorParamFixer/Fixture/skip_other_method.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer\Fixture;
+
+final class SkipOtherMethod
+{
+    public function process(CorePermissions $security, Translator $translator): void
+    {
+    }
+}

packages/coding-standard/tests/Fixer/Spacing/StandaloneLinePlainConstructorParamFixer/Fixture/skip_promoted_property.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer\Fixture;
+
+final class SkipPromotedProperty
+{
+    public function __construct(private readonly Translator $translator, RouterInterface $router)
+    {
+    }
+}

packages/coding-standard/tests/Fixer/Spacing/StandaloneLinePlainConstructorParamFixer/StandaloneLinePlainConstructorParamFixerTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\CodingStandard\Tests\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\EasyCodingStandard\Testing\PHPUnit\AbstractCheckerTestCase;
+
+final class StandaloneLinePlainConstructorParamFixerTest extends AbstractCheckerTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFiles(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfig(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

packages/coding-standard/tests/Fixer/Spacing/StandaloneLinePlainConstructorParamFixer/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Symplify\CodingStandard\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->rule(StandaloneLinePlainConstructorParamFixer::class);
+};

src/Config/Level/SpacesLevel.php

@@ -31,6 +31,7 @@
 use PhpCsFixer\Fixer\Whitespace\TypesSpacesFixer;
 use Symplify\CodingStandard\Fixer\Spacing\MethodChainingNewlineFixer;
 use Symplify\CodingStandard\Fixer\Spacing\SpaceAfterCommaHereNowDocFixer;
+use Symplify\CodingStandard\Fixer\Spacing\StandaloneLinePlainConstructorParamFixer;
 use Symplify\CodingStandard\Fixer\Spacing\StandaloneLinePromotedPropertyFixer;
 use Symplify\CodingStandard\Fixer\Spacing\StandaloneLineRequiredParamFixer;
 use Symplify\CodingStandard\Fixer\Strict\BlankLineAfterStrictTypesFixer;
@@ -75,6 +76,7 @@ final class SpacesLevel
         // most invasive structural changes
         MethodChainingIndentationFixer::class,
         StandaloneLinePromotedPropertyFixer::class,
+        StandaloneLinePlainConstructorParamFixer::class,
         StandaloneLineRequiredParamFixer::class,
         MethodArgumentSpaceFixer::class,