Issue #1: Add PSALM type declarations.

loophp · Jan 22, 2020 · 365a726 · 365a726
1 parent a31a4a6
commit 365a726
Show file tree

Hide file tree

Showing 25 changed files with 196 additions and 26 deletions.
diff --git a/composer.json b/composer.json
@@ -24,7 +24,8 @@
         "phpspec/phpspec": "^5.1.2 || ^6.1.1",
         "phpstan/phpstan": "^0.12.5",
         "phpstan/phpstan-strict-rules": "^0.12",
-        "scrutinizer/ocular": "^1.6"
+        "scrutinizer/ocular": "^1.6",
+        "vimeo/psalm": "^3.8"
     },
     "config": {
         "sort-packages": true

diff --git a/grumphp.yml.dist b/grumphp.yml.dist
@@ -4,6 +4,7 @@ imports:
 parameters:
     process_timeout: 600
     extra_tasks:
+        psalm: ~
         phpspec:
             verbose: true
             metadata:

diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    totallyTyped="false"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>
diff --git a/src/Combinator/A.php b/src/Combinator/A.php
@@ -8,6 +8,9 @@
 
 /**
  * Class A.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class A extends Combinator
 {
@@ -24,6 +27,9 @@ final class A extends Combinator
     /**
      * A constructor.
      *
+     * @psalm-param callable(XType) : ResultType $f
+     * @psalm-param XType $x
+     *
      * @param callable $f
      * @param mixed $x
      */
@@ -34,6 +40,8 @@ public function __construct(callable $f, $x)
     }
 
     /**
+     * @psalm-return ResultType
+     *
      * @return mixed
      */
     public function __invoke()

diff --git a/src/Combinator/B.php b/src/Combinator/B.php
@@ -8,6 +8,10 @@
 
 /**
  * Class B.
+ *
+ * @psalm-template GOutput
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class B extends Combinator
 {
@@ -29,6 +33,10 @@ final class B extends Combinator
     /**
      * B constructor.
      *
+     * @psalm-param callable(GOutput) : ResultType $f
+     * @psalm-param callable(XType) : GOutput $g
+     * @psalm-param XType $x
+     *
      * @param callable $f
      * @param callable $g
      * @param mixed $x
@@ -41,7 +49,7 @@ public function __construct(callable $f, callable $g, $x)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/C.php b/src/Combinator/C.php
@@ -8,6 +8,9 @@
 
 /**
  * Class C.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class C extends Combinator
 {
@@ -29,6 +32,10 @@ final class C extends Combinator
     /**
      * C constructor.
      *
+     * @psalm-param callable(XType) : ResultType $f
+     * @psalm-param XType $x
+     * @psalm-param XType $y
+     *
      * @param callable $f
      * @param mixed $x
      * @param mixed $y
@@ -41,7 +48,7 @@ public function __construct(callable $f, $x, $y)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/D.php b/src/Combinator/D.php
@@ -8,6 +8,9 @@
 
 /**
  * Class D.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class D extends Combinator
 {
@@ -34,6 +37,11 @@ final class D extends Combinator
     /**
      * D constructor.
      *
+     * @psalm-param callable(XType) : ResultType $f
+     * @psalm-param callable(XType) : ResultType $g
+     * @psalm-param XType $x
+     * @psalm-param XType $y
+     *
      * @param callable $f
      * @param callable $g
      * @param mixed $x
@@ -48,7 +56,7 @@ public function __construct(callable $f, $x, callable $g, $y)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/E.php b/src/Combinator/E.php
@@ -8,6 +8,9 @@
 
 /**
  * Class E.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class E extends Combinator
 {
@@ -39,6 +42,12 @@ final class E extends Combinator
     /**
      * E constructor.
      *
+     * @psalm-param callable(XType) : ResultType $f
+     * @psalm-param XType $x
+     * @psalm-param callable(XType) : ResultType $g
+     * @psalm-param XType $y
+     * @psalm-param XType $z
+     *
      * @param callable $f
      * @param mixed $x
      * @param callable $g
@@ -55,7 +64,7 @@ public function __construct(callable $f, $x, callable $g, $y, $z)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/F.php b/src/Combinator/F.php
@@ -8,6 +8,9 @@
 
 /**
  * Class F.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class F extends Combinator
 {
@@ -22,13 +25,17 @@ final class F extends Combinator
     private $x;
 
     /**
-     * @var callable
+     * @var mixed
      */
     private $y;
 
     /**
      * F constructor.
      *
+     * @psalm-param XType $x
+     * @psalm-param XType $y
+     * @psalm-param callable(XType) : ResultType $f
+     *
      * @param mixed $x
      * @param mixed $y
      * @param callable $f
@@ -41,7 +48,7 @@ public function __construct($x, $y, callable $f)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/G.php b/src/Combinator/G.php
@@ -8,6 +8,9 @@
 
 /**
  * Class G.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class G extends Combinator
 {
@@ -27,13 +30,18 @@ final class G extends Combinator
     private $x;
 
     /**
-     * @var callable
+     * @var mixed
      */
     private $y;
 
     /**
      * G constructor.
      *
+     * @psalm-param callable(XType) : callable $f
+     * @psalm-param callable(XType) : ResultType $g
+     * @psalm-param XType $x
+     * @psalm-param XType $y
+     *
      * @param callable $f
      * @param callable $g
      * @param mixed $x
@@ -48,7 +56,7 @@ public function __construct(callable $f, callable $g, $x, $y)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/H.php b/src/Combinator/H.php
@@ -8,6 +8,9 @@
 
 /**
  * Class H.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class H extends Combinator
 {
@@ -17,7 +20,7 @@ final class H extends Combinator
     private $f;
 
     /**
-     * @var callable
+     * @var mixed
      */
     private $x;
 
@@ -29,6 +32,10 @@ final class H extends Combinator
     /**
      * H constructor.
      *
+     * @psalm-param callable(XType) : callable $f
+     * @psalm-param XType $x
+     * @psalm-param XType $y
+     *
      * @param callable $f
      * @param mixed $x
      * @param mixed $y
@@ -41,7 +48,7 @@ public function __construct(callable $f, $x, $y)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/I.php b/src/Combinator/I.php
@@ -8,6 +8,9 @@
 
 /**
  * Class I.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class I extends Combinator
 {
@@ -19,6 +22,8 @@ final class I extends Combinator
     /**
      * I constructor.
      *
+     * @psalm-param XType $x
+     *
      * @param mixed $x
      */
     public function __construct($x)
@@ -27,7 +32,7 @@ public function __construct($x)
     }
 
     /**
-     * @return mixed
+     * @psalm-return XType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/J.php b/src/Combinator/J.php
@@ -8,6 +8,9 @@
 
 /**
  * Class J.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class J extends Combinator
 {
@@ -17,7 +20,7 @@ final class J extends Combinator
     private $f;
 
     /**
-     * @var callable
+     * @var mixed
      */
     private $x;
 
@@ -34,6 +37,11 @@ final class J extends Combinator
     /**
      * J constructor.
      *
+     * @psalm-param callable(XType) : callable $f
+     * @psalm-param XType $x
+     * @psalm-param XType $y
+     * @psalm-param XType $z
+     *
      * @param callable $f
      * @param mixed $x
      * @param mixed $y
@@ -48,7 +56,7 @@ public function __construct(callable $f, $x, $y, $z)
     }
 
     /**
-     * @return mixed
+     * @psalm-return ResultType
      */
     public function __invoke()
     {

diff --git a/src/Combinator/K.php b/src/Combinator/K.php
@@ -8,6 +8,9 @@
 
 /**
  * Class K.
+ *
+ * @psalm-template XType
+ * @psalm-template ResultType
  */
 final class K extends Combinator
 {
@@ -24,6 +27,9 @@ final class K extends Combinator
     /**
      * K constructor.
      *
+     * @psalm-param XType $x
+     * @psalm-param XType $y
+     *
      * @param mixed $x
      * @param mixed $y
      */
@@ -34,7 +40,7 @@ public function __construct($x, $y)
     }
 
     /**
-     * @return mixed
+     * @psalm-return XType
      */
     public function __invoke()
     {