Fixed parsing really strange WordPress documentation

Author: kukulich

SlevomatCodingStandard/Helpers/AnnotationHelper.php

@@ -36,9 +36,9 @@
 use function get_class;
 use function in_array;
 use function preg_match;
+use function preg_match_all;
 use function preg_replace;
 use function sprintf;
-use function substr_count;
 use function trim;
 use const T_DOC_COMMENT_CLOSE_TAG;
 use const T_DOC_COMMENT_STAR;
@@ -238,7 +238,7 @@ public static function getAnnotations(File $phpcsFile, int $pointer): array
 				$annotationEndPointer = $i;
 
 				// Fix for wrong PHPCS parsing
-				$parenthesesLevel = substr_count($tokens[$i]['content'], '(') - substr_count($tokens[$i]['content'], ')');
+				$parenthesesLevel = (int) preg_match_all('~[({]~', $tokens[$i]['content']) - (int) preg_match_all('~[)}]~', $tokens[$i]['content']);
 				$annotationCode = $tokens[$i]['content'];
 
 				for ($j = $i + 1; $j <= $tokens[$docCommentOpenToken]['comment_closer']; $j++) {
@@ -267,7 +267,7 @@ public static function getAnnotations(File $phpcsFile, int $pointer): array
 						}
 					}
 
-					$parenthesesLevel += substr_count($tokens[$j]['content'], '(') - substr_count($tokens[$j]['content'], ')');
+					$parenthesesLevel += (int) preg_match_all('~[({]~', $tokens[$j]['content']) - (int) preg_match_all('~[)}]~', $tokens[$j]['content']);
 					$annotationCode .= $tokens[$j]['content'];
 				}
 

tests/Helpers/AnnotationHelperTest.php

@@ -3,6 +3,7 @@
 namespace SlevomatCodingStandard\Helpers;
 
 use PHP_CodeSniffer\Files\File;
+use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use SlevomatCodingStandard\Helpers\Annotation\GenericAnnotation;
 use SlevomatCodingStandard\Helpers\Annotation\ParameterAnnotation;
 use SlevomatCodingStandard\Helpers\Annotation\PropertyAnnotation;
@@ -167,6 +168,21 @@ public function testInlineDocCommentWithParametrizedAnnotation(): void
 		self::assertNull($annotations[0]->getContent());
 	}
 
+	public function testWordPressAnnotations(): void
+	{
+		$annotations = AnnotationHelper::getAnnotations($this->getTestedCodeSnifferFile(), $this->findFunctionPointerByName($this->getTestedCodeSnifferFile(), 'wordPress'));
+
+		self::assertCount(1, $annotations);
+		self::assertCount(1, $annotations['@param']);
+
+		$annotation = $annotations['@param'][0];
+
+		self::assertInstanceOf(ParameterAnnotation::class, $annotation);
+		self::assertInstanceOf(IdentifierTypeNode::class, $annotation->getType());
+		self::assertSame('$parameters', $annotation->getParameterName());
+		self::assertSame('{ Optional. Parameters for filtering the list of user assignments. Default empty array. @type bool $is_active                Pass `true` to only return active user assignments and `false` to return  inactive user assignments. @type DateTime|string $updated_since Only return user assignments that have been updated since the given date and time. }', $annotation->getDescription());
+	}
+
 	public function testFunctionWithoutAnnotation(): void
 	{
 		self::assertCount(0, AnnotationHelper::getAnnotationsByName($this->getTestedCodeSnifferFile(), $this->findFunctionPointerByName($this->getTestedCodeSnifferFile(), 'withoutAnnotation'), '@param'));

tests/Helpers/data/annotation.php

@@ -85,4 +85,18 @@ public function withReturnAnnotation()
 
 	}
 
+	/**
+	 * @param array $parameters {
+	 *     Optional. Parameters for filtering the list of user assignments. Default empty array.
+	 *
+	 *     @type bool $is_active                Pass `true` to only return active user assignments and `false` to
+	 *                                          return  inactive user assignments.
+	 *     @type DateTime|string $updated_since Only return user assignments that have been updated since the given
+	 *                                          date and time.
+	 * }
+	 */
+	public function wordPress(array $parameters = [])
+	{
+	}
+
 }