Squiz/FunctionComment: bug fix - classnames with underscores truncate the return type

If a return type included a class name containing an underscore, the type would be truncated at the underscore and would not take anything after it into account.

Bug introduced in PHPCS 2.8.1 via PR squizlabs/PHP_CodeSniffer 1310 and for some reason never reported... 😳

Fixed now.

Includes tests.

Fixes 1197

Author: jrfnl

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

@@ -76,7 +76,7 @@ protected function processReturn(File $phpcsFile, $stackPtr, $commentStart)
                 $phpcsFile->addError($error, $return, 'MissingReturnType');
             } else {
                 // Support both a return type and a description.
-                preg_match('`^((?:\|?(?:array\([^\)]*\)|[\\\\a-z0-9\[\]]+))*)( .*)?`i', $content, $returnParts);
+                preg_match('`^((?:\|?(?:array\([^\)]*\)|[\\\\a-z0-9_\[\]]+))*)( .*)?`i', $content, $returnParts);
                 if (isset($returnParts[1]) === false) {
                     return;
                 }

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc

@@ -1167,3 +1167,30 @@ public function setTranslator($a): void
 {
     $this->translator = $translator;
 }
+
+/**
+ * Issue PHPCSStandards/PHP_CodeSniffer#1197.
+ *
+ * @return int|WP_Error
+ */
+function doNotTruncateClassNamesContainingUnderscoresAtEndOfType() {
+    return 0;
+}
+
+/**
+ * Issue PHPCSStandards/PHP_CodeSniffer#1197.
+ *
+ * @return WP_Error|int
+ */
+function doNotTruncateClassNamesContainingUnderscoresAtStartOfType() {
+    return 0;
+}
+
+/**
+ * Issue PHPCSStandards/PHP_CodeSniffer#1197.
+ *
+ * @return int|WP_Error|false
+ */
+function doNotTruncateClassNamesContainingUnderscoresInTheMiddelOfType() {
+    return 0;
+}

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed

@@ -1167,3 +1167,30 @@ public function setTranslator($a): void
 {
     $this->translator = $translator;
 }
+
+/**
+ * Issue PHPCSStandards/PHP_CodeSniffer#1197.
+ *
+ * @return integer|WP_Error
+ */
+function doNotTruncateClassNamesContainingUnderscoresAtEndOfType() {
+    return 0;
+}
+
+/**
+ * Issue PHPCSStandards/PHP_CodeSniffer#1197.
+ *
+ * @return WP_Error|integer
+ */
+function doNotTruncateClassNamesContainingUnderscoresAtStartOfType() {
+    return 0;
+}
+
+/**
+ * Issue PHPCSStandards/PHP_CodeSniffer#1197.
+ *
+ * @return integer|WP_Error|false
+ */
+function doNotTruncateClassNamesContainingUnderscoresInTheMiddelOfType() {
+    return 0;
+}

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.php

@@ -141,6 +141,9 @@ public function getErrorList()
             1144 => 1,
             1145 => 1,
             1151 => 1,
+            1174 => 1,
+            1183 => 1,
+            1192 => 1,
         ];
 
         // Scalar type hints only work from PHP 7 onwards.