AbstractMethodInNonAbstractClassRule - better error message for enums

ondrejmirtes · ondrejmirtes · commit b5dd34e492b0 · 2023-11-13T11:51:55.000+01:00
diff --git a/Makefile b/Makefile
@@ -31,6 +31,7 @@ lint:
 		--exclude tests/PHPStan/Rules/Classes/data/implements-error.php \
 		--exclude tests/PHPStan/Rules/Classes/data/interface-extends-error.php \
 		--exclude tests/PHPStan/Rules/Classes/data/trait-use-error.php \
+		--exclude tests/PHPStan/Rules/Methods/data/method-in-enum-without-body.php \
 		--exclude tests/PHPStan/Rules/Properties/data/default-value-for-native-property-type.php \
 		--exclude tests/PHPStan/Rules/Arrays/data/empty-array-item.php \
 		--exclude tests/PHPStan/Rules/Classes/data/invalid-promoted-properties.php \
diff --git a/src/Rules/Methods/AbstractMethodInNonAbstractClassRule.php b/src/Rules/Methods/AbstractMethodInNonAbstractClassRule.php
@@ -29,10 +29,11 @@ public function processNode(Node $node, Scope $scope): array
 		$class = $scope->getClassReflection();
 
 		if (!$class->isAbstract() && $node->isAbstract()) {
+			$description = $class->getClassTypeDescription();
 			return [
 				RuleErrorBuilder::message(sprintf(
 					'%s %s contains abstract method %s().',
-					$class->isInterface() ? 'Interface' : 'Non-abstract class',
+					$description === 'Class' ? 'Non-abstract class' : $description,
 					$class->getDisplayName(),
 					$node->name->toString(),
 				))
@@ -54,6 +55,8 @@ public function processNode(Node $node, Scope $scope): array
 					->build(),
 			];
 		}
+
+		return [];
 	}
 
 }
diff --git a/tests/PHPStan/Rules/Methods/AbstractMethodInNonAbstractClassRuleTest.php b/tests/PHPStan/Rules/Methods/AbstractMethodInNonAbstractClassRuleTest.php
@@ -6,6 +6,7 @@
 use Bug3406\ClassFoo;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use const PHP_VERSION_ID;
 
 /**
  * @extends RuleTestCase<AbstractMethodInNonAbstractClassRule>
@@ -70,4 +71,22 @@ public function testNonAbstractMethodWithNoBody(): void
 		]);
 	}
 
+	public function testEnum(): void
+	{
+		if (PHP_VERSION_ID < 80100) {
+			$this->markTestSkipped('Test requires PHP 8.1.');
+		}
+
+		$this->analyse([__DIR__ . '/data/method-in-enum-without-body.php'], [
+			[
+				'Non-abstract method MethodInEnumWithoutBody\Foo::doFoo() must contain a body.',
+				8,
+			],
+			[
+				'Enum MethodInEnumWithoutBody\Foo contains abstract method doBar().',
+				10,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Methods/data/method-in-enum-without-body.php b/tests/PHPStan/Rules/Methods/data/method-in-enum-without-body.php
@@ -0,0 +1,12 @@
+<?php // lint >= 8.1
+
+namespace MethodInEnumWithoutBody;
+
+enum Foo
+{
+
+	public function doFoo(): void;
+
+	abstract public function doBar(): void;
+
+}

Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,11 @@ public function processNode(Node $node, Scope $scope): array`
`29`	`29`	`$class = $scope->getClassReflection();`
`30`	`30`
`31`	`31`	`if (!$class->isAbstract() && $node->isAbstract()) {`
	`32`	`+ $description = $class->getClassTypeDescription();`
`32`	`33`	`return [`
`33`	`34`	`RuleErrorBuilder::message(sprintf(`
`34`	`35`	`'%s %s contains abstract method %s().',`
`35`		`- $class->isInterface() ? 'Interface' : 'Non-abstract class',`
	`36`	`+ $description === 'Class' ? 'Non-abstract class' : $description,`
`36`	`37`	`$class->getDisplayName(),`
`37`	`38`	`$node->name->toString(),`
`38`	`39`	`))`
`@@ -54,6 +55,8 @@ public function processNode(Node $node, Scope $scope): array`
`54`	`55`	`->build(),`
`55`	`56`	`];`
`56`	`57`	`}`
	`58`	`+`
	`59`	`+ return [];`
`57`	`60`	`}`
`58`	`61`
`59`	`62`	`}`