Priority: AlignMultilineComment should run before every Phpdoc Fixer

I made use of the graph I generated with https://github.com/dmvdbrugge/fixer-prio-graph I also found a hidden priority between LineEnding and Braces, which I had to add in this PR as well, because otherwise the @Symfony_whitespace.test would fail.
PHP-CS-Fixer · Nov 13, 2018 · 69003f1 · 69003f1
1 parent 5d82d40
commit 69003f1
Show file tree

Hide file tree

Showing 13 changed files with 103 additions and 19 deletions.
diff --git a/src/AbstractNoUselessElseFixer.php b/src/AbstractNoUselessElseFixer.php
@@ -26,7 +26,7 @@ abstract class AbstractNoUselessElseFixer extends AbstractFixer
     public function getPriority()
     {
         // should be run before NoWhitespaceInBlankLineFixer, NoExtraBlankLinesFixer, BracesFixer and after NoEmptyStatementFixer.
-        return 25;
+        return 34;
     }
 
     /**

diff --git a/src/Fixer/Basic/BracesFixer.php b/src/Fixer/Basic/BracesFixer.php
@@ -127,7 +127,7 @@ public function bar($baz)
     public function getPriority()
     {
         // should be run after the ElseIfFixer, NoEmptyStatementFixer and NoUselessElseFixer
-        return -25;
+        return 33;
     }
 
     /**

diff --git a/src/Fixer/ControlStructure/ElseifFixer.php b/src/Fixer/ControlStructure/ElseifFixer.php
@@ -36,6 +36,14 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getPriority()
+    {
+        return 34;
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Fixer/ControlStructure/NoAlternativeSyntaxFixer.php b/src/Fixer/ControlStructure/NoAlternativeSyntaxFixer.php
@@ -67,7 +67,7 @@ public function isCandidate(Tokens $tokens)
      */
     public function getPriority()
     {
-        return 1;
+        return 35;
     }
 
     /**

diff --git a/src/Fixer/ControlStructure/NoUnneededCurlyBracesFixer.php b/src/Fixer/ControlStructure/NoUnneededCurlyBracesFixer.php
@@ -52,7 +52,7 @@ public function getDefinition()
     public function getPriority()
     {
         // must be run before NoUselessElseFixer and NoUselessReturnFixer.
-        return 26;
+        return 35;
     }
 
     /**

diff --git a/src/Fixer/Phpdoc/AlignMultilineCommentFixer.php b/src/Fixer/Phpdoc/AlignMultilineCommentFixer.php
@@ -88,8 +88,8 @@ public function getDefinition()
      */
     public function getPriority()
     {
-        // Should run after ArrayIndentationFixer
-        return -40;
+        // Should run after ArrayIndentationFixer but before every other Phpdoc Fixer
+        return 30;
     }
 
     /**

diff --git a/src/Fixer/Semicolon/NoEmptyStatementFixer.php b/src/Fixer/Semicolon/NoEmptyStatementFixer.php
@@ -42,7 +42,7 @@ public function getPriority()
     {
         // should be run before the BracesFixer, CombineConsecutiveUnsetsFixer, NoExtraBlankLinesFixer, MultilineWhitespaceBeforeSemicolonsFixer, NoSinglelineWhitespaceBeforeSemicolonsFixer,
         // NoTrailingCommaInListCallFixer, NoUselessReturnFixer, NoWhitespaceInBlankLineFixer, SpaceAfterSemicolonFixer, SwitchCaseSemicolonToColonFixer.
-        return 26;
+        return 35;
     }
 
     /**

diff --git a/src/Fixer/Whitespace/ArrayIndentationFixer.php b/src/Fixer/Whitespace/ArrayIndentationFixer.php
@@ -50,7 +50,7 @@ public function isCandidate(Tokens $tokens)
     public function getPriority()
     {
         // should run after BracesFixer
-        return -30;
+        return 32;
     }
 
     protected function applyFix(\SplFileInfo $file, Tokens $tokens)

diff --git a/src/Fixer/Whitespace/LineEndingFixer.php b/src/Fixer/Whitespace/LineEndingFixer.php
@@ -52,6 +52,12 @@ public function getDefinition()
         );
     }
 
+    public function getPriority()
+    {
+        // Should run before braces
+        return 34;
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/tests/AutoReview/FixerFactoryTest.php b/tests/AutoReview/FixerFactoryTest.php
@@ -95,6 +95,7 @@ public function provideFixersPriorityCases()
             [$fixers['general_phpdoc_annotation_remove'], $fixers['no_empty_phpdoc']],
             [$fixers['indentation_type'], $fixers['phpdoc_indent']],
             [$fixers['is_null'], $fixers['yoda_style']],
+            [$fixers['line_ending'], $fixers['braces']],
             [$fixers['list_syntax'], $fixers['binary_operator_spaces']],
             [$fixers['list_syntax'], $fixers['ternary_operator_spaces']],
             [$fixers['method_separation'], $fixers['braces']],
@@ -229,15 +230,18 @@ public function provideFixersPrioritySpecialPhpdocCases()
         $cases = [];
 
         // prepare bulk tests for phpdoc fixers to test that:
-        // * `comment_to_phpdoc` is first
-        // * `phpdoc_to_comment` is second
-        // * `phpdoc_indent` is third
-        // * `phpdoc_types` is fourth
-        // * `phpdoc_scalar` is fifth
+        // * `align_multiline_comment` is first
+        // * `comment_to_phpdoc` is second
+        // * `phpdoc_to_comment` is third
+        // * `phpdoc_indent` is fourth
+        // * `phpdoc_types` is fifth
+        // * `phpdoc_scalar` is sixth
         // * `phpdoc_align` is last
+        // Add these cases in test-order instead of alphabetical
+        $cases[] = [$fixers['align_multiline_comment'], $fixers['comment_to_phpdoc']];
         $cases[] = [$fixers['comment_to_phpdoc'], $fixers['phpdoc_to_comment']];
-        $cases[] = [$fixers['phpdoc_indent'], $fixers['phpdoc_types']];
         $cases[] = [$fixers['phpdoc_to_comment'], $fixers['phpdoc_indent']];
+        $cases[] = [$fixers['phpdoc_indent'], $fixers['phpdoc_types']];
         $cases[] = [$fixers['phpdoc_types'], $fixers['phpdoc_scalar']];
 
         $docFixerNames = array_filter(
@@ -249,6 +253,7 @@ static function ($name) {
 
         foreach ($docFixerNames as $docFixerName) {
             if (!\in_array($docFixerName, ['comment_to_phpdoc', 'phpdoc_to_comment', 'phpdoc_indent', 'phpdoc_types', 'phpdoc_scalar'], true)) {
+                $cases[] = [$fixers['align_multiline_comment'], $fixers[$docFixerName]];
                 $cases[] = [$fixers['comment_to_phpdoc'], $fixers[$docFixerName]];
                 $cases[] = [$fixers['phpdoc_indent'], $fixers[$docFixerName]];
                 $cases[] = [$fixers['phpdoc_scalar'], $fixers[$docFixerName]];
@@ -289,13 +294,14 @@ public function testFixersPriorityPairsHaveIntegrationTest(FixerInterface $first
         ];
 
         $integrationTestExists = $this->doesIntegrationTestExist($first, $second);
+        $integrationTestName = $this->generateIntegrationTestName($first, $second);
 
-        if (\in_array($this->generateIntegrationTestName($first, $second), $casesWithoutTests, true)) {
-            $this->assertFalse($integrationTestExists, sprintf('Case "%s" already has an integration test, so it should be removed from "$casesWithoutTests".', $this->generateIntegrationTestName($first, $second)));
-            $this->markTestIncomplete(sprintf('Case "%s" has no integration test yet, please help and add it.', $this->generateIntegrationTestName($first, $second)));
+        if (\in_array($integrationTestName, $casesWithoutTests, true)) {
+            $this->assertFalse($integrationTestExists, sprintf('Case "%s" already has an integration test, so it should be removed from "$casesWithoutTests".', $integrationTestName));
+            $this->markTestIncomplete(sprintf('Case "%s" has no integration test yet, please help and add it.', $integrationTestName));
         }
 
-        $this->assertTrue($integrationTestExists, sprintf('There shall be an integration test "%s". How do you know that priority set up is good, if there is no integration test to check it?', $this->generateIntegrationTestName($first, $second)));
+        $this->assertTrue($integrationTestExists, sprintf('There shall be an integration test "%s". How do you know that priority set up is good, if there is no integration test to check it?', $integrationTestName));
     }
 
     public function provideFixersPriorityPairsHaveIntegrationTestCases()
@@ -371,7 +377,7 @@ public function testPriorityIntegrationTestFilesAreListedPriorityCases($fileName
 
         $this->assertSame(
             1,
-            preg_match('#^([a-z][a-z0-9_]*),([a-z][a-z_]*)(?:_\d{1,3})?\.test$#', $fileName, $matches),
+            preg_match('#^([a-z][a-z0-9_]*),([a-z][a-z_]*)(?:_\d{1,3})?\.test(-(in|out)\.php)?$#', $fileName, $matches),
             sprintf('File with unexpected name "%s" in the priority integration test directory.', $fileName)
         );
 

diff --git a/tests/Fixtures/Integration/priority/line_ending,braces.test b/tests/Fixtures/Integration/priority/line_ending,braces.test
@@ -0,0 +1,6 @@
+--TEST--
+Integration of @Symfony [whitespace version].
+--RULESET--
+{"line_ending": true, "braces": true}
+--CONFIG--
+{"indent": "\t", "lineEnding": "\r\n"}
diff --git a/tests/Fixtures/Integration/priority/line_ending,braces.test-in.php b/tests/Fixtures/Integration/priority/line_ending,braces.test-in.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Coding standards demonstration.
+ */
+class FooBar
+{
+
+
+    const SOME_CONST = 42;
+
+    private $fooBar;
+
+    /**
+     * @param string $dummy Some argument description
+     */
+    public function __construct($dummy)
+    {
+        $this->fooBar = $this->transformText($dummy);
+    }
+}
diff --git a/tests/Fixtures/Integration/priority/line_ending,braces.test-out.php b/tests/Fixtures/Integration/priority/line_ending,braces.test-out.php
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Coding standards demonstration.
+ */
+class FooBar
+{
+	const SOME_CONST = 42;
+
+	private $fooBar;
+
+	/**
+	 * @param string $dummy Some argument description
+	 */
+	public function __construct($dummy)
+	{
+		$this->fooBar = $this->transformText($dummy);
+	}
+}