More precise types after Option::filter()

Author: devnix

extension.neon

@@ -20,3 +20,8 @@ services:
 		class: Psl\PHPStan\Type\MatchesTypeSpecifyingExtension
 		tags:
 			- phpstan.typeSpecifier.methodTypeSpecifyingExtension
+
+	-
+		class: Psl\PHPStan\Option\OptionFilterReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicMethodReturnTypeExtension

src/Option/OptionFilterReturnTypeExtension.php

@@ -0,0 +1,72 @@
+<?php declare(strict_types = 1);
+
+namespace Psl\PHPStan\Option;
+
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Name;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\Expr\TypeExpr;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Generic\GenericObjectType;
+use PHPStan\Type\IntegerType;
+use PHPStan\Type\Type;
+use Psl\Option\Option;
+
+class OptionFilterReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	public function getClass(): string
+	{
+		return Option::class;
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'filter';
+	}
+
+	public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type
+	{
+		$args = $methodCall->getArgs();
+		if (!isset($args[0])) {
+			return null;
+		}
+		$filterCallback = $args[0]->value;
+
+		$optionType = $scope->getType($methodCall->var);
+		$originalType = $optionType->getTemplateType(Option::class, 'T');
+
+		$refinedType = $this->analyzeFilterCallback($filterCallback, $originalType, $scope);
+
+		return new GenericObjectType(
+			Option::class,
+			[$refinedType]
+		);
+	}
+
+	private function analyzeFilterCallback(Expr $filterCallback, Type $originalType, Scope $scope): Type
+	{
+		$arrayType = new ArrayType(new IntegerType(), $originalType);
+
+		$refinedType = $scope
+			->getType(
+				new FuncCall(
+					new Name('array_filter'),
+					[new Arg(new TypeExpr($arrayType)), new Arg($filterCallback)]
+				)
+			)
+			->getIterableValueType();
+
+		if (!$refinedType->equals($originalType)) {
+			return $refinedType;
+		}
+
+		return $originalType;
+	}
+
+}

tests/Option/PslTypeSpecifyingExtensionTest.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types = 1);
+
+namespace Psl\PHPStan\Option;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class PslTypeSpecifyingExtensionTest extends TypeInferenceTestCase
+{
+
+	/**
+	 * @return iterable<mixed>
+	 */
+	public function dataFileAsserts(): iterable
+	{
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/filter.php');
+	}
+
+	/**
+	 * @dataProvider dataFileAsserts
+	 * @param mixed ...$args
+	 */
+	public function testFileAsserts(
+		string $assertType,
+		string $file,
+		...$args
+	): void
+	{
+		$this->assertFileAsserts($assertType, $file, ...$args);
+	}
+
+	/***
+	 * @return string[]
+	 */
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [__DIR__ . '/../../extension.neon'];
+	}
+
+}

tests/Option/data/filter.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PslOptionTest;
+
+use Psl\Option;
+
+use function PHPStan\Testing\assertType;
+
+
+function positive_int(int $value): void
+{
+	$option = Option\some($value);
+	$option = $option->filter(fn($value) => $value > 0);
+	assertType('Psl\Option\Option<int<1, max>>', $option);
+
+	$option = Option\some($value);
+	$option = $option->filter(\Psl\Type\positive_int()->matches(...));
+	assertType('Psl\Option\Option<int<1, max>>', $option);
+}
+
+function non_empty_string(string $value): void
+{
+	$option = Option\some($value);
+	$option = $option->filter(fn($value) => '' !== $value);
+	assertType('Psl\Option\Option<non-empty-string>', $option);
+
+	$option = Option\some($value);
+	$option = $option->filter(\Psl\Type\non_empty_string()->matches(...));
+	assertType('Psl\Option\Option<non-empty-string>', $option);
+}
+
+
+function numeric_string(string $value): void
+{
+	$option = Option\some($value);
+	$option = $option->filter(fn($value) => is_numeric($value));
+	assertType('Psl\Option\Option<numeric-string>', $option);
+
+	$option = Option\some($value);
+	$option = $option->filter(is_numeric(...));
+	assertType('Psl\Option\Option<numeric-string>', $option);
+
+	$option = Option\some($value);
+	$option = $option->filter(\Psl\Type\numeric_string()->matches(...));
+	assertType('Psl\Option\Option<numeric-string>', $option);
+}
+
+function literal_string(string $value): void
+{
+	$option = Option\some($value);
+	$option = $option->filter(fn($value) => 'potato' === $value);
+	assertType('Psl\Option\Option<\'potato\'>', $option);
+
+	$option = Option\some($value);
+	$option = $option->filter(fn ($value) => 'potato' === $value || 'tomato' === $value);
+	assertType('Psl\Option\Option<\'potato\'|\'tomato\'>', $option);
+
+	$option = Option\some($value);
+	$option = $option->filter(fn ($value) => in_array($value, ['potato', 'tomato'], true));
+	assertType('Psl\Option\Option<\'potato\'|\'tomato\'>', $option);
+
+	$option = Option\some($value);
+	$option = $option->filter(\Psl\Type\literal_string('potato')->matches(...));
+	assertType('Psl\Option\Option<\'potato\'>', $option);
+}
+
+
+/**
+ * @param list<float> $value
+ */
+function filter_list(array $value): void
+{
+	$option = Option\some($value);
+	assertType('Psl\Option\Option<list<float>>', $option);
+	$option = $option->filter(fn($value) => [] !== $value);
+	assertType('Psl\Option\Option<non-empty-list<float>>', $option);
+
+	$option = Option\some($value);
+	assertType('Psl\Option\Option<list<float>>', $option);
+	$option = $option->filter(\Psl\Type\non_empty_list()->matches(...));
+	assertType('Psl\Option\Option<non-empty-list<float>>', $option);
+}
+