Merge pull request #484 from phpDocumentor/feature/introduce-paramete…

…r-reducer Move parameter building to reducer
phpDocumentor · Dec 12, 2023 · 6d04b42 · 6d04b42
2 parents b602552 + a73e3c4
commit 6d04b42
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 261 deletions.
diff --git a/src/phpDocumentor/Reflection/NodeVisitor/ElementNameResolver.php b/src/phpDocumentor/Reflection/NodeVisitor/ElementNameResolver.php
@@ -159,12 +159,12 @@ private function resetState(string|null $namespace = null): void
      */
     private function buildName(): string
     {
-        $name = null;
+        $name = '';
         foreach ($this->parts as $part) {
             $name .= $part;
         }
 
-        return rtrim((string) $name, '\\');
+        return rtrim($name, '\\');
     }
 
     private function setFqsen(Node $node): void

diff --git a/src/phpDocumentor/Reflection/Php/Factory/AbstractFactory.php b/src/phpDocumentor/Reflection/Php/Factory/AbstractFactory.php
@@ -29,8 +29,10 @@
 abstract class AbstractFactory implements ProjectFactoryStrategy
 {
     /** @param iterable<Reducer> $reducers */
-    public function __construct(private readonly DocBlockFactoryInterface $docBlockFactory, private readonly iterable $reducers = [])
-    {
+    public function __construct(
+        private readonly DocBlockFactoryInterface $docBlockFactory,
+        private readonly iterable $reducers = [],
+    ) {
     }
 
     /**

diff --git a/src/phpDocumentor/Reflection/Php/Factory/Argument.php b/src/phpDocumentor/Reflection/Php/Factory/Argument.php
diff --git a/src/phpDocumentor/Reflection/Php/Factory/Function_.php b/src/phpDocumentor/Reflection/Php/Factory/Function_.php
@@ -61,16 +61,11 @@ protected function doCreate(
 
         $file->addFunction($function);
 
-        $thisContext = $context->push($function);
-        foreach ($object->params as $param) {
-            $strategy = $strategies->findMatching($thisContext, $param);
-            $strategy->create($thisContext, $param, $strategies);
-        }
-
         if (!is_array($object->stmts)) {
-            return null;
+            return $function;
         }
 
+        $thisContext = $context->push($function);
         foreach ($object->stmts as $stmt) {
             $strategy = $strategies->findMatching($thisContext, $stmt);
             $strategy->create($thisContext, $stmt, $strategies);

diff --git a/src/phpDocumentor/Reflection/Php/Factory/Method.php b/src/phpDocumentor/Reflection/Php/Factory/Method.php
@@ -72,16 +72,11 @@ protected function doCreate(
         );
         $methodContainer->addMethod($method);
 
-        $thisContext = $context->push($method);
-        foreach ($object->params as $param) {
-            $strategy = $strategies->findMatching($thisContext, $param);
-            $strategy->create($thisContext, $param, $strategies);
-        }
-
         if (!is_array($object->stmts)) {
-            return null;
+            return $method;
         }
 
+        $thisContext = $context->push($method);
         foreach ($object->stmts as $stmt) {
             $strategy = $strategies->findMatching($thisContext, $stmt);
             $strategy->create($thisContext, $stmt, $strategies);

diff --git a/src/phpDocumentor/Reflection/Php/Factory/Reducer/Parameter.php b/src/phpDocumentor/Reflection/Php/Factory/Reducer/Parameter.php
@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Reflection\Php\Factory\Reducer;
+
+use phpDocumentor\Reflection\Php\Argument as ArgumentDescriptor;
+use phpDocumentor\Reflection\Php\Factory\ContextStack;
+use phpDocumentor\Reflection\Php\Factory\Type;
+use phpDocumentor\Reflection\Php\Function_;
+use phpDocumentor\Reflection\Php\Method;
+use phpDocumentor\Reflection\Php\StrategyContainer;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\FunctionLike;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
+use Webmozart\Assert\Assert;
+
+use function is_string;
+
+class Parameter implements Reducer
+{
+    public function __construct(private readonly PrettyPrinter $valueConverter)
+    {
+    }
+
+    public function reduce(
+        ContextStack $context,
+        object $object,
+        StrategyContainer $strategies,
+        object|null $carry,
+    ): object|null {
+        if ($object instanceof FunctionLike === false) {
+            return $carry;
+        }
+
+        if ($carry instanceof Method === false && $carry instanceof Function_ === false) {
+            return null;
+        }
+
+        foreach ($object->getParams() as $param) {
+            Assert::isInstanceOf($param->var, Variable::class);
+
+            $carry->addArgument(
+                new ArgumentDescriptor(
+                    is_string($param->var->name) ? $param->var->name : $this->valueConverter->prettyPrintExpr($param->var->name),
+                    (new Type())->fromPhpParser($param->type),
+                    $param->default !== null ? $this->valueConverter->prettyPrintExpr($param->default) : null,
+                    $param->byRef,
+                    $param->variadic,
+                ),
+            );
+        }
+
+        return $carry;
+    }
+}
diff --git a/src/phpDocumentor/Reflection/Php/ProjectFactory.php b/src/phpDocumentor/Reflection/Php/ProjectFactory.php
@@ -17,7 +17,6 @@
 use phpDocumentor\Reflection\Exception;
 use phpDocumentor\Reflection\File as SourceFile;
 use phpDocumentor\Reflection\Fqsen;
-use phpDocumentor\Reflection\Php\Factory\Argument;
 use phpDocumentor\Reflection\Php\Factory\Class_;
 use phpDocumentor\Reflection\Php\Factory\ClassConstant;
 use phpDocumentor\Reflection\Php\Factory\ConstructorPromotion;
@@ -33,6 +32,7 @@
 use phpDocumentor\Reflection\Php\Factory\Noop;
 use phpDocumentor\Reflection\Php\Factory\Property;
 use phpDocumentor\Reflection\Php\Factory\Reducer\Attribute;
+use phpDocumentor\Reflection\Php\Factory\Reducer\Parameter;
 use phpDocumentor\Reflection\Php\Factory\Trait_;
 use phpDocumentor\Reflection\Php\Factory\TraitUse;
 use phpDocumentor\Reflection\Project as ProjectInterface;
@@ -67,20 +67,22 @@ public static function createInstance(): self
     {
         $docblockFactory = DocBlockFactory::createInstance();
 
-        $methodStrategy =  new Method($docblockFactory);
+        $attributeReducer = new Attribute();
+        $parameterReducer = new Parameter(new PrettyPrinter());
+
+        $methodStrategy =  new Method($docblockFactory, [$attributeReducer, $parameterReducer]);
 
         $strategies = new ProjectFactoryStrategies(
             [
                 new \phpDocumentor\Reflection\Php\Factory\Namespace_(),
-                new Argument(new PrettyPrinter()),
-                new Class_($docblockFactory, [new Attribute()]),
-                new Enum_($docblockFactory),
+                new Class_($docblockFactory, [$attributeReducer]),
+                new Enum_($docblockFactory, [$attributeReducer]),
                 new EnumCase($docblockFactory, new PrettyPrinter()),
                 new Define($docblockFactory, new PrettyPrinter()),
                 new GlobalConstant($docblockFactory, new PrettyPrinter()),
                 new ClassConstant($docblockFactory, new PrettyPrinter()),
                 new Factory\File($docblockFactory, NodesFactory::createInstance()),
-                new Function_($docblockFactory),
+                new Function_($docblockFactory, [$attributeReducer, $parameterReducer]),
                 new Interface_($docblockFactory),
                 $methodStrategy,
                 new Property($docblockFactory, new PrettyPrinter()),
@@ -97,9 +99,7 @@ public static function createInstance(): self
         );
         $strategies->addStrategy(new Noop(), -PHP_INT_MAX);
 
-        return new static(
-            $strategies,
-        );
+        return new self($strategies);
     }
 
     public function addStrategy(

diff --git a/tests/unit/phpDocumentor/Reflection/Php/Factory/ArgumentTest.php b/tests/unit/phpDocumentor/Reflection/Php/Factory/ArgumentTest.php
diff --git a/tests/unit/phpDocumentor/Reflection/Php/Factory/Function_Test.php b/tests/unit/phpDocumentor/Reflection/Php/Factory/Function_Test.php
@@ -22,9 +22,7 @@
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Expr\FuncCall;
-use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Name;
-use PhpParser\Node\Param;
 use PhpParser\Node\Stmt\Expression;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
@@ -87,41 +85,6 @@ public function testCreateWithoutParameters(): void
         $this->assertEquals('\SomeSpace::function()', (string) $function->getFqsen());
     }
 
-    /** @covers ::create */
-    public function testCreateWithParameters(): void
-    {
-        $param1 = new Param(new Variable('param1'));
-        $functionMock = $this->prophesize(\PhpParser\Node\Stmt\Function_::class);
-        $functionMock->getAttribute('fqsen')->willReturn(new Fqsen('\SomeSpace::function()'));
-        $functionMock->params = [$param1];
-        $functionMock->getDocComment()->willReturn(null);
-        $functionMock->getLine()->willReturn(1);
-        $functionMock->getEndLine()->willReturn(2);
-        $functionMock->getReturnType()->willReturn(null);
-
-        $argumentStrategy = $this->prophesize(ProjectFactoryStrategy::class);
-        $containerMock = $this->prophesize(StrategyContainer::class);
-        $containerMock->findMatching(Argument::type(ContextStack::class), $param1)->willReturn($argumentStrategy);
-        $argumentStrategy->create(
-            Argument::that(fn ($agument): bool => $agument->peek() instanceof FunctionDescriptor),
-            $param1,
-            $containerMock->reveal(),
-        )->shouldBeCalled();
-
-        $file = new File('hash', 'path');
-
-        $this->fixture->create(
-            self::createContext(null)->push($file),
-            $functionMock->reveal(),
-            $containerMock->reveal(),
-        );
-
-        $function = current($file->getFunctions());
-
-        self::assertInstanceOf(FunctionDescriptor::class, $function);
-        $this->assertEquals('\SomeSpace::function()', (string) $function->getFqsen());
-    }
-
     /** @covers ::create */
     public function testCreateWithDocBlock(): void
     {