add nowdoc

Author: shmax

src/Parser/TypeParser.php

@@ -944,12 +944,31 @@ private function parseObjectShapeItem(TokenIterator $tokens): Ast\Type\ObjectSha
 		$startLine = $tokens->currentTokenLine();
 		$startIndex = $tokens->currentTokenIndex();
 
+		// parse any comments above the item
+		$comments = [];
+		while (1) {
+			if ($tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL)) {
+				continue;
+			} elseif ($tokens->currentTokenType() === Lexer::TOKEN_COMMENT) {
+				$comments[] = new Ast\Comment($tokens->currentTokenValue(), $tokens->currentTokenLine(), $tokens->currentTokenIndex());
+				$tokens->next();
+			} else {
+				break;
+			}
+		}
+
 		$key = $this->parseObjectShapeKey($tokens);
 		$optional = $tokens->tryConsumeTokenType(Lexer::TOKEN_NULLABLE);
 		$tokens->consumeTokenType(Lexer::TOKEN_COLON);
 		$value = $this->parse($tokens);
 
-		return $this->enrichWithAttributes($tokens, new Ast\Type\ObjectShapeItemNode($key, $optional, $value), $startLine, $startIndex);
+		return $this->enrichWithAttributes(
+			$tokens,
+			new Ast\Type\ObjectShapeItemNode($key, $optional, $value),
+			$startLine,
+			$startIndex,
+			$comments
+		);
 	}
 
 	/**

tests/PHPStan/Parser/TypeParserTest.php

@@ -1966,6 +1966,7 @@ public function provideParseData(): array
 			],
 			[
 				'object{
+					// a is for apple
 				 	a: int,
 				 }',
 				new ObjectShapeNode([
@@ -1979,6 +1980,9 @@ public function provideParseData(): array
 			[
 				'object{
 				 	a: int,
+				 	/*
+				 	 * b is for banana
+				 	 */
 				 	b: string,
 				 }',
 				new ObjectShapeNode([

tests/PHPStan/Printer/PrinterTest.php

@@ -52,6 +52,41 @@
 use function count;
 use const PHP_EOL;
 
+function nowdoc(string $str): string
+{
+	$lines = \preg_split('/\\n/', $str);
+
+	if ($lines === false) {
+		return '';
+	}
+
+	if (\count($lines) <= 2) {
+		return '';
+	}
+
+	// Toss out the first line
+	$lines = \array_slice($lines, 1, \count($lines) - 1);
+
+	// normalize any tabs to spaces
+	$lines = array_map(static function($line) {
+		return preg_replace_callback('/(\t+)/m', function ($matches) {
+			$fixed = str_repeat('  ', strlen($matches[1]));
+			return $fixed;
+		}, $line);
+		}, $lines);
+
+	// take the ws from the first line and subtract them from all lines
+	$matches = [];
+	\preg_match('/(^[ \t]+)/', $lines[0], $matches);
+
+	$numLines = \count($lines);
+	for ($i = 0; $i < $numLines; ++$i) {
+		$lines[$i] = \str_replace($matches[0], '', $lines[$i]);
+	}
+
+	return \implode("\n", $lines);
+}
+
 class PrinterTest extends TestCase
 {
 
@@ -648,7 +683,7 @@ public function enterNode(Node $node)
 			$changeCallableTypeIdentifier,
 		];
 
-		$addItemsToArrayShape = new class extends AbstractNodeVisitor {
+		$addKeylessItemsToArrayShape = new class extends AbstractNodeVisitor {
 
 			public function enterNode(Node $node)
 			{
@@ -806,7 +841,7 @@ public function enterNode(Node $node)
 			'/**
  * @return array{float, int, string}
  */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		yield [
@@ -816,7 +851,7 @@ public function enterNode(Node $node)
 			'/**
  * @return array{float, int, Foo, string}
  */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		yield [
@@ -834,7 +869,7 @@ public function enterNode(Node $node)
  *   string,
  * }
  */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		yield [
@@ -852,7 +887,7 @@ public function enterNode(Node $node)
  *   string
  * }
  */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		yield [
@@ -870,7 +905,7 @@ public function enterNode(Node $node)
  *     string
  * }
  */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		yield [
@@ -888,7 +923,7 @@ public function enterNode(Node $node)
 	 *   string,
 	 * }
 	 */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		yield [
@@ -906,7 +941,7 @@ public function enterNode(Node $node)
      *   string
      * }
      */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		yield [
@@ -924,7 +959,7 @@ public function enterNode(Node $node)
 	 *     string
 	 * }
 	 */',
-			$addItemsToArrayShape,
+			$addKeylessItemsToArrayShape,
 		];
 
 		$addItemsToObjectShape = new class extends AbstractNodeVisitor {
@@ -941,25 +976,66 @@ public function enterNode(Node $node)
 		};
 
 		yield [
-			'/**
- * @return object{}
- */',
-			'/**
- * @return object{foo: int}
- */',
+			nowdoc('
+				/**
+				 * @return object{}
+				 */'),
+			nowdoc('
+				/**
+				 * @return object{foo: int}
+				 */'),
 			$addItemsToObjectShape,
 		];
 
+		yield [
+			nowdoc('
+				/**
+				 * @return object{bar: string}
+				 */'),
+			nowdoc('
+				/**
+				 * @return object{bar: string, foo: int}
+				 */'),
+			$addItemsToObjectShape,
+		];
+
+		yield [
+			nowdoc('
+			/**
+			 * @return object{bar: string}
+			 */'),
+			nowdoc('
+			/**
+			 * @return object{bar: string, foo: int}
+			 */'),
+			$addItemsToObjectShape,
+		];
+		$addCommentedItemsToMultilineObjectShape = new class extends AbstractNodeVisitor {
+
+			public function enterNode(Node $node)
+			{
+				if ($node instanceof ObjectShapeNode) {
+					$node = new ObjectShapeItemNode(new IdentifierTypeNode('foo'), false, new IdentifierTypeNode('int'));
+					$node->setAttribute(Attribute::COMMENTS, [new Comment('// bar')]);
+					$node->items[] = $node;
+				}
+
+				return $node;
+			}
+		};
+
 		yield [
 			'/**
- * @return object{bar: string}
+ * @return object{}
  */',
 			'/**
- * @return object{bar: string, foo: int}
+ * @return object{foo: int}
  */',
-			$addItemsToObjectShape,
+			$addCommentedItemsToMultilineObjectShape,
 		];
 
+
+
 		$addItemsToConstExprArray = new class extends AbstractNodeVisitor {
 
 			public function enterNode(Node $node)