Squiz.Classes.ClassDeclaration no longer enforces spacing rules when a class is followed by a function (ref #2033)

Author: gsherwood

package.xml

@@ -38,6 +38,8 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - PSR2.Namespaces.UseDeclaration now supports commas at the end of group use declarations
     -- Also improves checking and fixing for use statements containing parse errors
     -- Thanks to Juliette Reinders Folmer for the patch
+  - Squiz.Classes.ClassDeclaration no longer enforces spacing rules when a class is followed by a function
+    -- Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff
   - Squiz.Commenting.InlineComment no longer enforces spacing rules when an inline comment is followed by a docblock
     -- Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff
   - Squiz.WhiteSpace.SuperfluousWhitespace now recognizes unicode whitespace at the start and end of a file

src/Standards/Squiz/Sniffs/Classes/ClassDeclarationSniff.php

@@ -106,7 +106,7 @@ public function processClose(File $phpcsFile, $stackPtr)
 
         // Check that the closing brace has one blank line after it.
         for ($nextContent = ($closeBrace + 1); $nextContent < $phpcsFile->numTokens; $nextContent++) {
-            // Ignore comments on the same lines as the brace.
+            // Ignore comments on the same line as the brace.
             if ($tokens[$nextContent]['line'] === $tokens[$closeBrace]['line']
                 && ($tokens[$nextContent]['code'] === T_WHITESPACE
                 || $tokens[$nextContent]['code'] === T_COMMENT
@@ -166,6 +166,13 @@ public function processClose(File $phpcsFile, $stackPtr)
         }//end if
 
         if ($difference !== -1 && $difference !== 1) {
+            if ($tokens[$nextContent]['code'] === T_DOC_COMMENT_OPEN_TAG) {
+                $next = $phpcsFile->findNext(T_WHITESPACE, ($tokens[$nextContent]['comment_closer'] + 1), null, true);
+                if ($next !== false && $tokens[$next]['code'] === T_FUNCTION) {
+                    return;
+                }
+            }
+
             $error = 'Closing brace of a %s must be followed by a single blank line; found %s';
             $data  = [
                 $tokens[$stackPtr]['content'],

src/Standards/Squiz/Tests/Classes/ClassDeclarationUnitTest.inc

@@ -94,6 +94,17 @@ interface MyInterface
 
 <?php
 
+class MyClass2
+{
+    var $x;
+}
+
+
+/**
+ * No error.
+ */
+function example() {}
+
 class CorrectClassDeclaration
 {
 

src/Standards/Squiz/Tests/Classes/ClassDeclarationUnitTest.inc.fixed

@@ -102,6 +102,17 @@ interface MyInterface
 
 <?php
 
+class MyClass2
+{
+    var $x;
+}
+
+
+/**
+ * No error.
+ */
+function example() {}
+
 class CorrectClassDeclaration
 {
 

src/Standards/Squiz/Tests/Classes/ClassDeclarationUnitTest.php

@@ -56,10 +56,11 @@ public function getErrorList()
             89  => 1,
             92  => 1,
             97  => 1,
-            103 => 1,
-            105 => 1,
-            107 => 1,
-            110 => 1,
+            108 => 1,
+            114 => 1,
+            116 => 1,
+            118 => 1,
+            121 => 1,
         ];
 
     }//end getErrorList()