Fixed bug #893 : Squiz.WhiteSpace.MemberVarSpacing.AfterComment fails…

… to fix error when comment is not a docblock
squizlabs · May 12, 2016 · 0434c48 · 0434c48
1 parent e2e4756
commit 0434c48
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 0 deletions.
diff --git a/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/MemberVarSpacingSniff.php b/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/MemberVarSpacingSniff.php
@@ -63,6 +63,12 @@ protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                     $fix   = $phpcsFile->addFixableError($error, $prev, 'AfterComment', $data);
                     if ($fix === true) {
                         $phpcsFile->fixer->beginChangeset();
+                        // Inline comments have the newline included in the content but
+                        // docblock do not.
+                        if ($tokens[$prev]['code'] === T_COMMENT) {
+                            $phpcsFile->fixer->replaceToken($prev, rtrim($tokens[$prev]['content']));
+                        }
+
                         for ($i = ($prev + 1); $i <= $stackPtr; $i++) {
                             if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) {
                                 break;

diff --git a/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc b/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc
@@ -147,4 +147,8 @@ class Foo
 
     private $bar;
 
+    //  here comes the comment
+
+    private $caseStudy = null;
+
 }
diff --git a/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc.fixed b/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc.fixed
@@ -146,4 +146,7 @@ class Foo
 
     private $bar;
 
+    //  here comes the comment
+    private $caseStudy = null;
+
 }
diff --git a/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.php b/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.php
@@ -54,6 +54,7 @@ public function getErrorList()
                 86  => 1,
                 106 => 1,
                 115 => 1,
+                150 => 1,
                );
 
     }//end getErrorList()

diff --git a/package.xml b/package.xml
@@ -46,6 +46,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #973 : Anonymous class declaration and PSR1.Files.SideEffects.FoundWithSymbols
   - Fixed bug #974 : Error when file ends with "function"
   - Fixed bug #979 : Anonymous function with return type hint is not refactored as expected
+  - Fixed bug #893 : Squiz.WhiteSpace.MemberVarSpacing.AfterComment fails to fix error when comment is not a docblock
  </notes>
  <contents>
   <dir name="/">