Consider default exceptions as possibly thrown exceptions (#59)

Author: marcospassos

src/Rules/ThrowsPhpDocRule.php

@@ -5,10 +5,13 @@
 use Iterator;
 use IteratorAggregate;
 use Pepakriz\PHPStanExceptionRules\CheckedExceptionService;
+use Pepakriz\PHPStanExceptionRules\DefaultThrowTypeService;
 use Pepakriz\PHPStanExceptionRules\DynamicThrowTypeService;
 use Pepakriz\PHPStanExceptionRules\Node\FunctionEnd;
 use Pepakriz\PHPStanExceptionRules\Node\TryCatchTryEnd;
 use Pepakriz\PHPStanExceptionRules\ThrowsAnnotationReader;
+use Pepakriz\PHPStanExceptionRules\UnsupportedClassException;
+use Pepakriz\PHPStanExceptionRules\UnsupportedFunctionException;
 use PhpParser\Node;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\FuncCall;
@@ -65,6 +68,11 @@ class ThrowsPhpDocRule implements Rule
 	 */
 	private $dynamicThrowTypeService;
 
+	/**
+	 * @var DefaultThrowTypeService
+	 */
+	private $defaultThrowTypeService;
+
 	/**
 	 * @var ThrowsAnnotationReader
 	 */
@@ -93,6 +101,7 @@ class ThrowsPhpDocRule implements Rule
 	public function __construct(
 		CheckedExceptionService $checkedExceptionService,
 		DynamicThrowTypeService $dynamicThrowTypeService,
+		DefaultThrowTypeService $defaultThrowTypeService,
 		ThrowsAnnotationReader $throwsAnnotationReader,
 		Broker $broker,
 		bool $reportUnusedCatchesOfUncheckedExceptions,
@@ -101,6 +110,7 @@ public function __construct(
 	{
 		$this->checkedExceptionService = $checkedExceptionService;
 		$this->dynamicThrowTypeService = $dynamicThrowTypeService;
+		$this->defaultThrowTypeService = $defaultThrowTypeService;
 		$this->throwsAnnotationReader = $throwsAnnotationReader;
 		$this->broker = $broker;
 		$this->throwsScope = new ThrowsScope();
@@ -438,26 +448,41 @@ private function filterUnusedExceptions(array $declaredThrows, array $usedThrows
 		$checkedThrowsAnnotations = $this->checkedExceptionService->filterCheckedExceptions($usedThrowsAnnotations);
 		$unusedThrows = array_diff($declaredThrows, $checkedThrowsAnnotations);
 
-		if (!$this->ignoreDescriptiveUncheckedExceptions) {
-			return $unusedThrows;
-		}
-
 		$functionReflection = $scope->getFunction();
 		if ($functionReflection === null) {
 			return $unusedThrows;
 		}
 
+		try {
+			if ($functionReflection instanceof MethodReflection) {
+				$defaultThrowsType = $functionReflection->getName() === '__construct' ?
+					$this->defaultThrowTypeService->getConstructorThrowType($functionReflection) :
+					$this->defaultThrowTypeService->getMethodThrowType($functionReflection);
+			} else {
+				$defaultThrowsType = $this->defaultThrowTypeService->getFunctionThrowType($functionReflection);
+			}
+		} catch (UnsupportedClassException | UnsupportedFunctionException $exception) {
+			$defaultThrowsType = new VoidType();
+		}
+
+		$unusedThrows = array_diff($unusedThrows, TypeUtils::getDirectClassNames($defaultThrowsType));
+
 		try {
 			if ($functionReflection instanceof MethodReflection) {
 				$nativeClassReflection = $functionReflection->getDeclaringClass()->getNativeReflection();
 				$nativeFunctionReflection = $nativeClassReflection->getMethod($functionReflection->getName());
+
 			} else {
 				$nativeFunctionReflection = new ReflectionFunction($functionReflection->getName());
 			}
 		} catch (ReflectionException $exception) {
 			return $unusedThrows;
 		}
 
+		if (!$this->ignoreDescriptiveUncheckedExceptions) {
+			return $unusedThrows;
+		}
+
 		$throwsAnnotations = $this->throwsAnnotationReader->read($nativeFunctionReflection);
 
 		return array_filter($unusedThrows, static function (string $type) use ($throwsAnnotations, $usedThrowsAnnotations): bool {

tests/src/Rules/PhpInternalsTest.php

@@ -3,6 +3,7 @@
 namespace Pepakriz\PHPStanExceptionRules\Rules;
 
 use Pepakriz\PHPStanExceptionRules\CheckedExceptionService;
+use Pepakriz\PHPStanExceptionRules\DefaultThrowTypeService;
 use Pepakriz\PHPStanExceptionRules\DynamicThrowTypeService;
 use Pepakriz\PHPStanExceptionRules\Extension\DateTimeExtension;
 use Pepakriz\PHPStanExceptionRules\Extension\JsonEncodeDecodeExtension;
@@ -36,6 +37,7 @@ protected function getRule(): Rule
 					$jsonEncodeDecodeExtension,
 				]
 			),
+			new DefaultThrowTypeService([], []),
 			$this->createThrowsAnnotationReader(),
 			$this->createBroker(),
 			true,

tests/src/Rules/ThrowsPhpDocRuleTest.php

@@ -8,6 +8,8 @@
 use Pepakriz\PHPStanExceptionRules\DynamicThrowTypeService;
 use Pepakriz\PHPStanExceptionRules\Rules\Data\CheckedException;
 use Pepakriz\PHPStanExceptionRules\Rules\DynamicExtension\DynamicExtension;
+use Pepakriz\PHPStanExceptionRules\Rules\UnusedCatches\FooException;
+use Pepakriz\PHPStanExceptionRules\Rules\UnusedCatches\UnusedCatches;
 use Pepakriz\PHPStanExceptionRules\RuleTestCase;
 use PharData;
 use PHPStan\Rules\Rule;
@@ -27,19 +29,26 @@ class ThrowsPhpDocRuleTest extends RuleTestCase
 	 */
 	private $ignoreDescriptiveUncheckedExceptions = false;
 
+	/**
+	 * @var mixed[]
+	 */
+	private $methodThrowTypes = [];
+
+	/**
+	 * @var mixed[]
+	 */
+	private $functionThrowTypes = [];
+
 	protected function getRule(): Rule
 	{
+		$defaultThrowTypeService = new DefaultThrowTypeService(
+			$this->methodThrowTypes,
+			$this->functionThrowTypes
+		);
+
 		$extensions = [
 			new DynamicExtension(),
-			new DefaultThrowTypeExtension(
-				new DefaultThrowTypeService([
-					PharData::class => [
-						'extractTo' => [
-							RuntimeException::class,
-						],
-					],
-				], [])
-			),
+			new DefaultThrowTypeExtension($defaultThrowTypeService),
 		];
 
 		return new ThrowsPhpDocRule(
@@ -56,6 +65,7 @@ protected function getRule(): Rule
 				$extensions,
 				$extensions
 			),
+			$defaultThrowTypeService,
 			$this->createThrowsAnnotationReader(),
 			$this->createBroker(),
 			$this->reportUnusedCatchesOfUncheckedExceptions,
@@ -80,6 +90,19 @@ public function testUnusedThrows(): void
 
 	public function testUnusedCatches(): void
 	{
+		$this->methodThrowTypes = [
+			PharData::class => [
+				'extractTo' => [
+					RuntimeException::class,
+				],
+			],
+			UnusedCatches::class => [
+				'methodWithDefaultThrowType' => [
+					FooException::class,
+				],
+			],
+		];
+
 		$this->analyse(__DIR__ . '/data/unused-catches.php');
 	}
 

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

@@ -115,5 +115,12 @@ private function dynamicThrowType(): void
 		}
 	}
 
-}
+	/**
+	 * @throws FooException
+	 */
+	private function methodWithDefaultThrowType(callable $callable): void
+	{
+		$callable();
+	}
 
+}