Added auto-fixing for the file header sniff (ref #750)

Author: gsherwood

package.xml

@@ -1151,8 +1151,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
         <file baseinstalldir="PHP/CodeSniffer" name="DeclareStatementUnitTest.php" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.1.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.2.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.2.inc.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.3.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.4.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.4.inc.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileHeaderUnitTest.php" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ImportStatementUnitTest.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ImportStatementUnitTest.php" role="test" />

src/Standards/PSR12/Sniffs/Files/FileHeaderSniff.php

@@ -147,8 +147,27 @@ public function process(File $phpcsFile, $stackPtr)
                 $next = $phpcsFile->findNext(T_WHITESPACE, ($line['end'] + 1), null, true);
                 if ($tokens[$next]['line'] !== ($tokens[$line['end']]['line'] + 2)) {
                     $error = 'Header blocks must be followed by a single blank line';
-                    $phpcsFile->addError($error, $line['end'], 'SpacingAfterBlock');
-                }
+                    $fix = $phpcsFile->addFixableError($error, $line['end'], 'SpacingAfterBlock');
+                    if ($fix === true) {
+                        if ($tokens[$next]['line'] === $tokens[$line['end']]['line']) {
+                            $phpcsFile->fixer->addNewlineBefore($next);
+                            $phpcsFile->fixer->addNewlineBefore($next);
+                        } else if ($tokens[$next]['line'] === ($tokens[$line['end']]['line'] + 1)) {
+                            $phpcsFile->fixer->addNewline($line['end']);
+                        } else {
+                            $phpcsFile->fixer->beginChangeset();
+                            for ($i = ($line['end'] + 1); $i < $next; $i++) {
+                                if ($tokens[$i]['line'] === ($tokens[$line['end']]['line'] + 2)) {
+                                    break;
+                                }
+
+                                $phpcsFile->fixer->replaceToken($i, '');
+                            }
+
+                            $phpcsFile->fixer->endChangeset();
+                        }
+                    }//end if
+                }//end if
 
                 // Make sure we haven't seen this next block before.
                 if (isset($headerLines[($i + 1)]) === true
@@ -168,7 +187,23 @@ public function process(File $phpcsFile, $stackPtr)
                 $next = $phpcsFile->findNext(T_WHITESPACE, ($line['end'] + 1), null, true);
                 if ($tokens[$next]['line'] > ($tokens[$line['end']]['line'] + 1)) {
                     $error = 'Header blocks must not contain blank lines';
-                    $phpcsFile->addError($error, $line['end'], 'SpacingInsideBlock');
+                    $fix   = $phpcsFile->addFixableError($error, $line['end'], 'SpacingInsideBlock');
+                    if ($fix === true) {
+                        $phpcsFile->fixer->beginChangeset();
+                        for ($i = ($line['end'] + 1); $i < $next; $i++) {
+                            if ($tokens[$i]['line'] === $tokens[$line['end']]['line']) {
+                                continue;
+                            }
+
+                            if ($tokens[$i]['line'] === $tokens[$next]['line']) {
+                                break;
+                            }
+
+                            $phpcsFile->fixer->replaceToken($i, '');
+                        }
+
+                        $phpcsFile->fixer->endChangeset();
+                    }
                 }
             }//end if
 

src/Standards/PSR12/Tests/Files/FileHeaderUnitTest.2.inc.fixed

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * This file contains an example of coding styles.
+ */
+
+declare(strict_types=1);
+
+namespace Vendor\Package;
+
+use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
+// Comments are probably ok; PSR-12 doesn't say.
+use Vendor\Package\SomeNamespace\ClassD as D;
+use Vendor\Package\AnotherNamespace\ClassE as E;
+
+// Comments are probably ok; PSR-12 doesn't say.
+use function Vendor\Package\{functionA, functionB, functionC};
+use function Another\Vendor\functionD;
+
+use const Vendor\Package\{CONSTANT_A, CONSTANT_B, CONSTANT_C};
+use const Another\Vendor\CONSTANT_D;
+
+/**
+ * FooBar is an example class.
+ */
+class FooBar
+{
+    // ... additional PHP code ...
+}

src/Standards/PSR12/Tests/Files/FileHeaderUnitTest.4.inc

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
 use Vendor\Package\SomeNamespace\ClassD as D;
-use Vendor\Package\AnotherNamespace\ClassE as E;
+use Vendor\Package\AnotherNamespace\ClassE as E;use const Another\Vendor\CONSTANT_D;
 
 /**
  * FooBar is an example class.

src/Standards/PSR12/Tests/Files/FileHeaderUnitTest.4.inc.fixed

@@ -0,0 +1,19 @@
+<?php
+
+namespace Vendor\Package;
+
+declare(strict_types=1);
+
+use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
+use Vendor\Package\SomeNamespace\ClassD as D;
+use Vendor\Package\AnotherNamespace\ClassE as E;
+
+use const Another\Vendor\CONSTANT_D;
+
+/**
+ * FooBar is an example class.
+ */
+class FooBar
+{
+    // ... additional PHP code ...
+}

src/Standards/PSR12/Tests/Files/FileHeaderUnitTest.php

@@ -46,6 +46,7 @@ public function getErrorList($testFile='')
                 1 => 1,
                 2 => 1,
                 3 => 1,
+                7 => 1,
             ];
         default:
             return [];