Use DocBlock classes and allow override of doc block

Author: sandrokeil

src/Code/DocBlock/DocBlock.php

@@ -63,6 +63,12 @@ public function generate(): string
             $comment .= ' * ' . $tag->generate() . "\n";
         }
 
-        return \preg_replace("/ \* \n/", " *\n", $comment) . "\n */";
+        $comment = \preg_replace("/ \* \n/", " *\n", $comment);
+
+        if (\count($this->tags) === 0) {
+            return \trim($comment) . '/';
+        }
+
+        return $comment . "\n */";
     }
 }

src/Code/PropertyGenerator.php

@@ -10,6 +10,8 @@
 
 namespace OpenCodeModeling\CodeAst\Code;
 
+use OpenCodeModeling\CodeAst\Code\DocBlock\DocBlock;
+use OpenCodeModeling\CodeAst\Code\DocBlock\Tag\VarTag;
 use PhpParser\Comment\Doc;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Property;
@@ -49,6 +51,11 @@ final class PropertyGenerator extends AbstractMemberGenerator
      */
     private $typeDocBlockHint;
 
+    /**
+     * @var DocBlock|null
+     */
+    private $docBlock;
+
     public function __construct(
         string $name = null,
         string $type = null,
@@ -87,7 +94,7 @@ public function getType(): ?TypeGenerator
         return $this->type;
     }
 
-    public function docBlockComment(): ?string
+    public function getDocBlockComment(): ?string
     {
         return $this->docBlockComment;
     }
@@ -97,6 +104,16 @@ public function setDocBlockComment(?string $docBlockComment): void
         $this->docBlockComment = $docBlockComment;
     }
 
+    /**
+     * Ignores generation of the doc block and uses provided doc block instead.
+     *
+     * @param DocBlock $docBlock
+     */
+    public function overrideDocBlock(DocBlock $docBlock): void
+    {
+        $this->docBlock = $docBlock;
+    }
+
     /**
      * @param ValueGenerator|mixed $defaultValue
      * @param string $defaultValueType
@@ -142,37 +159,6 @@ public function setTypeDocBlockHint(string $typeDocBlockHint): void
 
     public function generate(): Property
     {
-        $docBlockType = $this->type->isNullable()
-            ? $this->type->type() . '|null'
-            : $this->type->type();
-
-        if ($typeHint = $this->getTypeDocBlockHint()) {
-            $docBlockType = $typeHint;
-        }
-
-        $propComment = <<<EOF
-/**
- * @var {$docBlockType}
- */
-EOF;
-        if ($this->docBlockComment) {
-            $multiLineDocBlockComment = \trim(\preg_replace("/\n/", "\n * ", $this->docBlockComment));
-
-            $propComment = <<<EOF
-/**
- * {$multiLineDocBlockComment}
- *
- * @var {$docBlockType}
- */
-EOF;
-        }
-
-        $attributes = [];
-
-        if ($this->typed === false || $this->docBlockComment) {
-            $attributes = ['comments' => [new Doc($propComment)]];
-        }
-
         return new Property(
             $this->flags,
             [
@@ -181,8 +167,30 @@ public function generate(): Property
                     $this->defaultValue ? $this->defaultValue->generate() : null
                 ),
             ],
-            $attributes,
+            $this->generateAttributes(),
             $this->typed ? $this->type->generate() : null
         );
     }
+
+    private function generateAttributes(): array
+    {
+        $attributes = [];
+
+        if ($this->docBlock) {
+            return ['comments' => [new Doc($this->docBlock->generate())]];
+        }
+
+        if ($this->typed === false || $this->docBlockComment) {
+            $docBlockType = new VarTag($this->type->types());
+
+            if ($typeHint = $this->getTypeDocBlockHint()) {
+                $docBlockType->setTypes($typeHint);
+            }
+            $docBlock = new DocBlock($this->docBlockComment, $docBlockType);
+
+            $attributes = ['comments' => [new Doc($docBlock->generate())]];
+        }
+
+        return $attributes;
+    }
 }

tests/Code/PropertyGeneratorTest.php

@@ -4,6 +4,7 @@
 
 namespace OpenCodeModelingTest\CodeAst\Code;
 
+use OpenCodeModeling\CodeAst\Code\DocBlock\DocBlock;
 use OpenCodeModeling\CodeAst\Code\PropertyGenerator;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
@@ -50,6 +51,27 @@ public function it_generates_property_with_doc_block(): void
         $this->assertSame($expectedOutput, $this->printer->prettyPrintFile([$property->generate()]));
     }
 
+    /**
+     * @test
+     */
+    public function it_generates_property_with_overridden_doc_block(): void
+    {
+        $property = new PropertyGenerator('sourceFolder', 'string');
+        $property->setDocBlockComment('source folder');
+        $property->overrideDocBlock(new DocBlock('Awesome'));
+
+        $expectedOutput = <<<'EOF'
+<?php
+
+/**
+ * Awesome
+ */
+private $sourceFolder;
+EOF;
+
+        $this->assertSame($expectedOutput, $this->printer->prettyPrintFile([$property->generate()]));
+    }
+
     /**
      * @test
      */
@@ -97,7 +119,7 @@ public function it_generates_property_with_long_doc_block(): void
  * standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a
  * type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting,
  * remaining essentially unchanged.
- * 
+ *
  * It is a long established fact that a reader will be distracted by the readable content of a page when looking at
  * its layout.
  *