Merge pull request #17 from minvws/feature/doc-update

chore: small update of license documentation

Author: lkeijmel

LICENSES.md

@@ -4,7 +4,7 @@ First - The work that is created in the Covid19 context, such as the notificatio
 
 However - that does not mean that all (derived) work is solely under that single license. For example - where appropriate certain (open source) modules may be required and included. These will remain under their original Copyright and License (though some may be released under the EUPL/1.2 if they are unsuitable to be contributed back upstream).
 
-Secondly – The documents of this project that are held in the directory ‘documentation’ are released under the CC0 license (see www.rijksoverheid.nl/copyright). If you use (parts) of these documents, you are not obliged to quote the source, but you must not imply that the Dutch government endorses the derivative work.
+Secondly – The documentation of this project is released under the CC0 license (see www.rijksoverheid.nl/copyright). If you use (parts) of these documents, you are not obliged to quote the source, but you must not imply that the Dutch government endorses the derivative work.
 
 The CC0 does not apply to:
 

phpstan.neon.dist

@@ -3,9 +3,11 @@ parameters:
         - ./src
         - ./tests
     level: max
-    checkGenericClassInNonGenericObjectType: false
-    checkMissingIterableValueType: false
     universalObjectCratesClasses:
         - MinVWS\Codable\Encoding\EncodingContainer
         - MinVWS\Codable\Decoding\DecodingContainer
-    editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
+    editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
+
+    ignoreErrors:
+        - identifier: missingType.generics
+        - identifier: missingType.iterableValue

tests/Encoding/EncoderTest.php

@@ -4,6 +4,7 @@
 
 namespace Encoding;
 
+use Countable;
 use DateTimeImmutable;
 use Generator;
 use MinVWS\Codable\Encoding\Encoder;
@@ -17,6 +18,26 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * @phpstan-type PersonShape array{
+ *     firstName: string,
+ *     infix: string,
+ *     surname: string,
+ *     birthDate: string,
+ *     favoriteFruit: string,
+ *     address: array{
+ *         country: string,
+ *     },
+ *     dislikedFruits: array<Fruit>,
+ *     notes: array<string>,
+ * }
+ * @phpstan-type FruitSaladShape array{
+ *     title: string,
+ *     description: string,
+ *     author: string,
+ *     fruits: Countable,
+ * }
+ */
 class EncoderTest extends TestCase
 {
     use WithFaker;
@@ -98,6 +119,8 @@ public function testEncodeComplexType(Person $person): void
     {
         $encoder = new Encoder();
         $encoder->getContext()->setUseAssociativeArraysForObjects(true);
+
+        /** @var PersonShape $data */
         $data = $encoder->encode($person);
         $this->assertIsArray($data);
         $this->assertEquals($person->firstName, $data['firstName']);
@@ -119,6 +142,7 @@ public static function encodingModeProvider(): Generator
         yield [EncodingContext::MODE_DISPLAY, false];
     }
 
+
     #[DataProvider('encodingModeProvider')]
     public function testEncodingMode(?string $mode, bool $expectsAuthor): void
     {
@@ -132,6 +156,8 @@ public function testEncodingMode(?string $mode, bool $expectsAuthor): void
         $encoder = new Encoder();
         $encoder->getContext()->setMode($mode);
         $encoder->getContext()->setUseAssociativeArraysForObjects(true);
+
+        /** @var FruitSaladShape $data */
         $data = $encoder->encode($salad);
         $this->assertIsArray($data);
         $this->assertEquals($salad->title, $data['title']);