feat: add removeClassAttribute method for class attributes

README.md

@@ -55,6 +55,10 @@ Add new `use TraitName;` statements to a class, trait, or enum. This method auto
 
 **Note:** Need to provide the full trait class name (FQCN); the method will import it automatically.
 
+#### removeClassAttribute
+
+Remove a PHP attribute from the specified class. If the class does not exist in the file a `NodeNotExistException` is thrown.
+
 ## Special Laravel structure builders
 
 ### Bootstrap app

src/Builders/PHPFileBuilder.php

@@ -16,6 +16,7 @@
 use RonasIT\Larabuilder\Visitors\PropertyVisitors\AddArrayPropertyItem;
 use RonasIT\Larabuilder\Visitors\PropertyVisitors\RemoveArrayPropertyItem;
 use RonasIT\Larabuilder\Visitors\PropertyVisitors\SetProperty;
+use RonasIT\Larabuilder\Visitors\RemoveClassAttribute;
 
 class PHPFileBuilder
 {
@@ -85,6 +86,13 @@ public function insertCodeToMethod(string $methodName, string $code, InsertPosit
         return $this;
     }
 
+    public function removeClassAttribute(string $className, string $attributeName): self
+    {
+        $this->traverser->addVisitor(new RemoveClassAttribute($className, $attributeName));
+
+        return $this;
+    }
+
     public function save(): void
     {
         $this->traverser->addVisitor(new CloningVisitor());

src/Visitors/RemoveClassAttribute.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace RonasIT\Larabuilder\Visitors;
+
+use PhpParser\Node;
+use PhpParser\Node\Attribute;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\Nop;
+use RonasIT\Larabuilder\Exceptions\NodeNotExistException;
+
+class RemoveClassAttribute extends AbstractNodeVisitor
+{
+    protected array $allowedParentNodesTypes = [
+        Class_::class,
+    ];
+
+    public function __construct(
+        protected string $className,
+        protected string $attributeName,
+    ) {
+    }
+
+    protected function modify(Node $node): Node
+    {
+        /** @var Class_ $node */
+        $this->validateClassName($node);
+
+        $this->removeMatchingAttributes($node);
+
+        return $node;
+    }
+
+    protected function validateClassName(Class_ $node): void
+    {
+        if ($this->className !== $node->name->name) {
+            throw new NodeNotExistException('Class', $this->className);
+        }
+    }
+
+    protected function removeMatchingAttributes(Class_ $node): void
+    {
+        foreach ($node->attrGroups as $key => $attrGroup) {
+            if ($attrGroup instanceof Nop) {
+                continue;
+            }
+
+            $attrGroup->attrs = array_filter($attrGroup->attrs, fn (Attribute $attr) => $attr->name->name !== $this->attributeName);
+
+            // Replace with Nop to avoid leftover `#[]` and preserve original blank lines (full removal shifts token offsets in Printer)
+            if (empty($attrGroup->attrs)) {
+                $node->attrGroups[$key] = new Nop();
+            }
+        }
+    }
+}

tests/PHPFileBuilderTest.php

@@ -530,4 +530,82 @@ public function testInsertDuplicateCodeToMethod(string $code): void
             ->insertCodeToMethod('someMethod', $code)
             ->save();
     }
+
+    public function testRemoveClassAttributeNotClass(): void
+    {
+        $file = $this->generateOriginalStructurePath('interface.php');
+
+        $this->assertExceptionThrew(InvalidStructureTypeException::class, "'RemoveClassAttribute' operation may only be applied to: Class.");
+
+        new PHPFileBuilder($file)
+            ->removeClassAttribute('SomeClass', 'someAttribute')
+            ->save();
+    }
+
+    public function testRemoveClassAttributeWhenClassNotExist(): void
+    {
+        $file = $this->generateOriginalStructurePath('class_with_properties.php');
+
+        $this->assertExceptionThrew(NodeNotExistException::class, "Class 'AnotherClass' does not exist.");
+
+        new PHPFileBuilder($file)
+            ->removeClassAttribute('AnotherClass', 'someAttribute')
+            ->save();
+    }
+
+    public function testRemoveClassAttribute(): void
+    {
+        $file = $this->generateOriginalStructurePath('class_with_attributes.php');
+
+        $this->mockNativeFunction(
+            'RonasIT\Larabuilder\Builders',
+            $this->callFilePutContent($file, 'class_without_attributes.php'),
+        );
+
+        new PHPFileBuilder($file)
+            ->removeClassAttribute('SomeClass', 'MyAttribute')
+            ->removeClassAttribute('SomeClass', 'AnotherAttribute')
+            ->save();
+    }
+
+    public function testRemoveClassAttributeFromGroupedAttributes(): void
+    {
+        $file = $this->generateOriginalStructurePath('class_with_grouped_attributes.php');
+
+        $this->mockNativeFunction(
+            'RonasIT\Larabuilder\Builders',
+            $this->callFilePutContent($file, 'class_with_grouped_attributes_one_removed.php'),
+        );
+
+        new PHPFileBuilder($file)
+            ->removeClassAttribute('SomeClass', 'MyAttribute')
+            ->save();
+    }
+
+    public function testRemoveClassAttributeMultipleSameNameAttributes(): void
+    {
+        $file = $this->generateOriginalStructurePath('class_with_multiple_same_attributes.php');
+        $this->mockNativeFunction(
+            'RonasIT\Larabuilder\Builders',
+            $this->callFilePutContent($file, 'class_without_attributes.php'),
+        );
+
+        new PHPFileBuilder($file)
+            ->removeClassAttribute('SomeClass', 'MyAttribute')
+            ->save();
+    }
+
+    public function testRemoveClassAttributeNoMatchingAttribute(): void
+    {
+        $file = $this->generateOriginalStructurePath('class_with_attributes.php');
+
+        $this->mockNativeFunction(
+            'RonasIT\Larabuilder\Builders',
+            $this->callFilePutContent($file, 'class_with_attributes_unchanged.php'),
+        );
+
+        new PHPFileBuilder($file)
+            ->removeClassAttribute('SomeClass', 'NonExistentAttribute')
+            ->save();
+    }
 }

tests/Support/OriginStructures/class_with_attributes.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use App\MyAttribute;
+use App\SetUp;
+
+#[MyAttribute]
+#[AnotherAttribute]
+class SomeClass
+{
+    #[MyAttribute]
+    public int $prop;
+
+    #[SetUp]
+    public function someMethod()
+    {
+    }
+}

tests/Support/OriginStructures/class_with_grouped_attributes.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use App\MyAttribute;
+use App\AnotherAttribute;
+use App\SetUp;
+
+#[MyAttribute, AnotherAttribute]
+class SomeClass
+{
+    #[SetUp]
+    public function someMethod()
+    {
+    }
+}

tests/Support/OriginStructures/class_with_multiple_same_attributes.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use App\MyAttribute;
+use App\SetUp;
+
+#[MyAttribute(1234)]
+#[MyAttribute(5678)]
+class SomeClass
+{
+    #[MyAttribute]
+    public int $prop;
+
+    #[SetUp]
+    public function someMethod()
+    {
+    }
+}

tests/fixtures/PHPFileBuilderTest/class_with_attributes_unchanged.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use App\MyAttribute;
+use App\SetUp;
+
+#[MyAttribute]
+#[AnotherAttribute]
+class SomeClass
+{
+    #[MyAttribute]
+    public int $prop;
+
+    #[SetUp]
+    public function someMethod()
+    {
+    }
+}

tests/fixtures/PHPFileBuilderTest/class_with_grouped_attributes_one_removed.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use App\MyAttribute;
+use App\AnotherAttribute;
+use App\SetUp;
+
+#[AnotherAttribute]
+class SomeClass
+{
+    #[SetUp]
+    public function someMethod()
+    {
+    }
+}

tests/fixtures/PHPFileBuilderTest/class_without_attributes.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use App\MyAttribute;
+use App\SetUp;
+
+class SomeClass
+{
+    #[MyAttribute]
+    public int $prop;
+
+    #[SetUp]
+    public function someMethod()
+    {
+    }
+}