Added PHPStan annotations

php-etl · Jun 26, 2021 · 0a788de · 0a788de
1 parent 6a7bdb5
commit 0a788de
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 17 deletions.
diff --git a/src/Deferred.php b/src/Deferred.php
@@ -2,35 +2,37 @@
 
 namespace Kiboko\Component\Promise;
 
-use Kiboko\Contract\Promise\DeferredInterface;
-use Kiboko\Contract\Promise\PromiseInterface;
+use Kiboko\Contract\Promise as Contract;
 
 /**
  * @api
+ * @template Type
+ * @implements Contract\DeferredInterface<Type>
  */
-final class Deferred implements DeferredInterface
+final class Deferred implements Contract\DeferredInterface
 {
-    public function __construct(private PromiseInterface $promise)
+    /** @param Contract\PromiseInterface<Type> $promise */
+    public function __construct(private Contract\PromiseInterface $promise)
     {
     }
 
     /**
-     * @param callable<mixed> $callback
+     * @param callable(Type): Type $callback
      *
-     * @return DeferredInterface
+     * @return Contract\DeferredInterface<Type>
      */
-    public function then(callable $callback): DeferredInterface
+    public function then(callable $callback): Contract\DeferredInterface
     {
         $this->promise->then($callback);
         return $this;
     }
 
     /**
-     * @param callable<\Throwable> $callback
+     * @param callable(\Throwable):\Throwable $callback
      *
-     * @return DeferredInterface
+     * @return Contract\DeferredInterface<Type>
      */
-    public function failure(callable $callback): DeferredInterface
+    public function failure(callable $callback): Contract\DeferredInterface
     {
         $this->promise->failure($callback);
         return $this;

diff --git a/src/FailedPromise.php b/src/FailedPromise.php
@@ -6,6 +6,8 @@
 
 /**
  * @api
+ * @template Type
+ * @implements Contract\PromiseInterface<Type>
  */
 final class FailedPromise implements Contract\PromiseInterface
 {
@@ -16,17 +18,28 @@ public function __construct(\Throwable $exception)
         $this->resolution = new Resolution\Failure($exception);
     }
 
+    /**
+     * @param callable(Type): Type $callback
+     *
+     * @return Contract\PromiseInterface<Type>
+     */
     public function then(callable $callback): Contract\PromiseInterface
     {
         return $this;
     }
 
+    /**
+     * @param callable(\Throwable): \Throwable $callback
+     *
+     * @return Contract\PromiseInterface<Type>
+     */
     public function failure(callable $callback): Contract\PromiseInterface
     {
         $this->resolution->apply($callback);
         return $this;
     }
 
+    /** @return Contract\DeferredInterface<Type> */
     public function defer(): Contract\DeferredInterface
     {
         return new Deferred($this);

diff --git a/src/Promise.php b/src/Promise.php
@@ -6,12 +6,14 @@
 
 /**
  * @api
+ * @template Type
+ * @implements Contract\ResolvablePromiseInterface<Type>
  */
 final class Promise implements Contract\ResolvablePromiseInterface
 {
-    /** @var callable */
+    /** @var array<callable(Type): Type> */
     private $successCallbacks;
-    /** @var callable */
+    /** @var array<callable(\Throwable): \Throwable> */
     private $failureCallbacks;
     private Contract\Resolution\ResolutionInterface $resolution;
 
@@ -22,11 +24,11 @@ public function __construct()
         $this->resolution = new Resolution\Pending();
     }
 
-    public function defer(): Contract\DeferredInterface
-    {
-        return new Deferred($this);
-    }
-
+    /**
+     * @param callable(Type): Type $callback
+     *
+     * @return Contract\PromiseInterface<Type>
+     */
     public function then(callable $callback): Contract\PromiseInterface
     {
         if ($this->resolution instanceof Contract\Resolution\SuccessInterface) {
@@ -38,6 +40,11 @@ public function then(callable $callback): Contract\PromiseInterface
         return $this;
     }
 
+    /**
+     * @param callable(\Throwable): \Throwable $callback
+     *
+     * @return Contract\PromiseInterface<Type>
+     */
     public function failure(callable $callback): Contract\PromiseInterface
     {
         if ($this->resolution instanceof Contract\Resolution\FailureInterface) {
@@ -49,6 +56,12 @@ public function failure(callable $callback): Contract\PromiseInterface
         return $this;
     }
 
+    /** @return Contract\DeferredInterface<Type> */
+    public function defer(): Contract\DeferredInterface
+    {
+        return new Deferred($this);
+    }
+
     public function resolve($value): void
     {
         if (!$this->resolution instanceof Resolution\Pending) {

diff --git a/src/Resolution/Success.php b/src/Resolution/Success.php
@@ -6,18 +6,23 @@
 
 /**
  * @internal
+ * @template Type
+ * @implements SuccessInterface<Type>
  */
 final class Success implements SuccessInterface
 {
+    /** @param Type $value */
     public function __construct(private $value)
     {
     }
 
+    /** @return Type */
     public function value()
     {
         return $this->value;
     }
 
+    /** @var callable(Type) */
     public function apply(callable $callback): void
     {
         if (($value = $callback($this->value)) !== null) {

diff --git a/src/SucceededPromise.php b/src/SucceededPromise.php
@@ -6,27 +6,44 @@
 
 /**
  * @api
+ * @template Type
+ * @implements Contract\PromiseInterface<Type>
  */
 final class SucceededPromise implements Contract\PromiseInterface
 {
+    /** @var Contract\Resolution\SuccessInterface<Type> */
     private Contract\Resolution\SuccessInterface $resolution;
 
+    /**
+     * @param Type $value
+     */
     public function __construct($value)
     {
         $this->resolution = new Resolution\Success($value);
     }
 
+    /**
+     * @param callable(Type): Type $callback
+     *
+     * @return Contract\PromiseInterface<Type>
+     */
     public function then(callable $callback): Contract\PromiseInterface
     {
         $this->resolution->apply($callback);
         return $this;
     }
 
+    /**
+     * @param callable(\Throwable): \Throwable $callback
+     *
+     * @return Contract\PromiseInterface<Type>
+     */
     public function failure(callable $callback): Contract\PromiseInterface
     {
         return $this;
     }
 
+    /** @return Contract\DeferredInterface<Type> */
     public function defer(): Contract\DeferredInterface
     {
         return new Deferred($this);