return the return type of the called method when generating factory methods and calls

Author: pscheit

composer.json

@@ -22,7 +22,8 @@
 		"phpunit/php-file-iterator": "^1.4 || ^2.0 || ^3.0",
 		"phpunit/phpunit": "^4.8.36 || ^5.7 || ^6.5 || ^7.0 || ^8.0 || ^9.0",
 		"phpstan/phpstan": "^2.1",
-		"phpstan/phpstan-phpunit": "^2.0"
+		"phpstan/phpstan-phpunit": "^2.0",
+		"symfony/var-dumper": "^5.4"
 	},
 
 	"replace": {

generator/FactoryFile.php

@@ -85,7 +85,19 @@ public function generateDeclarationArguments(FactoryMethod $method)
 
     public function generateReturnType(FactoryMethod $method): string
     {
-        return '\Hamcrest\Matcher';
+        $call = $method->getCalls()[0];
+        if (!$call instanceof FactoryCall) {
+            throw new Exception('The first call in the FactoryMethod cannot be used to determine the return type. Method: '.$method->getName());
+        }
+
+        $returnType = $call->getMethod()->getReturnType();
+
+        if (!$returnType) {
+            dump($method);
+            throw new \Exception('The first calls FactoryMethod cannot be used to determine the return type. Method: '.$method->getName());
+        }
+
+        return sprintf('\\%s', $returnType);
     }
 
     public function generateImport(FactoryMethod $method)

generator/FactoryMethod.php

@@ -214,6 +214,21 @@ public function getFullName()
         return $this->getClassName() . '::' . $this->getName();
     }
 
+    public function getReturnType(): ?string
+    {
+        if (!$this->reflector->hasReturnType()) {
+            return null;
+        }
+
+        $returnType = $this->reflector->getReturnType()->getName();
+
+        if ($returnType === 'self') {
+            return $this->reflector->getDeclaringClass()->getName();
+        }
+
+        return $returnType;
+    }
+
     public function getCommentText()
     {
         return implode("\n", $this->comment);