From 012dc3c27d3d26ed67b10691535d2f04af704896 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Mon, 13 Apr 2026 12:34:47 +0200
Subject: [PATCH] Add `StoredObjectEditorDecisionManager` with tests and
 interface for editability decisions

- Implemented `StoredObjectEditorDecisionManager` to assess editability of stored objects based on lock status and methods.
- Created `StoredObjectEditorDecisionManagerInterface` to define the contract for decision logic.
- Added comprehensive test suite `StoredObjectEditorDecisionManagerTest` to validate scenarios including lock absence, conflicting lock methods, and compatible WOPI locks.
---
 .../StoredObjectEditorDecisionManager.php     | 31 +++++++
 ...edObjectEditorDecisionManagerInterface.php | 37 ++++++++
 .../StoredObjectEditorDecisionManagerTest.php | 87 +++++++++++++++++++
 3 files changed, 155 insertions(+)
 create mode 100644 src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManager.php
 create mode 100644 src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManagerInterface.php
 create mode 100644 src/Bundle/ChillDocStoreBundle/Tests/Service/Lock/StoredObjectEditorDecisionManagerTest.php

diff --git a/src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManager.php b/src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManager.php
new file mode 100644
index 000000000..52d13b23b
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManager.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Service\Lock;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Entity\StoredObjectLockMethodEnum;
+
+final readonly class StoredObjectEditorDecisionManager implements StoredObjectEditorDecisionManagerInterface
+{
+    public function __construct(private StoredObjectLockManager $lockManager) {}
+
+    public function canEdit(StoredObject $storedObject, StoredObjectLockMethodEnum $lockMethodEnum): bool
+    {
+        if (!$this->lockManager->hasLock($storedObject)) {
+            return true;
+        }
+
+        $lock = $this->lockManager->getLock($storedObject);
+
+        return StoredObjectLockMethodEnum::WOPI === $lockMethodEnum && StoredObjectLockMethodEnum::WOPI === $lock->getMethod();
+    }
+}
diff --git a/src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManagerInterface.php b/src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManagerInterface.php
new file mode 100644
index 000000000..339c9a22a
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Service/Lock/StoredObjectEditorDecisionManagerInterface.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Service\Lock;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Entity\StoredObjectLockMethodEnum;
+
+/**
+ * Responsible for managing decisions related to editing stored objects based on their lock status and lock methods.
+ *
+ * This class focuses solely on determining editability concerning existing locks on the stored object.
+ * It does not evaluate permissions.
+ */
+interface StoredObjectEditorDecisionManagerInterface
+{
+    /**
+     * Determines if a stored object can be edited based on its lock status and the lock method.
+     *
+     * This method does not take into account the permissions to edit the stored object. Its purpose is to
+     * check that a future edition (and lock) will be allowed.
+     *
+     * @param StoredObject               $storedObject   the stored object to check for edit permissions
+     * @param StoredObjectLockMethodEnum $lockMethodEnum the lock method to verify against the stored object's lock
+     *
+     * @return bool returns true if the stored object can be edited, false otherwise
+     */
+    public function canEdit(StoredObject $storedObject, StoredObjectLockMethodEnum $lockMethodEnum): bool;
+}
diff --git a/src/Bundle/ChillDocStoreBundle/Tests/Service/Lock/StoredObjectEditorDecisionManagerTest.php b/src/Bundle/ChillDocStoreBundle/Tests/Service/Lock/StoredObjectEditorDecisionManagerTest.php
new file mode 100644
index 000000000..414f6c729
--- /dev/null
+++ b/src/Bundle/ChillDocStoreBundle/Tests/Service/Lock/StoredObjectEditorDecisionManagerTest.php
@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Tests\Service\Lock;
+
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Entity\StoredObjectLock;
+use Chill\DocStoreBundle\Entity\StoredObjectLockMethodEnum;
+use Chill\DocStoreBundle\Service\Lock\StoredObjectEditorDecisionManager;
+use Chill\DocStoreBundle\Service\Lock\StoredObjectLockManager;
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Prophecy\Prophecy\ObjectProphecy;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class StoredObjectEditorDecisionManagerTest extends TestCase
+{
+    use ProphecyTrait;
+
+    private ObjectProphecy|StoredObjectLockManager $lockManager;
+    private StoredObjectEditorDecisionManager $decisionManager;
+
+    protected function setUp(): void
+    {
+        $this->lockManager = $this->prophesize(StoredObjectLockManager::class);
+        $this->decisionManager = new StoredObjectEditorDecisionManager($this->lockManager->reveal());
+    }
+
+    public function testCanEditReturnsTrueIfNoLock(): void
+    {
+        $storedObject = $this->prophesize(StoredObject::class)->reveal();
+        $this->lockManager->hasLock($storedObject)->willReturn(false);
+
+        $this->assertTrue($this->decisionManager->canEdit($storedObject, StoredObjectLockMethodEnum::WEBDAV));
+        $this->assertTrue($this->decisionManager->canEdit($storedObject, StoredObjectLockMethodEnum::WOPI));
+    }
+
+    public function testCanEditReturnsFalseIfExistingLockIsWebdav(): void
+    {
+        $storedObject = $this->prophesize(StoredObject::class)->reveal();
+        $lock = $this->prophesize(StoredObjectLock::class);
+        $lock->getMethod()->willReturn(StoredObjectLockMethodEnum::WEBDAV);
+
+        $this->lockManager->hasLock($storedObject)->willReturn(true);
+        $this->lockManager->getLock($storedObject)->willReturn($lock->reveal());
+
+        // Always false if existing lock is Webdav
+        $this->assertFalse($this->decisionManager->canEdit($storedObject, StoredObjectLockMethodEnum::WEBDAV));
+        $this->assertFalse($this->decisionManager->canEdit($storedObject, StoredObjectLockMethodEnum::WOPI));
+    }
+
+    public function testCanEditReturnsTrueIfBothAreWopi(): void
+    {
+        $storedObject = $this->prophesize(StoredObject::class)->reveal();
+        $lock = $this->prophesize(StoredObjectLock::class);
+        $lock->getMethod()->willReturn(StoredObjectLockMethodEnum::WOPI);
+
+        $this->lockManager->hasLock($storedObject)->willReturn(true);
+        $this->lockManager->getLock($storedObject)->willReturn($lock->reveal());
+
+        $this->assertTrue($this->decisionManager->canEdit($storedObject, StoredObjectLockMethodEnum::WOPI));
+    }
+
+    public function testCanEditReturnsFalseIfExistingLockIsWopiButRequestedIsWebdav(): void
+    {
+        $storedObject = $this->prophesize(StoredObject::class)->reveal();
+        $lock = $this->prophesize(StoredObjectLock::class);
+        $lock->getMethod()->willReturn(StoredObjectLockMethodEnum::WOPI);
+
+        $this->lockManager->hasLock($storedObject)->willReturn(true);
+        $this->lockManager->getLock($storedObject)->willReturn($lock->reveal());
+
+        $this->assertFalse($this->decisionManager->canEdit($storedObject, StoredObjectLockMethodEnum::WEBDAV));
+    }
+}