Rename namespace to PascalCase

README.md

@@ -44,16 +44,16 @@ composer require malkusch/lock
 
 ## Usage
 
-This library uses the namespace `malkusch\lock`.
+This library uses the namespace `Malkusch\Lock`.
 
 ### Mutex
 
-The [`malkusch\lock\mutex\Mutex`][5] class is an abstract class and provides the
+The [`Malkusch\Lock\Mutex\Mutex`][5] class is an abstract class and provides the
 base API for this library.
 
 #### Mutex::synchronized()
 
-[`malkusch\lock\mutex\Mutex::synchronized()`][6] executes code exclusively. This
+[`Malkusch\Lock\Mutex\Mutex::synchronized()`][6] executes code exclusively. This
 method guarantees that the code is only executed by one process at once. Other
 processes have to wait until the mutex is available. The critical code may throw
 an exception, which would release the lock as well.
@@ -82,8 +82,8 @@ $newBalance = $mutex->synchronized(function () use (
 
 #### Mutex::check()
 
-[`malkusch\lock\mutex\Mutex::check()`][7] sets a callable, which will be
-executed when [`malkusch\lock\util\DoubleCheckedLocking::then()`][8] is called,
+[`Malkusch\Lock\Mutex\Mutex::check()`][7] sets a callable, which will be
+executed when [`Malkusch\Lock\Util\DoubleCheckedLocking::then()`][8] is called,
 and performs a double-checked locking pattern, where it's return value decides
 if the lock needs to be acquired and the synchronized code to be executed.
 
@@ -92,12 +92,12 @@ detailed explanation of that feature.
 
 If the check's callable returns `false`, no lock will be acquired and the
 synchronized code will not be executed. In this case the
-[`malkusch\lock\util\DoubleCheckedLocking::then()`][8] method, will also return
+[`Malkusch\Lock\Util\DoubleCheckedLocking::then()`][8] method, will also return
 `false` to indicate that the check did not pass either before or after acquiring
 the lock.
 
 In the case where the check's callable returns a value other than `false`, the
-[`malkusch\lock\util\DoubleCheckedLocking::then()`][8] method, will
+[`Malkusch\Lock\Util\DoubleCheckedLocking::then()`][8] method, will
 try to acquire the lock and on success will perform the check again. Only when
 the check returns something other than `false` a second time, the synchronized
 code callable, which has been passed to `then()` will be executed. In this case
@@ -127,8 +127,8 @@ if ($newBalance === false) {
 
 ### Extracting code result after lock release exception
 
-Mutex implementations based on [`malkush\lock\mutex\LockMutex`][12] will throw
-[`malkusch\lock\exception\LockReleaseException`][13] in case of lock release
+Mutex implementations based on [`Malkush\Lock\Mutex\LockMutex`][12] will throw
+[`Malkusch\Lock\Exception\LockReleaseException`][13] in case of lock release
 problem, but the synchronized code block will be already executed at this point.
 In order to read the code result (or an exception thrown there),
 `LockReleaseException` provides methods to extract it.
@@ -160,7 +160,7 @@ try {
 
 ### Implementations
 
-Because the [`malkusch\lock\mutex\Mutex`](#mutex) class is an abstract class,
+Because the [`Malkusch\Lock\Mutex\Mutex`](#mutex) class is an abstract class,
 you can choose from one of the provided implementations or create/extend your
 own implementation.
 
@@ -179,7 +179,7 @@ own implementation.
 The **CASMutex** has to be used with a [Compare-and-swap][10] operation. This
 mutex is lock free. It will repeat executing the code until the CAS operation
 was successful. The code should therefore notify the mutex by calling
-[`malkusch\lock\mutex\CASMutex::notify()`][11].
+[`Malkusch\Lock\Mutex\CASMutex::notify()`][11].
 
 As the mutex keeps executing the critical code, it must not have any side
 effects as long as the CAS operation was not successful.

composer.json

@@ -71,12 +71,12 @@
     "prefer-stable": true,
     "autoload": {
         "psr-4": {
-            "malkusch\\lock\\": "src/"
+            "Malkusch\\Lock\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "malkusch\\lock\\Tests\\": "tests/"
+            "Malkusch\\Lock\\Tests\\": "tests/"
         }
     },
     "config": {

phpstan.neon.dist

@@ -12,27 +12,27 @@ parameters:
     ignoreErrors:
         # TODO
         -
-            path: 'src/mutex/RedisMutex.php'
+            path: 'src/Mutex/RedisMutex.php'
             identifier: if.condNotBoolean
             message: '~^Only booleans are allowed in an if condition, mixed given\.$~'
             count: 1
         -
-            path: 'src/mutex/TransactionalMutex.php'
+            path: 'src/Mutex/TransactionalMutex.php'
             identifier: if.condNotBoolean
             message: '~^Only booleans are allowed in an if condition, mixed given\.$~'
             count: 1
         -
-            message: '~^Parameter #1 \$(redisAPI|redis) \(Redis\|RedisCluster\) of method malkusch\\lock\\mutex\\PHPRedisMutex::(add|evalScript)\(\) should be contravariant with parameter \$redisAPI \(mixed\) of method malkusch\\lock\\mutex\\RedisMutex::(add|evalScript)\(\)$~'
+            message: '~^Parameter #1 \$(redisAPI|redis) \(Redis\|RedisCluster\) of method Malkusch\\Lock\\Mutex\\PHPRedisMutex::(add|evalScript)\(\) should be contravariant with parameter \$redisAPI \(mixed\) of method Malkusch\\Lock\\Mutex\\RedisMutex::(add|evalScript)\(\)$~'
             identifier: method.childParameterType
-            path: 'src/mutex/PHPRedisMutex.php'
+            path: 'src/Mutex/PHPRedisMutex.php'
             count: 2
         -
-            message: '~^Parameter #1 \$(redisAPI|client) \(Predis\\ClientInterface\) of method malkusch\\lock\\mutex\\PredisMutex::(add|evalScript)\(\) should be contravariant with parameter \$redisAPI \(mixed\) of method malkusch\\lock\\mutex\\RedisMutex::(add|evalScript)\(\)$~'
+            message: '~^Parameter #1 \$(redisAPI|client) \(Predis\\ClientInterface\) of method Malkusch\\Lock\\Mutex\\PredisMutex::(add|evalScript)\(\) should be contravariant with parameter \$redisAPI \(mixed\) of method Malkusch\\Lock\\Mutex\\RedisMutex::(add|evalScript)\(\)$~'
             identifier: method.childParameterType
-            path: 'src/mutex/PredisMutex.php'
+            path: 'src/Mutex/PredisMutex.php'
             count: 2
         -
-            path: 'tests/mutex/*Test.php'
+            path: 'tests/Mutex/*Test.php'
             identifier: empty.notAllowed
             message: '~^Construct empty\(\) is not allowed\. Use more strict comparison\.$~'
             count: 6

src/exception/DeadlineException.php → src/Exception/DeadlineException.php

@@ -2,6 +2,6 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\exception;
+namespace Malkusch\Lock\Exception;
 
 class DeadlineException extends \RuntimeException implements PhpLockException {}

src/exception/ExecutionOutsideLockException.php → src/Exception/ExecutionOutsideLockException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\exception;
+namespace Malkusch\Lock\Exception;
 
 /**
  * Execution outside lock exception.
@@ -14,7 +14,7 @@
  *
  * Should only be used in contexts where the is being released.
  *
- * @see \malkusch\lock\mutex\SpinlockMutex::unlock()
+ * @see \Malkusch\Lock\Mutex\SpinlockMutex::unlock()
  */
 class ExecutionOutsideLockException extends LockReleaseException
 {

src/exception/LockAcquireException.php → src/Exception/LockAcquireException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\exception;
+namespace Malkusch\Lock\Exception;
 
 /**
  * Lock acquire exception.

src/exception/LockReleaseException.php → src/Exception/LockReleaseException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\exception;
+namespace Malkusch\Lock\Exception;
 
 /**
  * Lock release exception.

src/exception/MutexException.php → src/Exception/MutexException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\exception;
+namespace Malkusch\Lock\Exception;
 
 /**
  * Mutex exception.

src/exception/PhpLockException.php → src/Exception/PhpLockException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\exception;
+namespace Malkusch\Lock\Exception;
 
 /**
  * Common php-lock/lock exception interface.

src/exception/TimeoutException.php → src/Exception/TimeoutException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\exception;
+namespace Malkusch\Lock\Exception;
 
 /**
  * Timeout exception.

src/mutex/CASMutex.php → src/Mutex/CASMutex.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\TimeoutException;
-use malkusch\lock\util\Loop;
+use Malkusch\Lock\Exception\TimeoutException;
+use Malkusch\Lock\Util\Loop;
 
 /**
  * CAS based mutex implementation.

src/mutex/FlockMutex.php → src/Mutex/FlockMutex.php

@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
-
-use malkusch\lock\exception\DeadlineException;
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
-use malkusch\lock\exception\TimeoutException;
-use malkusch\lock\util\Loop;
-use malkusch\lock\util\PcntlTimeout;
+namespace Malkusch\Lock\Mutex;
+
+use Malkusch\Lock\Exception\DeadlineException;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
+use Malkusch\Lock\Exception\TimeoutException;
+use Malkusch\Lock\Util\Loop;
+use Malkusch\Lock\Util\PcntlTimeout;
 
 /**
  * Flock() based mutex implementation.

src/mutex/LockMutex.php → src/Mutex/LockMutex.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
 
 /**
  * Locking mutex.

src/mutex/MemcachedMutex.php → src/Mutex/MemcachedMutex.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
 /**
  * Memcached based spinlock implementation.

src/mutex/Mutex.php → src/Mutex/Mutex.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\ExecutionOutsideLockException;
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
-use malkusch\lock\util\DoubleCheckedLocking;
+use Malkusch\Lock\Exception\ExecutionOutsideLockException;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
+use Malkusch\Lock\Util\DoubleCheckedLocking;
 
 /**
  * The mutex provides methods for exclusive execution.
@@ -40,7 +40,7 @@ abstract public function synchronized(callable $code);
     /**
      * Performs a double-checked locking pattern.
      *
-     * Call {@link \malkusch\lock\util\DoubleCheckedLocking::then()} on the
+     * Call {@link \Malkusch\Lock\Util\DoubleCheckedLocking::then()} on the
      * returned object.
      *
      * Example:

src/mutex/MySQLMutex.php → src/Mutex/MySQLMutex.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\TimeoutException;
-use malkusch\lock\util\LockUtil;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\TimeoutException;
+use Malkusch\Lock\Util\LockUtil;
 
 class MySQLMutex extends LockMutex
 {

src/mutex/NoMutex.php → src/Mutex/NoMutex.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
 /**
  * This mutex doesn't lock at all.

src/mutex/PHPRedisMutex.php → src/Mutex/PHPRedisMutex.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
 
 /**
  * Mutex based on the Redlock algorithm using the phpredis extension.

src/mutex/PgAdvisoryLockMutex.php → src/Mutex/PgAdvisoryLockMutex.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\util\LockUtil;
+use Malkusch\Lock\Util\LockUtil;
 
 class PgAdvisoryLockMutex extends LockMutex
 {

src/mutex/PredisMutex.php → src/Mutex/PredisMutex.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
 use Predis\ClientInterface;
 use Predis\PredisException;
 

src/mutex/RedisMutex.php → src/Mutex/RedisMutex.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
-use malkusch\lock\util\LockUtil;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
+use Malkusch\Lock\Util\LockUtil;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;

src/mutex/SemaphoreMutex.php → src/Mutex/SemaphoreMutex.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
 
 /**
  * System V IPC based mutex implementation.

src/mutex/SpinlockMutex.php → src/Mutex/SpinlockMutex.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace malkusch\lock\mutex;
+namespace Malkusch\Lock\Mutex;
 
-use malkusch\lock\exception\ExecutionOutsideLockException;
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\LockReleaseException;
-use malkusch\lock\util\LockUtil;
-use malkusch\lock\util\Loop;
+use Malkusch\Lock\Exception\ExecutionOutsideLockException;
+use Malkusch\Lock\Exception\LockAcquireException;
+use Malkusch\Lock\Exception\LockReleaseException;
+use Malkusch\Lock\Util\LockUtil;
+use Malkusch\Lock\Util\Loop;
 
 /**
  * Spinlock implementation.