add AbstractNode with attributes and make all nodes extend it

TomasVotruba · TomasVotruba · commit d9ce9f6336e9 · 2021-03-12T13:49:58.000+01:00
diff --git a/src/Ast/BaseNode.php b/src/Ast/BaseNode.php
@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\PhpDocParser\Ast;
+
+abstract class BaseNode implements Node
+{
+
+	/** @var array<string, mixed> */
+	private $attributes = [];
+
+    /**
+     * @param mixed $value
+     */
+	public function setAttribute(string $key, $value): void
+	{
+		$this->attributes[$key] = $value;
+	}
+
+	public function hasAttribute(string $key): bool
+	{
+		return array_key_exists($key, $this->attributes);
+	}
+
+	/**
+	 * @param mixed|null $default
+	 * @return mixed|null
+	 */
+	public function getAttribute(string $key, $default = null)
+	{
+		if ($this->hasAttribute($key)) {
+			return $this->attributes[$key];
+		}
+
+		return $default;
+	}
+
+}
diff --git a/src/Ast/ConstExpr/ConstExprArrayItemNode.php b/src/Ast/ConstExpr/ConstExprArrayItemNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprArrayItemNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprArrayItemNode extends BaseNode implements ConstExprNode
 {
 
 	/** @var ConstExprNode|null */
diff --git a/src/Ast/ConstExpr/ConstExprArrayNode.php b/src/Ast/ConstExpr/ConstExprArrayNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprArrayNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprArrayNode extends BaseNode implements ConstExprNode
 {
 
 	/** @var ConstExprArrayItemNode[] */
diff --git a/src/Ast/ConstExpr/ConstExprFalseNode.php b/src/Ast/ConstExpr/ConstExprFalseNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprFalseNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprFalseNode extends BaseNode implements ConstExprNode
 {
 
 	public function __toString(): string
diff --git a/src/Ast/ConstExpr/ConstExprFloatNode.php b/src/Ast/ConstExpr/ConstExprFloatNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprFloatNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprFloatNode extends BaseNode implements ConstExprNode
 {
 
 	/** @var string */
diff --git a/src/Ast/ConstExpr/ConstExprIntegerNode.php b/src/Ast/ConstExpr/ConstExprIntegerNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprIntegerNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprIntegerNode extends BaseNode implements ConstExprNode
 {
 
 	/** @var string */
diff --git a/src/Ast/ConstExpr/ConstExprNullNode.php b/src/Ast/ConstExpr/ConstExprNullNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprNullNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprNullNode extends BaseNode implements ConstExprNode
 {
 
 	public function __toString(): string
diff --git a/src/Ast/ConstExpr/ConstExprStringNode.php b/src/Ast/ConstExpr/ConstExprStringNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprStringNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprStringNode extends BaseNode implements ConstExprNode
 {
 
 	/** @var string */
diff --git a/src/Ast/ConstExpr/ConstExprTrueNode.php b/src/Ast/ConstExpr/ConstExprTrueNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstExprTrueNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstExprTrueNode extends BaseNode implements ConstExprNode
 {
 
 	public function __toString(): string
diff --git a/src/Ast/ConstExpr/ConstFetchNode.php b/src/Ast/ConstExpr/ConstFetchNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\ConstExpr;
 
-class ConstFetchNode implements ConstExprNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ConstFetchNode extends BaseNode implements ConstExprNode
 {
 
 	/** @var string class name for class constants or empty string for non-class constants */
diff --git a/src/Ast/PhpDoc/DeprecatedTagValueNode.php b/src/Ast/PhpDoc/DeprecatedTagValueNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
-class DeprecatedTagValueNode implements PhpDocTagValueNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class DeprecatedTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var string (may be empty) */
diff --git a/src/Ast/PhpDoc/ExtendsTagValueNode.php b/src/Ast/PhpDoc/ExtendsTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 
-class ExtendsTagValueNode implements PhpDocTagValueNode
+class ExtendsTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var GenericTypeNode */
diff --git a/src/Ast/PhpDoc/GenericTagValueNode.php b/src/Ast/PhpDoc/GenericTagValueNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
-class GenericTagValueNode implements PhpDocTagValueNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class GenericTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var string (may be empty) */
diff --git a/src/Ast/PhpDoc/ImplementsTagValueNode.php b/src/Ast/PhpDoc/ImplementsTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 
-class ImplementsTagValueNode implements PhpDocTagValueNode
+class ImplementsTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var GenericTypeNode */
diff --git a/src/Ast/PhpDoc/InvalidTagValueNode.php b/src/Ast/PhpDoc/InvalidTagValueNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
-class InvalidTagValueNode implements PhpDocTagValueNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class InvalidTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var string (may be empty) */
diff --git a/src/Ast/PhpDoc/MethodTagValueNode.php b/src/Ast/PhpDoc/MethodTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class MethodTagValueNode implements PhpDocTagValueNode
+class MethodTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var bool */
diff --git a/src/Ast/PhpDoc/MethodTagValueParameterNode.php b/src/Ast/PhpDoc/MethodTagValueParameterNode.php
@@ -2,11 +2,12 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprNode;
 use PHPStan\PhpDocParser\Ast\Node;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class MethodTagValueParameterNode implements Node
+class MethodTagValueParameterNode extends BaseNode implements Node
 {
 
 	/** @var TypeNode|null */
diff --git a/src/Ast/PhpDoc/MixinTagValueNode.php b/src/Ast/PhpDoc/MixinTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class MixinTagValueNode implements PhpDocTagValueNode
+class MixinTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var TypeNode */
diff --git a/src/Ast/PhpDoc/ParamTagValueNode.php b/src/Ast/PhpDoc/ParamTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class ParamTagValueNode implements PhpDocTagValueNode
+class ParamTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var TypeNode */
diff --git a/src/Ast/PhpDoc/PhpDocNode.php b/src/Ast/PhpDoc/PhpDocNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Node;
 
-class PhpDocNode implements Node
+class PhpDocNode extends BaseNode implements Node
 {
 
 	/** @var PhpDocChildNode[] */
diff --git a/src/Ast/PhpDoc/PhpDocTagNode.php b/src/Ast/PhpDoc/PhpDocTagNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
-class PhpDocTagNode implements PhpDocChildNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class PhpDocTagNode extends BaseNode implements PhpDocChildNode
 {
 
 	/** @var string */
diff --git a/src/Ast/PhpDoc/PhpDocTextNode.php b/src/Ast/PhpDoc/PhpDocTextNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
-class PhpDocTextNode implements PhpDocChildNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class PhpDocTextNode extends BaseNode implements PhpDocChildNode
 {
 
 	/** @var string */
diff --git a/src/Ast/PhpDoc/PropertyTagValueNode.php b/src/Ast/PhpDoc/PropertyTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class PropertyTagValueNode implements PhpDocTagValueNode
+class PropertyTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var TypeNode */
diff --git a/src/Ast/PhpDoc/ReturnTagValueNode.php b/src/Ast/PhpDoc/ReturnTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class ReturnTagValueNode implements PhpDocTagValueNode
+class ReturnTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var TypeNode */
diff --git a/src/Ast/PhpDoc/TemplateTagValueNode.php b/src/Ast/PhpDoc/TemplateTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class TemplateTagValueNode implements PhpDocTagValueNode
+class TemplateTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var string */
diff --git a/src/Ast/PhpDoc/ThrowsTagValueNode.php b/src/Ast/PhpDoc/ThrowsTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class ThrowsTagValueNode implements PhpDocTagValueNode
+class ThrowsTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var TypeNode */
diff --git a/src/Ast/PhpDoc/UsesTagValueNode.php b/src/Ast/PhpDoc/UsesTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 
-class UsesTagValueNode implements PhpDocTagValueNode
+class UsesTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var GenericTypeNode */
diff --git a/src/Ast/PhpDoc/VarTagValueNode.php b/src/Ast/PhpDoc/VarTagValueNode.php
@@ -2,9 +2,10 @@
 
 namespace PHPStan\PhpDocParser\Ast\PhpDoc;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 
-class VarTagValueNode implements PhpDocTagValueNode
+class VarTagValueNode extends BaseNode implements PhpDocTagValueNode
 {
 
 	/** @var TypeNode */
diff --git a/src/Ast/Type/ArrayShapeItemNode.php b/src/Ast/Type/ArrayShapeItemNode.php
@@ -2,10 +2,11 @@
 
 namespace PHPStan\PhpDocParser\Ast\Type;
 
+use PHPStan\PhpDocParser\Ast\BaseNode;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
 
-class ArrayShapeItemNode implements TypeNode
+class ArrayShapeItemNode extends BaseNode implements TypeNode
 {
 
 	/** @var ConstExprIntegerNode|ConstExprStringNode|IdentifierTypeNode|null */
diff --git a/src/Ast/Type/ArrayShapeNode.php b/src/Ast/Type/ArrayShapeNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\Type;
 
-class ArrayShapeNode implements TypeNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ArrayShapeNode extends BaseNode implements TypeNode
 {
 
 	/** @var ArrayShapeItemNode[] */
diff --git a/src/Ast/Type/ArrayTypeNode.php b/src/Ast/Type/ArrayTypeNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\Type;
 
-class ArrayTypeNode implements TypeNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class ArrayTypeNode extends BaseNode implements TypeNode
 {
 
 	/** @var TypeNode */
diff --git a/src/Ast/Type/CallableTypeNode.php b/src/Ast/Type/CallableTypeNode.php
@@ -2,7 +2,9 @@
 
 namespace PHPStan\PhpDocParser\Ast\Type;
 
-class CallableTypeNode implements TypeNode
+use PHPStan\PhpDocParser\Ast\BaseNode;
+
+class CallableTypeNode extends BaseNode implements TypeNode
 {
 
 	/** @var IdentifierTypeNode */
diff --git a/src/Ast/Type/CallableTypeParameterNode.php b/src/Ast/Type/CallableTypeParameterNode.php
diff --git a/src/Ast/Type/ConstTypeNode.php b/src/Ast/Type/ConstTypeNode.php
diff --git a/src/Ast/Type/GenericTypeNode.php b/src/Ast/Type/GenericTypeNode.php
diff --git a/src/Ast/Type/IdentifierTypeNode.php b/src/Ast/Type/IdentifierTypeNode.php
diff --git a/src/Ast/Type/IntersectionTypeNode.php b/src/Ast/Type/IntersectionTypeNode.php
diff --git a/src/Ast/Type/NullableTypeNode.php b/src/Ast/Type/NullableTypeNode.php
diff --git a/src/Ast/Type/ThisTypeNode.php b/src/Ast/Type/ThisTypeNode.php
diff --git a/src/Ast/Type/UnionTypeNode.php b/src/Ast/Type/UnionTypeNode.php
diff --git a/tests/PHPStan/Ast/Attributes/AttributesTest.php b/tests/PHPStan/Ast/Attributes/AttributesTest.php

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprArrayItemNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprArrayItemNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`/** @var ConstExprNode\|null */`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprArrayNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprArrayNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`/** @var ConstExprArrayItemNode[] */`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprFalseNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprFalseNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`public function __toString(): string`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprFloatNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprFloatNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`/** @var string */`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprIntegerNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprIntegerNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`/** @var string */`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprNullNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprNullNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`public function __toString(): string`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprStringNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprStringNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`/** @var string */`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstExprTrueNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstExprTrueNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`public function __toString(): string`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace PHPStan\PhpDocParser\Ast\ConstExpr;`
`4`	`4`
`5`		`-class ConstFetchNode implements ConstExprNode`
	`5`	`+use PHPStan\PhpDocParser\Ast\BaseNode;`
	`6`	`+`
	`7`	`+class ConstFetchNode extends BaseNode implements ConstExprNode`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`/** @var string class name for class constants or empty string for non-class constants */`