Merge pull request #22 from square/custom-exception

Throw custom exception on missing required prop

Author: khepin

src/Exceptions/MissingRequiredPropertyException.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Square\Pjson\Exceptions;
+
+use Exception;
+
+class MissingRequiredPropertyException extends Exception
+{
+    public function __construct(array $path, string $json)
+    {
+        parent::__construct(sprintf("missing property %s in %s", json_encode($path), $json));
+    }
+}

src/Json.php

@@ -4,6 +4,7 @@
 use Attribute;
 use ReflectionNamedType;
 use ReflectionProperty;
+use Square\Pjson\Exceptions\MissingRequiredPropertyException;
 use Square\Pjson\Internal\RClass;
 use Traversable;
 
@@ -64,7 +65,7 @@ public function retrieveValue(array $data, ?ReflectionNamedType $type = null)
     {
         foreach ($this->path as $pathBit) {
             if (!array_key_exists($pathBit, $data)) {
-                return $this->handleMissingValue();
+                return $this->handleMissingValue($data);
             }
             $data = $data[$pathBit];
         }
@@ -119,10 +120,10 @@ public function retrieveValue(array $data, ?ReflectionNamedType $type = null)
     /**
      * What happens when deserializing a property that isn't set.
      */
-    protected function handleMissingValue()
+    protected function handleMissingValue($data)
     {
         if ($this->required) {
-            throw new \Exception('missing required value: '.json_encode($this->path));
+            throw new MissingRequiredPropertyException($this->path, json_encode($data));
         }
         return null;
     }

tests/DeSerializationTest.php

@@ -3,6 +3,7 @@
 
 use PHPUnit\Framework\TestCase;
 use ReflectionClass;
+use Square\Pjson\Exceptions\MissingRequiredPropertyException;
 use Square\Pjson\Tests\Definitions\BigCat;
 use Square\Pjson\Tests\Definitions\BigInt;
 use Square\Pjson\Tests\Definitions\CatalogCategory;
@@ -562,7 +563,7 @@ public function testRequiredPropertyMissing()
     {
         $json = '{}';
 
-        $this->expectException(\Exception::class);
+        $this->expectException(MissingRequiredPropertyException::class);
 
         Token::fromJsonString($json);
     }