Improve priorities calculation (#851)

Author: kubawerlos

.dev-tools/src/Priority/PriorityCollection.php

@@ -13,6 +13,7 @@
 
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\FixerFactory;
+use PhpCsFixerCustomFixers\Fixer\CommentSurroundedBySpacesFixer;
 use PhpCsFixerCustomFixers\Fixers;
 use Tests\PriorityTest;
 
@@ -84,12 +85,35 @@ private function isFixerWithoutPriorityInCollection(): bool
 
     private function getFirstPriorityFixerWithoutPriority(): ?PriorityFixer
     {
-        foreach ($this->priorityFixers as $priorityFixer) {
-            if (!$priorityFixer->hasPriority()) {
-                return $priorityFixer;
-            }
+        static $firstFixers = [
+            CommentSurroundedBySpacesFixer::class,
+        ];
+
+        $priorityFixersWithoutPriorities = \array_filter(
+            $this->priorityFixers,
+            static fn (PriorityFixer $priorityFixer) => !$priorityFixer->hasPriority()
+        );
+
+        if ($priorityFixersWithoutPriorities === []) {
+            return null;
         }
 
-        return null;
+        \usort(
+            $priorityFixersWithoutPriorities,
+            static function (PriorityFixer $p1, PriorityFixer $p2) use ($firstFixers): int {
+                foreach ($firstFixers as $firstFixer) {
+                    if ($p1->name() === $firstFixer) {
+                        return -1;
+                    }
+                    if ($p2->name() === $firstFixer) {
+                        return 1;
+                    }
+                }
+
+                return $p1->name() <=> $p2->name();
+            }
+        );
+
+        return \reset($priorityFixersWithoutPriorities);
     }
 }

.dev-tools/src/Priority/PriorityFixer.php

@@ -33,6 +33,11 @@ public function __construct(FixerInterface $fixer, ?int $priority)
         $this->priority = $priority;
     }
 
+    public function name(): string
+    {
+        return \get_class($this->fixer);
+    }
+
     public function addFixerToRunAfter(self $priorityFixer): void
     {
         $this->fixersToRunAfter[] = $priorityFixer;