PHP 8.0 | Squiz.WhiteSpace.FunctionSpacing: add support for attributes

squizlabs · Mar 31, 2021 · cf0a195 · cf0a195
1 parent 1030040
commit cf0a195
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 0 deletions.
diff --git a/src/Standards/Squiz/Sniffs/WhiteSpace/FunctionSpacingSniff.php b/src/Standards/Squiz/Sniffs/WhiteSpace/FunctionSpacingSniff.php
@@ -115,6 +115,12 @@ public function process(File $phpcsFile, $stackPtr)
         $ignore = ([T_WHITESPACE => T_WHITESPACE] + Tokens::$methodPrefixes);
 
         $prev = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true);
+
+        while ($tokens[$prev]['code'] === T_ATTRIBUTE_END) {
+            // Skip past function attributes.
+            $prev = $phpcsFile->findPrevious($ignore, ($tokens[$prev]['attribute_opener'] - 1), null, true);
+        }
+
         if ($tokens[$prev]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
             // Skip past function docblocks.
             $prev = $phpcsFile->findPrevious($ignore, ($tokens[$prev]['comment_opener'] - 1), null, true);
@@ -241,6 +247,14 @@ public function process(File $phpcsFile, $stackPtr)
                 return;
             }
 
+            while ($tokens[$prevContent]['code'] === T_ATTRIBUTE_END
+                && $tokens[$prevContent]['line'] === ($currentLine - 1)
+            ) {
+                // Account for function attributes.
+                $currentLine = $tokens[$tokens[$prevContent]['attribute_opener']]['line'];
+                $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, ($tokens[$prevContent]['attribute_opener'] - 1), null, true);
+            }
+
             if ($tokens[$prevContent]['code'] === T_DOC_COMMENT_CLOSE_TAG
                 && $tokens[$prevContent]['line'] === ($currentLine - 1)
             ) {

diff --git a/src/Standards/Squiz/Tests/WhiteSpace/FunctionSpacingUnitTest.1.inc b/src/Standards/Squiz/Tests/WhiteSpace/FunctionSpacingUnitTest.1.inc
@@ -540,6 +540,37 @@ class MyClass {
     // function d() {}
 }
 
+class ClassWithAttributes {
+
+    #[Attribute1]
+    #[Attribute2]
+    function a(){}
+
+
+    #[Attribute3]
+    function b(){}
+    #[Attribute4]
+    function c(){}
+
+
+    /**
+     * Description.
+     */
+    #[Attribute5]
+    function d(){}
+    /**
+     * Description.
+     */
+    #[Attribute6]
+    #[Attribute7]
+    function e(){}
+
+
+    #[Attribute8]
+    #[Attribute9]
+    function f(){}
+}
+
 // phpcs:set Squiz.WhiteSpace.FunctionSpacing spacing 2
 // phpcs:set Squiz.WhiteSpace.FunctionSpacing spacingBeforeFirst 2
 // phpcs:set Squiz.WhiteSpace.FunctionSpacing spacingAfterLast 2
diff --git a/src/Standards/Squiz/Tests/WhiteSpace/FunctionSpacingUnitTest.1.inc.fixed b/src/Standards/Squiz/Tests/WhiteSpace/FunctionSpacingUnitTest.1.inc.fixed
@@ -624,6 +624,35 @@ class MyClass {
     // function d() {}
 }
 
+class ClassWithAttributes {
+    #[Attribute1]
+    #[Attribute2]
+    function a(){}
+
+    #[Attribute3]
+    function b(){}
+
+    #[Attribute4]
+    function c(){}
+
+    /**
+     * Description.
+     */
+    #[Attribute5]
+    function d(){}
+
+    /**
+     * Description.
+     */
+    #[Attribute6]
+    #[Attribute7]
+    function e(){}
+
+    #[Attribute8]
+    #[Attribute9]
+    function f(){}
+}
+
 // phpcs:set Squiz.WhiteSpace.FunctionSpacing spacing 2
 // phpcs:set Squiz.WhiteSpace.FunctionSpacing spacingBeforeFirst 2
 // phpcs:set Squiz.WhiteSpace.FunctionSpacing spacingAfterLast 2
diff --git a/src/Standards/Squiz/Tests/WhiteSpace/FunctionSpacingUnitTest.php b/src/Standards/Squiz/Tests/WhiteSpace/FunctionSpacingUnitTest.php
@@ -90,6 +90,11 @@ public function getErrorList($testFile='')
                 495 => 1,
                 529 => 1,
                 539 => 1,
+                547 => 2,
+                551 => 1,
+                553 => 1,
+                560 => 1,
+                566 => 1,
             ];
 
         case 'FunctionSpacingUnitTest.2.inc':