Rewrite locker API

Author: antonkomarev

README.md

@@ -35,7 +35,7 @@ composer require cybercog/php-db-locker
 $dbConnection = new PDO($dsn, $username, $password);
 
 $locker = new \Cog\DbLocker\Postgres\PostgresAdvisoryLocker();
-$lockId = \Cog\DbLocker\Postgres\PostgresLockId::fromKeyValue('user', '4');
+$lockId = \Cog\DbLocker\Postgres\PostgresLockKey::create('user', '4');
 
 $dbConnection->beginTransaction();
 $lock = $locker->acquireSessionLevelLockHandler(
@@ -58,7 +58,7 @@ $dbConnection->commit();
 $dbConnection = new PDO($dsn, $username, $password);
 
 $locker = new \Cog\DbLocker\Postgres\PostgresAdvisoryLocker();
-$lockId = \Cog\DbLocker\Postgres\PostgresLockId::fromKeyValue('user', '4');
+$lockId = \Cog\DbLocker\Postgres\PostgresLockKey::create('user', '4');
 
 try {
     $lock = $locker->acquireSessionLevelLockHandler(

src/Postgres/LockHandle/PostgresSessionLevelLockHandle.php renamed to src/Postgres/LockHandle/SessionLevelLockHandle.php

@@ -15,20 +15,20 @@
 
 use Cog\DbLocker\Postgres\Enum\PostgresLockAccessModeEnum;
 use Cog\DbLocker\Postgres\PostgresAdvisoryLocker;
-use Cog\DbLocker\Postgres\PostgresLockId;
+use Cog\DbLocker\Postgres\PostgresLockKey;
 use PDO;
 
 /**
  * @internal
  */
-final class PostgresSessionLevelLockHandle
+final class SessionLevelLockHandle
 {
     private bool $isReleased = false;
 
     public function __construct(
         private readonly PDO $dbConnection,
         private readonly PostgresAdvisoryLocker $locker,
-        public readonly PostgresLockId $lockId,
+        public readonly PostgresLockKey $lockId,
         public readonly PostgresLockAccessModeEnum $accessMode,
         public readonly bool $wasAcquired,
     ) {}

src/Postgres/LockHandle/PostgresTransactionLevelLockHandle.php renamed to src/Postgres/LockHandle/TransactionLevelLockHandle.php

@@ -16,7 +16,7 @@
 /**
  * @internal
  */
-final class PostgresTransactionLevelLockHandle
+final class TransactionLevelLockHandle
 {
     public function __construct(
         public readonly bool $wasAcquired,

src/Postgres/PostgresAdvisoryLocker.php

@@ -16,8 +16,8 @@
 use Cog\DbLocker\Postgres\Enum\PostgresLockAccessModeEnum;
 use Cog\DbLocker\Postgres\Enum\PostgresLockLevelEnum;
 use Cog\DbLocker\Postgres\Enum\PostgresLockWaitModeEnum;
-use Cog\DbLocker\Postgres\LockHandle\PostgresSessionLevelLockHandle;
-use Cog\DbLocker\Postgres\LockHandle\PostgresTransactionLevelLockHandle;
+use Cog\DbLocker\Postgres\LockHandle\SessionLevelLockHandle;
+use Cog\DbLocker\Postgres\LockHandle\TransactionLevelLockHandle;
 use LogicException;
 use PDO;
 
@@ -30,11 +30,11 @@ final class PostgresAdvisoryLocker
      */
     public function acquireTransactionLevelLockHandler(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockWaitModeEnum $waitMode = PostgresLockWaitModeEnum::NonBlocking,
         PostgresLockAccessModeEnum $accessMode = PostgresLockAccessModeEnum::Exclusive,
-    ): PostgresTransactionLevelLockHandle {
-        return new PostgresTransactionLevelLockHandle(
+    ): TransactionLevelLockHandle {
+        return new TransactionLevelLockHandle(
             wasAcquired: $this->acquireLock(
                 $dbConnection,
                 $postgresLockId,
@@ -50,7 +50,7 @@ public function acquireTransactionLevelLockHandler(
      */
     public function acquireTransactionLevelLock(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockWaitModeEnum $waitMode = PostgresLockWaitModeEnum::NonBlocking,
         PostgresLockAccessModeEnum $accessMode = PostgresLockAccessModeEnum::Exclusive,
     ): bool {
@@ -71,11 +71,11 @@ public function acquireTransactionLevelLock(
      */
     public function acquireSessionLevelLockHandler(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockWaitModeEnum $waitMode = PostgresLockWaitModeEnum::NonBlocking,
         PostgresLockAccessModeEnum $accessMode = PostgresLockAccessModeEnum::Exclusive,
-    ): PostgresSessionLevelLockHandle {
-        return new PostgresSessionLevelLockHandle(
+    ): SessionLevelLockHandle {
+        return new SessionLevelLockHandle(
             $dbConnection,
             $this,
             $postgresLockId,
@@ -97,7 +97,7 @@ public function acquireSessionLevelLockHandler(
      */
     public function acquireSessionLevelLock(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockWaitModeEnum $waitMode = PostgresLockWaitModeEnum::NonBlocking,
         PostgresLockAccessModeEnum $accessMode = PostgresLockAccessModeEnum::Exclusive,
     ): bool {
@@ -115,7 +115,7 @@ public function acquireSessionLevelLock(
      */
     public function releaseSessionLevelLock(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockAccessModeEnum $accessMode = PostgresLockAccessModeEnum::Exclusive,
     ): bool {
         $sql = match ($accessMode) {
@@ -151,7 +151,7 @@ public function releaseAllSessionLevelLocks(
 
     private function acquireLock(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockLevelEnum $level,
         PostgresLockWaitModeEnum $waitMode = PostgresLockWaitModeEnum::NonBlocking,
         PostgresLockAccessModeEnum $accessMode = PostgresLockAccessModeEnum::Exclusive,

src/Postgres/PostgresLockId.php renamed to src/Postgres/PostgresLockKey.php

@@ -15,7 +15,7 @@
 
 use InvalidArgumentException;
 
-final class PostgresLockId
+final class PostgresLockKey
 {
     private const DB_INT32_VALUE_MIN = -2_147_483_648;
     private const DB_INT32_VALUE_MAX = 2_147_483_647;
@@ -39,20 +39,20 @@ private function __construct(
         }
     }
 
-    public static function fromKeyValue(
-        string $key,
+    public static function create(
+        string $namespace,
         string $value = '',
     ): self {
         return new self(
-            classId: self::convertStringToSignedInt32($key),
+            classId: self::convertStringToSignedInt32($namespace),
             objectId: self::convertStringToSignedInt32($value),
             // TODO: Do we need to sanitize it?
             // TODO: Do we need to omit ":" on end if no value is passed
-            humanReadableValue: "$key:$value",
+            humanReadableValue: "$namespace:$value",
         );
     }
 
-    public static function fromIntKeys(
+    public static function createFromInternalIds(
         int $classId,
         int $objectId,
     ): self {

test/Integration/AbstractIntegrationTestCase.php

@@ -14,7 +14,7 @@
 namespace Cog\Test\DbLocker\Integration;
 
 use Cog\DbLocker\Postgres\Enum\PostgresLockAccessModeEnum;
-use Cog\DbLocker\Postgres\PostgresLockId;
+use Cog\DbLocker\Postgres\PostgresLockKey;
 use PDO;
 use PHPUnit\Framework\TestCase;
 
@@ -44,7 +44,7 @@ protected function initPostgresPdoConnection(): PDO
 
     protected function assertPgAdvisoryLockExistsInConnection(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockAccessModeEnum $mode = PostgresLockAccessModeEnum::Exclusive,
     ): void {
         $row = $this->findPostgresAdvisoryLockInConnection(
@@ -63,7 +63,7 @@ protected function assertPgAdvisoryLockExistsInConnection(
 
     protected function assertPgAdvisoryLockMissingInConnection(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockAccessModeEnum $mode = PostgresLockAccessModeEnum::Exclusive,
     ): void {
         $row = $this->findPostgresAdvisoryLockInConnection(
@@ -95,7 +95,7 @@ protected function assertPgAdvisoryLocksCount(
 
     private function findPostgresAdvisoryLockInConnection(
         PDO $dbConnection,
-        PostgresLockId $postgresLockId,
+        PostgresLockKey $postgresLockId,
         PostgresLockAccessModeEnum $mode,
     ): object | null {
         $statement = $dbConnection->prepare(