From af33d6733a472c20c3369b5d1662205dd62ebca5 Mon Sep 17 00:00:00 2001
From: Cees-Jan Kiewiet <ceesjank@gmail.com>
Date: Sun, 8 Jul 2018 16:18:58 +0200
Subject: [PATCH] Deprecate triats in favour of interfaces

---
 src/ErrorMiddlewareInterface.php | 24 +++++++++++++++
 src/ErrorTrait.php               |  2 +-
 src/MiddlewareInterface.php      | 51 +-------------------------------
 src/PostMiddlewareInterface.php  | 23 ++++++++++++++
 src/PostTrait.php                |  1 +
 src/PreMiddlewareInterface.php   | 25 ++++++++++++++++
 src/PreTrait.php                 |  1 +
 7 files changed, 76 insertions(+), 51 deletions(-)
 create mode 100644 src/ErrorMiddlewareInterface.php
 create mode 100644 src/PostMiddlewareInterface.php
 create mode 100644 src/PreMiddlewareInterface.php

diff --git a/src/ErrorMiddlewareInterface.php b/src/ErrorMiddlewareInterface.php
new file mode 100644
index 0000000..0a30a8b
--- /dev/null
+++ b/src/ErrorMiddlewareInterface.php
@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Foundation\Middleware;
+
+use React\Promise\CancellablePromiseInterface;
+use Throwable;
+
+interface ErrorMiddlewareInterface
+{
+    /**
+     * Transform the throwable into another throwable or exception,
+     * but never turn it into a successful promise again.
+     *
+     * @param  Throwable                   $throwable
+     * @param  array                       $options
+     * @param  string                      $transactionId
+     * @return CancellablePromiseInterface
+     */
+    public function error(
+        Throwable $throwable,
+        string $transactionId,
+        array $options = []
+    ): CancellablePromiseInterface;
+}
diff --git a/src/ErrorTrait.php b/src/ErrorTrait.php
index 347e97f..db25a64 100644
--- a/src/ErrorTrait.php
+++ b/src/ErrorTrait.php
@@ -4,7 +4,6 @@
 
 use React\Promise\CancellablePromiseInterface;
 use Throwable;
-
 use function React\Promise\reject;
 
 trait ErrorTrait
@@ -13,6 +12,7 @@ trait ErrorTrait
      * @param  Throwable                   $throwable
      * @param  array                       $options
      * @return CancellablePromiseInterface
+     * @deprecated Will be removed in the next major version.
      */
     public function error(
         Throwable $throwable,
diff --git a/src/MiddlewareInterface.php b/src/MiddlewareInterface.php
index 63a6488..58b4a99 100644
--- a/src/MiddlewareInterface.php
+++ b/src/MiddlewareInterface.php
@@ -2,61 +2,12 @@
 
 namespace ApiClients\Foundation\Middleware;
 
-use Psr\Http\Message\RequestInterface;
-use Psr\Http\Message\ResponseInterface;
-use React\Promise\CancellablePromiseInterface;
-use Throwable;
-
 /**
  * Middleware, when a new request is made an instance specifically for that request is made for each request.
  *
  * Priority ranging from 0 to 1000. Where 1000 will be executed first on `pre`/`post`/`error`
  * and 0 last on `pre`/`post`/`error`.
  */
-interface MiddlewareInterface
+interface MiddlewareInterface extends PreMiddlewareInterface, PostMiddlewareInterface, ErrorMiddlewareInterface
 {
-    /**
-     * Return the processed $request via a fulfilled promise.
-     * When implementing cache or other feature that returns a response, do it with a rejected promise.
-     * If neither is possible, e.g. on some kind of failure, resolve the unaltered request.
-     *
-     * @param  RequestInterface            $request
-     * @param  array                       $options
-     * @param  string                      $transactionId
-     * @return CancellablePromiseInterface
-     */
-    public function pre(
-        RequestInterface $request,
-        string $transactionId,
-        array $options = []
-    ): CancellablePromiseInterface;
-
-    /**
-     * Return the processed $response via a promise.
-     *
-     * @param  ResponseInterface           $response
-     * @param  array                       $options
-     * @param  string                      $transactionId
-     * @return CancellablePromiseInterface
-     */
-    public function post(
-        ResponseInterface $response,
-        string $transactionId,
-        array $options = []
-    ): CancellablePromiseInterface;
-
-    /**
-     * Transform the throwable into another throwable or exception,
-     * but never turn it into a successful promise again.
-     *
-     * @param  Throwable                   $throwable
-     * @param  array                       $options
-     * @param  string                      $transactionId
-     * @return CancellablePromiseInterface
-     */
-    public function error(
-        Throwable $throwable,
-        string $transactionId,
-        array $options = []
-    ): CancellablePromiseInterface;
 }
diff --git a/src/PostMiddlewareInterface.php b/src/PostMiddlewareInterface.php
new file mode 100644
index 0000000..93cd1d0
--- /dev/null
+++ b/src/PostMiddlewareInterface.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Foundation\Middleware;
+
+use Psr\Http\Message\ResponseInterface;
+use React\Promise\CancellablePromiseInterface;
+
+interface PostMiddlewareInterface
+{
+    /**
+     * Return the processed $response via a promise.
+     *
+     * @param  ResponseInterface           $response
+     * @param  array                       $options
+     * @param  string                      $transactionId
+     * @return CancellablePromiseInterface
+     */
+    public function post(
+        ResponseInterface $response,
+        string $transactionId,
+        array $options = []
+    ): CancellablePromiseInterface;
+}
diff --git a/src/PostTrait.php b/src/PostTrait.php
index 15d7667..31b0fa2 100644
--- a/src/PostTrait.php
+++ b/src/PostTrait.php
@@ -12,6 +12,7 @@ trait PostTrait
      * @param  ResponseInterface           $response
      * @param  array                       $options
      * @return CancellablePromiseInterface
+     * @deprecated Will be removed in the next major version.
      */
     public function post(
         ResponseInterface $response,
diff --git a/src/PreMiddlewareInterface.php b/src/PreMiddlewareInterface.php
new file mode 100644
index 0000000..1885dc7
--- /dev/null
+++ b/src/PreMiddlewareInterface.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Foundation\Middleware;
+
+use Psr\Http\Message\RequestInterface;
+use React\Promise\CancellablePromiseInterface;
+
+interface PreMiddlewareInterface
+{
+    /**
+     * Return the processed $request via a fulfilled promise.
+     * When implementing cache or other feature that returns a response, do it with a rejected promise.
+     * If neither is possible, e.g. on some kind of failure, resolve the unaltered request.
+     *
+     * @param  RequestInterface            $request
+     * @param  array                       $options
+     * @param  string                      $transactionId
+     * @return CancellablePromiseInterface
+     */
+    public function pre(
+        RequestInterface $request,
+        string $transactionId,
+        array $options = []
+    ): CancellablePromiseInterface;
+}
diff --git a/src/PreTrait.php b/src/PreTrait.php
index af697f6..fd97196 100644
--- a/src/PreTrait.php
+++ b/src/PreTrait.php
@@ -12,6 +12,7 @@ trait PreTrait
      * @param  RequestInterface            $request
      * @param  array                       $options
      * @return CancellablePromiseInterface
+     * @deprecated Will be removed in the next major version.
      */
     public function pre(
         RequestInterface $request,