Fixed bug #1817 : Blank line not enforced after control structure if …

…comment on same line as closing brace
squizlabs · Jan 2, 2018 · a7d4118 · a7d4118
1 parent 2f5af2d
commit a7d4118
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 6 deletions.
diff --git a/package.xml b/package.xml
@@ -33,6 +33,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Thanks to Raúl Arellano for the patch
   - Fixed bug #1793 : PSR2 forcing exact indent for function call opening statements
   - Fixed bug #1803 : Squiz.WhiteSpace.ScopeKeywordSpacing removes member var name while fixing if no space after scope keyword
+  - Fixed bug #1817 : Blank line not enforced after control structure if comment on same line as closing brace
  </notes>
  <contents>
   <dir name="/">

diff --git a/src/Config.php b/src/Config.php
@@ -1223,7 +1223,6 @@ public function processLongArgument($arg, $pos)
                     $this->processUnknownArgument('--'.$arg, $pos);
                 }
             }//end if
-
             break;
         }//end switch
 

diff --git a/src/Standards/Squiz/Sniffs/WhiteSpace/ControlStructureSpacingSniff.php b/src/Standards/Squiz/Sniffs/WhiteSpace/ControlStructureSpacingSniff.php
@@ -250,6 +250,7 @@ public function process(File $phpcsFile, $stackPtr)
 
             if ($tokens[$nextCode]['code'] === T_ELSE
                 || $tokens[$nextCode]['code'] === T_ELSEIF
+                || $tokens[$trailingContent]['line'] === $tokens[$scopeCloser]['line']
             ) {
                 $trailingContent = $nextCode;
             }
@@ -319,7 +320,20 @@ public function process(File $phpcsFile, $stackPtr)
             $error = 'No blank line found after control structure';
             $fix   = $phpcsFile->addFixableError($error, $scopeCloser, 'NoLineAfterClose');
             if ($fix === true) {
-                $phpcsFile->fixer->addNewline($scopeCloser);
+                $trailingContent = $phpcsFile->findNext(
+                    T_WHITESPACE,
+                    ($scopeCloser + 1),
+                    null,
+                    true
+                );
+
+                if ($tokens[$trailingContent]['code'] === T_COMMENT
+                    && $tokens[$trailingContent]['line'] === $tokens[$scopeCloser]['line']
+                ) {
+                    $phpcsFile->fixer->addNewline($trailingContent);
+                } else {
+                    $phpcsFile->fixer->addNewline($scopeCloser);
+                }
             }
         }//end if
 

diff --git a/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.inc b/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.inc
@@ -229,6 +229,11 @@ if (true) { echo 'foo';
     echo 'foo';
 }
 
+if ($true) {
+    echo 'hi 2';
+}//end if
+echo 'hi';
+
 ?>
 <?php foreach($formset['Fieldset'] as $fieldset): ?>
 

diff --git a/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.inc.fixed b/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.inc.fixed
@@ -222,6 +222,12 @@ if (true) { echo 'foo';
     echo 'foo';
 }
 
+if ($true) {
+    echo 'hi 2';
+}//end if
+
+echo 'hi';
+
 ?>
 <?php foreach($formset['Fieldset'] as $fieldset): ?>
     <?php foreach($fieldset['Field'] as $field):

diff --git a/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.php b/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.php
@@ -53,8 +53,9 @@ public function getErrorList($testFile='ControlStructureSpacingUnitTest.inc')
                 179 => 1,
                 189 => 1,
                 222 => 1,
-                233 => 1,
-                235 => 1,
+                234 => 1,
+                238 => 1,
+                240 => 1,
             ];
             break;
         case 'ControlStructureSpacingUnitTest.js':

diff --git a/src/Tokenizers/CSS.php b/src/Tokenizers/CSS.php
@@ -358,7 +358,6 @@ public function tokenize($string)
                     $finalTokens[($stackPtr + 1)]['content'] = '-'.$finalTokens[($stackPtr + 1)]['content'];
                     unset($finalTokens[$stackPtr]);
                 }//end if
-
                 break;
             case T_COLON:
                 // Only interested in colons that are defining styles.
@@ -472,7 +471,6 @@ public function tokenize($string)
                         unset($finalTokens[$stackPtr]);
                     }
                 }//end if
-
                 break;
             case T_ASPERAND:
                 $asperandStart = true;