Squiz/ArrayDeclaration: fix grammar for various error messages

Correct pluralization of the word space/spaces depending on the spacing value.

Includes adding tests for the `CloseBraceNotAligned` error code which would use the "1 space" phrasing.

Co-authored-by: Danny van der Sluijs <danny.van.der.sluijs@infi.nl>

Author: jrfnl

src/Standards/Squiz/Sniffs/Arrays/ArrayDeclarationSniff.php

@@ -330,11 +330,17 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
             }
         } else if ($tokens[$arrayEnd]['column'] !== $keywordStart) {
             // Check the closing bracket is lined up under the "a" in array.
-            $expected = ($keywordStart - 1);
-            $found    = ($tokens[$arrayEnd]['column'] - 1);
-            $error    = 'Closing parenthesis not aligned correctly; expected %s space(s) but found %s';
-            $data     = [
+            $expected       = ($keywordStart - 1);
+            $found          = ($tokens[$arrayEnd]['column'] - 1);
+            $pluralizeSpace = 's';
+            if ($expected === 1) {
+                $pluralizeSpace = '';
+            }
+
+            $error = 'Closing parenthesis not aligned correctly; expected %s space%s but found %s';
+            $data  = [
                 $expected,
+                $pluralizeSpace,
                 $found,
             ];
 
@@ -674,12 +680,18 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
                 } else if ($previousIsWhitespace === true) {
                     $expected = $keywordStart;
 
-                    $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $valuePointer, true);
-                    $found = ($tokens[$first]['column'] - 1);
+                    $first          = $phpcsFile->findFirstOnLine(T_WHITESPACE, $valuePointer, true);
+                    $found          = ($tokens[$first]['column'] - 1);
+                    $pluralizeSpace = 's';
+                    if ($expected === 1) {
+                        $pluralizeSpace = '';
+                    }
+
                     if ($found !== $expected) {
-                        $error = 'Array value not aligned correctly; expected %s spaces but found %s';
+                        $error = 'Array value not aligned correctly; expected %s space%s but found %s';
                         $data  = [
                             $expected,
+                            $pluralizeSpace,
                             $found,
                         ];
 
@@ -763,11 +775,17 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
             }
 
             if ($tokens[$indexPointer]['column'] !== $indicesStart && ($indexPointer - 1) !== $arrayStart) {
-                $expected = ($indicesStart - 1);
-                $found    = ($tokens[$indexPointer]['column'] - 1);
-                $error    = 'Array key not aligned correctly; expected %s spaces but found %s';
-                $data     = [
+                $expected       = ($indicesStart - 1);
+                $found          = ($tokens[$indexPointer]['column'] - 1);
+                $pluralizeSpace = 's';
+                if ($expected === 1) {
+                    $pluralizeSpace = '';
+                }
+
+                $error = 'Array key not aligned correctly; expected %s space%s but found %s';
+                $data  = [
                     $expected,
+                    $pluralizeSpace,
                     $found,
                 ];
 
@@ -779,15 +797,21 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
                         $phpcsFile->fixer->replaceToken(($indexPointer - 1), str_repeat(' ', $expected));
                     }
                 }
-            }
+            }//end if
 
             $arrowStart = ($tokens[$indexPointer]['column'] + $maxLength + 1);
             if ($tokens[$index['arrow']]['column'] !== $arrowStart) {
-                $expected = ($arrowStart - ($index['index_length'] + $tokens[$indexPointer]['column']));
-                $found    = ($tokens[$index['arrow']]['column'] - ($index['index_length'] + $tokens[$indexPointer]['column']));
-                $error    = 'Array double arrow not aligned correctly; expected %s space(s) but found %s';
-                $data     = [
+                $expected       = ($arrowStart - ($index['index_length'] + $tokens[$indexPointer]['column']));
+                $found          = ($tokens[$index['arrow']]['column'] - ($index['index_length'] + $tokens[$indexPointer]['column']));
+                $pluralizeSpace = 's';
+                if ($expected === 1) {
+                    $pluralizeSpace = '';
+                }
+
+                $error = 'Array double arrow not aligned correctly; expected %s space%s but found %s';
+                $data  = [
                     $expected,
+                    $pluralizeSpace,
                     $found,
                 ];
 
@@ -801,7 +825,7 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
                 }
 
                 continue;
-            }
+            }//end if
 
             $valueStart = ($arrowStart + 3);
             if ($tokens[$valuePointer]['column'] !== $valueStart) {
@@ -811,9 +835,15 @@ public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $array
                     $found = 'newline';
                 }
 
-                $error = 'Array value not aligned correctly; expected %s space(s) but found %s';
+                $pluralizeSpace = 's';
+                if ($expected === 1) {
+                    $pluralizeSpace = '';
+                }
+
+                $error = 'Array value not aligned correctly; expected %s space%s but found %s';
                 $data  = [
                     $expected,
+                    $pluralizeSpace,
                     $found,
                 ];
 

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc

@@ -529,3 +529,9 @@ $x = array(
     'bar',
     'baz' => 'bar', // KeySpecified (based on first entry).
      );
+
+ $x =
+ array(
+  'a',
+  'b',
+   );

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc.fixed

@@ -565,3 +565,9 @@ $x = array(
     'bar',
     'baz' => 'bar', // KeySpecified (based on first entry).
      );
+
+ $x =
+ array(
+  'a',
+  'b',
+ );

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc

@@ -518,3 +518,9 @@ $x = [
     'bar',
     'baz' => 'bar', // KeySpecified (based on first entry).
      ];
+
+ $x =
+ [
+  'a',
+  'b',
+   ];

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc.fixed

@@ -552,3 +552,9 @@ $x = [
     'bar',
     'baz' => 'bar', // KeySpecified (based on first entry).
      ];
+
+ $x =
+ [
+  'a',
+  'b',
+ ];

src/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.php

@@ -128,6 +128,7 @@ public function getErrorList($testFile='')
                 516 => 1,
                 523 => 1,
                 530 => 1,
+                537 => 1,
             ];
         case 'ArrayDeclarationUnitTest.2.inc':
             return [
@@ -218,6 +219,7 @@ public function getErrorList($testFile='')
                 505 => 1,
                 512 => 1,
                 519 => 1,
+                526 => 1,
             ];
         default:
             return [];