Support for Assert\that* functions

Author: ondrejmirtes

README.md

@@ -32,6 +32,8 @@ This extension specifies types of values passed to:
 
 `Assert::that`, `Assert::thatNullOr` and `Assert::thatAll` chaining methods are also supported.
 
+`Assert\that`, `Assert\thatNullOr` and `Assert\thatAll` functions are supported too.
+
 ## Usage
 
 To use this extension, require it in [Composer](https://getcomposer.org/):

extension.neon

@@ -13,6 +13,10 @@ services:
 		class: PHPStan\Type\BeberleiAssert\AssertThatDynamicMethodReturnTypeExtension
 		tags:
 			- phpstan.broker.dynamicStaticMethodReturnTypeExtension
+	-
+		class: PHPStan\Type\BeberleiAssert\AssertThatFunctionDynamicReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicFunctionReturnTypeExtension
 
 	-
 		class: PHPStan\Type\BeberleiAssert\AssertTypeSpecifyingExtension

src/Type/BeberleiAssert/AssertThatFunctionDynamicReturnTypeExtension.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\BeberleiAssert;
+
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+
+class AssertThatFunctionDynamicReturnTypeExtension implements \PHPStan\Type\DynamicFunctionReturnTypeExtension
+{
+
+	public function isFunctionSupported(
+		FunctionReflection $functionReflection
+	): bool
+	{
+		return in_array($functionReflection->getName(), [
+			'Assert\\that',
+			'Assert\\thatNullOr',
+			'Assert\\thatAll',
+		], true);
+	}
+
+	public function getTypeFromFunctionCall(
+		FunctionReflection $functionReflection,
+		\PhpParser\Node\Expr\FuncCall $functionCall,
+		Scope $scope
+	): \PHPStan\Type\Type
+	{
+		if (count($functionCall->args) === 0) {
+			return $functionReflection->getReturnType();
+		}
+
+		$valueExpr = $functionCall->args[0]->value;
+		$type = new AssertThatType($valueExpr, $scope->getType($valueExpr));
+		if ($functionReflection->getName() === 'Assert\\thatNullOr') {
+			return $type->toNullOr();
+		} elseif ($functionReflection->getName() === 'Assert\\thatAll') {
+			return $type->toAll();
+		}
+
+		return $type;
+	}
+
+}

tests/Type/BeberleiAssert/AssertTypeSpecifyingExtensionTest.php

@@ -57,7 +57,9 @@ public function getDynamicStaticMethodReturnTypeExtensions(): array
 	 */
 	public function getDynamicFunctionReturnTypeExtensions(): array
 	{
-		return [];
+		return [
+			new AssertThatFunctionDynamicReturnTypeExtension(),
+		];
 	}
 
 	public function testExtension(): void
@@ -227,6 +229,18 @@ public function testExtension(): void
 				'Variable $f is: array<string>',
 				145,
 			],
+			[
+				'Variable $assertThatFunction is: Assert\AssertionChain<mixed>',
+				148,
+			],
+			[
+				'Variable $assertThatNullOrFunction is: Assert\AssertionChain<mixed>-nullOr',
+				151,
+			],
+			[
+				'Variable $assertThatAllFunction is: Assert\AssertionChain<mixed>-all',
+				154,
+			],
 		]);
 	}
 

tests/Type/BeberleiAssert/data/data.php

@@ -110,7 +110,7 @@ public function doFoo($a, $b, array $c, iterable $d, $e, $f, $g, $h, $i, $j, $k,
 		$ab;
 	}
 
-	public function doBar(?int $a, $b, $c, array $d, iterable $e)
+	public function doBar(?int $a, $b, $c, array $d, iterable $e, $g)
 	{
 		$that = Assert::that($a);
 		$that;
@@ -143,6 +143,15 @@ public function doBar(?int $a, $b, $c, array $d, iterable $e)
 		$f = doFoo();
 		Assert::thatAll($f)->notNull();
 		$f;
+
+		$assertThatFunction = \Assert\that($g);
+		$assertThatFunction;
+
+		$assertThatNullOrFunction = \Assert\thatNullOr($g);
+		$assertThatNullOrFunction;
+
+		$assertThatAllFunction = \Assert\thatAll($g);
+		$assertThatAllFunction;
 	}
 
 }