Add attribute support to more elements

jaapio · jaapio · commit 61e2f1fe7683 · 2024-05-23T21:28:12.000+02:00
diff --git a/src/phpDocumentor/Reflection/Php/Factory/AbstractFactory.php b/src/phpDocumentor/Reflection/Php/Factory/AbstractFactory.php
@@ -31,7 +31,7 @@ abstract class AbstractFactory implements ProjectFactoryStrategy
     /** @param iterable<Reducer> $reducers */
     public function __construct(
         private readonly DocBlockFactoryInterface $docBlockFactory,
-        private readonly iterable $reducers = [],
+        protected readonly iterable $reducers = [],
     ) {
     }
 
diff --git a/src/phpDocumentor/Reflection/Php/Factory/ClassConstant.php b/src/phpDocumentor/Reflection/Php/Factory/ClassConstant.php
@@ -18,6 +18,7 @@
 use phpDocumentor\Reflection\Php\Class_;
 use phpDocumentor\Reflection\Php\Constant as ConstantElement;
 use phpDocumentor\Reflection\Php\Enum_;
+use phpDocumentor\Reflection\Php\Factory\Reducer\Reducer;
 use phpDocumentor\Reflection\Php\Interface_;
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use phpDocumentor\Reflection\Php\Trait_;
@@ -34,9 +35,13 @@
  */
 final class ClassConstant extends AbstractFactory
 {
-    public function __construct(DocBlockFactoryInterface $blockFactory, private readonly PrettyPrinter $valueConverter)
-    {
-        parent::__construct($blockFactory);
+    /** @param iterable<Reducer> $reducers */
+    public function __construct(
+        DocBlockFactoryInterface $blockFactory,
+        private readonly PrettyPrinter $valueConverter,
+        iterable $reducers = [],
+    ) {
+        parent::__construct($blockFactory, $reducers);
     }
 
     public function matches(ContextStack $context, object $object): bool
@@ -73,15 +78,25 @@ protected function doCreate(
         $constants = new ClassConstantIterator($object);
 
         foreach ($constants as $const) {
-            $constantContainer->addConstant(new ConstantElement(
+            $constant = new ConstantElement(
                 $const->getFqsen(),
                 $this->createDocBlock($const->getDocComment(), $context->getTypeContext()),
                 $const->getValue() !== null ? $this->valueConverter->prettyPrintExpr($const->getValue()) : null,
                 new Location($const->getLine()),
                 new Location($const->getEndLine()),
                 $this->buildVisibility($const),
                 $const->isFinal(),
-            ));
+            );
+
+            foreach ($this->reducers as $reducer) {
+                $constant = $reducer->reduce($context, $const, $strategies, $constant);
+            }
+
+            if ($constant === null) {
+                continue;
+            }
+
+            $constantContainer->addConstant($constant);
         }
 
         return null;
diff --git a/src/phpDocumentor/Reflection/Php/Factory/ConstructorPromotion.php b/src/phpDocumentor/Reflection/Php/Factory/ConstructorPromotion.php
@@ -9,6 +9,7 @@
 use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\Location;
 use phpDocumentor\Reflection\Php\Class_ as ClassElement;
+use phpDocumentor\Reflection\Php\Factory\Reducer\Reducer;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\Property;
 use phpDocumentor\Reflection\Php\StrategyContainer;
@@ -22,12 +23,14 @@
 
 final class ConstructorPromotion extends AbstractFactory
 {
+    /** @param iterable<Reducer> $reducers */
     public function __construct(
         private readonly ProjectFactoryStrategy $methodStrategy,
         DocBlockFactoryInterface $docBlockFactory,
         private readonly PrettyPrinter $valueConverter,
+        iterable $reducers = [],
     ) {
-        parent::__construct($docBlockFactory);
+        parent::__construct($docBlockFactory, $reducers);
     }
 
     public function matches(ContextStack $context, object $object): bool
@@ -51,13 +54,13 @@ protected function doCreate(ContextStack $context, object $object, StrategyConta
                 continue;
             }
 
-            $this->promoteParameterToProperty($context, $param);
+            $this->promoteParameterToProperty($context, $strategies, $param);
         }
 
         return $context->peek();
     }
 
-    private function promoteParameterToProperty(ContextStack $context, Param $param): void
+    private function promoteParameterToProperty(ContextStack $context, StrategyContainer $strategies, Param $param): void
     {
         $methodContainer = $context->peek();
         Assert::isInstanceOf($methodContainer, ClassElement::class);
@@ -75,6 +78,14 @@ private function promoteParameterToProperty(ContextStack $context, Param $param)
             $this->readOnly($param->flags),
         );
 
+        foreach ($this->reducers as $reducer) {
+            $property = $reducer->reduce($context, $param, $strategies, $property);
+        }
+
+        if ($property === null) {
+            return;
+        }
+
         $methodContainer->addProperty($property);
     }
 
diff --git a/src/phpDocumentor/Reflection/Php/Factory/EnumCase.php b/src/phpDocumentor/Reflection/Php/Factory/EnumCase.php
@@ -8,6 +8,7 @@
 use phpDocumentor\Reflection\Location;
 use phpDocumentor\Reflection\Php\Enum_ as EnumElement;
 use phpDocumentor\Reflection\Php\EnumCase as EnumCaseElement;
+use phpDocumentor\Reflection\Php\Factory\Reducer\Reducer;
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use PhpParser\Node\Stmt\EnumCase as EnumCaseNode;
 use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
@@ -16,9 +17,13 @@
 
 final class EnumCase extends AbstractFactory
 {
-    public function __construct(DocBlockFactoryInterface $docBlockFactory, private readonly PrettyPrinter $prettyPrinter)
-    {
-        parent::__construct($docBlockFactory);
+    /** @param iterable<Reducer> $reducers */
+    public function __construct(
+        DocBlockFactoryInterface $docBlockFactory,
+        private readonly PrettyPrinter $prettyPrinter,
+        iterable $reducers = [],
+    ) {
+        parent::__construct($docBlockFactory, $reducers);
     }
 
     public function matches(ContextStack $context, object $object): bool
diff --git a/src/phpDocumentor/Reflection/Php/Factory/Property.php b/src/phpDocumentor/Reflection/Php/Factory/Property.php
@@ -16,6 +16,7 @@
 use phpDocumentor\Reflection\DocBlockFactoryInterface;
 use phpDocumentor\Reflection\Location;
 use phpDocumentor\Reflection\Php\Class_;
+use phpDocumentor\Reflection\Php\Factory\Reducer\Reducer;
 use phpDocumentor\Reflection\Php\Property as PropertyDescriptor;
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use phpDocumentor\Reflection\Php\Trait_;
@@ -32,12 +33,13 @@
  */
 final class Property extends AbstractFactory
 {
-    /**
-     * Initializes the object.
-     */
-    public function __construct(DocBlockFactoryInterface $docBlockFactory, private readonly PrettyPrinter $valueConverter)
-    {
-        parent::__construct($docBlockFactory);
+    /** @param iterable<Reducer> $reducers */
+    public function __construct(
+        DocBlockFactoryInterface $docBlockFactory,
+        private readonly PrettyPrinter $valueConverter,
+        iterable $reducers = [],
+    ) {
+        parent::__construct($docBlockFactory, $reducers);
     }
 
     public function matches(ContextStack $context, object $object): bool
@@ -75,19 +77,27 @@ protected function doCreate(
                 $default = $this->valueConverter->prettyPrintExpr($default);
             }
 
-            $propertyContainer->addProperty(
-                new PropertyDescriptor(
-                    $stmt->getFqsen(),
-                    $this->buildVisibility($stmt),
-                    $this->createDocBlock($stmt->getDocComment(), $context->getTypeContext()),
-                    $default,
-                    $stmt->isStatic(),
-                    new Location($stmt->getLine()),
-                    new Location($stmt->getEndLine()),
-                    (new Type())->fromPhpParser($stmt->getType()),
-                    $stmt->isReadonly(),
-                ),
+            $property = new PropertyDescriptor(
+                $stmt->getFqsen(),
+                $this->buildVisibility($stmt),
+                $this->createDocBlock($stmt->getDocComment(), $context->getTypeContext()),
+                $default,
+                $stmt->isStatic(),
+                new Location($stmt->getLine()),
+                new Location($stmt->getEndLine()),
+                (new Type())->fromPhpParser($stmt->getType()),
+                $stmt->isReadonly(),
             );
+
+            foreach ($this->reducers as $reducer) {
+                $property = $reducer->reduce($context, $object, $strategies, $property);
+            }
+
+            if ($property === null) {
+                continue;
+            }
+
+            $propertyContainer->addProperty($property);
         }
 
         return null;
diff --git a/src/phpDocumentor/Reflection/Php/Factory/Reducer/Reducer.php b/src/phpDocumentor/Reflection/Php/Factory/Reducer/Reducer.php
@@ -9,6 +9,13 @@
 
 interface Reducer
 {
+    /**
+     * @param TCarry|null $carry
+     *
+     * @return TCarry|null
+     *
+     * @template TCarry of object
+     */
     public function reduce(
         ContextStack $context,
         object $object,
diff --git a/src/phpDocumentor/Reflection/Php/ProjectFactory.php b/src/phpDocumentor/Reflection/Php/ProjectFactory.php
@@ -77,24 +77,24 @@ public static function createInstance(): self
                 new \phpDocumentor\Reflection\Php\Factory\Namespace_(),
                 new Class_($docblockFactory, [$attributeReducer]),
                 new Enum_($docblockFactory, [$attributeReducer]),
-                new EnumCase($docblockFactory, new PrettyPrinter()),
+                new EnumCase($docblockFactory, new PrettyPrinter(), [$attributeReducer]),
                 new Define($docblockFactory, new PrettyPrinter()),
                 new GlobalConstant($docblockFactory, new PrettyPrinter()),
-                new ClassConstant($docblockFactory, new PrettyPrinter()),
+                new ClassConstant($docblockFactory, new PrettyPrinter(), [$attributeReducer]),
                 new Factory\File($docblockFactory, NodesFactory::createInstance()),
                 new Function_($docblockFactory, [$attributeReducer, $parameterReducer]),
-                new Interface_($docblockFactory),
+                new Interface_($docblockFactory, [$attributeReducer]),
                 $methodStrategy,
-                new Property($docblockFactory, new PrettyPrinter()),
-                new Trait_($docblockFactory),
+                new Property($docblockFactory, new PrettyPrinter(), [$attributeReducer]),
+                new Trait_($docblockFactory, [$attributeReducer]),
 
                 new IfStatement(),
                 new TraitUse(),
             ],
         );
 
         $strategies->addStrategy(
-            new ConstructorPromotion($methodStrategy, $docblockFactory, new PrettyPrinter()),
+            new ConstructorPromotion($methodStrategy, $docblockFactory, new PrettyPrinter(), [$attributeReducer]),
             1100,
         );
         $strategies->addStrategy(new Noop(), -PHP_INT_MAX);

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ abstract class AbstractFactory implements ProjectFactoryStrategy`
`31`	`31`	`/** @param iterable<Reducer> $reducers */`
`32`	`32`	`public function __construct(`
`33`	`33`	`private readonly DocBlockFactoryInterface $docBlockFactory,`
`34`		`- private readonly iterable $reducers = [],`
	`34`	`+ protected readonly iterable $reducers = [],`
`35`	`35`	`) {`
`36`	`36`	`}`
`37`	`37`