📚 Updated README and examples

Author: cdosoftei

README.md

@@ -10,16 +10,15 @@ Asynchronous [Redlock](https://redis.io/topics/distlock) algorithm implementatio
 
 ## Quickstart
 
-Once [installed](#installation), you can incorporate Redlock in your projects by instantiating its _Custodian_; this entity is responsible for lock orchestration and it requires access to your process's event loop as well as to a Redis client object instance, e.g.
+Once [installed](#installation), you can incorporate Redlock in your projects by instantiating its _Custodian_; this entity is responsible for lock orchestration and it requires access to a Redis client object instance, e.g.
 
 ```php
 /* Instantiate prerequisites */
-$loop = \React\EventLoop\Factory::create();
 $factory = new \Clue\React\Redis\Factory($loop);
 $client = $factory->createLazyClient('127.0.0.1');
 
 /* Instantiate our lock custodian */
-$custodian = new \RTCKit\React\Redlock\Custodian($loop, $client);
+$custodian = new \RTCKit\React\Redlock\Custodian($client);
 ```
 
 #### Acquiring locks
@@ -106,16 +105,16 @@ composer install
 Then, go to the project root and run:
 
 ```bash
-php -d memory_limit=-1 ./vendor/bin/phpunit
+php -d memory_limit=-1 ./vendor/bin/phpunit -c ./etc/phpunit.xml.dist
 ```
 
 ### Static Analysis
 
 In order to ensure high code quality, Redlock uses [PHPStan](https://github.com/phpstan/phpstan) and [Psalm](https://github.com/vimeo/psalm):
 
 ```sh
-php -d memory_limit=-1 ./vendor/bin/phpstan analyse -n -vvv --ansi --level=max src
-php -d memory_limit=-1 ./vendor/bin/psalm --show-info=true
+php -d memory_limit=-1 ./vendor/bin/phpstan analyse -c ./etc/phpstan.neon -n -vvv --ansi --level=max src
+php -d memory_limit=-1 ./vendor/bin/psalm --config=./etc/psalm.xml --show-info=true
 ```
 
 ## License

examples/01-basic.php

@@ -9,7 +9,7 @@
 require(__DIR__ . '/../vendor/autoload.php');
 
 use Clue\React\Redis\Factory as RedisFactory;
-use React\EventLoop\Factory as LoopFactory;
+use React\EventLoop\Loop;
 use React\Promise\PromiseInterface;
 use RTCKit\React\Redlock\Custodian;
 use RTCKit\React\Redlock\Lock;
@@ -23,14 +23,13 @@
 }
 
 /* Instantiate prerequisites */
-$loop = LoopFactory::create();
-$factory = new RedisFactory($loop);
+$factory = new RedisFactory(Loop::get());
 $client = $factory->createLazyClient($host);
 
 /* Instantiate our lock custodian */
-$custodian = new Custodian($loop, $client);
+$custodian = new Custodian($client);
 
-$loop->addTimer(0.001, function () use ($custodian, $loop): void {
+Loop::addTimer(0.001, function () use ($custodian): void {
     $custodian->acquire('01-basic', 1)
         ->then(function (?Lock $lock) use ($custodian): PromiseInterface {
             if (is_null($lock)) {
@@ -58,11 +57,9 @@
         ->otherwise(function (Throwable $t): void {
             echo "Something bad happened:" . PHP_EOL . " > " . $t->getMessage() . PHP_EOL;
         })
-        ->always(function() use ($loop): void {
-            $loop->stop();
+        ->always(function(): void {
+            Loop::stop();
 
             echo "Bye!" . PHP_EOL;
         });
 });
-
-$loop->run();

examples/02-spin.php

@@ -9,7 +9,7 @@
 require(__DIR__ . '/../vendor/autoload.php');
 
 use Clue\React\Redis\Factory as RedisFactory;
-use React\EventLoop\Factory as LoopFactory;
+use React\EventLoop\Loop;
 use React\Promise\PromiseInterface;
 use RTCKit\React\Redlock\Custodian;
 use RTCKit\React\Redlock\Lock;
@@ -22,15 +22,14 @@
 }
 
 /* Instantiate prerequisites */
-$loop = LoopFactory::create();
-$factory = new RedisFactory($loop);
+$factory = new RedisFactory(Loop::get());
 $client = $factory->createLazyClient($host);
 
 /* Instantiate our lock custodian */
-$custodian = new Custodian($loop, $client);
+$custodian = new Custodian($client);
 
 /* First routine to acquire the lock */
-$loop->addTimer(0.001, function () use ($custodian): void {
+Loop::addTimer(0.001, function () use ($custodian): void {
     /* Lock '02-spin' for 5 seconds */
     $custodian->acquire('02-spin', 5)
         ->then(function (?Lock $lock): void {
@@ -46,7 +45,7 @@
 });
 
 /* Hopeful routine, attempting to eventually acquire the lock */
-$loop->addTimer(1, function ($timer) use ($custodian, $loop): void {
+Loop::addTimer(1, function ($timer) use ($custodian): void {
     /* Attempt to lock '02-spin', trying up to 7 times with a one second pause between retries.
        Once secured, hold the lock for 10 seconds. */
     $custodian->spin(7, 1, '02-spin', 10)
@@ -60,11 +59,9 @@
         ->otherwise(function (Throwable $t): void {
             echo "[hopeful] Something bad happened:" . PHP_EOL . " > " . $t->getMessage() . PHP_EOL;
         })
-        ->always(function() use ($loop): void {
-            $loop->stop();
+        ->always(function(): void {
+            Loop::stop();
 
             echo "Bye!" . PHP_EOL;
         });
 });
-
-$loop->run();