Various sniffs: fix grammar for various error messages

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

For these sniffs, the changes are already covered by pre-existing tests.

Port squizlabs/PHP_CodeSniffer 3881 to this repo

Author: DannyvdSluijs

src/Standards/Generic/Sniffs/Formatting/SpaceAfterCastSniff.php

@@ -54,8 +54,12 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $tokens        = $phpcsFile->getTokens();
-        $this->spacing = (int) $this->spacing;
+        $tokens         = $phpcsFile->getTokens();
+        $this->spacing  = (int) $this->spacing;
+        $pluralizeSpace = 's';
+        if ($this->spacing === 1) {
+            $pluralizeSpace = '';
+        }
 
         if ($tokens[$stackPtr]['code'] === T_BINARY_CAST
             && $tokens[$stackPtr]['content'] === 'b'
@@ -83,8 +87,11 @@ public function process(File $phpcsFile, $stackPtr)
 
         $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
         if ($nextNonEmpty !== $nextNonWhitespace) {
-            $error = 'Expected %s space(s) after cast statement; comment found';
-            $data  = [$this->spacing];
+            $error = 'Expected %s space%s after cast statement; comment found';
+            $data  = [
+                $this->spacing,
+                $pluralizeSpace,
+            ];
             $phpcsFile->addError($error, $stackPtr, 'CommentFound', $data);
 
             if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) {
@@ -109,9 +116,10 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        $error = 'Expected %s space(s) after cast statement; %s found';
+        $error = 'Expected %s space%s after cast statement; %s found';
         $data  = [
             $this->spacing,
+            $pluralizeSpace,
             $found,
         ];
 

src/Standards/Generic/Sniffs/Formatting/SpaceAfterNotSniff.php

@@ -64,8 +64,12 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $tokens        = $phpcsFile->getTokens();
-        $this->spacing = (int) $this->spacing;
+        $tokens         = $phpcsFile->getTokens();
+        $this->spacing  = (int) $this->spacing;
+        $pluralizeSpace = 's';
+        if ($this->spacing === 1) {
+            $pluralizeSpace = '';
+        }
 
         $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
         if ($nextNonEmpty === false) {
@@ -84,8 +88,11 @@ public function process(File $phpcsFile, $stackPtr)
 
         $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
         if ($nextNonEmpty !== $nextNonWhitespace) {
-            $error = 'Expected %s space(s) after NOT operator; comment found';
-            $data  = [$this->spacing];
+            $error = 'Expected %s space%s after NOT operator; comment found';
+            $data  = [
+                $this->spacing,
+                $pluralizeSpace,
+            ];
             $phpcsFile->addError($error, $stackPtr, 'CommentFound', $data);
             return;
         }
@@ -101,9 +108,10 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        $error = 'Expected %s space(s) after NOT operator; %s found';
+        $error = 'Expected %s space%s after NOT operator; %s found';
         $data  = [
             $this->spacing,
+            $pluralizeSpace,
             $found,
         ];
 

src/Standards/Squiz/Sniffs/Commenting/DocCommentAlignmentSniff.php

@@ -112,9 +112,15 @@ public function process(File $phpcsFile, $stackPtr)
             }
 
             if ($tokens[$i]['column'] !== $requiredColumn) {
-                $error = 'Expected %s space(s) before asterisk; %s found';
+                $pluralizeSpace = 's';
+                if (($requiredColumn - 1) === 1) {
+                    $pluralizeSpace = '';
+                }
+
+                $error = 'Expected %s space%s before asterisk; %s found';
                 $data  = [
                     ($requiredColumn - 1),
+                    $pluralizeSpace,
                     ($tokens[$i]['column'] - 1),
                 ];
                 $fix   = $phpcsFile->addFixableError($error, $i, 'SpaceBeforeStar', $data);
@@ -126,7 +132,7 @@ public function process(File $phpcsFile, $stackPtr)
                         $phpcsFile->fixer->replaceToken(($i - 1), $padding);
                     }
                 }
-            }
+            }//end if
 
             if ($tokens[$i]['code'] !== T_DOC_COMMENT_STAR) {
                 continue;