add tests for class level attributes

Author: jrushlow

src/Util/ClassSourceManipulator.php

@@ -923,12 +923,11 @@ public function addUseStatementIfNecessary(string $class): string
     /**
      * Builds a PHPParser attribute node.
      *
-     * @param string $attributeClass The attribute class which should be used for the attribute. If the class has a substitute
-     *                                         prefix, the node is built using the prefix. E.g. #[ORM\Column()] Otherwise, the
-     *                                         short name is used. E.g. #[Column()]
-     * @param array            $options        the named arguments for the attribute ($key = argument name, $value = argument value)
+     * @param string  $attributeClass  The attribute class which should be used for the attribute E.g. #[Column()]
+     * @param array   $options         The named arguments for the attribute ($key = argument name, $value = argument value)
+     * @param ?string $attributePrefix If a prefix is provided, the node is built using the prefix. E.g. #[ORM\Column()]
      */
-    public function buildAttributeNode(string $attributeClass, array $options, string $attributePrefix = null): Node\Attribute
+    public function buildAttributeNode(string $attributeClass, array $options, ?string $attributePrefix = null): Node\Attribute
     {
         $options = $this->sortOptionsByClassConstructorParameters($options, $attributeClass);
 

tests/Util/ClassSourceManipulatorTest.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\MakerBundle\Tests\Util;
 
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
 use PhpParser\Builder\Param;
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\MakerBundle\Doctrine\RelationManyToMany;
@@ -167,6 +169,36 @@ public function getAddSetterTests()
         ];
     }
 
+    /**
+     * @dataProvider getAttributeClassTests
+     */
+    public function testAddAttributeToClass(string $sourceFilename, string $expectedSourceFilename, string $attributeClass, array $attributeOptions, string $attributePrefix = null): void
+    {
+        $source = file_get_contents(__DIR__.'/fixtures/source/'.$sourceFilename);
+        $expectedSource = file_get_contents(__DIR__.'/fixtures/add_class_attribute/'.$expectedSourceFilename);
+        $manipulator = new ClassSourceManipulator($source);
+        $manipulator->addAttributeToClass($attributeClass, $attributeOptions, $attributePrefix);
+
+        self::assertSame($expectedSource, $manipulator->getSourceCode());
+    }
+
+    public function getAttributeClassTests(): \Generator
+    {
+        yield 'Empty class' => [
+            'User_empty.php',
+            'User_empty.php',
+            Entity::class,
+            [],
+        ];
+
+        yield 'Class already has attributes' => [
+            'User_simple.php',
+            'User_simple.php',
+            Column::class,
+            ['message' => 'We use this attribute for class level tests so we dont have to add additional test dependencies.'],
+        ];
+    }
+
     /**
      * @dataProvider getAnnotationTests
      */

tests/Util/fixtures/add_class_attribute/User_empty.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping\Entity;
+
+#[Entity]
+class User
+{
+}

tests/Util/fixtures/add_class_attribute/User_simple.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Doctrine\ORM\Mapping\Column;
+
+#[ORM\Entity]
+#[Column(message: 'We use this attribute for class level tests so we dont have to add additional test dependencies.')]
+class User
+{
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column(type: 'integer')]
+    private $id;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+}