Add PSR2R.WhiteSpace.ArrayDeclarationSpacing

Author: dereuromark

PSR2R/Sniffs/WhiteSpace/ArrayDeclarationSpacingSniff.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace PSR2R\Sniffs\WhiteSpace;
+
+use PHP_CodeSniffer\Files\File;
+use PSR2R\Tools\AbstractSniff;
+
+/**
+ * Ensures that array opening brackets are on the same line as the assignment operator.
+ * Prevents cases like:
+ *
+ *     public $components =
+ *     [
+ *
+ * Should be:
+ *
+ *     public $components = [
+ *
+ * @author Mark Scherer
+ * @license MIT
+ */
+class ArrayDeclarationSpacingSniff extends AbstractSniff {
+
+	/**
+	 * @inheritDoc
+	 */
+	public function register(): array {
+		return [T_OPEN_SHORT_ARRAY];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function process(File $phpcsFile, $stackPtr) {
+		$tokens = $phpcsFile->getTokens();
+
+		// Find the previous non-whitespace token
+		$prevIndex = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
+		if ($prevIndex === false) {
+			return;
+		}
+
+		// Check if the previous token is an assignment operator
+		$assignmentTokens = [T_EQUAL, T_DOUBLE_ARROW];
+		if (!in_array($tokens[$prevIndex]['code'], $assignmentTokens, true)) {
+			return;
+		}
+
+		// Check if the opening bracket is on a different line than the assignment
+		if ($tokens[$prevIndex]['line'] === $tokens[$stackPtr]['line']) {
+			return;
+		}
+
+		// We found the issue: assignment on one line, bracket on another
+		$fix = $phpcsFile->addFixableError(
+			'Array opening bracket must be on the same line as the assignment operator',
+			$stackPtr,
+			'OpeningBracketNewline',
+		);
+		if (!$fix) {
+			return;
+		}
+
+		$phpcsFile->fixer->beginChangeset();
+
+		// Remove all whitespace between the assignment and the opening bracket
+		for ($i = $prevIndex + 1; $i < $stackPtr; $i++) {
+			$phpcsFile->fixer->replaceToken($i, '');
+		}
+
+		// Add a single space after the assignment operator
+		$phpcsFile->fixer->addContent($prevIndex, ' ');
+
+		$phpcsFile->fixer->endChangeset();
+	}
+
+}

docs/sniffs.md

@@ -1,6 +1,6 @@
 # PSR2R Code Sniffer
 
-The PSR2R standard contains 207 sniffs
+The PSR2R standard contains 208 sniffs
 
 Generic (24 sniffs)
 -------------------
@@ -108,7 +108,7 @@ PSR2 (6 sniffs)
 - PSR2.Namespaces.NamespaceDeclaration
 - PSR2.Namespaces.UseDeclaration
 
-PSR2R (42 sniffs)
+PSR2R (43 sniffs)
 -----------------
 - PSR2R.Classes.BraceOnSameLine
 - PSR2R.Classes.InterfaceName
@@ -142,6 +142,7 @@ PSR2R (42 sniffs)
 - PSR2R.PHP.ListComma
 - PSR2R.PHP.NoShortOpenTag
 - PSR2R.PHP.PreferStaticOverSelf
+- PSR2R.WhiteSpace.ArrayDeclarationSpacing
 - PSR2R.WhiteSpace.ArraySpacing
 - PSR2R.WhiteSpace.DocBlockAlignment
 - PSR2R.WhiteSpace.EmptyEnclosingLine

tests/PSR2R/Sniffs/WhiteSpace/ArrayDeclarationSpacingSniffTest.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PSR2R\Test\PSR2R\Sniffs\WhiteSpace;
+
+use PSR2R\Sniffs\WhiteSpace\ArrayDeclarationSpacingSniff;
+use PSR2R\Test\TestCase;
+
+class ArrayDeclarationSpacingSniffTest extends TestCase {
+
+	/**
+	 * @return void
+	 */
+	public function testArrayDeclarationSpacingSniffer(): void {
+		$this->assertSnifferFindsErrors(new ArrayDeclarationSpacingSniff(), 4);
+	}
+
+	/**
+	 * @return void
+	 */
+	public function testArrayDeclarationSpacingFixer(): void {
+		$this->assertSnifferCanFixErrors(new ArrayDeclarationSpacingSniff());
+	}
+
+}

tests/_data/ArrayDeclarationSpacing/after.php

@@ -0,0 +1,57 @@
+<?php declare(strict_types = 1);
+
+namespace PSR2R;
+
+class ArrayDeclarationSpacingExample {
+
+	/**
+	 * Test case: class property array with opening bracket on new line
+	 *
+	 * @var array
+	 */
+	public $components = [
+		'RequestHandler',
+		'Flash',
+		'Auth',
+	];
+
+	/**
+	 * @var array
+	 */
+	protected array $helpers = [
+		'Html',
+		'Form',
+	];
+
+	/**
+	 * Test case: variable assignment with array on new line
+	 *
+	 * @return void
+	 */
+	public function testVariableAssignment(): void {
+		$config = [
+			'debug' => true,
+			'cache' => false,
+		];
+
+		$options = [
+			'verbose' => true,
+			'timeout' => 30,
+		];
+	}
+
+	/**
+	 * Test case: Correct formatting (should not be flagged)
+	 *
+	 * @return void
+	 */
+	public function testCorrectFormatting(): void {
+		$correct = [
+			'a' => 'b',
+			'c' => 'd',
+		];
+
+		$alsoCorrect = ['x', 'y', 'z'];
+	}
+
+}

tests/_data/ArrayDeclarationSpacing/before.php

@@ -0,0 +1,61 @@
+<?php declare(strict_types = 1);
+
+namespace PSR2R;
+
+class ArrayDeclarationSpacingExample {
+
+	/**
+	 * Test case: class property array with opening bracket on new line
+	 *
+	 * @var array
+	 */
+	public $components =
+	[
+		'RequestHandler',
+		'Flash',
+		'Auth',
+	];
+
+	/**
+	 * @var array
+	 */
+	protected array $helpers =
+	[
+		'Html',
+		'Form',
+	];
+
+	/**
+	 * Test case: variable assignment with array on new line
+	 *
+	 * @return void
+	 */
+	public function testVariableAssignment(): void {
+		$config =
+		[
+			'debug' => true,
+			'cache' => false,
+		];
+
+		$options =
+		[
+			'verbose' => true,
+			'timeout' => 30,
+		];
+	}
+
+	/**
+	 * Test case: Correct formatting (should not be flagged)
+	 *
+	 * @return void
+	 */
+	public function testCorrectFormatting(): void {
+		$correct = [
+			'a' => 'b',
+			'c' => 'd',
+		];
+
+		$alsoCorrect = ['x', 'y', 'z'];
+	}
+
+}