fix(file): Improve function statement sorting logic for better accuracy

guanguans · guanguans · commit dc37a355a26c · 2026-02-05T21:19:06.000+08:00
- Adds a check to ensure all function names are in sorted order before processing
- Implements a reduce method to insert Nop statements when function statements overlap or are out of order
- Enhances code clarity and maintains proper statement sequence for file sorting functionality
diff --git a/baselines/loader.neon b/baselines/loader.neon
@@ -1,4 +1,4 @@
-# total 12 errors
+# total 13 errors
 
 includes:
     - complexity.functionLike.neon
diff --git a/baselines/method.nonObject.neon b/baselines/method.nonObject.neon
@@ -1,4 +1,4 @@
-# total 3 errors
+# total 4 errors
 
 parameters:
     ignoreErrors:
@@ -7,6 +7,11 @@ parameters:
             count: 1
             path: ../src/Rector/Array_/SimplifyListIndexRector.php
 
+        -
+            message: '#^Cannot call method all\(\) on mixed\.$#'
+            count: 1
+            path: ../src/Rector/File/SortFileFunctionStmtRector.php
+
         -
             message: '#^Cannot call method all\(\) on mixed\.$#'
             count: 1
diff --git a/composer.json b/composer.json
@@ -375,7 +375,7 @@
         "rector-rules:list-files": "Guanguans\\RectorRules\\Support\\ComposerScripts::listFiles",
         "rector:custom-rule": "@rector custom-rule",
         "rector:list-rules": "@rector list-rules",
-        "rector:process": "@rector process",
+        "rector:process": "@rector process --ansi",
         "rector:process-clear-cache": "@rector:process --clear-cache",
         "rector:process-clear-cache-dry-run": "@rector:process-clear-cache --dry-run",
         "rector:process-dry-run": "@rector:process --dry-run",
diff --git a/docs/rules-overview.md b/docs/rules-overview.md
@@ -266,7 +266,9 @@ Sort file function stmt
 
 -function c(): void {}
 +function a(): void {}
+
  function b(): void {}
+
 -function a(): void {}
 +function c(): void {}
 ```
diff --git a/src/Rector/File/SortFileFunctionStmtRector.php b/src/Rector/File/SortFileFunctionStmtRector.php
@@ -15,6 +15,7 @@
 namespace Guanguans\RectorRules\Rector\File;
 
 use Guanguans\RectorRules\Rector\AbstractRector;
+use Illuminate\Support\Collection;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\BooleanNot;
@@ -26,6 +27,7 @@
 use PhpParser\Node\Stmt\Function_;
 use PhpParser\Node\Stmt\If_;
 use PhpParser\Node\Stmt\Namespace_;
+use PhpParser\Node\Stmt\Nop;
 use Rector\PhpParser\Node\FileNode;
 use Rector\PhpParser\Node\Value\ValueResolver;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -70,6 +72,10 @@ public function refactor(Node $node): ?Node
             || !collect($rootNode->stmts)->containsStrict(
                 fn (Stmt $stmtNode): ?string => $this->parseFuncName($stmtNode)
             )
+            || collect($rootNode->stmts)
+                ->map(fn (Stmt $stmtNode): ?string => $this->parseFuncName($stmtNode))
+                ->filter()
+                ->pipe(static fn (Collection $funcNames): bool => $funcNames->all() === $funcNames->sort()->all())
         ) {
             return null;
         }
@@ -81,7 +87,19 @@ public function refactor(Node $node): ?Node
                     ? $aName <=> $bName
                     : 0
             )
-            // ->values()
+            ->reduce(
+                static function (Collection $stmtNodes, Stmt $stmtNode): Collection {
+                    if (
+                        ($prevStmtNode = $stmtNodes->last()) instanceof Stmt
+                        && $stmtNode->getStartLine() <= $prevStmtNode->getEndLine()
+                    ) {
+                        $stmtNodes->push(new Nop);
+                    }
+
+                    return $stmtNodes->push($stmtNode);
+                },
+                collect()
+            )
             ->all();
 
         if ($rootNode->stmts === $sortedStmts) {
@@ -105,15 +123,19 @@ protected function codeSamples(): array
                     namespace Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStmtRector\Fixture;
 
                     function c(): void {}
+
                     function b(): void {}
+
                     function a(): void {}
                     PHP,
                 <<<'PHP'
                     /** @noinspection ALL */
                     namespace Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStmtRector\Fixture;
 
                     function a(): void {}
+
                     function b(): void {}
+
                     function c(): void {}
                     PHP
             ),
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -59,7 +59,7 @@
 | "expect()" function gives you access to a set of "expectations" methods that you can use
 | to assert different things. Of course, you may extend the Expectation API at any time.
 |
- */
+*/
 
 /**
  * @see expect()->toBetween()
@@ -92,7 +92,7 @@ function (Closure $assertions): Expectation {
 | project that you don't want to repeat in every file. Here you can also expose helpers as
 | global functions to help you to reduce the number of lines of code in your test files.
 |
- */
+*/
 
 /**
  * @param class-string|object $class
diff --git a/tests/Rector/File/SortFileFunctionStmtRector/Fixture/fixture.php.inc b/tests/Rector/File/SortFileFunctionStmtRector/Fixture/fixture.php.inc
@@ -4,7 +4,9 @@
 namespace Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStmtRector\Fixture;
 
 function c(): void {}
+
 function b(): void {}
+
 function a(): void {}
 
 ?>
@@ -15,7 +17,9 @@ function a(): void {}
 namespace Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStmtRector\Fixture;
 
 function a(): void {}
+
 function b(): void {}
+
 function c(): void {}
 
 ?>
diff --git a/tests/Rector/File/SortFileFunctionStmtRector/Fixture/fixture_if_function_exists.php.inc b/tests/Rector/File/SortFileFunctionStmtRector/Fixture/fixture_if_function_exists.php.inc
@@ -35,9 +35,11 @@ if (!function_exists('Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStm
     {
     }
 }
+
 function b(): void
 {
 }
+
 if (!function_exists('Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStmtRector\Fixture\c')) {
     function c(): void
     {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# total 12 errors`
	`1`	`+# total 13 errors`
`2`	`2`
`3`	`3`	`includes:`
`4`	`4`	`- complexity.functionLike.neon`
Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,11 @@ if (!function_exists('Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStm`
`35`	`35`	`{`
`36`	`36`	`}`
`37`	`37`	`}`
	`38`	`+`
`38`	`39`	`function b(): void`
`39`	`40`	`{`
`40`	`41`	`}`
	`42`	`+`
`41`	`43`	`if (!function_exists('Guanguans\RectorRulesTests\Rector\File\SortFileFunctionStmtRector\Fixture\c')) {`
`42`	`44`	`function c(): void`
`43`	`45`	`{`