Upgrade PHPUnit and change coverage config (#60)

facile-it · Apr 24, 2023 · 28318ae · 28318ae
1 parent 7196242
commit 28318ae
Show file tree

Hide file tree

Showing 36 changed files with 120 additions and 30 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -24,8 +24,8 @@ jobs:
       - name: Install dependencies
         uses: ramsey/composer-install@v2
       - name: Run tests
-        run: ./vendor/bin/phpunit --coverage-clover=build/coverage-report.xml
+        run: ./vendor/bin/phpunit
       - name: Upload code coverage
         uses: codecov/codecov-action@v1
         with:
-          file: build/coverage-report.xml
+          file: build/clover.xml
diff --git a/Makefile b/Makefile
@@ -35,7 +35,7 @@ type-assertions:
 	./vendor/bin/psalm tests/type-assertions --no-cache
 
 test:
-	./vendor/bin/phpunit
+	XDEBUG_MODE=coverage ./vendor/bin/phpunit
 
 .PHONY: ci ci-check cs-check cs-fix
 cs-fix:

diff --git a/composer.json b/composer.json
@@ -3,13 +3,12 @@
     "description": "A partial porting of io-ts in PHP",
     "type": "library",
     "require-dev": {
-        "phpunit/phpunit": "^8.5",
+        "phpunit/phpunit": "^9",
         "giorgiosironi/eris": "^0.14.0",
-        "phpunit/php-code-coverage": "^7.0",
         "phpat/phpat": "^0.10",
-        "facile-it/facile-coding-standard": "^0.5.1",
+        "facile-it/facile-coding-standard": "0.5.2",
         "vimeo/psalm": "4.30.0",
-        "friendsofphp/php-cs-fixer": "^3.3",
+        "friendsofphp/php-cs-fixer": "3.16.0",
         "phpstan/phpstan": "^1.8",
         "rector/rector": "^0.15.25"
     },

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,25 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.5/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         executionOrder="depends,defects"
-         forceCoversAnnotation="false"
-         beStrictAboutCoversAnnotation="false"
-         beStrictAboutOutputDuringTests="true"
-         beStrictAboutTodoAnnotatedTests="true"
-         verbose="true">
-    <testsuites>
-        <testsuite name="Unit">
-            <directory suffix="Test.php">./tests/unit/</directory>
-        </testsuite>
-        <testsuite name="Examples">
-            <directory suffix="Test.php">./tests/examples</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" forceCoversAnnotation="false" beStrictAboutCoversAnnotation="false" beStrictAboutOutputDuringTests="true" beStrictAboutTodoAnnotatedTests="true" verbose="true">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <report>
+      <clover outputFile="build/clover.xml"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="Unit">
+      <directory suffix="Test.php">./tests/unit/</directory>
+    </testsuite>
+    <testsuite name="Examples">
+      <directory suffix="Test.php">./tests/examples</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/src/Decoder.php b/src/Decoder.php
@@ -16,6 +16,7 @@ interface Decoder
     /**
      * @psalm-param I $i
      * @psalm-param Context $context
+     *
      * @psalm-return Validation<A>
      *
      * @param mixed $i
@@ -24,6 +25,7 @@ public function validate($i, Context $context): Validation;
 
     /**
      * @psalm-param I $i
+     *
      * @psalm-return Validation<A>
      *
      * @param mixed $i

diff --git a/src/Decoders.php b/src/Decoders.php
@@ -37,8 +37,10 @@ private function __construct()
     /**
      * @template I
      * @template A
+     *
      * @psalm-param callable(I, Context):Validation<A> $f
      * @psalm-param string $name
+     *
      * @psalm-return Decoder<I, A>
      */
     public static function make(callable $f, string $name = 'anon'): Decoder
@@ -51,8 +53,10 @@ public static function make(callable $f, string $name = 'anon'): Decoder
      * @template IB
      * @template A of IB
      * @template B
+     *
      * @psalm-param Decoder<IB, B> $db
      * @psalm-param Decoder<IA, A> $da
+     *
      * @psalm-return Decoder<IA, B>
      */
     public static function compose(Decoder $db, Decoder $da): Decoder
@@ -161,6 +165,7 @@ public static function union(Decoder $a, Decoder $b, ?Decoder $c = null, ?Decode
      *
      * @psalm-param Decoder<IA, A> $a
      * @psalm-param Decoder<IB, B> $b
+     *
      * @psalm-return Decoder<IA & IB, A & B>
      */
     public static function intersection(Decoder $a, Decoder $b): Decoder
@@ -180,8 +185,10 @@ public static function intersection(Decoder $a, Decoder $b): Decoder
      * @template I
      * @template A
      * @template B
+     *
      * @psalm-param callable(A):B $f
      * @psalm-param Decoder<I, A> $da
+     *
      * @psalm-return Decoder<I, B>
      */
     public static function transformValidationSuccess(callable $f, Decoder $da): Decoder
@@ -194,7 +201,9 @@ public static function transformValidationSuccess(callable $f, Decoder $da): Dec
 
     /**
      * @psalm-template T of bool | string | int
+     *
      * @psalm-param T $l
+     *
      * @psalm-return Decoder<mixed, T>
      *
      * @param mixed $l
@@ -221,6 +230,7 @@ public static function listOf(Decoder $elementDecoder): Decoder
      * @psalm-template MapOfDecoders of non-empty-array<array-key, Decoder<mixed, mixed>>
      *
      * @psalm-param MapOfDecoders $props
+     *
      * @psalm-return Decoder<mixed, non-empty-array<array-key, mixed>>
      *
      * @param Decoder[] $props
@@ -244,6 +254,7 @@ public static function arrayProps(array $props): Decoder
      * @psalm-param Decoder<mixed, Properties> $propsDecoder
      * @psalm-param ClassFactory $factory
      * @psalm-param string $decoderName
+     *
      * @psalm-return Decoder<mixed, T>
      */
     public static function classFromArrayPropsDecoder(
@@ -271,7 +282,9 @@ public static function classFromArrayPropsDecoder(
 
     /**
      * @psalm-template U
+     *
      * @psalm-param U $default
+     *
      * @psalm-return Decoder<mixed, U>
      *
      * @param null|mixed $default
@@ -369,6 +382,7 @@ public static function regex(string $regex): Decoder
 
     /**
      * @psalm-param string $regex
+     *
      * @psalm-return Decoder<string, string>
      */
     public static function stringMatchingRegex(string $regex): Decoder

diff --git a/src/Internal/Arrays/ListOfDecoder.php b/src/Internal/Arrays/ListOfDecoder.php
@@ -15,7 +15,9 @@
  * @psalm-template I of mixed
  * @psalm-template IT of mixed
  * @psalm-template T
+ *
  * @template-implements Decoder<I, list<T>>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class ListOfDecoder implements Decoder

diff --git a/src/Internal/Combinators/ArrayPropsDecoder.php b/src/Internal/Combinators/ArrayPropsDecoder.php
@@ -17,7 +17,9 @@
  * @psalm-template Vs
  * @psalm-template I
  * @psalm-template PD of non-empty-array<K, Decoder<mixed, Vs>>
+ *
  * @template-implements Decoder<I, non-empty-array<K, Vs>>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class ArrayPropsDecoder implements Decoder

diff --git a/src/Internal/Combinators/ComposeDecoder.php b/src/Internal/Combinators/ComposeDecoder.php
@@ -15,6 +15,7 @@
  * @psalm-template B
  *
  * @template-implements Decoder<IA, B>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class ComposeDecoder implements Decoder
@@ -39,6 +40,7 @@ public function __construct(
     /**
      * @psalm-param IA      $i
      * @psalm-param Context $context
+     *
      * @psalm-return Validation<B>
      *
      * @param mixed $i

diff --git a/src/Internal/Combinators/IntersectionDecoder.php b/src/Internal/Combinators/IntersectionDecoder.php
@@ -17,7 +17,9 @@
  * @psalm-template IB
  * @psalm-template A
  * @psalm-template B
+ *
  * @template-implements Decoder<IA & IB, A & B>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class IntersectionDecoder implements Decoder
@@ -89,8 +91,10 @@ public function getName(): string
     /**
      * @template T1
      * @template T2
+     *
      * @psalm-param T1 $a
      * @psalm-param T2 $b
+     *
      * @psalm-return T1&T2
      *
      * @param mixed $a

diff --git a/src/Internal/Combinators/LiteralDecoder.php b/src/Internal/Combinators/LiteralDecoder.php
@@ -11,15 +11,19 @@
 
 /**
  * @psalm-type literable = bool | string | int
+ *
  * @template I of mixed
  * @template T of literable
+ *
  * @template-implements Decoder<I, T>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class LiteralDecoder implements Decoder
 {
     /**
      * @var T
+     *
      * @readonly
      */
     private $literal;

diff --git a/src/Internal/Combinators/MapDecoder.php b/src/Internal/Combinators/MapDecoder.php
@@ -12,7 +12,9 @@
 /**
  * @template A
  * @template B
+ *
  * @implements Decoder<A, B>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class MapDecoder implements Decoder

diff --git a/src/Internal/Combinators/UnionDecoder.php b/src/Internal/Combinators/UnionDecoder.php
@@ -16,7 +16,9 @@
  * @psalm-template IB
  * @psalm-template A
  * @psalm-template B
+ *
  * @template-implements Decoder<IA & IB, A | B>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class UnionDecoder implements Decoder

diff --git a/src/Internal/FunctionUtils.php b/src/Internal/FunctionUtils.php
@@ -38,8 +38,10 @@ public static function nameFromProps(array $props): string
     /**
      * @psalm-template A
      * @psalm-template I
+     *
      * @psalm-param Decoder<I, A> $decoder
      * @psalm-param I             $input
+     *
      * @psalm-return Validation<A>
      *
      * @param mixed $input
@@ -57,7 +59,9 @@ public static function standardDecode(Decoder $decoder, $input): Validation
 
     /**
      * @psalm-template R
+     *
      * @psalm-param callable(mixed...):R $f
+     *
      * @psalm-return callable(list<mixed>):R
      */
     public static function destructureIn(callable $f): callable

diff --git a/src/Internal/Primitives/BoolDecoder.php b/src/Internal/Primitives/BoolDecoder.php
@@ -11,7 +11,9 @@
 
 /**
  * @template I of mixed
+ *
  * @template-implements Decoder<I, bool>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class BoolDecoder implements Decoder

diff --git a/src/Internal/Primitives/CallableDecoder.php b/src/Internal/Primitives/CallableDecoder.php
@@ -11,7 +11,9 @@
 
 /**
  * @template I of mixed
+ *
  * @template-implements Decoder<I, callable>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class CallableDecoder implements Decoder

diff --git a/src/Internal/Primitives/FloatDecoder.php b/src/Internal/Primitives/FloatDecoder.php
@@ -11,7 +11,9 @@
 
 /**
  * @template I of mixed
+ *
  * @template-implements Decoder<I, float>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class FloatDecoder implements Decoder

diff --git a/src/Internal/Primitives/IntDecoder.php b/src/Internal/Primitives/IntDecoder.php
@@ -11,7 +11,9 @@
 
 /**
  * @template I of mixed
+ *
  * @template-implements Decoder<I, int>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class IntDecoder implements Decoder

diff --git a/src/Internal/Primitives/MixedDecoder.php b/src/Internal/Primitives/MixedDecoder.php
@@ -11,7 +11,9 @@
 
 /**
  * @psalm-template U of mixed
+ *
  * @template-implements Decoder<U, U>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class MixedDecoder implements Decoder

diff --git a/src/Internal/Primitives/NullDecoder.php b/src/Internal/Primitives/NullDecoder.php
@@ -11,7 +11,9 @@
 
 /**
  * @template I of mixed
+ *
  * @template-implements Decoder<I, null>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class NullDecoder implements Decoder

diff --git a/src/Internal/Primitives/StringDecoder.php b/src/Internal/Primitives/StringDecoder.php
@@ -11,7 +11,9 @@
 
 /**
  * @template I of mixed
+ *
  * @template-implements Decoder<I, string>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class StringDecoder implements Decoder

diff --git a/src/Internal/Primitives/UndefinedDecoder.php b/src/Internal/Primitives/UndefinedDecoder.php
@@ -12,7 +12,9 @@
 
 /**
  * @psalm-template U
+ *
  * @template-implements Decoder<mixed, U>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class UndefinedDecoder implements Decoder

diff --git a/src/Internal/Useful/DateTimeFromStringDecoder.php b/src/Internal/Useful/DateTimeFromStringDecoder.php
@@ -11,6 +11,7 @@
 
 /**
  * @template-implements Decoder<string, \DateTimeInterface>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class DateTimeFromStringDecoder implements Decoder

diff --git a/src/Internal/Useful/IntFromStringDecoder.php b/src/Internal/Useful/IntFromStringDecoder.php
@@ -11,6 +11,7 @@
 
 /**
  * @implements Decoder<string, int>
+ *
  * @psalm-internal Facile\PhpCodec
  */
 final class IntFromStringDecoder implements Decoder
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,7 @@ @@
     /**
      * @template-implements Decoder<string, \DateTimeInterface>
+     *
      * @psalm-internal Facile\PhpCodec
      */
     final class DateTimeFromStringDecoder implements Decoder
@@ Expand Down @@