Improved annotations parsing

kukulich · kukulich · commit ca7b670ce928 · 2018-02-15T18:13:26.000+01:00
diff --git a/SlevomatCodingStandard/Helpers/AnnotationHelper.php b/SlevomatCodingStandard/Helpers/AnnotationHelper.php
@@ -37,16 +37,27 @@ public static function getAnnotations(\PHP_CodeSniffer\Files\File $codeSnifferFi
 		}
 
 		$tokens = $codeSnifferFile->getTokens();
-		for ($i = $docCommentOpenToken + 1; $i < $tokens[$docCommentOpenToken]['comment_closer']; $i++) {
+		$i = $docCommentOpenToken + 1;
+		while ($i < $tokens[$docCommentOpenToken]['comment_closer']) {
+			$annotationPointer = $i;
+
 			if ($tokens[$i]['code'] !== T_DOC_COMMENT_TAG) {
+				$i++;
 				continue;
 			}
 
 			// Fix for wrong PHPCS parsing
+			$parenthesesLevel = substr_count($tokens[$i]['content'], '(') - substr_count($tokens[$i]['content'], ')');
 			$annotationCode = $tokens[$i]['content'];
 
-			for ($j = $i + 1; $j < $tokens[$docCommentOpenToken]['comment_closer']; $j++) {
-				if (!in_array($tokens[$j]['code'], [T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_STRING, T_DOC_COMMENT_STAR], true)) {
+			for ($j = $i + 1; $j <= $tokens[$docCommentOpenToken]['comment_closer']; $j++) {
+				if ($tokens[$j]['code'] === T_DOC_COMMENT_CLOSE_TAG) {
+					$i = $j;
+					break;
+				}
+
+				if ($tokens[$j]['code'] === T_DOC_COMMENT_TAG && $parenthesesLevel === 0) {
+					$i = $j;
 					break;
 				}
 
@@ -63,13 +74,14 @@ public static function getAnnotations(\PHP_CodeSniffer\Files\File $codeSnifferFi
 					}
 				}
 
+				$parenthesesLevel += substr_count($tokens[$j]['content'], '(') - substr_count($tokens[$j]['content'], ')');
 				$annotationCode .= $tokens[$j]['content'];
 			}
 
-			$annotationName = $tokens[$i]['content'];
+			$annotationName = $tokens[$annotationPointer]['content'];
 			$annotationParameters = null;
 			$annotationContent = null;
-			if (preg_match('~^(@[a-zA-Z\\\\]+)(?:\((.*?)\))?(?:\\s+(.+))?($)~s', trim($annotationCode), $matches)) {
+			if (preg_match('~^(@[a-zA-Z\\\\]+)(?:\((.*)\))?(?:\\s+(.+))?($)~s', trim($annotationCode), $matches)) {
 				$annotationName = $matches[1];
 				$annotationParameters = trim($matches[2]);
 				if ($annotationParameters === '') {
@@ -81,7 +93,7 @@ public static function getAnnotations(\PHP_CodeSniffer\Files\File $codeSnifferFi
 				}
 			}
 
-			$annotations[$annotationName][] = new Annotation($annotationName, $i, $annotationParameters, $annotationContent);
+			$annotations[$annotationName][] = new Annotation($annotationName, $annotationPointer, $annotationParameters, $annotationContent);
 		}
 
 		return $annotations;
diff --git a/tests/Helpers/AnnotationHelperTest.php b/tests/Helpers/AnnotationHelperTest.php
@@ -107,6 +107,20 @@ public function testFunctionWithoutAnnotation(): void
 		self::assertCount(0, AnnotationHelper::getAnnotationsByName($this->getTestedCodeSnifferFile(), $this->findFunctionPointerByName($this->getTestedCodeSnifferFile(), 'withoutAnnotation'), '@param'));
 	}
 
+	public function testMultilineIndentedAnnotation(): void
+	{
+		$annotations = AnnotationHelper::getAnnotations($this->getTestedCodeSnifferFile(), $this->findPropertyPointerByName($this->getTestedCodeSnifferFile(), 'multilineIndentedAnnotation'));
+
+		self::assertCount(1, $annotations);
+		self::assertArrayHasKey('@X', $annotations);
+
+		$xAnnotations = $annotations['@X'];
+
+		self::assertCount(1, $xAnnotations);
+		self::assertSame('@X', $xAnnotations[0]->getName());
+		self::assertSame('Content', $xAnnotations[0]->getContent());
+	}
+
 	private function getTestedCodeSnifferFile(): \PHP_CodeSniffer\Files\File
 	{
 		if ($this->testedCodeSnifferFile === null) {
diff --git a/tests/Helpers/data/annotation.php b/tests/Helpers/data/annotation.php
@@ -60,4 +60,16 @@ abstract public function withMultilineParametrizedAnnotation();
 	/** @ORM\OneToMany(targetEntity=Bar::class, mappedBy="boo") */
 	private $inlineDocComment;
 
+	/**
+	 * @X(
+	 *     a=Y::SOME,
+	 *     b={
+	 *         @Z(
+	 *             code=123
+	 *         )
+	 *     }
+	 * ) Content
+	 */
+	private $multilineIndentedAnnotation;
+
 }

Original file line number	Diff line number	Diff line change
`@@ -37,16 +37,27 @@ public static function getAnnotations(\PHP_CodeSniffer\Files\File $codeSnifferFi`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`$tokens = $codeSnifferFile->getTokens();`
`40`		`- for ($i = $docCommentOpenToken + 1; $i < $tokens[$docCommentOpenToken]['comment_closer']; $i++) {`
	`40`	`+ $i = $docCommentOpenToken + 1;`
	`41`	`+ while ($i < $tokens[$docCommentOpenToken]['comment_closer']) {`
	`42`	`+ $annotationPointer = $i;`
	`43`	`+`
`41`	`44`	`if ($tokens[$i]['code'] !== T_DOC_COMMENT_TAG) {`
	`45`	`+ $i++;`
`42`	`46`	`continue;`
`43`	`47`	`}`
`44`	`48`
`45`	`49`	`// Fix for wrong PHPCS parsing`
	`50`	`+ $parenthesesLevel = substr_count($tokens[$i]['content'], '(') - substr_count($tokens[$i]['content'], ')');`
`46`	`51`	`$annotationCode = $tokens[$i]['content'];`
`47`	`52`
`48`		`- for ($j = $i + 1; $j < $tokens[$docCommentOpenToken]['comment_closer']; $j++) {`
`49`		`- if (!in_array($tokens[$j]['code'], [T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_STRING, T_DOC_COMMENT_STAR], true)) {`
	`53`	`+ for ($j = $i + 1; $j <= $tokens[$docCommentOpenToken]['comment_closer']; $j++) {`
	`54`	`+ if ($tokens[$j]['code'] === T_DOC_COMMENT_CLOSE_TAG) {`
	`55`	`+ $i = $j;`
	`56`	`+ break;`
	`57`	`+ }`
	`58`	`+`
	`59`	`+ if ($tokens[$j]['code'] === T_DOC_COMMENT_TAG && $parenthesesLevel === 0) {`
	`60`	`+ $i = $j;`
`50`	`61`	`break;`
`51`	`62`	`}`
`52`	`63`
`@@ -63,13 +74,14 @@ public static function getAnnotations(\PHP_CodeSniffer\Files\File $codeSnifferFi`
`63`	`74`	`}`
`64`	`75`	`}`
`65`	`76`
	`77`	`+ $parenthesesLevel += substr_count($tokens[$j]['content'], '(') - substr_count($tokens[$j]['content'], ')');`
`66`	`78`	`$annotationCode .= $tokens[$j]['content'];`
`67`	`79`	`}`
`68`	`80`
`69`		`- $annotationName = $tokens[$i]['content'];`
	`81`	`+ $annotationName = $tokens[$annotationPointer]['content'];`
`70`	`82`	`$annotationParameters = null;`
`71`	`83`	`$annotationContent = null;`
`72`		`- if (preg_match('~^(@[a-zA-Z\\\\]+)(?:\((.*?)\))?(?:\\s+(.+))?($)~s', trim($annotationCode), $matches)) {`
	`84`	`+ if (preg_match('~^(@[a-zA-Z\\\\]+)(?:\((.*)\))?(?:\\s+(.+))?($)~s', trim($annotationCode), $matches)) {`
`73`	`85`	`$annotationName = $matches[1];`
`74`	`86`	`$annotationParameters = trim($matches[2]);`
`75`	`87`	`if ($annotationParameters === '') {`
`@@ -81,7 +93,7 @@ public static function getAnnotations(\PHP_CodeSniffer\Files\File $codeSnifferFi`
`81`	`93`	`}`
`82`	`94`	`}`
`83`	`95`
`84`		`- $annotations[$annotationName][] = new Annotation($annotationName, $i, $annotationParameters, $annotationContent);`
	`96`	`+ $annotations[$annotationName][] = new Annotation($annotationName, $annotationPointer, $annotationParameters, $annotationContent);`
`85`	`97`	`}`
`86`	`98`
`87`	`99`	`return $annotations;`