fix: remove pivot from context when removing element from many-to-many relation (#177)

Author: tntrex

src/Relation/ManyToMany.php

@@ -36,9 +36,9 @@ class ManyToMany extends Relation\AbstractRelation
 
     /**
      * @param ORMInterface $orm
-     * @param string       $name
-     * @param string       $target
-     * @param array        $schema
+     * @param string $name
+     * @param string $target
+     * @param array $schema
      */
     public function __construct(ORMInterface $orm, string $name, string $target, array $schema)
     {
@@ -144,6 +144,8 @@ public function queue(CC $store, $entity, Node $node, $related, $original): Comm
             if (!$related->has($item)) {
                 // todo: add support for nullable pivot entities
                 $sequence->addCommand($this->orm->queueDelete($original->get($item)));
+                $sequence->addCommand($this->orm->queueStore($item));
+                $original->getContext()->offsetUnset($item);
             }
         }
 
@@ -153,9 +155,9 @@ public function queue(CC $store, $entity, Node $node, $related, $original): Comm
     /**
      * Link two entities together and create/update pivot context.
      *
-     * @param Node                   $node
-     * @param object                 $related
-     * @param object                 $pivot
+     * @param Node $node
+     * @param object $related
+     * @param object $pivot
      * @param Pivoted\PivotedStorage $storage
      * @return CommandInterface
      */
@@ -205,9 +207,9 @@ protected function link(Node $node, $related, $pivot, Pivoted\PivotedStorage $st
      * Since many to many relation can overlap from two directions we have to properly resolve the pivot entity upon
      * it's generation. This is achieved using temporary mapping associated with each of the entity states.
      *
-     * @param Node   $node
+     * @param Node $node
      * @param object $related
-     * @param mixed  $pivot
+     * @param mixed $pivot
      * @return mixed|object|null
      */
     protected function initPivot(Node $node, $related, $pivot)

tests/ORM/ManyToManySingleEntityTest.php

@@ -8,6 +8,7 @@
 use Cycle\ORM\Mapper\Mapper;
 use Cycle\ORM\Mapper\StdMapper;
 use Cycle\ORM\Relation;
+use Cycle\ORM\Relation\Pivoted\PivotedCollection;
 use Cycle\ORM\Schema;
 use Cycle\ORM\Select;
 use Cycle\ORM\Tests\Fixtures\RbacItemAbstract;
@@ -117,4 +118,43 @@ public function testStore(): void
         self::assertInstanceOf(RbacPermission::class, $fetchedRole->children->first());
         self::assertSame('writeUser', $fetchedRole->children->first()->name);
     }
+
+    public function testClearAndFillRelation(): void
+    {
+        $role = new RbacRole('superAdmin');
+
+        $permission = new RbacPermission('writeUser');
+
+        $role->children->add($permission);
+        $permission->parents->add($role);
+
+        $tr = new Transaction($this->orm);
+        $tr->persist($role);
+        $tr->run();
+
+        unset($role, $permission);
+
+        $this->orm = $this->orm->withHeap(new Heap());
+
+        /** @var RbacRole $fetchedRole */
+        $fetchedRole = (new Select($this->orm, 'rbac_item'))->wherePK('superAdmin')->fetchOne();
+        /** @var RbacPermission $fetchedPermission */
+        $fetchedPermission = (new Select($this->orm, 'rbac_item'))->wherePK('writeUser')->fetchOne();
+
+        $fetchedRole->children->removeElement($fetchedPermission);
+        $fetchedPermission->parents->removeElement($fetchedRole);
+
+        $tr = new Transaction($this->orm);
+        $tr->persist($fetchedRole);
+        $tr->run();
+
+        $fetchedRole->children->add($fetchedPermission);
+        $fetchedPermission->parents->add($fetchedRole);
+
+        $tr = new Transaction($this->orm);
+        $tr->persist($fetchedRole);
+        $tr->run();
+
+        self::assertTrue(true);
+    }
 }