minor: Split BracesFixer (#4884)

.github/workflows/sca.yml

@@ -113,9 +113,9 @@ jobs:
         if: ${{ env.CHANGED_PHP_FILES }}
         run: |
           if [ '${{ github.event_name }}' == 'pull_request' ]; then
-            ./dev-tools/vendor/bin/phpmd `echo "$CHANGED_PHP_FILES" | xargs | sed 's/ /,/g'` github phpmd.xml --exclude tests/Fixtures/
+            ./dev-tools/vendor/bin/phpmd `echo "$CHANGED_PHP_FILES" | grep -v /Fixtures/ | xargs | sed 's/ /,/g'` github phpmd.xml
           else
-            ./dev-tools/vendor/bin/phpmd `echo "$CHANGED_PHP_FILES" | xargs | sed 's/ /,/g'` ansi phpmd.xml --exclude tests/Fixtures/
+            ./dev-tools/vendor/bin/phpmd `echo "$CHANGED_PHP_FILES" | grep -v /Fixtures/ | xargs | sed 's/ /,/g'` ansi phpmd.xml
           fi
 
       - name: Check - ensure test files are not present in the archive

phpstan.neon

@@ -23,6 +23,6 @@ parameters:
         -
             message: '#^.+no value type specified in iterable type.+\.$#'
             path: *
-            count: 540
+            count: 538
     tipsOfTheDay: false
     tmpDir: dev-tools/phpstan/cache

src/Fixer/Basic/NoMultipleStatementsPerLineFixer.php

@@ -44,11 +44,11 @@ public function getDefinition(): FixerDefinitionInterface
     /**
      * {@inheritdoc}
      *
-     * Must run after NoEmptyStatementFixer.
+     * Must run after ControlStructureBracesFixer, NoEmptyStatementFixer.
      */
     public function getPriority(): int
     {
-        return 39;
+        return -1;
     }
 
     /**

src/Fixer/ControlStructure/ControlStructureBracesFixer.php

@@ -46,7 +46,7 @@ public function isCandidate(Tokens $tokens): bool
     /**
      * {@inheritdoc}
      *
-     * Must run before ControlStructureContinuationPositionFixer, CurlyBracesPositionFixer.
+     * Must run before ControlStructureContinuationPositionFixer, CurlyBracesPositionFixer, NoMultipleStatementsPerLineFixer.
      */
     public function getPriority(): int
     {

src/Fixer/FunctionNotation/MethodArgumentSpaceFixer.php

@@ -122,7 +122,7 @@ public function configure(array $configuration): void
      * {@inheritdoc}
      *
      * Must run before ArrayIndentationFixer.
-     * Must run after CombineNestedDirnameFixer, FunctionDeclarationFixer, ImplodeCallFixer, LambdaNotUsedImportFixer, MethodChainingIndentationFixer, NoMultilineWhitespaceAroundDoubleArrowFixer, NoUselessSprintfFixer, PowToExponentiationFixer, StrictParamFixer.
+     * Must run after CombineNestedDirnameFixer, FunctionDeclarationFixer, ImplodeCallFixer, LambdaNotUsedImportFixer, NoMultilineWhitespaceAroundDoubleArrowFixer, NoUselessSprintfFixer, PowToExponentiationFixer, StrictParamFixer.
      */
     public function getPriority(): int
     {

src/Fixer/Whitespace/ArrayIndentationFixer.php

@@ -54,7 +54,7 @@ public function isCandidate(Tokens $tokens): bool
      * {@inheritdoc}
      *
      * Must run before AlignMultilineCommentFixer, BinaryOperatorSpacesFixer.
-     * Must run after MethodArgumentSpaceFixer, MethodChainingIndentationFixer.
+     * Must run after MethodArgumentSpaceFixer.
      */
     public function getPriority(): int
     {

src/Fixer/Whitespace/LineEndingFixer.php

@@ -54,16 +54,6 @@ public function getDefinition(): FixerDefinitionInterface
         );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * Must run before BracesFixer.
-     */
-    public function getPriority(): int
-    {
-        return 40;
-    }
-
     /**
      * {@inheritdoc}
      */

src/Fixer/Whitespace/MethodChainingIndentationFixer.php

@@ -40,17 +40,6 @@ public function getDefinition(): FixerDefinitionInterface
         );
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * Must run before ArrayIndentationFixer, MethodArgumentSpaceFixer.
-     * Must run after BracesFixer.
-     */
-    public function getPriority(): int
-    {
-        return 34;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -90,6 +79,33 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
             if ($currentIndent !== $expectedIndent) {
                 $tokens[$index - 1] = new Token([T_WHITESPACE, $lineEnding.$expectedIndent]);
             }
+
+            $endParenthesisIndex = $tokens->findBlockEnd(
+                Tokens::BLOCK_TYPE_PARENTHESIS_BRACE,
+                $tokens->getNextTokenOfKind($index, ['('])
+            );
+
+            for ($searchIndex = $index + 1; $searchIndex < $endParenthesisIndex; ++$searchIndex) {
+                $searchToken = $tokens[$searchIndex];
+
+                if (!$searchToken->isWhitespace()) {
+                    continue;
+                }
+
+                $content = $searchToken->getContent();
+
+                if (!Preg::match('/\R/', $content)) {
+                    continue;
+                }
+
+                $content = Preg::replace(
+                    '/(\R)'.$currentIndent.'(\h*)$/D',
+                    '$1'.$expectedIndent.'$2',
+                    $content
+                );
+
+                $tokens[$searchIndex] = new Token([$searchToken->getId(), $content]);
+            }
         }
     }
 

src/Fixer/Whitespace/NoExtraBlankLinesFixer.php

@@ -441,13 +441,7 @@ private function removeEmptyLinesAfterLineWithTokenAt(int $index): void
                 continue;
             }
 
-            $pos = strrpos($content, "\n");
-
-            if ($pos + 2 <= \strlen($content)) { // preserve indenting where possible
-                $newContent = $ending.substr($content, $pos + 1);
-            } else {
-                $newContent = $ending;
-            }
+            $newContent = Preg::replace('/^.*\R(\h*)$/s', $ending.'$1', $content);
 
             $this->tokens[$i] = new Token([T_WHITESPACE, $newContent]);
         }

tests/AutoReview/FixerFactoryTest.php

@@ -358,7 +358,6 @@ private static function getFixersPriorityGraph(): array
             ],
             'braces' => [
                 'heredoc_indentation',
-                'method_chaining_indentation',
             ],
             'class_attributes_separation' => [
                 'braces',
@@ -392,6 +391,7 @@ private static function getFixersPriorityGraph(): array
             'control_structure_braces' => [
                 'control_structure_continuation_position',
                 'curly_braces_position',
+                'no_multiple_statements_per_line',
             ],
             'declare_strict_types' => [
                 'blank_line_after_opening_tag',
@@ -473,20 +473,13 @@ private static function getFixersPriorityGraph(): array
                 'method_argument_space',
                 'no_spaces_inside_parenthesis',
             ],
-            'line_ending' => [
-                'braces',
-            ],
             'list_syntax' => [
                 'binary_operator_spaces',
                 'ternary_operator_spaces',
             ],
             'method_argument_space' => [
                 'array_indentation',
             ],
-            'method_chaining_indentation' => [
-                'array_indentation',
-                'method_argument_space',
-            ],
             'modernize_strpos' => [
                 'binary_operator_spaces',
                 'no_extra_blank_lines',

tests/Fixer/Basic/BracesFixerTest.php

@@ -817,7 +817,8 @@ public function bar() {
     <?php
     if (true) {
         echo \'x\';
-    } ?>
+    }
+    ?>
 <hr />
     <?php
 }',
@@ -1146,10 +1147,6 @@ public function provideFixMissingBracesAndIndentCases(): iterable
                 '<?php
     class ClassName
     {
-
-
-
-
         /**
          * comment
          */
@@ -1900,10 +1897,6 @@ public function __construct(
             [
                 '<?php
     class ClassName {
-
-
-
-
         /**
          * comment
          */
@@ -1928,10 +1921,6 @@ class ClassName
             [
                 '<?php
     class ClassName {
-
-
-
-
         /**
          * comment
          */
@@ -2233,9 +2222,9 @@ function mixedComplex()
             [
                 '<?php
     if (true)
+    // foo
+    // bar
     {
-        // foo
-        // bar
         if (true)
         {
             print("foo");
@@ -4884,13 +4873,12 @@ public function providePreserveLineAfterControlBraceCases(): iterable
 }',
             ],
             [
-                "<?php if (true) {\r\n\r\n    // CRLF newline\n}",
+                "<?php if (true) {\n    // CRLF newline\n}",
                 "<?php if (true) {\r\n\r\n// CRLF newline\n}",
             ],
             [
                 '<?php
 if (true) {
-
     //  The blank line helps with legibility in nested control structures
     if (true) {
         // if body
@@ -4903,9 +4891,30 @@ public function providePreserveLineAfterControlBraceCases(): iterable
             ],
             [
                 '<?php
+if (true) {
+    //  The blank line helps with legibility in nested control structures
+    if (true) {
+        // if body
+    }
+
+    // if body
+}',
+                '<?php
+if (true) {
+
+    //  The blank line helps with legibility in nested control structures
+    if (true) {
+        // if body
+    }
+
+    // if body
+}',
+                self::CONFIGURATION_OOP_POSITION_SAME_LINE,
+            ],
+            [
+                '<?php
 if (true)
 {
-
     //  The blank line helps with legibility in nested control structures
     if (true)
     {
@@ -4927,13 +4936,13 @@ public function providePreserveLineAfterControlBraceCases(): iterable
                 self::CONFIGURATION_OOP_POSITION_SAME_LINE + self::CONFIGURATION_CTRL_STRUCT_POSITION_NEXT_LINE,
             ],
             [
+                "<?php if (true) {\n    // CRLF newline\n}",
                 "<?php if (true) {\r\n\r\n    // CRLF newline\n}",
-                null,
                 self::CONFIGURATION_OOP_POSITION_SAME_LINE,
             ],
             [
                 "<?php if (true)
-{\r\n\r\n    // CRLF newline\n}",
+{\n    // CRLF newline\n}",
                 "<?php if (true){\r\n\r\n// CRLF newline\n}",
                 self::CONFIGURATION_OOP_POSITION_SAME_LINE + self::CONFIGURATION_CTRL_STRUCT_POSITION_NEXT_LINE,
             ],

tests/Fixer/Whitespace/MethodChainingIndentationFixerTest.php

@@ -214,12 +214,12 @@ public function provideFixCases(): array
 
     $user->setFoo(1)
         ->setBar([
-                1 => 1,
-                ])
+            1 => 1,
+            ])
         ->setBaz(true)
         ->setX(array(
-    2 => 2,
-))
+            2 => 2,
+        ))
         ->setY();
 ',
                 '<?php

tests/Fixtures/Integration/misc/method_chaining_indentation,array_indentation.test

@@ -9,9 +9,29 @@ Foo::bar([
 ])
     ->call();
 
+function foo($foo)
+{
+    $foo
+        ->bar()
+        ->baz([
+            'foo' => 'bar',
+        ])
+    ;
+}
+
 --INPUT--
 <?php
 Foo::bar([
 		'baz',
 	])
 	    ->call();
+
+function foo($foo)
+{
+    $foo
+        ->bar()
+           ->baz([
+                'foo' => 'bar',
+            ])
+    ;
+}

tests/Fixtures/Integration/priority/control_structure_braces,no_multiple_statements_per_line.test

@@ -0,0 +1,11 @@
+--TEST--
+Integration of fixers: control_structure_braces,no_multiple_statements_per_line.
+--RULESET--
+{"control_structure_braces": true, "no_multiple_statements_per_line": true}
+--EXPECT--
+<?php
+$callback = function () { if ($a) { return true; } return false; };
+
+--INPUT--
+<?php
+$callback = function () { if ($a) return true; return false; };