Task to Action rename

Author: Anton Shabovta

examples/cancel.php

@@ -18,13 +18,13 @@
     ;
 
     try {
-        $task = $dispatcher->dispatch('endless', '.');
+        $action = $dispatcher->dispatch('endless', '.');
 
-        Amp\Loop::delay(500, function () use ($task) {
-            $task->cancel();
+        Amp\Loop::delay(500, function () use ($action) {
+            $action->cancel();
         });
 
-        yield $task;
+        yield $action;
     } catch (Exception $exception) {
         exit(\PHP_EOL . $exception->getMessage());
     }

examples/concurent.php

@@ -20,12 +20,12 @@
     ;
 
     $times   = \rand(5, 10);
-    $taskOne = $dispatcher->dispatch('emit', '-', $times, 100);
-    $taskTwo = $dispatcher->dispatch('emit', '+', $times + \rand(5, 10), 100);
+    $actionOne = $dispatcher->dispatch('emit', '-', $times, 100);
+    $actionTwo = $dispatcher->dispatch('emit', '+', $times + \rand(5, 10), 100);
 
-    [$resultOne, $resultTwo] = yield [$taskOne, $taskTwo];
+    [$resultOne, $resultTwo] = yield [$actionOne, $actionTwo];
 
     echo \PHP_EOL;
-    echo \sprintf('Task one done %d times.' . \PHP_EOL, $resultOne);
-    echo \sprintf('Task two done %d times.' . \PHP_EOL, $resultTwo);
+    echo \sprintf('Action one done %d times.' . \PHP_EOL, $resultOne);
+    echo \sprintf('Action two done %d times.' . \PHP_EOL, $resultTwo);
 });

examples/emit.php

@@ -44,8 +44,7 @@ public function __construct(int $num, int $delay = 100)
         })
     ;
 
-    $task = $dispatcher->dispatch(new SimpleCommand(10));
-    $data = yield $task;
+    $data = yield $dispatcher->dispatch(new SimpleCommand(10));
 
-    echo \sprintf('Task resolved with value: %d at %s' . \PHP_EOL, $data, \microtime(true));
+    echo \sprintf('Action resolved with value: %d at %s' . \PHP_EOL, $data, \microtime(true));
 });

examples/pool.php

@@ -16,14 +16,6 @@
 
 interface Dispatcher
 {
-    /**
-     * @param string   $signal
-     * @param callable $handler
-     *
-     * @return self
-     */
-    public function register(string $signal, callable $handler): self;
-
     /**
      * @param mixed       $signal
      * @param mixed    ...$arguments

src/Contract/Dispatcher.php

@@ -33,9 +33,12 @@ public function __construct(Kernel $kernel = null)
     }
 
     /**
-     * {@inheritdoc}
+     * @param string   $signal
+     * @param callable $handler
+     *
+     * @return self
      */
-    public function register(string $signal, callable $handler): Contract\Dispatcher
+    public function register(string $signal, callable $handler): self
     {
         $this->handlers[$signal] = $handler;
 

src/Dispatcher.php

@@ -20,7 +20,7 @@
 class ActionTest extends EnsignTest
 {
     /**
-     * Test that Task can be canceled
+     * Test that Action can be canceled
      *
      * @test
      * @expectedException \PHPinnacle\Ensign\Exception\ActionCanceled
@@ -29,15 +29,15 @@ public function cancel()
     {
         self::loop(function () {
             $id   = UUID::random();
-            $task = new Action($id, new Success(), new Token($id));
-            $task->cancel();
+            $action = new Action($id, new Success(), new Token($id));
+            $action->cancel();
 
-            yield $task;
+            yield $action;
         });
     }
 
     /**
-     * Test that Task throw exception when timeout reached
+     * Test that Action throw exception when timeout reached
      *
      * @test
      * @expectedException \PHPinnacle\Ensign\Exception\ActionTimeout
@@ -46,26 +46,26 @@ public function timeout()
     {
         self::loop(function () {
             $id   = UUID::random();
-            $task = new Action($id, new Delayed(100, true), new Token($id));
-            $task->timeout(10);
+            $action = new Action($id, new Delayed(100, true), new Token($id));
+            $action->timeout(10);
 
-            yield $task;
+            yield $action;
         });
     }
 
     /**
-     * Test that Task can has timeout
+     * Test that Action can has timeout
      *
      * @test
      */
     public function fast()
     {
         self::loop(function () {
             $id   = UUID::random();
-            $task = new Action($id, new Success(true), new Token($id));
-            $task->timeout(100);
+            $action = new Action($id, new Success(true), new Token($id));
+            $action->timeout(100);
 
-            self::assertTrue(yield $task);
+            self::assertTrue(yield $action);
         });
     }
 }

tests/ActionTest.php

@@ -30,11 +30,11 @@ public function dispatchSignals()
                 return strtolower($text);
             });
 
-            self::assertTask($upperTask = $dispatcher->dispatch('upper', 'test'));
-            self::assertTask($lowerTask = $dispatcher->dispatch('lower', 'TEST'));
+            self::assertAction($upperAction = $dispatcher->dispatch('upper', 'test'));
+            self::assertAction($lowerAction = $dispatcher->dispatch('lower', 'TEST'));
 
-            self::assertEquals('TEST', yield $upperTask);
-            self::assertEquals('test', yield $lowerTask);
+            self::assertEquals('TEST', yield $upperAction);
+            self::assertEquals('test', yield $lowerAction);
         });
     }
 
@@ -51,8 +51,8 @@ public function dispatchObject()
                 return strtoupper($event->data);
             });
 
-            self::assertTask($task = $dispatcher->dispatch(new Stub\SimpleEvent('test')));
-            self::assertEquals('TEST', yield $task);
+            self::assertAction($action = $dispatcher->dispatch(new Stub\SimpleEvent('test')));
+            self::assertEquals('TEST', yield $action);
         });
     }
 
@@ -84,8 +84,8 @@ public function dispatchSignalFromCoroutine()
                 self::assertEquals(4, $event->data);
             });
 
-            self::assertTask($task = $dispatcher->dispatch('coroutine', 3));
-            self::assertEquals(6, yield $task);
+            self::assertAction($action = $dispatcher->dispatch('coroutine', 3));
+            self::assertEquals(6, yield $action);
         });
     }
 
@@ -100,7 +100,7 @@ public function dispatchUnknownSignal()
         self::loop(function () {
             $dispatcher = new Dispatcher();
 
-            self::assertTask($failure = $dispatcher->dispatch('unknown'));
+            self::assertAction($failure = $dispatcher->dispatch('unknown'));
 
             yield $failure;
         });

tests/DispatcherTest.php

@@ -42,7 +42,7 @@ public static function assertPromise($value): void
      *
      * @return void
      */
-    public static function assertTask($value): void
+    public static function assertAction($value): void
     {
         self::assertInstanceOf(Action::class, $value);
     }

tests/EnsignTest.php

@@ -24,8 +24,8 @@ public function dispatchSignal()
                 return strtoupper($text);
             });
 
-            self::assertTask($upperTask = ensign_dispatch('upper', 'test'));
-            self::assertEquals('TEST', yield $upperTask);
+            self::assertAction($upperAction = ensign_dispatch('upper', 'test'));
+            self::assertEquals('TEST', yield $upperAction);
         });
     }