Global scope support (fixed #65 #64) (#66)

Author: pepakriz

README.md

@@ -23,6 +23,7 @@ This extension provides following rules and features:
 * Unreachable catch statements
 	* exception has been caught in some previous catch statement ([examples](https://github.com/pepakriz/phpstan-exception-rules/blob/master/tests/src/Rules/data/unreachable-catches.php))
 	* checked exception is never thrown in the corresponding try block ([examples](https://github.com/pepakriz/phpstan-exception-rules/blob/master/tests/src/Rules/data/unused-catches.php))
+* Report throwing checked exceptions in the global scope ([examples](https://github.com/pepakriz/phpstan-exception-rules/blob/master/tests/src/Rules/data/throws-in-global-scope.php))
 
 Features and rules provided by PHPStan core (we rely on):
 
@@ -46,6 +47,7 @@ includes:
 parameters:
 	exceptionRules:
 		reportUnusedCatchesOfUncheckedExceptions: false
+		reportCheckedThrowsInGlobalScope: false
 		ignoreDescriptiveUncheckedExceptions: false
 		checkedExceptions:
 			- RuntimeException

extension.neon

@@ -1,6 +1,7 @@
 parameters:
 	exceptionRules:
 		reportUnusedCatchesOfUncheckedExceptions: false
+		reportCheckedThrowsInGlobalScope: false
 		ignoreDescriptiveUncheckedExceptions: false
 		checkedExceptions: []
 		uncheckedExceptions: []
@@ -46,6 +47,7 @@ services:
 		class: Pepakriz\PHPStanExceptionRules\Rules\ThrowsPhpDocRule
 		arguments:
 			reportUnusedCatchesOfUncheckedExceptions: %exceptionRules.reportUnusedCatchesOfUncheckedExceptions%
+			reportCheckedThrowsInGlobalScope: %exceptionRules.reportCheckedThrowsInGlobalScope%
 			ignoreDescriptiveUncheckedExceptions: %exceptionRules.ignoreDescriptiveUncheckedExceptions%
 		tags: [phpstan.rules.rule]
 

phpstan.neon.dist

@@ -13,6 +13,7 @@ parameters:
 
 	exceptionRules:
 		reportUnusedCatchesOfUncheckedExceptions: true
+		reportCheckedThrowsInGlobalScope: true
 		uncheckedExceptions:
 			- LogicException
 			- PHPStan\ShouldNotHappenException

src/Rules/ThrowsPhpDocRule.php

@@ -93,6 +93,11 @@ class ThrowsPhpDocRule implements Rule
 	 */
 	private $reportUnusedCatchesOfUncheckedExceptions;
 
+	/**
+	 * @var bool
+	 */
+	private $reportCheckedThrowsInGlobalScope;
+
 	/**
 	 * @var bool
 	 */
@@ -105,6 +110,7 @@ public function __construct(
 		ThrowsAnnotationReader $throwsAnnotationReader,
 		Broker $broker,
 		bool $reportUnusedCatchesOfUncheckedExceptions,
+		bool $reportCheckedThrowsInGlobalScope,
 		bool $ignoreDescriptiveUncheckedExceptions
 	)
 	{
@@ -115,6 +121,7 @@ public function __construct(
 		$this->broker = $broker;
 		$this->throwsScope = new ThrowsScope();
 		$this->reportUnusedCatchesOfUncheckedExceptions = $reportUnusedCatchesOfUncheckedExceptions;
+		$this->reportCheckedThrowsInGlobalScope = $reportCheckedThrowsInGlobalScope;
 		$this->ignoreDescriptiveUncheckedExceptions = $ignoreDescriptiveUncheckedExceptions;
 	}
 
@@ -129,7 +136,7 @@ public function getNodeType(): string
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if ($node instanceof TryCatch) {
-			return $this->processTryCatch($node, $scope);
+			return $this->processTryCatch($node);
 		}
 
 		if ($node instanceof TryCatchTryEnd) {
@@ -178,14 +185,8 @@ public function processNode(Node $node, Scope $scope): array
 	/**
 	 * @return string[]
 	 */
-	private function processTryCatch(TryCatch $node, Scope $scope): array
+	private function processTryCatch(TryCatch $node): array
 	{
-		$classReflection = $scope->getClassReflection();
-		$methodReflection = $scope->getFunction();
-		if ($classReflection === null || $methodReflection === null) {
-			return [];
-		}
-
 		$this->throwsScope->enterToTryCatch($node);
 
 		if (!$node->hasAttribute(self::ATTRIBUTE_HAS_TRY_CATCH_END)) {
@@ -216,7 +217,16 @@ private function processThrow(Throw_ $node, Scope $scope): array
 		$exceptionClassNames = $this->throwsScope->filterExceptionsByUncaught($exceptionClassNames);
 		$exceptionClassNames = $this->checkedExceptionService->filterCheckedExceptions($exceptionClassNames);
 
-		return array_map(static function (string $exceptionClassName): string {
+		$isInGlobalScope = $this->throwsScope->isInGlobalScope();
+		if (!$this->reportCheckedThrowsInGlobalScope && $isInGlobalScope) {
+			return [];
+		}
+
+		return array_map(static function (string $exceptionClassName) use ($isInGlobalScope): string {
+			if ($isInGlobalScope) {
+				return sprintf('Throwing checked exception %s in global scope is prohibited', $exceptionClassName);
+			}
+
 			return sprintf('Missing @throws %s annotation', $exceptionClassName);
 		}, $exceptionClassNames);
 	}

src/Rules/ThrowsScope.php

@@ -20,22 +20,22 @@ class ThrowsScope
 	/**
 	 * @var int
 	 */
-	private $stackIndex = -1;
+	private $stackIndex = 0;
 
 	/**
 	 * @var array<Type|null>
 	 */
-	private $throwsAnnotationBlockStack = [];
+	private $throwsAnnotationBlockStack = [null];
 
 	/**
 	 * @var bool[][]
 	 */
-	private $usedThrowsAnnotationsStack = [];
+	private $usedThrowsAnnotationsStack = [[]];
 
 	/**
 	 * @var TryCatch[][]
 	 */
-	private $tryCatchStack = [];
+	private $tryCatchStack = [[]];
 
 	public function enterToThrowsAnnotationBlock(?Type $type): void
 	{
@@ -62,6 +62,11 @@ public function exitFromThrowsAnnotationBlock(): array
 		return array_keys($usedThrowsAnnotations);
 	}
 
+	public function isInGlobalScope(): bool
+	{
+		return $this->stackIndex === 0;
+	}
+
 	public function enterToTryCatch(TryCatch $tryCatch): void
 	{
 		$this->tryCatchStack[$this->stackIndex][] = $tryCatch;

tests/src/Rules/PhpInternalsTest.php

@@ -41,6 +41,7 @@ protected function getRule(): Rule
 			$this->createThrowsAnnotationReader(),
 			$this->createBroker(),
 			true,
+			true,
 			true
 		);
 	}

tests/src/Rules/ThrowsPhpDocRuleTest.php

@@ -29,6 +29,11 @@ class ThrowsPhpDocRuleTest extends RuleTestCase
 	 */
 	private $ignoreDescriptiveUncheckedExceptions = false;
 
+	/**
+	 * @var bool
+	 */
+	private $reportCheckedThrowsInGlobalScope = false;
+
 	/**
 	 * @var mixed[]
 	 */
@@ -69,6 +74,7 @@ protected function getRule(): Rule
 			$this->createThrowsAnnotationReader(),
 			$this->createBroker(),
 			$this->reportUnusedCatchesOfUncheckedExceptions,
+			$this->reportCheckedThrowsInGlobalScope,
 			$this->ignoreDescriptiveUncheckedExceptions
 		);
 	}
@@ -149,4 +155,10 @@ public function testAnonymClass(): void
 		$this->analyse(__DIR__ . '/data/throws-anonym-class.php');
 	}
 
+	public function testThrowsInGlobalScope(): void
+	{
+		$this->reportCheckedThrowsInGlobalScope = true;
+		$this->analyse(__DIR__ . '/data/throws-in-global-scope.php');
+	}
+
 }

tests/src/Rules/data/throws-in-global-scope.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+namespace Pepakriz\PHPStanExceptionRules\Rules\ThrowsInGlobalScope;
+
+use LogicException;
+use RuntimeException;
+
+if (false) {
+	throw new LogicException();
+	throw new RuntimeException(); // error: Throwing checked exception RuntimeException in global scope is prohibited
+
+	try {
+		throw new RuntimeException();
+	} catch (RuntimeException $e) {
+		// ignore
+	}
+}