Option for reporting all unused catch statements (#13)

Author: pepakriz

README.md

@@ -44,6 +44,7 @@ includes:
 
 parameters:
 	exceptionRules:
+		reportUnusedCatchesOfUncheckedExceptions: false
 		checkedExceptions:
 			- RuntimeException
 ```

extension.neon

@@ -1,6 +1,6 @@
 parameters:
 	exceptionRules:
-		reportMaybes: true
+		reportUnusedCatchesOfUncheckedExceptions: false
 		checkedExceptions: []
 		uncheckedExceptions: []
 		methodThrowTypeDeclarations: []
@@ -22,6 +22,8 @@ services:
 
 	-
 		class: Pepakriz\PHPStanExceptionRules\Rules\ThrowsPhpDocRule
+		arguments:
+			reportUnusedCatchesOfUncheckedExceptions: %exceptionRules.reportUnusedCatchesOfUncheckedExceptions%
 		tags: [phpstan.rules.rule]
 
 	-

phpstan.neon.dist

@@ -12,6 +12,7 @@ parameters:
 		- %rootDir%/../../../tests/*/data/*
 
 	exceptionRules:
+		reportUnusedCatchesOfUncheckedExceptions: true
 		uncheckedExceptions:
 			- LogicException
 			- PHPStan\ShouldNotHappenException

src/Rules/ThrowsPhpDocRule.php

@@ -67,16 +67,23 @@ class ThrowsPhpDocRule implements Rule
 	 */
 	private $throwsScope;
 
+	/**
+	 * @var bool
+	 */
+	private $reportUnusedCatchesOfUncheckedExceptions;
+
 	public function __construct(
 		CheckedExceptionService $checkedExceptionService,
 		DynamicThrowTypeService $dynamicThrowTypeService,
-		Broker $broker
+		Broker $broker,
+		bool $reportUnusedCatchesOfUncheckedExceptions
 	)
 	{
 		$this->checkedExceptionService = $checkedExceptionService;
 		$this->dynamicThrowTypeService = $dynamicThrowTypeService;
 		$this->broker = $broker;
 		$this->throwsScope = new ThrowsScope();
+		$this->reportUnusedCatchesOfUncheckedExceptions = $reportUnusedCatchesOfUncheckedExceptions;
 	}
 
 	public function getNodeType(): string
@@ -391,13 +398,19 @@ private function processCatch(Catch_ $node): array
 				}
 			}
 
-			$caughtExceptions = $this->checkedExceptionService->filterCheckedExceptions($caughtExceptions);
-			if (count($caughtExceptions) > 0) {
+			$exceptionClass = $type->toString();
+			if (
+				!$this->reportUnusedCatchesOfUncheckedExceptions
+				&& !$this->checkedExceptionService->isCheckedException($exceptionClass)
+			) {
 				continue;
 			}
 
-			$exceptionClass = $type->toString();
-			if (!$this->checkedExceptionService->isCheckedException($exceptionClass)) {
+			if (!$this->reportUnusedCatchesOfUncheckedExceptions) {
+				$caughtExceptions = $this->checkedExceptionService->filterCheckedExceptions($caughtExceptions);
+			}
+
+			if (count($caughtExceptions) > 0) {
 				continue;
 			}
 

tests/src/Rules/ThrowsPhpDocRuleTest.php

@@ -15,6 +15,11 @@
 class ThrowsPhpDocRuleTest extends RuleTestCase
 {
 
+	/**
+	 * @var bool
+	 */
+	private $reportUnusedCatchesOfUncheckedExceptions = false;
+
 	protected function getRule(): Rule
 	{
 		$throwsRule = new ThrowsPhpDocRule(
@@ -31,7 +36,8 @@ protected function getRule(): Rule
 			], [
 				new DynamicFunctionExtension(),
 			]),
-			$this->createBroker()
+			$this->createBroker(),
+			$this->reportUnusedCatchesOfUncheckedExceptions
 		);
 
 		return $throwsRule;
@@ -57,6 +63,12 @@ public function testUnusedCatches(): void
 		$this->analyse(__DIR__ . '/data/unused-catches.php');
 	}
 
+	public function testAllUnusedCatches(): void
+	{
+		$this->reportUnusedCatchesOfUncheckedExceptions = true;
+		$this->analyse(__DIR__ . '/data/unused-catches-all.php');
+	}
+
 	public function testIterators(): void
 	{
 		$this->analyse(__DIR__ . '/data/iterators.php');

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

@@ -0,0 +1,66 @@
+<?php declare(strict_types = 1);
+
+namespace Pepakriz\PHPStanExceptionRules\Rules\UnusedCatchesAll;
+
+use LogicException;
+use RuntimeException;
+
+class FooException extends RuntimeException
+{
+
+}
+
+class UnusedCatches
+{
+
+	public function nestedUnusedCatch(): void
+	{
+		try {
+			try {
+				throw new FooException();
+			} catch (LogicException $e) { // error: LogicException is never thrown in the corresponding try block
+
+			} catch (RuntimeException $e) {
+
+			}
+		} catch (FooException $e) { // error: Pepakriz\PHPStanExceptionRules\Rules\UnusedCatchesAll\FooException is never thrown in the corresponding try block
+
+		}
+	}
+
+	public function correctCatchMethodCall(): void
+	{
+		try {
+			$this->someVoidMethod();
+		} 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
+
+		}
+	}
+
+	public function correctCatchMethodCallWithThrows(): void
+	{
+		try {
+			$this->throwLogic();
+		} catch (LogicException $e) {
+
+		} catch (RuntimeException $e) { // error: RuntimeException is never thrown in the corresponding try block
+
+		}
+	}
+
+	private function someVoidMethod(): void
+	{
+	}
+
+	/**
+	 * @throws LogicException
+	 */
+	private function throwLogic(): void // error: Unused @throws LogicException annotation
+	{
+		throw new LogicException();
+	}
+
+}
+

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

@@ -71,5 +71,39 @@ public function nestedUnusedCatch(): void
 		}
 	}
 
+	public function correctCatchMethodCall(): void
+	{
+		try {
+			$this->someVoidMethod();
+		} catch (LogicException $e) {
+
+		} catch (RuntimeException $e) { // error: RuntimeException is never thrown in the corresponding try block
+
+		}
+	}
+
+	public function correctCatchMethodCallWithThrows(): void
+	{
+		try {
+			$this->throwLogic();
+		} catch (LogicException $e) {
+
+		} catch (RuntimeException $e) { // error: RuntimeException is never thrown in the corresponding try block
+
+		}
+	}
+
+	private function someVoidMethod(): void
+	{
+	}
+
+	/**
+	 * @throws LogicException
+	 */
+	private function throwLogic(): void // error: Unused @throws LogicException annotation
+	{
+		throw new LogicException();
+	}
+
 }