Fix array bracket issue with comments.

Author: dereuromark

PhpCollective/Sniffs/Arrays/ArrayBracketSpacingSniff.php

@@ -70,6 +70,15 @@ public function process(File $phpcsFile, $stackPtr): void
         // Any extra blank lines should be removed
         if ($closerLine - $lastContentLine > 1) {
             $error = 'Extra blank lines found before array closing bracket';
+
+            // Check if the last content is a comment - these are problematic for auto-fixing
+            if ($tokens[$lastContentPtr]['code'] === T_COMMENT) {
+                // Report as non-fixable error when last element is a comment
+                $phpcsFile->addError($error, $closerPtr, 'ExtraBlankLineBeforeCloser');
+
+                return;
+            }
+
             $fix = $phpcsFile->addFixableError($error, $closerPtr, 'ExtraBlankLineBeforeCloser');
 
             if ($fix === true) {
@@ -90,13 +99,33 @@ public function process(File $phpcsFile, $stackPtr): void
                     }
                 }
 
-                // Remove all tokens between last content and closer
+                // Find whitespace tokens between last content and closer
+                $whitespaceTokens = [];
                 for ($i = $lastContentPtr + 1; $i < $closerPtr; $i++) {
-                    $phpcsFile->fixer->replaceToken($i, '');
+                    if ($tokens[$i]['code'] === T_WHITESPACE) {
+                        $whitespaceTokens[] = $i;
+                    }
                 }
 
-                // Add a single newline with proper indentation after the last content
-                $phpcsFile->fixer->addContent($lastContentPtr, "\n" . $indent);
+                // Find the position to insert the newline
+                // If there's already whitespace, replace it; otherwise add new
+                $nextToken = $lastContentPtr + 1;
+
+                if ($nextToken < $closerPtr && $tokens[$nextToken]['code'] === T_WHITESPACE) {
+                    // There's whitespace right after the last content
+                    // Replace it with a single newline and indent
+                    $phpcsFile->fixer->replaceToken($nextToken, "\n" . $indent);
+
+                    // Remove any additional whitespace tokens
+                    for ($i = $nextToken + 1; $i < $closerPtr; $i++) {
+                        if ($tokens[$i]['code'] === T_WHITESPACE) {
+                            $phpcsFile->fixer->replaceToken($i, '');
+                        }
+                    }
+                } else {
+                    // No whitespace immediately after, need to add it
+                    $phpcsFile->fixer->addContent($lastContentPtr, "\n" . $indent);
+                }
 
                 $phpcsFile->fixer->endChangeset();
             }

tests/PhpCollective/Sniffs/Arrays/ArrayBracketSpacingSniffTest.php

@@ -17,7 +17,8 @@ class ArrayBracketSpacingSniffTest extends TestCase
      */
     public function testArrayBracketSpacingSniffer(): void
     {
-        $this->assertSnifferFindsErrors(new ArrayBracketSpacingSniff(), 4);
+        // 4 original errors + 1 new error from array with comments
+        $this->assertSnifferFindsErrors(new ArrayBracketSpacingSniff(), 5);
     }
 
     /**

tests/PhpCollective/Sniffs/Commenting/AttributesSniffTest.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PhpCollective\Test\PhpCollective\Sniffs\Commenting;
+
+use PhpCollective\Sniffs\Commenting\AttributesSniff;
+use PhpCollective\Test\TestCase;
+
+class AttributesSniffTest extends TestCase
+{
+    /**
+     * @return void
+     */
+    public function testAttributesSniffer(): void
+    {
+        $this->assertSnifferFindsErrors(new AttributesSniff(), 4);
+    }
+}

tests/_data/ArrayBracketSpacing/after.php

@@ -43,5 +43,14 @@ public function test(): void
             'item1',
             'item2',
         ];
+
+        // Array with comment as last element followed by blank lines
+        // This should report an error but NOT be auto-fixable
+        $array7 = [
+            'key' => 'value',
+            //'conditions' => array('ConversationUsers.status <'=>ConversationUser::STATUS_REMOVED),
+            //'group' => array('ConversationUser.conversation_id HAVING SUM(...)'), //HAVING COUNT(*) = '.count($users).'
+
+        ];
     }
 }

tests/_data/ArrayBracketSpacing/before.php

@@ -48,5 +48,14 @@ public function test(): void
             'item2',
 
         ];
+
+        // Array with comment as last element followed by blank lines
+        // This should report an error but NOT be auto-fixable
+        $array7 = [
+            'key' => 'value',
+            //'conditions' => array('ConversationUsers.status <'=>ConversationUser::STATUS_REMOVED),
+            //'group' => array('ConversationUser.conversation_id HAVING SUM(...)'), //HAVING COUNT(*) = '.count($users).'
+
+        ];
     }
 }

tests/_data/Attributes/after.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace PhpCollective;
+
+// Correct - FQCN with leading backslash
+#[\AllowDynamicProperties]
+class CorrectExample1
+{
+}
+
+// Correct - FQCN with namespace separator tokens
+#[\Some\Namespace\MyAttribute]
+class CorrectExample2
+{
+}
+
+// Incorrect - missing leading backslash
+#[AllowDynamicProperties]
+class IncorrectExample1
+{
+}
+
+// Incorrect - not FQCN
+#[MyAttribute]
+class IncorrectExample2
+{
+}
+
+// Multiple attributes - mixed correct and incorrect
+#[\AllowDynamicProperties]
+#[MyAttribute]
+#[\Another\Namespace\Attr]
+class MixedExample
+{
+}
+
+// Attribute with parameters - correct
+#[\Attribute(Attribute::TARGET_CLASS)]
+class WithParameters
+{
+}
+
+// Attribute with parameters - incorrect
+#[Attribute(Attribute::TARGET_METHOD)]
+class WithParametersIncorrect
+{
+}

tests/_data/Attributes/before.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace PhpCollective;
+
+// Correct - FQCN with leading backslash
+#[\AllowDynamicProperties]
+class CorrectExample1
+{
+}
+
+// Correct - FQCN with namespace separator tokens
+#[\Some\Namespace\MyAttribute]
+class CorrectExample2
+{
+}
+
+// Incorrect - missing leading backslash
+#[AllowDynamicProperties]
+class IncorrectExample1
+{
+}
+
+// Incorrect - not FQCN
+#[MyAttribute]
+class IncorrectExample2
+{
+}
+
+// Multiple attributes - mixed correct and incorrect
+#[\AllowDynamicProperties]
+#[MyAttribute]
+#[\Another\Namespace\Attr]
+class MixedExample
+{
+}
+
+// Attribute with parameters - correct
+#[\Attribute(Attribute::TARGET_CLASS)]
+class WithParameters
+{
+}
+
+// Attribute with parameters - incorrect
+#[Attribute(Attribute::TARGET_METHOD)]
+class WithParametersIncorrect
+{
+}