Merge pull request #255 from brambaud/feat/url-to-string

Support dynamic return type of Drupal\Core\Url::toString

Author: mglaman

extension.neon

@@ -67,6 +67,9 @@ services:
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+	-
+		class: mglaman\PHPStanDrupal\Type\UrlToStringDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\DrupalClassResolverDynamicStaticReturnTypeExtension
 		tags: [phpstan.broker.dynamicStaticMethodReturnTypeExtension]

src/Type/UrlToStringDynamicReturnTypeExtension.php

@@ -0,0 +1,50 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Type;
+
+use Drupal\Core\GeneratedUrl;
+use Drupal\Core\Url;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+
+final class UrlToStringDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+    public function getClass(): string
+    {
+        return Url::class;
+    }
+
+    public function isMethodSupported(MethodReflection $methodReflection): bool
+    {
+        return $methodReflection->getName() === 'toString';
+    }
+
+    public function getTypeFromMethodCall(
+        MethodReflection $methodReflection,
+        MethodCall $methodCall,
+        Scope $scope
+    ): Type {
+        if (0 === \count($methodCall->getArgs())) {
+            return new StringType();
+        }
+
+        $arg1 = $scope->getType($methodCall->getArgs()[0]->value);
+        if (!$arg1 instanceof ConstantBooleanType) {
+            return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+        }
+
+        if (true === $arg1->getValue()) {
+            return new ObjectType(GeneratedUrl::class);
+        }
+
+        return new StringType();
+    }
+}

tests/src/Type/UrlDynamicReturnTypeTest.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Type;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class UrlDynamicReturnTypeTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public function dataFileAsserts(): iterable
+    {
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/url.php');
+    }
+
+    /**
+     * @dataProvider dataFileAsserts
+     * @param string $assertType
+     * @param string $file
+     * @param mixed ...$args
+     */
+    public function testFileAsserts(
+        string $assertType,
+        string $file,
+        ...$args
+    ): void
+    {
+        $this->assertFileAsserts($assertType, $file, ...$args);
+    }
+}

tests/src/Type/data/url.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace DrupalUrl;
+
+use Drupal\Core\Url;
+use Symfony\Component\HttpFoundation\Request;
+use function PHPStan\Testing\assertType;
+
+assertType('string', (new Url('route_name'))->toString());
+assertType('string', Url::fromRoute('route_name')->toString());
+assertType('string', Url::fromRouteMatch(\Drupal::routeMatch())->toString());
+assertType('string', Url::fromUri('the_uri')->toString());
+assertType('string', Url::fromUserInput('user_input')->toString());
+assertType('string', Url::createFromRequest(new Request())->toString());
+assertType('string', (new Url('route_name'))->toString(FALSE));
+assertType('string', Url::fromRoute('route_name')->toString(FALSE));
+assertType('string', Url::fromRouteMatch(\Drupal::routeMatch())->toString(FALSE));
+assertType('string', Url::fromUri('the_uri')->toString(FALSE));
+assertType('string', Url::fromUserInput('user_input')->toString(FALSE));
+assertType('string', Url::createFromRequest(new Request())->toString(FALSE));
+assertType('Drupal\Core\GeneratedUrl', (new Url('route_name'))->toString(TRUE));
+assertType('Drupal\Core\GeneratedUrl', Url::fromRoute('route_name')->toString(TRUE));
+assertType('Drupal\Core\GeneratedUrl', Url::fromRouteMatch(\Drupal::routeMatch())->toString(TRUE));
+assertType('Drupal\Core\GeneratedUrl', Url::fromUri('the_uri')->toString(TRUE));
+assertType('Drupal\Core\GeneratedUrl', Url::fromUserInput('user_input')->toString(TRUE));
+assertType('Drupal\Core\GeneratedUrl', Url::createFromRequest(new Request())->toString(TRUE));