minor improvements

Author: mvorisek

README.md

@@ -194,7 +194,7 @@ extension if possible or busy waiting if not.
 #### MemcachedMutex
 
 The **MemcachedMutex** is a spinlock implementation which uses the
-[`Memcached` API](http://php.net/manual/en/book.memcached.php).
+[`Memcached` extension](http://php.net/manual/en/book.memcached.php).
 
 Example:
 ```php

src/Mutex/RedisMutex.php

@@ -10,7 +10,7 @@
 use Predis\PredisException;
 
 /**
- * Mutex based on the Redlock algorithm supporting the phpredis extension and Predis API.
+ * Distributed mutex based on the Redlock algorithm supporting the phpredis extension and Predis API.
  *
  * @phpstan-type TClient \Redis|\RedisCluster|PredisClientInterface
  *

tests/Mutex/AbstractRedlockMutexTest.php

@@ -45,11 +45,11 @@ protected function setUp(): void
  }
 
  /**
- * @param int $count The amount of redis apis
+ * @param int $count The amount of redis APIs
  *
  * @return AbstractRedlockMutex<object>&MockObject
  */
- private function createAbstractRedlockMutexMock(int $count, float $timeout = 1): AbstractRedlockMutex
+ private function createRedlockMutexMock(int $count, float $timeout = 1): AbstractRedlockMutex
  {
  $clients = array_map(
  static fn ($id) => ['id' => $id],
@@ -76,7 +76,7 @@ public function testTooFewServerToAcquire(int $count, int $available): void
  $this->expectException(LockAcquireException::class);
  $this->expectExceptionCode(MutexException::REDIS_NOT_ENOUGH_SERVERS);
 
- $mutex = $this->createAbstractRedlockMutexMock($count);
+ $mutex = $this->createRedlockMutexMock($count);
 
  $i = 0;
  $mutex->expects(self::exactly($count))
@@ -109,7 +109,7 @@ static function () use (&$i, $available): bool {
  #[DataProvider('provideMajorityCases')]
  public function testFaultTolerance(int $count, int $available): void
  {
- $mutex = $this->createAbstractRedlockMutexMock($count);
+ $mutex = $this->createRedlockMutexMock($count);
  $mutex->expects(self::exactly($count))
  ->method('evalScript')
  ->willReturn(true);
@@ -146,7 +146,7 @@ public function testAcquireTooFewKeys(int $count, int $available): void
  $this->expectException(TimeoutException::class);
  $this->expectExceptionMessage('Timeout of 1.0 seconds exceeded');
 
- $mutex = $this->createAbstractRedlockMutexMock($count);
+ $mutex = $this->createRedlockMutexMock($count);
 
  $i = 0;
  $mutex->expects(self::any())
@@ -184,7 +184,7 @@ public function testTimingOut(int $count, float $timeout, float $delay): void
  $this->expectException(TimeoutException::class);
  $this->expectExceptionMessage('Timeout of ' . $timeoutStr . ' seconds exceeded');
 
- $mutex = $this->createAbstractRedlockMutexMock($count, $timeout);
+ $mutex = $this->createRedlockMutexMock($count, $timeout);
 
  $mutex->expects(self::exactly($count))
  ->method('add')
@@ -219,7 +219,7 @@ public static function provideTimingOutCases(): iterable
  #[DataProvider('provideMajorityCases')]
  public function testAcquireWithMajority(int $count, int $available): void
  {
- $mutex = $this->createAbstractRedlockMutexMock($count);
+ $mutex = $this->createRedlockMutexMock($count);
  $mutex->expects(self::exactly($count))
  ->method('evalScript')
  ->willReturn(true);
@@ -249,7 +249,7 @@ static function () use (&$i, $available): bool {
  #[DataProvider('provideMinorityCases')]
  public function testTooFewServersToRelease(int $count, int $available): void
  {
- $mutex = $this->createAbstractRedlockMutexMock($count);
+ $mutex = $this->createRedlockMutexMock($count);
  $mutex->expects(self::exactly($count))
  ->method('add')
  ->willReturn(true);
@@ -285,7 +285,7 @@ static function () use (&$i, $available): bool {
  #[DataProvider('provideMinorityCases')]
  public function testReleaseTooFewKeys(int $count, int $available): void
  {
- $mutex = $this->createAbstractRedlockMutexMock($count);
+ $mutex = $this->createRedlockMutexMock($count);
  $mutex->expects(self::exactly($count))
  ->method('add')
  ->willReturn(true);

tests/Mutex/AbstractSpinlockMutexTest.php

@@ -41,7 +41,7 @@ protected function setUp(): void
  /**
  * @return AbstractSpinlockMutex&MockObject
  */
- private function createAbstractSpinlockMutexMock(float $timeout = 3): AbstractSpinlockMutex
+ private function createSpinlockMutexMock(float $timeout = 3): AbstractSpinlockMutex
  {
  return $this->getMockBuilder(AbstractSpinlockMutex::class)
  ->setConstructorArgs(['test', $timeout])
@@ -56,7 +56,7 @@ public function testFailAcquireLock(): void
  {
  $this->expectException(LockAcquireException::class);
 
- $mutex = $this->createAbstractSpinlockMutexMock();
+ $mutex = $this->createSpinlockMutexMock();
  $mutex->expects(self::any())
  ->method('acquire')
  ->willThrowException(new LockAcquireException());
@@ -74,7 +74,7 @@ public function testAcquireTimesOut(): void
  $this->expectException(TimeoutException::class);
  $this->expectExceptionMessage('Timeout of 3.0 seconds exceeded');
 
- $mutex = $this->createAbstractSpinlockMutexMock();
+ $mutex = $this->createSpinlockMutexMock();
  $mutex->expects(self::atLeastOnce())
  ->method('acquire')
  ->willReturn(false);
@@ -89,7 +89,7 @@ public function testAcquireTimesOut(): void
  */
  public function testExecuteTooLong(): void
  {
- $mutex = $this->createAbstractSpinlockMutexMock(0.5);
+ $mutex = $this->createSpinlockMutexMock(0.5);
  $mutex->expects(self::any())
  ->method('acquire')
  ->willReturn(true);
@@ -114,7 +114,7 @@ public function testExecuteTooLong(): void
  */
  public function testExecuteBarelySucceeds(): void
  {
- $mutex = $this->createAbstractSpinlockMutexMock(0.5);
+ $mutex = $this->createSpinlockMutexMock(0.5);
  $mutex->expects(self::any())->method('acquire')->willReturn(true);
  $mutex->expects(self::once())->method('release')->willReturn(true);
 
@@ -130,7 +130,7 @@ public function testFailReleasingLock(): void
  {
  $this->expectException(LockReleaseException::class);
 
- $mutex = $this->createAbstractSpinlockMutexMock();
+ $mutex = $this->createSpinlockMutexMock();
  $mutex->expects(self::any())->method('acquire')->willReturn(true);
  $mutex->expects(self::any())->method('release')->willReturn(false);
 
@@ -142,7 +142,7 @@ public function testFailReleasingLock(): void
  */
  public function testExecuteTimeoutLeavesOneSecondForKeyToExpire(): void
  {
- $mutex = $this->createAbstractSpinlockMutexMock(0.2);
+ $mutex = $this->createSpinlockMutexMock(0.2);
  $mutex->expects(self::once())
  ->method('acquire')
  ->with(self::anything(), 1.2)

tests/Mutex/MutexConcurrencyTest.php

@@ -289,7 +289,7 @@ public static function provideExecutionIsSerializedWhenLockedCases(): iterable
  if (class_exists(\Redis::class)) {
  yield 'RedisMutex /w PHPRedis' => [
  static function ($timeout) use ($uris): Mutex {
- $apis = array_map(
+ $clients = array_map(
  static function (string $uri): \Redis {
  $redis = new \Redis();
 
@@ -308,7 +308,7 @@ static function (string $uri): \Redis {
  $uris
  );
 
- return new RedisMutex($apis, 'test', $timeout);
+ return new RedisMutex($clients, 'test', $timeout);
  },
  ];
  }

tests/Mutex/MutexTest.php

@@ -140,7 +140,7 @@ protected function unlock(): void {}
  if (class_exists(\Redis::class)) {
  yield 'RedisMutex /w PHPRedis' => [
  static function () use ($uris): Mutex {
- $apis = array_map(
+ $clients = array_map(
  static function ($uri) {
  $redis = new \Redis();
 
@@ -159,7 +159,7 @@ static function ($uri) {
  $uris
  );
 
- return new RedisMutex($apis, 'test', self::TIMEOUT);
+ return new RedisMutex($clients, 'test', self::TIMEOUT);
  },
  ];
  }

tests/Mutex/RedisMutexTest.php

@@ -14,7 +14,7 @@
 use PHPUnit\Framework\TestCase;
 
 if (\PHP_MAJOR_VERSION >= 8) {
- trait RedisTestTrait
+ trait RedisCompatibilityTrait
  {
  /**
  * @param list<mixed> $args
@@ -35,7 +35,7 @@ public function set($key, $value, $options = null): /* \Redis|string| */ bool
  }
  }
 } else {
- trait RedisTestTrait
+ trait RedisCompatibilityTrait
  {
  /**
  * @return mixed
@@ -92,7 +92,7 @@ protected function setUp(): void
 
  // original Redis::set and Redis::eval calls will reopen the connection
  $connection = new class extends \Redis {
- use RedisTestTrait;
+ use RedisCompatibilityTrait;
 
  /** @var bool */
  private $is_closed = false;