Merge pull request #11 from codenamephp/feature/9-add-before-to-deployer-functions

bastianschwarz · web-flow · commit bcd4f3279a18 · 2023-03-11T01:34:37.000+01:00
Added before function
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -1,5 +1,10 @@
 # Migration
 
+## 2.x -> 3.x
+
+The iAll interface was extended with the iBefore interface. If you created your own implementation of iAll you need to implement the iBefore interface as well. 
+If you use the All class you don't need to do anything.
+
 ## 1.x -> 2.x
 
 The ssh connection string is now part of `\Deployer\Host\Host`. This means the
diff --git a/src/functions/All.php b/src/functions/All.php
@@ -19,6 +19,7 @@
 
 use Closure;
 use de\codenamephp\deployer\base\MissingConfigurationException;
+use de\codenamephp\deployer\base\task\iTask;
 use de\codenamephp\deployer\base\task\iTaskWithDescription;
 use de\codenamephp\deployer\base\task\iTaskWithName;
 use Deployer\Deployer;
@@ -29,6 +30,7 @@
 use Symfony\Component\Console\Input\InputArgument;
 use function Deployer\add;
 use function Deployer\after;
+use function Deployer\before;
 use function Deployer\currentHost;
 use function Deployer\download;
 use function Deployer\get;
@@ -50,10 +52,14 @@ public function add(string $name, array $array) : void {
     add($name, $array);
   }
 
-  public function after(string $task, callable|\de\codenamephp\deployer\base\task\iTask|string $do) : ?Task {
+  public function after(string $task, callable|iTask|string $do) : ?Task {
     return after($task, $do);
   }
 
+  public function before(string $task, callable|iTask|string $do) : ?Task {
+    return before($task, $do);
+  }
+
   public function currentHost() : Host {
     return currentHost();
   }
@@ -151,7 +157,7 @@ public function set(string $name, mixed $value) : void {
     set($name, $value);
   }
 
-  public function task(string $name, callable|array|\de\codenamephp\deployer\base\task\iTask|null $body = null) : Task {
+  public function task(string $name, callable|array|iTask|null $body = null) : Task {
     return \Deployer\task($name, $body);
   }
 
diff --git a/src/functions/iAll.php b/src/functions/iAll.php
@@ -22,6 +22,6 @@
  *
  * The idea is to provide a stable, typed API and also a level of abstraction to the global deployer functions so testing is easier.
  */
-interface iAll extends iAdd, iAfter, iCurrentHost, iDownload, iGet, iHost, iInput, iLocalhost, iOn, iParse, iRun, iSet, iTask, iUpload {
+interface iAll extends iAdd, iAfter, iBefore, iCurrentHost, iDownload, iGet, iHost, iInput, iLocalhost, iOn, iParse, iRun, iSet, iTask, iUpload {
 
 }
diff --git a/src/functions/iBefore.php b/src/functions/iBefore.php
@@ -0,0 +1,36 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+namespace de\codenamephp\deployer\base\functions;
+
+use de\codenamephp\deployer\base\task\iTask;
+use Deployer\Task\Task;
+
+/**
+ * Interface for the Deployer\before function
+ */
+interface iBefore {
+
+  /**
+   * Registers a task to be executed before another task
+   *
+   * @param string $task The name of the task the given task should be executed before
+   * @param callable():void|iTask|string $do The task to execute before the given task name
+   * @return Task|null The added task or null if no task was added
+   */
+  public function before(string $task, iTask|string|callable $do) : ?Task;
+}

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,6 @@`
`22`	`22`	`*`
`23`	`23`	`* The idea is to provide a stable, typed API and also a level of abstraction to the global deployer functions so testing is easier.`
`24`	`24`	`*/`
`25`		`-interface iAll extends iAdd, iAfter, iCurrentHost, iDownload, iGet, iHost, iInput, iLocalhost, iOn, iParse, iRun, iSet, iTask, iUpload {`
	`25`	`+interface iAll extends iAdd, iAfter, iBefore, iCurrentHost, iDownload, iGet, iHost, iInput, iLocalhost, iOn, iParse, iRun, iSet, iTask, iUpload {`
`26`	`26`
`27`	`27`	`}`