Fix default value code generation for properties and parameters - Close #68

sandrokeil · sandrokeil · commit d1812761a623 · 2021-02-12T15:12:27.000+01:00
diff --git a/src/Builder/ClassPropertyBuilder.php b/src/Builder/ClassPropertyBuilder.php
@@ -53,14 +53,15 @@ final class ClassPropertyBuilder
      */
     private ?DocBlock $docBlock = null;
 
+    private PropertyGenerator $propertyGenerator;
+
     private function __construct()
     {
     }
 
     public static function fromNode(Node\Stmt\Property $node, bool $typed = true): self
     {
         $self = new self();
-
         $type = null;
 
         switch (true) {
@@ -76,10 +77,33 @@ public static function fromNode(Node\Stmt\Property $node, bool $typed = true): s
         }
 
         $self->name = $node->props[0]->name->name;
-        $self->defaultValue = $node->props[0]->default;
         $self->type = $type;
         $self->visibility = $node->flags;
         $self->typed = $typed;
+        $self->propertyGenerator = new PropertyGenerator($self->name, $self->type);
+
+        $defaultValue = $node->props[0]->default;
+
+        switch (true) {
+            case $defaultValue instanceof Node\Expr\ConstFetch:
+                $self->defaultValue = $defaultValue->name->toString();
+
+                if ($self->defaultValue === 'null') {
+                    $self->defaultValue = null;
+                }
+                $self->propertyGenerator->setDefaultValue($self->defaultValue);
+                break;
+            case $defaultValue instanceof Node\Expr\ClassConstFetch:
+                $self->defaultValue = $defaultValue->class->toString() . '::'.  $defaultValue->name->toString();
+                $self->propertyGenerator->setDefaultValue($self->defaultValue);
+                break;
+            default:
+                if ($defaultValue !== null) {
+                    $self->defaultValue = $defaultValue;
+                    $self->propertyGenerator->setDefaultValue($self->defaultValue);
+                }
+                break;
+        }
 
         $comments = $node->getAttribute('comments');
 
@@ -105,6 +129,7 @@ public static function fromScratch(string $name, string $type, bool $typed = tru
         $self->type = $type;
         $self->typed = $typed;
         $self->visibility = ClassConstGenerator::FLAG_PRIVATE;
+        $self->propertyGenerator = new PropertyGenerator($self->name, $self->type);
 
         return $self;
     }
@@ -203,6 +228,20 @@ public function overrideDocBlock(?DocBlock $docBlock): self
         return $this;
     }
 
+    /**
+     * @param mixed $defaultValue
+     */
+    public function setDefaultValue($defaultValue): void
+    {
+        $this->defaultValue = $defaultValue;
+        $this->propertyGenerator->setDefaultValue($this->defaultValue);
+    }
+
+    public function getDefaultValue()
+    {
+        return $this->defaultValue;
+    }
+
     public function generate(): NodeVisitor
     {
         return new Property($this->propertyGenerator());
@@ -211,14 +250,12 @@ public function generate(): NodeVisitor
     private function propertyGenerator(): PropertyGenerator
     {
         $flags = $this->visibility;
+        $this->propertyGenerator->setFlags($flags);
+        $this->propertyGenerator->setDocBlockComment($this->docBlockComment);
+        $this->propertyGenerator->setTypeDocBlockHint($this->typeDocBlockHint);
+        $this->propertyGenerator->overrideDocBlock($this->docBlock);
 
-        $propertyGenerator = new PropertyGenerator($this->name, $this->type, $this->defaultValue, $this->typed, $flags);
-
-        $propertyGenerator->setDocBlockComment($this->docBlockComment);
-        $propertyGenerator->setTypeDocBlockHint($this->typeDocBlockHint);
-        $propertyGenerator->overrideDocBlock($this->docBlock);
-
-        return $propertyGenerator;
+        return $this->propertyGenerator;
     }
 
     public function injectVisitors(NodeTraverser $nodeTraverser): void
diff --git a/src/Builder/ParameterBuilder.php b/src/Builder/ParameterBuilder.php
@@ -41,6 +41,8 @@ final class ParameterBuilder
      */
     private ?string $typeDocBlockHint = null;
 
+    private ParameterGenerator $parameterGenerator;
+
     private function __construct()
     {
     }
@@ -66,19 +68,40 @@ public static function fromNode(Node\Param $node): self
         $self->type = $type;
         $self->variadic = $node->variadic;
         $self->passedByReference = $node->byRef;
+        $self->parameterGenerator = new ParameterGenerator($self->name, $self->type);
+
+        $defaultValue = $node->default;
+
+        switch (true) {
+            case $defaultValue instanceof Node\Expr\ConstFetch:
+                $self->defaultValue = $defaultValue->name->toString();
+
+                if ($self->defaultValue === 'null') {
+                    $self->defaultValue = null;
+                }
+                $self->parameterGenerator->setDefaultValue($self->defaultValue);
+                break;
+            case $defaultValue instanceof Node\Expr\ClassConstFetch:
+                $self->defaultValue = $defaultValue->class->toString() . '::'.  $defaultValue->name->toString();
+                $self->parameterGenerator->setDefaultValue($self->defaultValue);
+                break;
+            default:
+                if ($defaultValue !== null) {
+                    $self->defaultValue = $defaultValue;
+                    $self->parameterGenerator->setDefaultValue($self->defaultValue);
+                }
+                break;
+        }
 
         return $self;
     }
 
-    public static function fromScratch(
-        string $name,
-        ?string $type = null,
-        $defaultValue = null
-    ): self {
+    public static function fromScratch(string $name, ?string $type = null): self
+    {
         $self = new self();
         $self->name = $name;
         $self->type = $type;
-        $self->defaultValue = $defaultValue;
+        $self->parameterGenerator = new ParameterGenerator($self->name, $self->type);
 
         return $self;
     }
@@ -112,6 +135,7 @@ public function getDefaultValue()
     public function setDefaultValue($defaultValue): self
     {
         $this->defaultValue = $defaultValue;
+        $this->parameterGenerator->setDefaultValue($this->defaultValue);
 
         return $this;
     }
@@ -166,11 +190,10 @@ public function setTypeDocBlockHint(?string $typeDocBlockHint): self
 
     public function generate(): ParameterGenerator
     {
-        $methodGenerator = new ParameterGenerator($this->name, $this->type, $this->defaultValue, $this->passedByReference);
-
-        $methodGenerator->setTypeDocBlockHint($this->typeDocBlockHint);
-        $methodGenerator->setVariadic($this->variadic);
+        $this->parameterGenerator->setPassedByReference($this->passedByReference);
+        $this->parameterGenerator->setTypeDocBlockHint($this->typeDocBlockHint);
+        $this->parameterGenerator->setVariadic($this->variadic);
 
-        return $methodGenerator;
+        return $this->parameterGenerator;
     }
 }
diff --git a/src/Code/ParameterGenerator.php b/src/Code/ParameterGenerator.php
@@ -55,23 +55,18 @@ final class ParameterGenerator
     /**
      * @param string $name
      * @param string|null $type
-     * @param mixed $defaultValue
      * @param bool $passByReference
      */
     public function __construct(
         string $name,
         string $type = null,
-        $defaultValue = null,
         bool $passByReference = false
     ) {
         $this->setName($name);
 
         if (null !== $type) {
             $this->setType($type);
         }
-        if (null !== $defaultValue) {
-            $this->setDefaultValue($defaultValue);
-        }
         if (false !== $passByReference) {
             $this->setPassedByReference(true);
         }
@@ -111,8 +106,6 @@ public function getName(): string
     /**
      * Set the default value of the parameter.
      *
-     * Certain variables are difficult to express
-     *
      * @param  ValueGenerator|mixed $defaultValue
      * @return ParameterGenerator
      */
diff --git a/src/Code/PropertyGenerator.php b/src/Code/PropertyGenerator.php
@@ -59,7 +59,6 @@ final class PropertyGenerator extends AbstractMemberGenerator
     public function __construct(
         string $name = null,
         string $type = null,
-        $defaultValue = null,
         bool $typed = true,
         int $flags = self::FLAG_PRIVATE
     ) {
@@ -71,10 +70,6 @@ public function __construct(
             $this->setType($type);
         }
 
-        if (null !== $defaultValue) {
-            $this->setDefaultValue($defaultValue);
-        }
-
         $this->typed = $typed;
 
         if ($flags !== self::FLAG_PUBLIC) {
@@ -117,19 +112,16 @@ public function overrideDocBlock(?DocBlock $docBlock): void
     }
 
     /**
-     * @param ValueGenerator|mixed $defaultValue
-     * @param string $defaultValueType
+     * Set the default value of the parameter.
      *
+     * @param  ValueGenerator|mixed $defaultValue
      * @return PropertyGenerator
      */
-    public function setDefaultValue(
-        $defaultValue,
-        $defaultValueType = ValueGenerator::TYPE_AUTO
-    ): self {
+    public function setDefaultValue($defaultValue): self
+    {
         if (! $defaultValue instanceof ValueGenerator) {
-            $defaultValue = new ValueGenerator($defaultValue, $defaultValueType);
+            $defaultValue = new ValueGenerator($defaultValue);
         }
-
         $this->defaultValue = $defaultValue;
 
         return $this;
diff --git a/tests/Builder/ClassPropertyBuilderTest.php b/tests/Builder/ClassPropertyBuilderTest.php
@@ -12,6 +12,7 @@
 
 use OpenCodeModeling\CodeAst\Builder\ClassBuilder;
 use OpenCodeModeling\CodeAst\Builder\ClassPropertyBuilder;
+use OpenCodeModeling\CodeAst\Code\PropertyGenerator;
 use PhpParser\NodeTraverser;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
@@ -207,4 +208,32 @@ class TestClass
 
         $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
     }
+
+    /**
+     * @test
+     */
+    public function it_generates_property_with_default_value_from_node(): void
+    {
+        $classBuilder = ClassBuilder::fromScratch('TestClass');
+        $classBuilder->addProperty(
+            ClassPropertyBuilder::fromNode(
+                (new PropertyGenerator('recordData', 'array'))->setDefaultValue(null)->generate()
+            )
+        );
+
+        $nodeTraverser = new NodeTraverser();
+        $classBuilder->injectVisitors($nodeTraverser, $this->parser);
+
+        $expected = <<<'EOF'
+<?php
+
+declare (strict_types=1);
+class TestClass
+{
+    private array $recordData = null;
+}
+EOF;
+
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
+    }
 }
diff --git a/tests/Builder/ParameterBuilderTest.php b/tests/Builder/ParameterBuilderTest.php
@@ -0,0 +1,75 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-ast for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-ast/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-ast/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModelingTest\CodeAst\Builder;
+
+use OpenCodeModeling\CodeAst\Builder\ClassBuilder;
+use OpenCodeModeling\CodeAst\Builder\ClassMethodBuilder;
+use OpenCodeModeling\CodeAst\Builder\ParameterBuilder;
+use PhpParser\NodeTraverser;
+use PhpParser\Parser;
+use PhpParser\ParserFactory;
+use PhpParser\PrettyPrinter\Standard;
+use PHPUnit\Framework\TestCase;
+
+final class ParameterBuilderTest extends TestCase
+{
+    /**
+     * @var Parser
+     */
+    private Parser $parser;
+
+    /**
+     * @var Standard
+     */
+    private Standard $printer;
+
+    public function setUp(): void
+    {
+        $this->parser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);
+        $this->printer = new Standard(['shortArraySyntax' => true]);
+    }
+
+    /**
+     * @test
+     */
+    public function it_generates_property_with_default_value_from_node(): void
+    {
+        $method = ClassMethodBuilder::fromScratch('setRecordData')
+            ->setReturnType('void')
+            ->setParameters(
+                ParameterBuilder::fromScratch('recordData', 'array')->setDefaultValue(null)
+            );
+        $classBuilder = ClassBuilder::fromScratch('TestClass');
+        $classBuilder->addMethod($method);
+
+        $nodeTraverser = new NodeTraverser();
+        $classBuilder->injectVisitors($nodeTraverser, $this->parser);
+
+        $expected = <<<'EOF'
+<?php
+
+declare (strict_types=1);
+class TestClass
+{
+    public function setRecordData(array $recordData = null) : void
+    {
+    }
+}
+EOF;
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
+
+        $classBuilder = ClassBuilder::fromNodes(...$nodeTraverser->traverse($this->parser->parse('')));
+        $nodeTraverser = new NodeTraverser();
+        $classBuilder->injectVisitors($nodeTraverser, $this->parser);
+
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
+    }
+}
diff --git a/tests/Code/ParameterGeneratorTest.php b/tests/Code/ParameterGeneratorTest.php
diff --git a/tests/Code/PropertyGeneratorTest.php b/tests/Code/PropertyGeneratorTest.php
