Add equality assert syntax

Author: rvanvelzen

src/Ast/PhpDoc/AssertTagMethodValueNode.php

@@ -23,23 +23,28 @@ class AssertTagMethodValueNode implements PhpDocTagValueNode
 	/** @var bool */
 	public $isNegated;
 
+	/** @var bool */
+	public $isEquality;
+
 	/** @var string (may be empty) */
 	public $description;
 
-	public function __construct(TypeNode $type, string $parameter, string $method, bool $isNegated, string $description)
+	public function __construct(TypeNode $type, string $parameter, string $method, bool $isNegated, string $description, bool $isEquality = false)
 	{
 		$this->type = $type;
 		$this->parameter = $parameter;
 		$this->method = $method;
 		$this->isNegated = $isNegated;
+		$this->isEquality = $isEquality;
 		$this->description = $description;
 	}
 
 
 	public function __toString(): string
 	{
 		$isNegated = $this->isNegated ? '!' : '';
-		return trim("{$isNegated}{$this->type} {$this->parameter}->{$this->method}() {$this->description}");
+		$isEquality = $this->isEquality ? '=' : '';
+		return trim("{$isNegated}{$isEquality}{$this->type} {$this->parameter}->{$this->method}() {$this->description}");
 	}
 
 }

src/Ast/PhpDoc/AssertTagPropertyValueNode.php

@@ -23,23 +23,28 @@ class AssertTagPropertyValueNode implements PhpDocTagValueNode
 	/** @var bool */
 	public $isNegated;
 
+	/** @var bool */
+	public $isEquality;
+
 	/** @var string (may be empty) */
 	public $description;
 
-	public function __construct(TypeNode $type, string $parameter, string $property, bool $isNegated, string $description)
+	public function __construct(TypeNode $type, string $parameter, string $property, bool $isNegated, string $description, bool $isEquality = false)
 	{
 		$this->type = $type;
 		$this->parameter = $parameter;
 		$this->property = $property;
 		$this->isNegated = $isNegated;
+		$this->isEquality = $isEquality;
 		$this->description = $description;
 	}
 
 
 	public function __toString(): string
 	{
 		$isNegated = $this->isNegated ? '!' : '';
-		return trim("{$isNegated}{$this->type} {$this->parameter}->{$this->property} {$this->description}");
+		$isEquality = $this->isEquality ? '=' : '';
+		return trim("{$isNegated}{$isEquality}{$this->type} {$this->parameter}->{$this->property} {$this->description}");
 	}
 
 }

src/Ast/PhpDoc/AssertTagValueNode.php

@@ -20,22 +20,27 @@ class AssertTagValueNode implements PhpDocTagValueNode
 	/** @var bool */
 	public $isNegated;
 
+	/** @var bool */
+	public $isEquality;
+
 	/** @var string (may be empty) */
 	public $description;
 
-	public function __construct(TypeNode $type, string $parameter, bool $isNegated, string $description)
+	public function __construct(TypeNode $type, string $parameter, bool $isNegated, string $description, bool $isEquality = false)
 	{
 		$this->type = $type;
 		$this->parameter = $parameter;
 		$this->isNegated = $isNegated;
+		$this->isEquality = $isEquality;
 		$this->description = $description;
 	}
 
 
 	public function __toString(): string
 	{
 		$isNegated = $this->isNegated ? '!' : '';
-		return trim("{$isNegated}{$this->type} {$this->parameter} {$this->description}");
+		$isEquality = $this->isEquality ? '=' : '';
+		return trim("{$isNegated}{$isEquality}{$this->type} {$this->parameter} {$this->description}");
 	}
 
 }

src/Parser/PhpDocParser.php

@@ -472,17 +472,18 @@ private function parseTypeAliasImportTagValue(TokenIterator $tokens): Ast\PhpDoc
 	private function parseAssertTagValue(TokenIterator $tokens): Ast\PhpDoc\PhpDocTagValueNode
 	{
 		$isNegated = $tokens->tryConsumeTokenType(Lexer::TOKEN_NEGATED);
+		$isEquality = $tokens->tryConsumeTokenType(Lexer::TOKEN_EQUAL);
 		$type = $this->typeParser->parse($tokens);
 		$parameter = $this->parseAssertParameter($tokens);
 		$description = $this->parseOptionalDescription($tokens);
 
 		if (array_key_exists('method', $parameter)) {
-			return new Ast\PhpDoc\AssertTagMethodValueNode($type, $parameter['parameter'], $parameter['method'], $isNegated, $description);
+			return new Ast\PhpDoc\AssertTagMethodValueNode($type, $parameter['parameter'], $parameter['method'], $isNegated, $description, $isEquality);
 		} elseif (array_key_exists('property', $parameter)) {
-			return new Ast\PhpDoc\AssertTagPropertyValueNode($type, $parameter['parameter'], $parameter['property'], $isNegated, $description);
+			return new Ast\PhpDoc\AssertTagPropertyValueNode($type, $parameter['parameter'], $parameter['property'], $isNegated, $description, $isEquality);
 		}
 
-		return new Ast\PhpDoc\AssertTagValueNode($type, $parameter['parameter'], $isNegated, $description);
+		return new Ast\PhpDoc\AssertTagValueNode($type, $parameter['parameter'], $isNegated, $description, $isEquality);
 	}
 
 	/**

tests/PHPStan/Parser/PhpDocParserTest.php

@@ -4002,6 +4002,40 @@ public function provideAssertTagsData(): Iterator
 				),
 			]),
 		];
+
+		yield [
+			'OK equality',
+			'/** @phpstan-assert =Type $var */',
+			new PhpDocNode([
+				new PhpDocTagNode(
+					'@phpstan-assert',
+					new AssertTagValueNode(
+						new IdentifierTypeNode('Type'),
+						'$var',
+						false,
+						'',
+						true
+					)
+				),
+			]),
+		];
+
+		yield [
+			'OK negated equality',
+			'/** @phpstan-assert !=Type $var */',
+			new PhpDocNode([
+				new PhpDocTagNode(
+					'@phpstan-assert',
+					new AssertTagValueNode(
+						new IdentifierTypeNode('Type'),
+						'$var',
+						true,
+						'',
+						true
+					)
+				),
+			]),
+		];
 	}
 
 	public function providerDebug(): Iterator