Handle subject return type

Author: akondas

extension.neon

@@ -4,7 +4,7 @@ services:
         tags: [phpstan.broker.methodsClassReflectionExtension]
 
 extensions:
-    phpspec: Proget\PHPStan\PhpSpec\DependencyInjection\PhpSpecDynamicMethodReturnTypeExtensionCreator
+    phpspec: Proget\PHPStan\PhpSpec\DependencyInjection\CollaboratorExtension
 
 parameters:
     specDirs:

spec/Proget/Tests/PHPStan/PhpSpec/FooSpec.php

@@ -7,6 +7,7 @@
 use Proget\Tests\PHPStan\PhpSpec\Baz;
 use Proget\Tests\PHPStan\PhpSpec\Foo;
 use PhpSpec\ObjectBehavior;
+use Proget\Tests\PHPStan\PhpSpec\ValueObject;
 
 class FooSpec extends ObjectBehavior
 {
@@ -26,4 +27,13 @@ public function it_should_make_baz(Baz $baz): void
 
         $this->makeBaz()->shouldBe(123);
     }
+
+    public function it_should_make_value_object_with_provided_string(): void
+    {
+        $vo = $this->makeValueObject('php-ml is awesome'); // little product placement XD
+
+        $vo->shouldBeAnInstanceOf(ValueObject::class);
+        $vo->string()->shouldEqual('php-ml is awesome');
+        $vo->copy()->copy()->string()->shouldEqual('php-ml is awesome');
+    }
 }

…amicMethodReturnTypeExtensionCreator.php …dencyInjection/CollaboratorExtension.phpsrc/DependencyInjection/PhpSpecDynamicMethodReturnTypeExtensionCreator.php renamed to src/DependencyInjection/CollaboratorExtension.php src/DependencyInjection/PhpSpecDynamicMethodReturnTypeExtensionCreator.php renamed to src/DependencyInjection/CollaboratorExtension.php

@@ -8,28 +8,34 @@
 use Nette\DI\ServiceDefinition;
 use Proget\PHPStan\PhpSpec\Extractor\CollaboratorExtractor;
 use Proget\PHPStan\PhpSpec\Locator\SpecClassLocator;
-use Proget\PHPStan\PhpSpec\Reflection\CollaboratorDynamicMethodReturnTypeExtension;
+use Proget\PHPStan\PhpSpec\Type\CollaboratorDynamicMethodReturnTypeExtension;
 
-final class PhpSpecDynamicMethodReturnTypeExtensionCreator extends CompilerExtension
+final class CollaboratorExtension extends CompilerExtension
 {
     public function beforeCompile()
     {
         $builder = $this->getContainerBuilder();
         $workingDir = $this->getContainerBuilder()->parameters['currentWorkingDirectory'];
+
         $specClasses = (new SpecClassLocator())->locate(array_map(function (string $dir) use ($workingDir) {
             return $workingDir.DIRECTORY_SEPARATOR.ltrim($dir, DIRECTORY_SEPARATOR);
         }, $this->getContainerBuilder()->parameters['specDirs']));
 
-        foreach ((new CollaboratorExtractor())->extract($specClasses) as $class) {
-            $definition = new ServiceDefinition();
-            $definition->addTag('phpstan.broker.dynamicMethodReturnTypeExtension');
-            $definition->setType(CollaboratorDynamicMethodReturnTypeExtension::class);
-            $definition->setArguments([$class]);
-
+        foreach ((new CollaboratorExtractor())->extract($specClasses) as $collaboratorClass) {
             $builder->addDefinition(
-                'collaborator.'.strtolower((string) preg_replace('/[^a-zA-Z0-9]+/', '', $class)),
-                $definition
+                'collaborator.'.strtolower((string) preg_replace('/[^a-zA-Z0-9]+/', '', $collaboratorClass)),
+                $this->createCollaboratorDefinition($collaboratorClass)
             );
         }
     }
+
+    private function createCollaboratorDefinition(string $collaboratorClass): ServiceDefinition
+    {
+        $definition = new ServiceDefinition();
+        $definition->addTag('phpstan.broker.dynamicMethodReturnTypeExtension');
+        $definition->setType(CollaboratorDynamicMethodReturnTypeExtension::class);
+        $definition->setArguments([$collaboratorClass]);
+
+        return $definition;
+    }
 }

src/Locator/SpecClassLocator.php

@@ -9,6 +9,11 @@
 
 final class SpecClassLocator
 {
+    /**
+     * @param string[] $dirs
+     *
+     * @return string[]
+     */
     public function locate(array $dirs): array
     {
         $finder = (new Finder())->in($dirs)->name('*.php');

src/Reflection/ObjectBehaviorMethodsClassReflectionExtension.php

@@ -9,15 +9,14 @@
 use PhpSpec\Locator\ResourceLocator;
 use PhpSpec\ObjectBehavior;
 use PhpSpec\Util\Filesystem;
-use PhpSpec\Wrapper\Subject;
 use PHPStan\Analyser\OutOfClassScope;
 use PHPStan\Broker\Broker;
 use PHPStan\Reflection\BrokerAwareExtension;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\MethodsClassReflectionExtension;
-use PHPStan\Type\ObjectType;
 use Proget\PHPStan\PhpSpec\Exception\SpecSourceClassNotFound;
+use Proget\PHPStan\PhpSpec\Type\SubjectType;
 
 final class ObjectBehaviorMethodsClassReflectionExtension implements MethodsClassReflectionExtension, BrokerAwareExtension
 {
@@ -63,7 +62,13 @@ public function getMethod(ClassReflection $classReflection, string $methodName):
         if (count($resources) === 0) {
             throw new SpecSourceClassNotFound(sprintf('Source class from %s not found', $classReflection->getName()));
         }
-        $srcClassReflection = $this->broker->getClass($resources[0]->getSrcClassname());
+
+        $className = $resources[0]->getSrcClassname();
+        if (!class_exists($className)) {
+            throw new SpecSourceClassNotFound(sprintf('Spec source class %s not found', $className));
+        }
+
+        $srcClassReflection = $this->broker->getClass($className);
 
         $method = $srcClassReflection->getNativeMethod($methodName);
         $this->replaceReturnType($method);
@@ -76,11 +81,11 @@ private function replaceReturnType(MethodReflection $method): void
         $methodReflection = new \ReflectionClass($method);
         $returnType = $methodReflection->getProperty('nativeReturnType');
         $returnType->setAccessible(true);
-        $returnType->setValue($method, new ObjectType(Subject::class));
+        $returnType->setValue($method, new SubjectType($returnType->getValue($method)));
 
         $nativeReturnType = $methodReflection->getProperty('returnType');
         $nativeReturnType->setAccessible(true);
-        $nativeReturnType->setValue($method, new ObjectType(Subject::class));
+        $nativeReturnType->setValue($method, new SubjectType($nativeReturnType->getValue($method)));
 
         $variants = $methodReflection->getProperty('variants');
         $variants->setAccessible(true);

…atorDynamicMethodReturnTypeExtension.php …atorDynamicMethodReturnTypeExtension.phpsrc/Reflection/CollaboratorDynamicMethodReturnTypeExtension.php renamed to src/Type/CollaboratorDynamicMethodReturnTypeExtension.php src/Reflection/CollaboratorDynamicMethodReturnTypeExtension.php renamed to src/Type/CollaboratorDynamicMethodReturnTypeExtension.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Proget\PHPStan\PhpSpec\Reflection;
+namespace Proget\PHPStan\PhpSpec\Type;
 
 use PhpParser\Node\Expr\MethodCall;
 use PHPStan\Analyser\Scope;

src/Type/SubjectType.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proget\PHPStan\PhpSpec\Type;
+
+use PhpSpec\Wrapper\Subject;
+use PHPStan\Reflection\ClassMemberAccessAnswerer;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PHPStan\Type\VerbosityLevel;
+
+final class SubjectType extends ObjectType
+{
+    /**
+     * @var Type
+     */
+    private $wrappedType;
+
+    public function __construct(Type $wrappedType)
+    {
+        parent::__construct(Subject::class);
+        $this->wrappedType = $wrappedType;
+    }
+
+    public function hasMethod(string $methodName): bool
+    {
+        if ($this->wrappedType->hasMethod($methodName)) {
+            return true;
+        }
+
+        return parent::hasMethod($methodName);
+    }
+
+    public function getMethod(string $methodName, ClassMemberAccessAnswerer $scope): MethodReflection
+    {
+        if ($this->wrappedType->hasMethod($methodName)) {
+            return $this->wrappedType->getMethod($methodName, $scope);
+        }
+
+        return parent::getMethod($methodName, $scope);
+    }
+
+    public function describe(VerbosityLevel $level): string
+    {
+        return sprintf('%s<%s>', parent::describe($level), $this->wrappedType->describe($level));
+    }
+}

tests/Foo.php

@@ -25,4 +25,9 @@ public function makeBaz(): int
     {
         return $this->baz->make();
     }
+
+    public function makeValueObject(string $string): ValueObject
+    {
+        return new ValueObject($string);
+    }
 }

tests/ValueObject.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Proget\Tests\PHPStan\PhpSpec;
+
+final class ValueObject
+{
+    /**
+     * @var string
+     */
+    private $string;
+
+    public function __construct(string $string)
+    {
+        $this->string = $string;
+    }
+
+    public function string(): string
+    {
+        return $this->string;
+    }
+
+    public function copy(): self
+    {
+        return new self($this->string);
+    }
+}