Caught more array declarations

Author: louisl

CodeIgniter4/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -85,6 +85,30 @@ public function process(File $phpcsFile, $stackPtr)
 
         $tokens = $phpcsFile->getTokens();
 
+        // First make sure all arrays use short array syntax, this makes fixing much easier.
+        if ($tokens[$stackPtr]['code'] === T_ARRAY) {
+            $error = 'Short array syntax must be used to define arrays';
+            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'FoundLongArray');
+
+            if ($fix === true) {
+                $tokens = $phpcsFile->getTokens();
+                $opener = $tokens[$stackPtr]['parenthesis_opener'];
+                $closer = $tokens[$stackPtr]['parenthesis_closer'];
+
+                $phpcsFile->fixer->beginChangeset();
+
+                if ($opener === null) {
+                    $phpcsFile->fixer->replaceToken($stackPtr, '[]');
+                } else {
+                    $phpcsFile->fixer->replaceToken($stackPtr, '');
+                    $phpcsFile->fixer->replaceToken($opener, '[');
+                    $phpcsFile->fixer->replaceToken($closer, ']');
+                }
+
+                $phpcsFile->fixer->endChangeset();
+            }
+        }//end if
+
         if ($tokens[$stackPtr]['code'] === T_ARRAY) {
             $arrayStart = $tokens[$stackPtr]['parenthesis_opener'];
             if (isset($tokens[$arrayStart]['parenthesis_closer']) === false) {
@@ -328,6 +352,8 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
                        T_OBJECT_CAST,
                        T_STATIC,
                        T_CONST,
+                       T_RETURN,
+                       T_OBJECT_OPERATOR,
                       );
 
             $firstOnLine = $phpcsFile->findFirstOnLine($starts, $prevNonWhitespaceToken);
@@ -357,6 +383,23 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
             $indentStart = $stackPtr;
         }//end switch
 
+        // If this is the first argument in a function ensure the bracket to be right after the parenthesis. eg "array_combine([".
+        if ($tokens[$prevNonWhitespaceToken]['code'] === T_OPEN_PARENTHESIS && $tokens[$stackPtr]['code'] === T_OPEN_SHORT_ARRAY) {
+            if ($tokens[$stackPtr]['line'] > $tokens[$prevNonWhitespaceToken]['line']) {
+                $error = 'Array open bracket should be after function open parenthesis "(["';
+                $data  = array();
+                $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'ShortArrayOpenWrongLine', $data);
+                if ($fix === true) {
+                    $phpcsFile->fixer->beginChangeset();
+                    for ($i = ($prevNonWhitespaceToken + 1); $i < $stackPtr; $i++) {
+                        $phpcsFile->fixer->replaceToken($i, '');
+                    }
+
+                    $phpcsFile->fixer->endChangeset();
+                }
+            }
+        }
+
         // Check the closing bracket is on a new line.
         $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($arrayEnd - 1), $arrayStart, true);
         if ($tokens[$lastContent]['line'] === $tokens[$arrayEnd]['line']) {

CodeIgniter4/Tests/Arrays/ArrayDeclarationUnitTest.inc

@@ -99,4 +99,17 @@ class MyClass {
 			'perPage' => $this->pager->getPerPage(),
 						 'total'   => $this->pager->getPerPage() * $this->pager->getPageCount(),
 								  ] , 15);
+
+	return preg_replace(
+				array(
+			'#<img[\s/]+.*?src\s*=\s*(["\'])([^\\1]+?)\\1.*?\>#i',
+			'#<img[\s/]+.*?src\s*=\s*?(([^\s"\'=<>`]+)).*?\>#i'
+				), '\\2', $str
+		);
+
+		$this->db->table($this->table)
+			->insert([
+'version'   => $version,
+'name'      => $this->name,
+			]);
 }

CodeIgniter4/Tests/Arrays/ArrayDeclarationUnitTest.inc.fixed

@@ -107,17 +107,17 @@ class MyClass {
         ],
 	];
 
-	$a = array
+	$a = 
 	// comment
-	(
+	[
         'a',
         'b', 
-    );
+    ];
 
-	$a = array /* comment */ (
-        'a',
-        'b', 
-    );
+	$a =  /* comment */ [
+                            'a',
+                            'b', 
+                        ];
 
 	protected static $statusCodes = [
 		// 1xx: Informational
@@ -149,7 +149,7 @@ class MyClass {
         ];
 	}
 
-	public $arr = array();
+	public $arr = [];
 
 	public $arr = [];
 
@@ -166,4 +166,16 @@ class MyClass {
         'perPage' => $this->pager->getPerPage(),
         'total'   => $this->pager->getPerPage() * $this->pager->getPageCount(),
     ] , 15);
+
+	return preg_replace([
+        '#<img[\s/]+.*?src\s*=\s*(["\'])([^\\1]+?)\\1.*?\>#i',
+        '#<img[\s/]+.*?src\s*=\s*?(([^\s"\'=<>`]+)).*?\>#i',
+    ], '\\2', $str
+		);
+
+		$this->db->table($this->table)
+			->insert([
+                'version' => $version,
+                'name'    => $this->name,
+			]);
 }

CodeIgniter4/Tests/Arrays/ArrayDeclarationUnitTest.php

@@ -65,8 +65,8 @@ public function getErrorList()
                 47  => 2,
                 48  => 2,
                 49  => 2,
-                52  => 1,
-                56  => 1,
+                52  => 2,
+                56  => 2,
                 60  => 1,
                 61  => 1,
                 62  => 1,
@@ -77,7 +77,7 @@ public function getErrorList()
                 80  => 1,
                 81  => 1,
                 82  => 1,
-                85  => 1,
+                85  => 2,
                 87  => 1,
                 89  => 1,
                 92  => 1,
@@ -86,6 +86,12 @@ public function getErrorList()
                 99  => 1,
                 100 => 1,
                 101 => 1,
+                104 => 1,
+                105 => 1,
+                106 => 1,
+                107 => 1,
+                112 => 1,
+                113 => 1,
                );
 
     }//end getErrorList()

CodeIgniter4/ruleset.xml

@@ -310,16 +310,13 @@
     -->
     <rule ref="CodeIgniter4.NamingConventions.ValidFunctionName"/>
     <!--
-    Checks arrays are declared as "[]" not "array()".
-    -->
-    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
-    <!--
     Checks array bracket spaces.
     -->
     <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
     <!--
     Check array declaration, indentation, alignment and that the last item
     has a trailing comma.
+    Checks arrays are declared as "[]" not "array()".
     -->
     <rule ref="CodeIgniter4.Arrays.ArrayDeclaration"/>
     <!--