chore: add and fix phpstan (#26)

gbprod · Aug 19, 2020 · 57a0a50 · 57a0a50
1 parent 81e2924
commit 57a0a50
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 19 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -19,6 +19,7 @@ before_script:
 
 script:
   - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
+  - make analyse
 
 after_success:
   - wget https://scrutinizer-ci.com/ocular.phar

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: install test-unit test-coverage
+.PHONY: install test-unit test-coverage analyse
 
 PHP?=php
 COMPOSER?=composer
@@ -16,3 +16,6 @@ vendor: composer.lock
 
 composer.lock: composer.json
 	$(COMPOSER) update
+
+analyse: install
+	$(PHP) vendor/bin/phpstan analyse --level max ./src ./tests
diff --git a/composer.json b/composer.json
@@ -19,12 +19,13 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^8.0",
-    "symfony/property-access": "^3.4|^4.3|^5.0"
+    "symfony/property-access": "^3.4|^4.3|^5.0",
+    "phpstan/phpstan": "^0.12.37"
   },
   "license": "WTFPL",
   "authors": [
     {
-      "name": "GBProd",
+      "name": "gbprod",
       "email": "contact@gb-prod.fr"
     }
   ]

diff --git a/src/UuidDenormalizer.php b/src/UuidDenormalizer.php
@@ -17,7 +17,13 @@
 class UuidDenormalizer implements DenormalizerInterface
 {
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @param array<mixed> $context
+     *
+     * @return UuidInterface|null
+     *
+     * @throws UnexpectedValueException
      */
     public function denormalize($data, $type, $format = null, array $context = [])
     {
@@ -33,14 +39,17 @@ public function denormalize($data, $type, $format = null, array $context = [])
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function supportsDenormalization($data, $type, $format = null)
     {
         return (Uuid::class === $type || UuidInterface::class === $type);
     }
 
-    private function isValid($data)
+    /**
+     * @param mixed $data
+     */
+    private function isValid($data): bool
     {
         return $data === null
             || (is_string($data) && Uuid::isValid($data));

diff --git a/src/UuidNormalizer.php b/src/UuidNormalizer.php
@@ -15,15 +15,19 @@
 class UuidNormalizer implements NormalizerInterface
 {
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
+     * @param array<mixed> $context
+     *
+     * @return string
      */
     public function normalize($object, $format = null, array $context = [])
     {
         return $object->toString();
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function supportsNormalization($data, $format = null)
     {

diff --git a/tests/Functionnal/DenormalizeUsingPhpDocTest.php b/tests/Functionnal/DenormalizeUsingPhpDocTest.php
@@ -17,6 +17,7 @@
 
 class DenormalizeUsingPhpDocTest extends TestCase
 {
+    /** @var Serializer */
     private $serializer;
 
     public function setUp(): void
@@ -39,23 +40,23 @@ public function setUp(): void
     public function testDenormalizeWithUuid(): void
     {
         $uuid = Uuid::uuid4();
-        $denormalized = $this->serializer->denormalize(
+        $denormalized = (array) $this->serializer->denormalize(
             ['uuid' => $uuid->toString()],
             ClassWithUuidAttribute::class
         );
 
-        $this->assertEquals($uuid, $denormalized->uuid);
+        $this->assertEquals($uuid, $denormalized['uuid']);
     }
 
     public function testDenormalizeWithUuidInterface(): void
     {
         $uuid = Uuid::uuid4();
-        $denormalized = $this->serializer->denormalize(
+        $denormalized = (array) $this->serializer->denormalize(
             ['uuid' => $uuid->toString()],
             ClassWithUuidInterfaceAttribute::class
         );
 
-        $this->assertEquals($uuid, $denormalized->uuid);
+        $this->assertEquals($uuid, $denormalized['uuid']);
     }
 
     public function testDenormalizeWithArrayOfUuid(): void
@@ -67,14 +68,14 @@ public function testDenormalizeWithArrayOfUuid(): void
             Uuid::uuid5(Uuid::NAMESPACE_DNS, 'php.net'),
         ];
 
-        $denormalized = $this->serializer->denormalize(
+        $denormalized = (array) $this->serializer->denormalize(
             ['uuids' => array_map(function ($uuid) {
                 return $uuid->toString();
             }, $uuids)],
             ClassWithArrayOfUuidAttribute::class
         );
 
-        $this->assertEquals($uuids, $denormalized->uuids);
+        $this->assertEquals($uuids, $denormalized['uuids']);
     }
 
     public function testDenormalizeWithArrayOfUuidInterface(): void
@@ -86,14 +87,14 @@ public function testDenormalizeWithArrayOfUuidInterface(): void
             Uuid::uuid5(Uuid::NAMESPACE_DNS, 'php.net'),
         ];
 
-        $denormalized = $this->serializer->denormalize(
+        $denormalized = (array) $this->serializer->denormalize(
             ['uuids' => array_map(function ($uuid) {
                 return $uuid->toString();
             }, $uuids)],
             ClassWithArrayOfUuidInterfaceAttribute::class
         );
 
-        $this->assertEquals($uuids, $denormalized->uuids);
+        $this->assertEquals($uuids, $denormalized['uuids']);
     }
 }
 

diff --git a/tests/Functionnal/NomalizeTest.php b/tests/Functionnal/NomalizeTest.php
@@ -8,11 +8,13 @@
 use GBProd\UuidNormalizer\UuidNormalizer;
 use PHPUnit\Framework\TestCase;
 use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\UuidInterface;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\Serializer\Serializer;
 
 class NormalizeTest extends TestCase
 {
+    /** @var Serializer */
     private $serializer;
 
     public function setUp(): void
@@ -28,7 +30,7 @@ public function testNormalizeOnArray(): void
     {
         $uuid = Uuid::uuid4();
 
-        $normalized = $this->serializer->normalize(
+        $normalized = (array) $this->serializer->normalize(
             ['uuid' => $uuid]
         );
 
@@ -43,7 +45,7 @@ public function testNormalizeOnObject(): void
         $object = new ClassWithUuid();
         $object->uuid = Uuid::uuid4();
 
-        $normalized = $this->serializer->normalize($object);
+        $normalized = (array) $this->serializer->normalize($object);
 
         $this->assertEquals(
             $object->uuid->toString(),
@@ -60,7 +62,7 @@ public function testNormalizeArrayOfUuidOnObject(): void
             Uuid::uuid4(),
         ];
 
-        $normalized = $this->serializer->normalize($object);
+        $normalized = (array) $this->serializer->normalize($object);
 
         $this->assertEquals(
             $object->uuid[0]->toString(),
@@ -71,5 +73,6 @@ public function testNormalizeArrayOfUuidOnObject(): void
 
 class ClassWithUuid
 {
+    /** @var UuidInterface|array<UuidInterface> */
     public $uuid;
 }
diff --git a/tests/UuidNormalizerTest.php b/tests/UuidNormalizerTest.php
@@ -18,6 +18,7 @@ class UuidNormalizerTest extends TestCase
 {
     const UUID_SAMPLE = '110e8400-e29b-11d4-a716-446655440000';
 
+    /** @var UuidNormalizer */
     private $normalizer;
 
     public function setUp(): void
@@ -42,6 +43,9 @@ public function testSupportsIsTrueIfUuid(UuidInterface $uuid): void
         );
     }
 
+    /**
+     * @return array<array<UuidInterface>>
+     */
     public function uuidProvider(): array
     {
         return array(