[27]: add RemoveArrayItem visitor

README.md

@@ -34,3 +34,7 @@ will change already existing class property's value **AND access level**
 #### addArrayPropertyItem
 
 Add new item to the `array` class property. Will add new property in case it does not exist yet.
+
+#### removeArrayPropertyItem
+
+Remove items from the `array` class property.

src/PHPFileBuilder.php

@@ -8,6 +8,7 @@
 use RonasIT\Larabuilder\Enums\AccessModifierEnum;
 use RonasIT\Larabuilder\Exceptions\InvalidPHPFileException;
 use RonasIT\Larabuilder\Visitors\AddArrayPropertyItem;
+use RonasIT\Larabuilder\Visitors\RemoveArrayPropertyItem;
 use RonasIT\Larabuilder\Visitors\SetPropertyValue;
 
 class PHPFileBuilder
@@ -48,6 +49,13 @@ public function addArrayPropertyItem(string $propertyName, mixed $value): self
         return $this;
     }
 
+    public function removeArrayPropertyItem(string $propertyName, array $value): self
+    {
+        $this->traverser->addVisitor(new RemoveArrayPropertyItem($propertyName, $value));
+
+        return $this;
+    }
+
     public function save(): void
     {
         $this->traverser->addVisitor(new CloningVisitor());

src/Visitors/RemoveArrayPropertyItem.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace RonasIT\Larabuilder\Visitors;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\ConstFetch;
+use PhpParser\Node\Scalar;
+use PhpParser\Node\Stmt\Property;
+use RonasIT\Larabuilder\Exceptions\UnexpectedPropertyTypeException;
+
+class RemoveArrayPropertyItem extends SetPropertyValue
+{
+    protected array $valuesToRemove;
+
+    public function __construct(
+        protected string $name,
+        array $valuesToRemove,
+    ) {
+        $this->valuesToRemove = array_map(
+            callback: fn ($value) => $this->getPropertyValue($value)[0],
+            array: $valuesToRemove,
+        );
+
+        parent::__construct($name, []);
+    }
+
+    /** @param Property $node */
+    protected function updateNode(Node $node): void
+    {
+        $arrayProperty = $node->props[0]->default;
+
+        if (!$arrayProperty instanceof Array_) {
+            throw new UnexpectedPropertyTypeException(
+                property: $this->name,
+                expectedType: 'array',
+                actualType: (is_null($node->type)) ? 'null' : (string) $node->type,
+            );
+        }
+
+        $newItems = [];
+
+        foreach ($arrayProperty->items as $item) {
+            if (!$this->shouldRemoveItem($item)) {
+                $newItems[] = $item;
+            }
+        }
+
+        $arrayProperty->items = $newItems;
+    }
+
+    protected function areNodesEqual(Node $expected, Node $actual): bool
+    {
+        return match (true) {
+            $expected instanceof Scalar && $actual instanceof Scalar => $expected->value === $actual->value,
+            $expected instanceof ConstFetch && $actual instanceof ConstFetch => $expected->name->name === $actual->name->name,
+            $expected instanceof Array_ && $actual instanceof Array_ => $this->areArrayNodesEqual($expected, $actual),
+            default => false,
+        };
+    }
+
+    protected function areArrayNodesEqual(Array_ $expected, Array_ $actual): bool
+    {
+        if (count($expected->items) !== count($actual->items)) {
+            return false;
+        }
+
+        foreach ($expected->items as $index => $expectedItem) {
+            $actualItem = $actual->items[$index];
+
+            if (!$this->areNodesEqual($expectedItem->value, $actualItem->value)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    protected function shouldRemoveItem(Node $item): bool
+    {
+        foreach ($this->valuesToRemove as $removeValue) {
+            if ($this->areNodesEqual($item->value, $removeValue)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    protected function insertNode(Node $node): Node
+    {
+        return $node;
+    }
+}

tests/PHPFileBuilderTest.php

@@ -109,6 +109,50 @@ public function testSetPropertyInTrait(): void
             ->addArrayPropertyItem('tags', 'three')
             ->addArrayPropertyItem('tags', 4)
             ->setProperty('newString', 'some string')
+            ->removeArrayPropertyItem('fillable', ['name'])
+            ->save();
+    }
+
+    public function testRemoveArrayPropertyItem(): void
+    {
+        $this->mockNativeFunction(
+            'RonasIT\Larabuilder',
+            $this->callFileGetContent('some_file_path.php', 'class_with_array_properties.php'),
+            $this->callFilePutContent('some_file_path.php', 'class_with_array_properties_removed.php'),
+        );
+
+        (new PHPFileBuilder('some_file_path.php'))
+            ->removeArrayPropertyItem('fillable', ['name', 'age'])
+            ->removeArrayPropertyItem('tags', ['two', 3, 5.5, true])
+            ->removeArrayPropertyItem('newMultiArrayProperty', ['arrayProperty' => [0 => 1, 1 => 'string', 2 => true]])
+            ->removeArrayPropertyItem('newMultiArrayProperty', ['arrayProperty2' => [1]])
+            ->save();
+    }
+
+    public function testRemoveArrayPropertyItemThrowsException(): void
+    {
+        $this->mockNativeFunction(
+            'RonasIT\Larabuilder',
+            $this->callFileGetContent('some_file_path.php', 'class_with_array_properties.php'),
+        );
+
+        $this->assertExceptionThrew(UnexpectedPropertyTypeException::class, "Property 'notArray' has unexpected type. Expected 'array', actual 'bool'.");
+
+        (new PHPFileBuilder('some_file_path.php'))
+            ->removeArrayPropertyItem('notArray', ['value'])
+            ->save();
+    }
+
+    public function testRemoveArrayPropertyItemNotProperty(): void
+    {
+        $this->mockNativeFunction(
+            'RonasIT\Larabuilder',
+            $this->callFileGetContent('some_file_path.php', 'class_without_properties.php'),
+            $this->callFilePutContent('some_file_path.php', 'class_without_properties_unchanged.php'),
+        );
+
+        (new PHPFileBuilder('some_file_path.php'))
+            ->removeArrayPropertyItem('notProperty', ['value'])
             ->save();
     }
 }

tests/fixtures/PHPFileBuilderTest/original/class_with_array_properties.php

@@ -7,13 +7,16 @@
 class SomeClass
 {
     public string $stringProperty = 'some value';
-    protected array $tags = ['one', 'two'];
+    protected array $tags = ['one', 'two', 3, true, 5.5, 78.4];
     public bool $notArray = false;
     protected array $fillable = [
         'name',
         'email',
     ];
-    public array $newMultiArrayProperty = ['arrayProperty' => [0 => 1, 1 => 'string', 2 => true]];
+    public array $newMultiArrayProperty = [
+        'arrayProperty' => [0 => 1, 1 => 'string', 2 => true],
+        'arrayProperty2' => [1, 2, 3],
+    ];
 
     public function __construct()
     {

tests/fixtures/PHPFileBuilderTest/original/trait.php

@@ -7,6 +7,11 @@
 trait SomeTrait {
     public float $floatProperty;
 
+    protected array $fillable = [
+        'name',
+        'email',
+    ];
+
     public function method1()
     {
         return $this

tests/fixtures/PHPFileBuilderTest/results/class_with_array_properties.php

@@ -7,20 +7,24 @@
 class SomeClass
 {
     public string $stringProperty = 'some value';
-    protected array $tags = ['one', 'two', 'three', 4];
+    protected array $tags = ['one', 'two', 3, true, 5.5, 78.4, 'three', 4];
     public bool $notArray = false;
     protected array $fillable = [
         'name',
         'email',
         'age',
     ];
-    public array $newMultiArrayProperty = ['arrayProperty' => [0 => 1, 1 => 'string', 2 => true], [
-        'array' => [
-            0 => 2,
-            1 => 'string',
-            2 => false,
+    public array $newMultiArrayProperty = [
+        'arrayProperty' => [0 => 1, 1 => 'string', 2 => true],
+        'arrayProperty2' => [1, 2, 3],
+        [
+            'array' => [
+                0 => 2,
+                1 => 'string',
+                2 => false,
+            ],
         ],
-    ]];
+    ];
     public array $role = [
         'admin',
     ];

tests/fixtures/PHPFileBuilderTest/results/class_with_array_properties_removed.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use Some;
+
+class SomeClass
+{
+    public string $stringProperty = 'some value';
+    protected array $tags = ['one', 78.4];
+    public bool $notArray = false;
+    protected array $fillable = [
+        'email',
+    ];
+    public array $newMultiArrayProperty = [
+        'arrayProperty2' => [1, 2, 3],
+    ];
+
+    public function __construct()
+    {
+    }
+
+    public function someMethod()
+    {
+    }
+}

tests/fixtures/PHPFileBuilderTest/results/class_without_properties_unchanged.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace RonasIT\Larabuilder\Tests\Support;
+
+use Some;
+use Test;
+use Some\SomeTrait;
+
+/**
+ * Test
+ */
+class SomeClass implements Test, Some
+{
+    use SomeTrait;
+
+    public function __construct()
+    {
+    }
+
+    public function someMethod()
+    {
+    }
+}

tests/fixtures/PHPFileBuilderTest/results/trait.php

@@ -6,6 +6,10 @@
 
 trait SomeTrait {
     public int $floatProperty = 56;
+
+    protected array $fillable = [
+        'email',
+    ];
     public array $tags = [
         'three',
         4,