Rename fail() to onfail()

Author: antonmedv

docs/api.md

@@ -14,7 +14,7 @@
  * [`task()`](#task)
  * [`before()`](#before)
  * [`after()`](#after)
- * [`fail()`](#fail)
+ * [`onfail()`](#onfail)
  * [`option()`](#option)
  * [`cd()`](#cd)
  * [`within()`](#within)
@@ -184,14 +184,14 @@ Call that task after specified task runs.
 
   The task to be run.
 
-## fail()
+## onfail()
 
 ```php
-fail(string $task, $do)
+onfail(string $task, $do)
 ```
 
 Setup which task run on failure of $task.
-When called multiple times for a task, previous fail() definitions will be overridden.
+When called multiple times for a task, previous onfail() definitions will be overridden.
 
 
 

recipe/common.php

@@ -184,7 +184,7 @@
 task('deploy:failed', function () {
 })->hidden();
 
-fail('deploy', 'deploy:failed');
+onfail('deploy', 'deploy:failed');
 
 /**
  * Follow latest application logs.

src/Command/MainCommand.php

@@ -131,8 +131,8 @@ protected function execute(Input $input, Output $output): int
         }
 
         // Check if we have tasks to execute on failure.
-        if ($this->deployer['fail']->has($this->getName())) {
-            $taskName = $this->deployer['fail']->get($this->getName());
+        if ($this->deployer['onfail']->has($this->getName())) {
+            $taskName = $this->deployer['onfail']->get($this->getName());
             $tasks = $this->deployer->scriptManager->getTasks($taskName);
             $this->deployer->master->run($tasks, $hosts);
         }

src/Deployer.php

@@ -69,7 +69,7 @@
  * @property Messenger $messenger
  * @property Messenger $logger
  * @property Printer $pop
- * @property Collection $fail
+ * @property Collection $onfail
  * @property InputDefinition $inputDefinition
  * @property Importer $importer
  */
@@ -150,7 +150,7 @@ public function __construct(Application $console)
         $this['selector'] = function ($c) {
             return new Selector($c['hosts']);
         };
-        $this['fail'] = function () {
+        $this['onfail'] = function () {
             return new Collection();
         };
         $this['messenger'] = function ($c) {

src/Exception/GracefulShutdownException.php

@@ -8,9 +8,9 @@
 namespace Deployer\Exception;
 
 /**
- * Then this exception thrown, it will not trigger "fail" callback.
+ * Then this exception thrown, it will not trigger "onfail" callback.
  *
- *     fail('deploy', 'deploy:failed');
+ *     onfail('deploy', 'deploy:failed');
  *
  *     task('deploy', function () {
  *         throw new GracefulShutdownException(...);

src/functions.php

@@ -230,22 +230,22 @@ function after(string $task, $do)
 
 /**
  * Setup which task run on failure of $task.
- * When called multiple times for a task, previous fail() definitions will be overridden.
+ * When called multiple times for a task, previous onfail() definitions will be overridden.
  *
  * @param string $task The task which need to fail so $that should be run.
  * @param string|callable $do The task to be run.
  *
  * @return Task|null
  */
-function fail(string $task, $do)
+function onfail(string $task, $do)
 {
     if (is_callable($do)) {
         $newTask = task("fail:$task", $do);
-        fail($task, "fail:$task");
+        onfail($task, "fail:$task");
         return $newTask;
     }
     $deployer = Deployer::get();
-    $deployer->fail->set($task, $do);
+    $deployer->onfail->set($task, $do);
 
     return null;
 }

tests/joy/recipe/deploy.php

@@ -44,4 +44,4 @@
     run('false');
 });
 
-fail('deploy:fail', 'deploy:unlock');
+onfail('deploy:fail', 'deploy:unlock');