Added extension for internal DateTime (#38)

Author: pepakriz

extension.neon

@@ -29,6 +29,11 @@ services:
 		tags:
 			- exceptionRules.dynamicConstructorThrowTypeExtension
 
+	-
+		class: Pepakriz\PHPStanExceptionRules\Extension\DateTimeExtension
+		tags:
+			- exceptionRules.dynamicConstructorThrowTypeExtension
+
 	-
 		class: Pepakriz\PHPStanExceptionRules\Rules\ThrowsPhpDocRule
 		arguments:

phpcs.xml

@@ -207,7 +207,6 @@
 	<rule ref="SlevomatCodingStandard.ControlStructures.EarlyExit"/>
 	<rule ref="SlevomatCodingStandard.ControlStructures.UselessConditionWithReturn"/>
 	<rule ref="SlevomatCodingStandard.Exceptions.DeadCatch"/>
-	<rule ref="SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly" />
 	<rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure"/>
 	<rule ref="SlevomatCodingStandard.Functions.UselessParameterDefaultValue"/>
 	<rule ref="SlevomatCodingStandard.Functions.StaticClosure"/>

src/Extension/DateTimeExtension.php

@@ -0,0 +1,74 @@
+<?php declare(strict_types = 1);
+
+namespace Pepakriz\PHPStanExceptionRules\Extension;
+
+use DateTime;
+use DateTimeImmutable;
+use Exception;
+use Pepakriz\PHPStanExceptionRules\DynamicConstructorThrowTypeExtension;
+use Pepakriz\PHPStanExceptionRules\UnsupportedClassException;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\New_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\NeverType;
+use PHPStan\Type\NullType;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+use PHPStan\Type\TypeUtils;
+use PHPStan\Type\VoidType;
+use function is_a;
+
+class DateTimeExtension implements DynamicConstructorThrowTypeExtension
+{
+
+	/**
+	 * @throws UnsupportedClassException
+	 */
+	public function getThrowTypeFromConstructor(MethodReflection $methodReflection, New_ $newNode, Scope $scope): Type
+	{
+		if (
+			is_a($methodReflection->getDeclaringClass()->getName(), DateTime::class, true)
+			|| is_a($methodReflection->getDeclaringClass()->getName(), DateTimeImmutable::class, true)
+		) {
+			return $this->resolveThrowType($newNode->args, $scope);
+		}
+
+		throw new UnsupportedClassException();
+	}
+
+	/**
+	 * @param Arg[] $args
+	 */
+	private function resolveThrowType(array $args, Scope $scope): Type
+	{
+		if (!isset($args[0])) {
+			return new VoidType();
+		}
+
+		$valueType = $scope->getType($args[0]->value);
+		if ($valueType instanceof NullType) {
+			return new VoidType();
+		}
+
+		$valueType = TypeCombinator::removeNull($valueType);
+		$exceptionType = new ObjectType(Exception::class);
+		foreach (TypeUtils::getConstantStrings($valueType) as $constantString) {
+			try {
+				new DateTime($constantString->getValue());
+			} catch (Exception $e) {
+				return $exceptionType;
+			}
+
+			$valueType = TypeCombinator::remove($valueType, $constantString);
+		}
+
+		if (!$valueType instanceof NeverType) {
+			return $exceptionType;
+		}
+
+		return new VoidType();
+	}
+
+}

tests/src/Rules/PhpInternalsTest.php

@@ -0,0 +1,45 @@
+<?php declare(strict_types = 1);
+
+namespace Pepakriz\PHPStanExceptionRules\Rules;
+
+use Pepakriz\PHPStanExceptionRules\CheckedExceptionService;
+use Pepakriz\PHPStanExceptionRules\DynamicThrowTypeService;
+use Pepakriz\PHPStanExceptionRules\Extension\DateTimeExtension;
+use Pepakriz\PHPStanExceptionRules\Extension\ReflectionExtension;
+use Pepakriz\PHPStanExceptionRules\RuleTestCase;
+use PHPStan\Rules\Rule;
+use Throwable;
+
+class PhpInternalsTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		$reflectionClassExtension = new ReflectionExtension($this->createBroker());
+		$dateTimeExtension = new DateTimeExtension();
+		return new ThrowsPhpDocRule(
+			new CheckedExceptionService(
+				[
+					Throwable::class,
+				]
+			),
+			new DynamicThrowTypeService(
+				[],
+				[],
+				[
+					$reflectionClassExtension,
+					$dateTimeExtension,
+				],
+				[]
+			),
+			$this->createBroker(),
+			true
+		);
+	}
+
+	public function testPhpInternalFunctions(): void
+	{
+		$this->analyse(__DIR__ . '/data/throws-php-internal-functions.php');
+	}
+
+}

tests/src/Rules/ThrowsPhpDocRuleTest.php

@@ -4,7 +4,6 @@
 
 use Pepakriz\PHPStanExceptionRules\CheckedExceptionService;
 use Pepakriz\PHPStanExceptionRules\DynamicThrowTypeService;
-use Pepakriz\PHPStanExceptionRules\Extension\ReflectionExtension;
 use Pepakriz\PHPStanExceptionRules\Rules\Data\CheckedException;
 use Pepakriz\PHPStanExceptionRules\Rules\DynamicExtension\DynamicExtension;
 use Pepakriz\PHPStanExceptionRules\RuleTestCase;
@@ -23,7 +22,6 @@ class ThrowsPhpDocRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		$dynamicExtension = new DynamicExtension();
-		$reflectionClassExtension = new ReflectionExtension($this->createBroker());
 		return new ThrowsPhpDocRule(
 			new CheckedExceptionService(
 				[
@@ -38,7 +36,6 @@ protected function getRule(): Rule
 				$dynamicExtension,
 			], [
 				$dynamicExtension,
-				$reflectionClassExtension,
 			], [
 				$dynamicExtension,
 			]),
@@ -103,9 +100,4 @@ public function testAnonymClass(): void
 		$this->analyse(__DIR__ . '/data/throws-anonym-class.php');
 	}
 
-	public function testPhpInternalFunctions(): void
-	{
-		$this->analyse(__DIR__ . '/data/throws-php-internal-functions.php');
-	}
-
 }

tests/src/Rules/data/throws-php-internal-functions.php

@@ -2,6 +2,9 @@
 
 namespace Pepakriz\PHPStanExceptionRules\Rules\PhpInternalFunctions;
 
+use DateTime;
+use DateTimeImmutable;
+use function rand;
 use ReflectionClass;
 use ReflectionFunction;
 use ReflectionProperty;
@@ -12,7 +15,7 @@ class Example
 
 	private $property;
 
-	public function testName(): void
+	public function testReflection(): void
 	{
 		new ReflectionClass(self::class);
 		new ReflectionClass('undefinedClass'); // error: Missing @throws ReflectionException annotation
@@ -28,5 +31,38 @@ public function testName(): void
 		new ReflectionZendExtension('unknownZendExtension'); // error: Missing @throws ReflectionException annotation
 	}
 
+	public function testDateTime(): void
+	{
+		new DateTime();
+		new DateTime(null);
+		new DateTime('2018-01-01');
+		new DateTime('invalid format'); // error: Missing @throws Exception annotation
+
+		new DateTimeImmutable();
+		new DateTimeImmutable(null);
+		new DateTimeImmutable('2018-01-01');
+		new DateTimeImmutable('invalid format'); // error: Missing @throws Exception annotation
+
+		$date1 = '2018-01-01';
+		if (rand(0, 1) === 0) {
+			$date1 = '2019-01-01';
+		}
+		new DateTime($date1);
+
+		if (rand(0, 1) === 0) {
+			$date2 = '2019-01-01';
+		} else {
+			$date2 = null;
+		}
+		new DateTime($date2);
+
+		if (rand(0, 1) === 0) {
+			$date3 = '2019-01-01';
+		} else {
+			$date3 = 123;
+		}
+		new DateTime($date3); // error: Missing @throws Exception annotation
+	}
+
 }