feat: LockableResource replaced by alias

README.md

@@ -45,20 +45,20 @@ var_dump($criticalOutput);
 
 ## Do you need to accept only locked resources?
 
-Use [`LockedResource`s](./src/LockedResource.php) if you need to be sure that you are not processing resource outside it's critical section.
+Use [`LockedResource`](./src/LockedResource.php) if you need to be sure that you are not processing resource outside it's critical section.
 
 ```php
 namespace PetrKnap\CriticalSection;
 
 use Symfony\Component\Lock\NoLock;
 
-/** @param LockedResource<Example\Resource> $lockedResource */
-function f(LockedResource $lockedResource) {
-    echo $lockedResource->value;
+/** @param Locked<Example\Resource> $resource */
+function f(Locked $resource) {
+    echo $resource->value;
 }
 
 $lock = new NoLock();
-$resource = LockableResource::create(new Example\Resource('data'), $lock);
+$resource = LockableResource::of(new Example\Resource('data'), $lock);
 CriticalSection::withLock($lock)(fn () => f($resource));
 ```
 

composer.json

@@ -8,7 +8,10 @@
   "autoload-dev": {
     "psr-4": {
       "PetrKnap\\CriticalSection\\": "tests"
-    }
+    },
+    "files": [
+      "src/aliases.php"
+    ]
   },
   "config": {
     "allow-plugins": false,

src/Exception/LockedResourceException.php

@@ -4,6 +4,8 @@
 
 namespace PetrKnap\CriticalSection\Exception;
 
-interface LockedResourceException extends LockableResourceException
+use Throwable;
+
+interface LockedResourceException extends Throwable
 {
 }

src/LockedResource.php

@@ -4,6 +4,8 @@
 
 namespace PetrKnap\CriticalSection;
 
+use Symfony\Component\Lock\LockInterface;
+
 /**
  * @template T of mixed
  *
@@ -14,7 +16,7 @@ abstract class LockedResource
     /**
      * @param T $resource
      */
-    public function __construct(
+    protected function __construct(
         private readonly mixed $resource,
     ) {
     }
@@ -37,6 +39,22 @@ public function __set(string $name, mixed $value): void
         $this->get()->$name = $value;
     }
 
+    /**
+     * @template U of mixed
+     *
+     * @param U $resource
+     *
+     * @return Locked<U>
+     */
+    public static function of(
+        mixed $resource,
+        LockInterface $lock1,
+        LockInterface ...$lockN,
+    ): self {
+        /** @var Locked<U> */
+        return new Symfony\Lock\LockedResource($resource, $lock1, ...$lockN);
+    }
+
     /**
      * @return T
      *

src/aliases.php

@@ -0,0 +1,12 @@
+<?php
+
+/**
+ * Aliases for better code readability
+ */
+
+declare(strict_types=1);
+
+namespace PetrKnap\CriticalSection;
+
+class_alias(LockedResource::class, 'PetrKnap\CriticalSection\LockableResource');
+class_alias(LockedResource::class, 'PetrKnap\CriticalSection\Locked');

tests/AliasesTest.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PetrKnap\CriticalSection;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Lock\LockInterface;
+
+final class AliasesTest extends TestCase
+{
+    public function testLockedResourceAliases(): void
+    {
+        self::assertInstanceOf(
+            Locked::class,
+            LockableResource::of(
+                new Example\Resource(),
+                self::createStub(LockInterface::class),
+            ),
+        );
+    }
+}

tests/Example/Resource.php

@@ -7,7 +7,7 @@
 final class Resource
 {
     public function __construct(
-        public string $value,
+        public string $value = '',
     ) {
     }
 

tests/LockedResourceTestCase.php

@@ -26,8 +26,8 @@ public function testCouldGetLockedResource(): void
     public function testIsMixin(): void
     {
         $string = 'string';
-        /** @var LockedResource<Example\Resource> $locked */
-        $locked = $this->getLockedResource(new Example\Resource(''));
+        /** @var Locked<Example\Resource> $locked */
+        $locked = $this->getLockedResource(new Example\Resource());
 
         $locked->value = $string;
         self::assertSame($string, $locked->value);