Fix various typos and small code style changes

php-lock · Jul 7, 2018 · 96cd2d8 · 96cd2d8
1 parent ff25973
commit 96cd2d8
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 22 deletions.
diff --git a/classes/mutex/CASMutex.php b/classes/mutex/CASMutex.php
@@ -39,15 +39,15 @@ public function __construct($timeout = 3)
     }
 
     /**
-     * Notifies the Mutex about a successfull CAS operation.
+     * Notifies the Mutex about a successful CAS operation.
      */
     public function notify()
     {
         $this->loop->end();
     }
 
     /**
-     * Repeats executing a code until a compare-and-swap operation was succesful.
+     * Repeats executing a code until a compare-and-swap operation was successful.
      *
      * The code has to be designed in a way that it can be repeated without any
      * side effects. When the CAS operation was successful it should notify

diff --git a/classes/mutex/FlockMutex.php b/classes/mutex/FlockMutex.php
@@ -56,7 +56,7 @@ class FlockMutex extends LockMutex
      * Sets the file handle.
      *
      * @param resource $fileHandle The file handle.
-     * @throws \InvalidArgumentException The file handle is not a valid resource.
+     * @param int $timeout
      */
     public function __construct($fileHandle, $timeout = self::INFINITE_TIMEOUT)
     {
@@ -131,8 +131,8 @@ private function lockBusy()
      */
     private function acquireNonBlockingLock()
     {
-        if (!flock($this->fileHandle, LOCK_EX | LOCK_NB, $wouldblock)) {
-            if ($wouldblock) {
+        if (!flock($this->fileHandle, LOCK_EX | LOCK_NB, $wouldBlock)) {
+            if ($wouldBlock) {
                 /*
                  * Another process holds the lock.
                  */

diff --git a/classes/mutex/Mutex.php b/classes/mutex/Mutex.php
@@ -2,6 +2,7 @@
 
 namespace malkusch\lock\mutex;
 
+use malkusch\lock\exception\ExecutionOutsideLockException;
 use malkusch\lock\exception\LockAcquireException;
 use malkusch\lock\exception\LockReleaseException;
 use malkusch\lock\util\DoubleCheckedLocking;
@@ -32,6 +33,7 @@ abstract class Mutex
      * @throws \Exception The execution block threw an exception.
      * @throws LockAcquireException The mutex could not be acquired, no further side effects.
      * @throws LockReleaseException The mutex could not be released, the code was already executed.
+     * @throws ExecutionOutsideLockException Some code was executed outside of the lock.
      */
     abstract public function synchronized(callable $code);
 

diff --git a/classes/mutex/RedisMutex.php b/classes/mutex/RedisMutex.php
@@ -106,22 +106,22 @@ protected function acquire($key, $expire)
         if ($isAcquired) {
             // 4.
             return true;
-        } else {
-            // 5.
-            $this->release($key);
-
-            // In addition to RedLock it's an exception if too many servers fail.
-            if (!$this->isMajority(count($this->redisAPIs) - $errored)) {
-                assert(!is_null($exception)); // The last exception for some context.
-                throw new LockAcquireException(
-                    "It's not possible to acquire a lock because at least half of the Redis server are not available.",
-                    LockAcquireException::REDIS_NOT_ENOUGH_SERVERS,
-                    $exception
-                );
-            }
+        }
 
-            return false;
+        // 5.
+        $this->release($key);
+
+        // In addition to RedLock it's an exception if too many servers fail.
+        if (!$this->isMajority(count($this->redisAPIs) - $errored)) {
+            assert(!is_null($exception)); // The last exception for some context.
+            throw new LockAcquireException(
+                "It's not possible to acquire a lock because at least half of the Redis server are not available.",
+                LockAcquireException::REDIS_NOT_ENOUGH_SERVERS,
+                $exception
+            );
         }
+
+        return false;
     }
 
     /**
@@ -193,7 +193,7 @@ abstract protected function add($redisAPI, $key, $value, $expire);
     /**
      * @param mixed  $redisAPI The connected Redis API.
      * @param string $script The Lua script.
-     * @param int    $numkeys The number of arguments that represent Redis key names.
+     * @param int    $numkeys The number of values in $arguments that represent Redis key names.
      * @param array  $arguments Keys and values.
      *
      * @return mixed The script result, or false if executing failed.

diff --git a/classes/util/Loop.php b/classes/util/Loop.php
@@ -68,6 +68,7 @@ public function end()
     public function execute(callable $code)
     {
         $this->looping = true;
+
         $minWait = 100; // microseconds
         $deadline = microtime(true) + $this->timeout; // At this time, the lock will time out.
         $result = null;
@@ -78,8 +79,8 @@ public function execute(callable $code)
                 break;
             }
 
-            $min    = (int) $minWait * 1.5 ** $i;
-            $max    = $min * 2;
+            $min = (int) $minWait * 1.5 ** $i;
+            $max = $min * 2;
 
             /*
              * Calculate max time remaining, don't sleep any longer than that.