allow comments when creating properties

Author: jrushlow

src/Util/ClassSourceManipulator.php

@@ -65,9 +65,9 @@ final class ClassSourceManipulator
     public function __construct(
         string $sourceCode,
         bool $overwrite = false,
-        bool $useAnnotations = true,
+        bool $useAnnotations = false,
         bool $fluentMutators = true,
-        bool $useAttributesForDoctrineMapping = false
+        bool $useAttributesForDoctrineMapping = true
     ) {
         $this->overwrite = $overwrite;
         $this->useAnnotations = $useAnnotations;
@@ -124,7 +124,7 @@ public function addEntityField(string $propertyName, array $columnOptions, array
             $defaultValue = new Node\Expr\Array_([], ['kind' => Node\Expr\Array_::KIND_SHORT]);
         }
 
-        $this->addProperty(name: $propertyName, annotationLines: $comments, defaultValue: $defaultValue, attributes: $attributes);
+        $this->addProperty(name: $propertyName, defaultValue: $defaultValue, attributes: $attributes, comments: $comments);
 
         $this->addGetter(
             $propertyName,
@@ -144,27 +144,13 @@ public function addEmbeddedEntity(string $propertyName, string $className): void
     {
         $typeHint = $this->addUseStatementIfNecessary($className);
 
-//        $annotations = [];
-//        $attributes = [];
-//
-//        if (!$this->useAttributesForDoctrineMapping) {
-//            $annotations = [
-//                $this->buildAnnotationLine(
-//                    '@ORM\\Embedded',
-//                    [
-//                        'class' => new ClassNameValue($className, $typeHint),
-//                    ]
-//                ),
-//            ];
-//        } else {
         $attributes = [
                 $this->buildAttributeNode(
                     Embedded::class,
                     ['class' => new ClassNameValue($className, $typeHint)],
                     'ORM'
                 ),
             ];
-//        }
 
         $this->addProperty(name: $propertyName, attributes: $attributes);
 
@@ -355,8 +341,12 @@ public function createMethodLevelBlankLine()
     /**
      * @param array<Node\Attribute|Node\AttributeGroup> $attributes
      */
-    public function addProperty(string $name, array $annotationLines = [], $defaultValue = null, array $attributes = []): void
+    public function addProperty(string $name, array $annotationLines = [], $defaultValue = null, array $attributes = [], array $comments = []): void
     {
+        if (!empty($annotationLines)) {
+            @trigger_deprecation('symfony/maker-bundle', '0.0.0', 'CSM:addProperty(annotationLines:) is going to be removed. Triggered from addProperty...');
+        }
+
         if ($this->propertyExists($name)) {
             // we never overwrite properties
             return;
@@ -368,8 +358,10 @@ public function addProperty(string $name, array $annotationLines = [], $defaultV
             foreach ($attributes as $attribute) {
                 $newPropertyBuilder->addAttribute($attribute);
             }
-        } elseif ($annotationLines && $this->useAnnotations) {
-            $newPropertyBuilder->setDocComment($this->createDocBlock($annotationLines));
+        }
+
+        if ($comments) {
+            $newPropertyBuilder->setDocComment($this->createDocBlock($comments));
         }
 
         if (null !== $defaultValue) {
@@ -559,34 +551,16 @@ private function addSingularRelation(BaseRelation $relation): void
             $annotationOptions['cascade'] = ['persist', 'remove'];
         }
 
-//        $annotations = [];
-//        $attributes = [];
-
-//        if (!$this->useAttributesForDoctrineMapping) {
-//            $annotations = [
-//                $this->buildAnnotationLine(
-//                    $relation instanceof RelationManyToOne ? '@ORM\\ManyToOne' : '@ORM\\OneToOne',
-//                    $annotationOptions
-//                ),
-//            ];
-//        } else {
         $attributes = [
                 $this->buildAttributeNode(
                     $relation instanceof RelationManyToOne ? ManyToOne::class : OneToOne::class,
                     $annotationOptions,
                     'ORM'
                 ),
             ];
-//        }
 
         if (!$relation->isNullable() && $relation->isOwning()) {
-//            if (!$this->useAttributesForDoctrineMapping) {
-//                $annotations[] = $this->buildAnnotationLine('@ORM\\JoinColumn', [
-//                    'nullable' => false,
-//                ]);
-//            } else {
             $attributes[] = $this->buildAttributeNode(JoinColumn::class, ['nullable' => false], 'ORM');
-//            }
         }
 
         $this->addProperty(name: $relation->getPropertyName(), attributes: $attributes);
@@ -654,25 +628,13 @@ private function addCollectionRelation(BaseCollectionRelation $relation): void
             $annotationOptions['orphanRemoval'] = true;
         }
 
-//        $annotations = [];
-//        $attributes = [];
-//
-//        if (!$this->useAttributesForDoctrineMapping) {
-//            $annotations = [
-//                $this->buildAnnotationLine(
-//                    $relation instanceof RelationManyToMany ? '@ORM\\ManyToMany' : '@ORM\\OneToMany',
-//                    $annotationOptions
-//                ),
-//            ];
-//        } else {
         $attributes = [
                 $this->buildAttributeNode(
                     $relation instanceof RelationManyToMany ? ManyToMany::class : OneToMany::class,
                     $annotationOptions,
                     'ORM'
                 ),
             ];
-//        }
 
         $this->addProperty(name: $relation->getPropertyName(), attributes: $attributes);
 

tests/Util/ClassSourceManipulatorTest.php

@@ -35,7 +35,7 @@ public function testAddProperty(string $sourceFilename, $propertyName, array $co
         $manipulator = new ClassSourceManipulator($source);
         $method = (new \ReflectionObject($manipulator))->getMethod('addProperty');
         $method->setAccessible(true);
-        $method->invoke($manipulator, $propertyName, $commentLines);
+        $method->invoke($manipulator, name: $propertyName, comments: $commentLines);
 
         $this->assertSame($expectedSource, $manipulator->getSourceCode());
     }