Add dateIntervalExtension (#142)

Author: VincentLanglet

extension.neon

@@ -57,6 +57,11 @@ services:
 		tags:
 			- exceptionRules.dynamicConstructorThrowTypeExtension
 
+	-
+		class: Pepakriz\PHPStanExceptionRules\Extension\DateIntervalExtension
+		tags:
+			- exceptionRules.dynamicConstructorThrowTypeExtension
+
 	-
 		class: Pepakriz\PHPStanExceptionRules\Extension\SplFileObjectExtension
 		tags:

src/Extension/DateIntervalExtension.php

@@ -0,0 +1,64 @@
+<?php declare(strict_types = 1);
+
+namespace Pepakriz\PHPStanExceptionRules\Extension;
+
+use DateInterval;
+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\ObjectType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+use PHPStan\Type\TypeUtils;
+use PHPStan\Type\VoidType;
+use function is_a;
+
+class DateIntervalExtension implements DynamicConstructorThrowTypeExtension
+{
+
+	/**
+	 * @throws UnsupportedClassException
+	 */
+	public function getThrowTypeFromConstructor(MethodReflection $methodReflection, New_ $newNode, Scope $scope): Type
+	{
+		if (is_a($methodReflection->getDeclaringClass()->getName(), DateInterval::class, true)) {
+			return $this->resolveThrowType($newNode->args, $scope);
+		}
+
+		throw new UnsupportedClassException();
+	}
+
+	/**
+	 * @param Arg[] $args
+	 */
+	private function resolveThrowType(array $args, Scope $scope): Type
+	{
+		$exceptionType = new ObjectType(Exception::class);
+		if (!isset($args[0])) {
+			return $exceptionType;
+		}
+
+		$valueType = $scope->getType($args[0]->value);
+		foreach (TypeUtils::getConstantStrings($valueType) as $constantString) {
+			try {
+				new DateInterval($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

@@ -5,6 +5,7 @@
 use Pepakriz\PHPStanExceptionRules\CheckedExceptionService;
 use Pepakriz\PHPStanExceptionRules\DefaultThrowTypeService;
 use Pepakriz\PHPStanExceptionRules\DynamicThrowTypeService;
+use Pepakriz\PHPStanExceptionRules\Extension\DateIntervalExtension;
 use Pepakriz\PHPStanExceptionRules\Extension\DateTimeExtension;
 use Pepakriz\PHPStanExceptionRules\Extension\DOMDocumentExtension;
 use Pepakriz\PHPStanExceptionRules\Extension\IntdivExtension;
@@ -24,6 +25,7 @@ class PhpInternalsTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		$reflectionClassExtension = new ReflectionExtension($this->createBroker());
+		$dateIntervalExtension = new DateIntervalExtension();
 		$dateTimeExtension = new DateTimeExtension();
 		$splFileObjectExtension = new SplFileObjectExtension();
 		$jsonEncodeDecodeExtension = new JsonEncodeDecodeExtension();
@@ -43,6 +45,7 @@ protected function getRule(): Rule
 				[],
 				[
 					$reflectionClassExtension,
+					$dateIntervalExtension,
 					$dateTimeExtension,
 					$splFileObjectExtension,
 				],

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

@@ -2,6 +2,7 @@
 
 namespace Pepakriz\PHPStanExceptionRules\Rules\PhpInternalFunctions;
 
+use DateInterval;
 use DateTime;
 use DateTimeImmutable;
 use DOMDocument;
@@ -105,6 +106,16 @@ public function testDateTime(): void
 		new DateTime(rand(0, 1) === 0 ? '2018-01-01' : 123); // error: Missing @throws Exception annotation
 	}
 
+	/**
+	 * @requires PHP 7.3
+	 */
+	public function testDateInterval(): void
+	{
+		new DateInterval(null); // error: Missing @throws Exception annotation
+		new DateInterval('P10D');
+		new DateInterval('invalid format'); // error: Missing @throws Exception annotation
+	}
+
 	public function testSplFileObject(): void
 	{
 		new SplFileObject(); // error: Missing @throws LogicException annotation; Missing @throws RuntimeException annotation