require-extends should not error on interfaces

staabm · web-flow · commit 98a10371f296 · 2024-01-10T22:01:58.000+01:00
diff --git a/src/Rules/Classes/RequireExtendsRule.php b/src/Rules/Classes/RequireExtendsRule.php
@@ -26,16 +26,20 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		$classReflection = $node->getClassReflection();
 
+		if ($classReflection->isInterface()) {
+			return [];
+		}
+
 		$errors = [];
-		foreach ($classReflection->getImmediateInterfaces() as $interface) {
+		foreach ($classReflection->getInterfaces() as $interface) {
 			$extendsTags = $interface->getRequireExtendsTags();
 			foreach ($extendsTags as $extendsTag) {
 				$type = $extendsTag->getType();
 				if (!$type instanceof ObjectType) {
 					continue;
 				}
 
-				if ($classReflection->isSubclassOf($type->getClassName())) {
+				if ($classReflection->is($type->getClassName())) {
 					continue;
 				}
 
@@ -50,15 +54,15 @@ public function processNode(Node $node, Scope $scope): array
 			}
 		}
 
-		foreach ($classReflection->getTraits() as $trait) {
+		foreach ($classReflection->getTraits(true) as $trait) {
 			$extendsTags = $trait->getRequireExtendsTags();
 			foreach ($extendsTags as $extendsTag) {
 				$type = $extendsTag->getType();
 				if (!$type instanceof ObjectType) {
 					continue;
 				}
 
-				if ($classReflection->isSubclassOf($type->getClassName())) {
+				if ($classReflection->is($type->getClassName())) {
 					continue;
 				}
 
diff --git a/src/Rules/Classes/RequireImplementsRule.php b/src/Rules/Classes/RequireImplementsRule.php
@@ -27,7 +27,7 @@ public function processNode(Node $node, Scope $scope): array
 		$classReflection = $node->getClassReflection();
 
 		$errors = [];
-		foreach ($classReflection->getTraits() as $trait) {
+		foreach ($classReflection->getTraits(true) as $trait) {
 			$implementsTags = $trait->getRequireImplementsTags();
 			foreach ($implementsTags as $implementsTag) {
 				$type = $implementsTag->getType();
diff --git a/tests/PHPStan/Rules/Classes/RequireExtendsRuleTest.php b/tests/PHPStan/Rules/Classes/RequireExtendsRuleTest.php
@@ -57,4 +57,24 @@ public function testRule(): void
 		$this->analyse([__DIR__ . '/../PhpDoc/data/incompatible-require-extends.php'], $expectedErrors);
 	}
 
+	public function testExtendedInterfaceBug(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-10302-extended-interface.php'], [
+			[
+				'Interface Bug10302ExtendedInterface\BatchAware requires implementing class to extend Bug10302ExtendedInterface\Model, but Bug10302ExtendedInterface\AnotherModel does not.',
+				34,
+			],
+		]);
+	}
+
+	public function testExtendedTraitBug(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-10302-extended-trait.php'], [
+			[
+				'Trait Bug10302ExtendedTrait\Foo requires using class to extend Bug10302ExtendedTrait\Father, but Bug10302ExtendedTrait\Baz does not.',
+				21,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Classes/RequireImplementsRuleTest.php b/tests/PHPStan/Rules/Classes/RequireImplementsRuleTest.php
@@ -73,4 +73,14 @@ public function testRule(): void
 		$this->analyse([__DIR__ . '/../PhpDoc/data/incompatible-require-implements.php'], $expectedErrors);
 	}
 
+	public function testExtendedTraitBug(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-10302-extended-implements-trait.php'], [
+			[
+				'Trait Bug10302ExtendedImplementsTrait\Foo requires using class to implement Bug10302ExtendedImplementsTrait\Interface1, but Bug10302ExtendedImplementsTrait\Baz does not.',
+				21,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Classes/data/bug-10302-extended-implements-trait.php b/tests/PHPStan/Rules/Classes/data/bug-10302-extended-implements-trait.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Bug10302ExtendedImplementsTrait;
+
+interface Interface1
+{
+
+}
+
+/** @phpstan-require-implements Interface1 */
+trait Foo
+{
+
+}
+
+trait Bar
+{
+	use Foo;
+}
+
+class Baz
+{
+
+	use Bar;
+
+}
+
+class Baz2 implements Interface1
+{
+
+	use Bar;
+
+}
diff --git a/tests/PHPStan/Rules/Classes/data/bug-10302-extended-interface.php b/tests/PHPStan/Rules/Classes/data/bug-10302-extended-interface.php
@@ -0,0 +1,50 @@
+<?php
+
+namespace Bug10302ExtendedInterface;
+
+use function PHPStan\Testing\assertType;
+
+/**
+ * @property-read bool $busy
+ * @phpstan-require-extends Model
+ */
+interface BatchAware
+{
+}
+
+interface BatchAwareExtended extends BatchAware
+{
+
+}
+
+/**
+ * @property-read bool $busy2
+ */
+class Model implements BatchAware
+{
+	/**
+	 * @return mixed
+	 */
+	public function __get(string $name)
+	{
+		return 1;
+	}
+}
+
+class AnotherModel implements BatchAwareExtended
+{
+
+}
+
+
+/**
+ * @property-read bool $busy
+ * @phpstan-require-extends TraitModel
+ */
+trait BatchAwareTrait
+{
+}
+
+class TraitModel {
+	use BatchAwareTrait;
+}
diff --git a/tests/PHPStan/Rules/Classes/data/bug-10302-extended-trait.php b/tests/PHPStan/Rules/Classes/data/bug-10302-extended-trait.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Bug10302ExtendedTrait;
+
+class Father
+{
+
+}
+
+/** @phpstan-require-extends Father */
+trait Foo
+{
+
+}
+
+trait Bar
+{
+	use Foo;
+}
+
+class Baz // should report: Trait Foo requires using class to extend Father, but Baz does not.
+{
+
+	use Bar;
+
+}
+
+
+class Baz2 extends Father
+{
+
+	use Bar;
+
+}

Original file line number	Diff line number	Diff line change
`@@ -26,16 +26,20 @@ public function processNode(Node $node, Scope $scope): array`
`26`	`26`	`{`
`27`	`27`	`$classReflection = $node->getClassReflection();`
`28`	`28`
	`29`	`+ if ($classReflection->isInterface()) {`
	`30`	`+ return [];`
	`31`	`+ }`
	`32`	`+`
`29`	`33`	`$errors = [];`
`30`		`- foreach ($classReflection->getImmediateInterfaces() as $interface) {`
	`34`	`+ foreach ($classReflection->getInterfaces() as $interface) {`
`31`	`35`	`$extendsTags = $interface->getRequireExtendsTags();`
`32`	`36`	`foreach ($extendsTags as $extendsTag) {`
`33`	`37`	`$type = $extendsTag->getType();`
`34`	`38`	`if (!$type instanceof ObjectType) {`
`35`	`39`	`continue;`
`36`	`40`	`}`
`37`	`41`
`38`		`- if ($classReflection->isSubclassOf($type->getClassName())) {`
	`42`	`+ if ($classReflection->is($type->getClassName())) {`
`39`	`43`	`continue;`
`40`	`44`	`}`
`41`	`45`
`@@ -50,15 +54,15 @@ public function processNode(Node $node, Scope $scope): array`
`50`	`54`	`}`
`51`	`55`	`}`
`52`	`56`
`53`		`- foreach ($classReflection->getTraits() as $trait) {`
	`57`	`+ foreach ($classReflection->getTraits(true) as $trait) {`
`54`	`58`	`$extendsTags = $trait->getRequireExtendsTags();`
`55`	`59`	`foreach ($extendsTags as $extendsTag) {`
`56`	`60`	`$type = $extendsTag->getType();`
`57`	`61`	`if (!$type instanceof ObjectType) {`
`58`	`62`	`continue;`
`59`	`63`	`}`
`60`	`64`
`61`		`- if ($classReflection->isSubclassOf($type->getClassName())) {`
	`65`	`+ if ($classReflection->is($type->getClassName())) {`
`62`	`66`	`continue;`
`63`	`67`	`}`
`64`	`68`
Original file line number	Diff line number	Diff line change
`@@ -73,4 +73,14 @@ public function testRule(): void`
`73`	`73`	`$this->analyse([__DIR__ . '/../PhpDoc/data/incompatible-require-implements.php'], $expectedErrors);`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ public function testExtendedTraitBug(): void`
	`77`	`+ {`
	`78`	`+ $this->analyse([__DIR__ . '/data/bug-10302-extended-implements-trait.php'], [`
	`79`	`+ [`
	`80`	`+ 'Trait Bug10302ExtendedImplementsTrait\Foo requires using class to implement Bug10302ExtendedImplementsTrait\Interface1, but Bug10302ExtendedImplementsTrait\Baz does not.',`
	`81`	`+ 21,`
	`82`	`+ ],`
	`83`	`+ ]);`
	`84`	`+ }`
	`85`	`+`
`76`	`86`	`}`