Remove ignoreDescriptiveUncheckedExceptions (#119)

Author: VincentLanglet

README.md

@@ -52,7 +52,6 @@ parameters:
 		reportUnusedCatchesOfUncheckedExceptions: false
 		reportUnusedCheckedThrowsInSubtypes: false
 		reportCheckedThrowsInGlobalScope: false
-		ignoreDescriptiveUncheckedExceptions: false
 		checkedExceptions:
 			- RuntimeException
 ```

extension.neon

@@ -3,7 +3,6 @@ parameters:
 		reportUnusedCatchesOfUncheckedExceptions: false
 		reportUnusedCheckedThrowsInSubtypes: false
 		reportCheckedThrowsInGlobalScope: true
-		ignoreDescriptiveUncheckedExceptions: false
 		checkedExceptions: []
 		uncheckedExceptions: []
 		methodThrowTypeDeclarations: []
@@ -15,7 +14,6 @@ parametersSchema:
 		reportUnusedCatchesOfUncheckedExceptions: bool()
 		reportUnusedCheckedThrowsInSubtypes: bool()
 		reportCheckedThrowsInGlobalScope: bool()
-		ignoreDescriptiveUncheckedExceptions: bool()
 		checkedExceptions: listOf(string())
 		uncheckedExceptions: listOf(string())
 		methodThrowTypeDeclarations: arrayOf(arrayOf(listOf(string())))
@@ -80,7 +78,6 @@ services:
 			reportUnusedCatchesOfUncheckedExceptions: %exceptionRules.reportUnusedCatchesOfUncheckedExceptions%
 			reportUnusedCheckedThrowsInSubtypes: %exceptionRules.reportUnusedCheckedThrowsInSubtypes%
 			reportCheckedThrowsInGlobalScope: %exceptionRules.reportCheckedThrowsInGlobalScope%
-			ignoreDescriptiveUncheckedExceptions: %exceptionRules.ignoreDescriptiveUncheckedExceptions%
 			methodWhitelist: %exceptionRules.methodWhitelist%
 		tags: [phpstan.rules.rule]
 

src/Rules/ThrowsPhpDocRule.php

@@ -112,11 +112,6 @@ class ThrowsPhpDocRule implements Rule
 	 */
 	private $reportCheckedThrowsInGlobalScope;
 
-	/**
-	 * @var bool
-	 */
-	private $ignoreDescriptiveUncheckedExceptions;
-
 	/**
 	 * @var bool
 	 */
@@ -137,7 +132,6 @@ public function __construct(
 		bool $reportUnusedCatchesOfUncheckedExceptions,
 		bool $reportUnusedCheckedThrowsInSubtypes,
 		bool $reportCheckedThrowsInGlobalScope,
-		bool $ignoreDescriptiveUncheckedExceptions,
 		array $methodWhitelist
 	)
 	{
@@ -149,7 +143,6 @@ public function __construct(
 		$this->throwsScope = new ThrowsScope();
 		$this->reportUnusedCatchesOfUncheckedExceptions = $reportUnusedCatchesOfUncheckedExceptions;
 		$this->reportCheckedThrowsInGlobalScope = $reportCheckedThrowsInGlobalScope;
-		$this->ignoreDescriptiveUncheckedExceptions = $ignoreDescriptiveUncheckedExceptions;
 		$this->reportUnusedCheckedThrowsInSubtypes = $reportUnusedCheckedThrowsInSubtypes;
 		$this->methodWhitelist = $methodWhitelist;
 	}
@@ -549,8 +542,7 @@ private function processFunctionEnd(Scope $scope, int $startLine): array
 	 */
 	private function filterUnusedExceptions(array $declaredThrows, array $usedThrowsAnnotations, Scope $scope): array
 	{
-		$checkedThrowsAnnotations = $this->checkedExceptionService->filterCheckedExceptions($usedThrowsAnnotations);
-		$unusedThrows = array_diff($declaredThrows, $checkedThrowsAnnotations);
+		$unusedThrows = array_diff($declaredThrows, $usedThrowsAnnotations);
 
 		$functionReflection = $scope->getFunction();
 		if ($functionReflection === null) {
@@ -581,10 +573,6 @@ private function filterUnusedExceptions(array $declaredThrows, array $usedThrows
 
 		$unusedThrows = array_diff($unusedThrows, TypeUtils::getDirectClassNames($defaultThrowsType));
 
-		if (!$this->ignoreDescriptiveUncheckedExceptions) {
-			return $unusedThrows;
-		}
-
 		$throwsAnnotations = $this->throwsAnnotationReader->read($scope);
 
 		return array_filter($unusedThrows, static function (string $type) use ($throwsAnnotations, $usedThrowsAnnotations): bool {

tests/src/Rules/Bug113Test.php

@@ -48,7 +48,6 @@ protected function getRule(): Rule
 			false,
 			true,
 			false,
-			false,
 			[]
 		);
 	}

tests/src/Rules/PhpInternalsTest.php

@@ -52,7 +52,6 @@ protected function getRule(): Rule
 			true,
 			true,
 			true,
-			false,
 			[]
 		);
 	}

tests/src/Rules/ThrowsPhpDocRuleTest.php

@@ -33,11 +33,6 @@ class ThrowsPhpDocRuleTest extends RuleTestCase
 	 */
 	private $reportUnusedCheckedThrowsInSubtypes = true;
 
-	/**
-	 * @var bool
-	 */
-	private $ignoreDescriptiveUncheckedExceptions = false;
-
 	/**
 	 * @var bool
 	 */
@@ -90,7 +85,6 @@ protected function getRule(): Rule
 			$this->reportUnusedCatchesOfUncheckedExceptions,
 			$this->reportUnusedCheckedThrowsInSubtypes,
 			$this->reportCheckedThrowsInGlobalScope,
-			$this->ignoreDescriptiveUncheckedExceptions,
 			$this->methodWhitelist
 		);
 	}
@@ -134,13 +128,6 @@ public function testAllUnusedCatches(): void
 		$this->analyse(__DIR__ . '/data/unused-catches-all.php');
 	}
 
-	public function testDescriptiveUnusedCatches(): void
-	{
-		$this->reportUnusedCatchesOfUncheckedExceptions = true;
-		$this->ignoreDescriptiveUncheckedExceptions = true;
-		$this->analyse(__DIR__ . '/data/unused-descriptive-throws.php');
-	}
-
 	public function testIterators(): void
 	{
 		$this->analyse(__DIR__ . '/data/iterators.php');

tests/src/Rules/data/unused-catches-all.php

@@ -48,6 +48,14 @@ public function correctCatchMethodCallWithThrows(): void
 		} catch (RuntimeException $e) { // error: RuntimeException is never thrown in the corresponding try block
 
 		}
+
+		try {
+			$this->throwLogicWithoutAnnotation();
+		} catch (LogicException $e) { // error: LogicException is never thrown in the corresponding try block
+
+		} catch (RuntimeException $e) { // error: RuntimeException is never thrown in the corresponding try block
+
+		}
 	}
 
 	private function someVoidMethod(): void
@@ -57,7 +65,12 @@ private function someVoidMethod(): void
 	/**
 	 * @throws LogicException
 	 */
-	private function throwLogic(): void // error: Unused @throws LogicException annotation
+	private function throwLogic(): void
+	{
+		throw new LogicException();
+	}
+
+	private function throwLogicWithoutAnnotation(): void
 	{
 		throw new LogicException();
 	}

tests/src/Rules/data/unused-catches.php

@@ -101,7 +101,7 @@ private function someVoidMethod(): void
 	/**
 	 * @throws LogicException
 	 */
-	private function throwLogic(): void // error: Unused @throws LogicException annotation
+	private function throwLogic(): void
 	{
 		throw new LogicException();
 	}

tests/src/Rules/data/unused-descriptive-throws.php

@@ -54,7 +54,12 @@ public function unusedBarAnnotation(): void // error: Unused @throws Pepakriz\PH
 	/**
 	 * @throws LogicException
 	 */
-	public function unusedLogic(): void // error: Unused @throws LogicException annotation
+	public function usedLogic(): void
+	{
+		throw new LogicException();
+	}
+
+	public function notMandatoryLogic(): void
 	{
 		throw new LogicException();
 	}