Introduce JsonPointerException

Replace all occurences of the generic Exception in JsonPointer with the
more specific JsonPointerException so that the origin of the error is
made explicit and can be handled by consuming code.

Author: Silvan-WMDE

src/JsonPointer.php

@@ -66,7 +66,7 @@ public static function splitPath($path)
             return self::splitPathURIFragment($pathItems);
         } else {
             if ($first !== '') {
-                throw new Exception('Path must start with "/": ' . $path);
+                throw new JsonPointerException('Path must start with "/": ' . $path);
             }
             return self::splitPathJsonString($pathItems);
         }
@@ -105,15 +105,15 @@ public static function add(&$holder, $pathItems, $value, $flags = self::RECURSIV
         while (null !== $key = array_shift($pathItems)) {
             if ($ref instanceof \stdClass || is_object($ref)) {
                 if (PHP_VERSION_ID < 70100 && '' === $key) {
-                    throw new Exception('Empty property name is not supported by PHP <7.1',
+                    throw new JsonPointerException('Empty property name is not supported by PHP <7.1',
                         Exception::EMPTY_PROPERTY_NAME_UNSUPPORTED);
                 }
 
                 if ($flags & self::RECURSIVE_KEY_CREATION) {
                     $ref = &$ref->$key;
                 } else {
                     if (!isset($ref->$key) && count($pathItems)) {
-                        throw new Exception('Non-existent path item: ' . $key);
+                        throw new JsonPointerException('Non-existent path item: ' . $key);
                     } else {
                         $ref = &$ref->$key;
                     }
@@ -126,7 +126,7 @@ public static function add(&$holder, $pathItems, $value, $flags = self::RECURSIV
                         $ref = new \stdClass();
                         $ref = &$ref->{$key};
                     } else {
-                        throw new Exception('Non-existent path item: ' . $key);
+                        throw new JsonPointerException('Non-existent path item: ' . $key);
                     }
                 } elseif ([] === $ref && 0 === ($flags & self::STRICT_MODE) && false === $intKey && '-' !== $key) {
                     $ref = new \stdClass();
@@ -138,7 +138,7 @@ public static function add(&$holder, $pathItems, $value, $flags = self::RECURSIV
                     } else {
                         if (false === $intKey) {
                             if (0 === ($flags & self::TOLERATE_ASSOCIATIVE_ARRAYS)) {
-                                throw new Exception('Invalid key for array operation');
+                                throw new JsonPointerException('Invalid key for array operation');
                             }
                             $ref = &$ref[$key];
                             continue;
@@ -148,9 +148,9 @@ public static function add(&$holder, $pathItems, $value, $flags = self::RECURSIV
                         }
                         if (0 === ($flags & self::TOLERATE_ASSOCIATIVE_ARRAYS)) {
                             if ($intKey > count($ref) && 0 === ($flags & self::RECURSIVE_KEY_CREATION)) {
-                                throw new Exception('Index is greater than number of items in array');
+                                throw new JsonPointerException('Index is greater than number of items in array');
                             } elseif ($intKey < 0) {
-                                throw new Exception('Negative index');
+                                throw new JsonPointerException('Negative index');
                             }
                         }
 
@@ -203,30 +203,30 @@ public static function get($holder, $pathItems)
         while (null !== $key = array_shift($pathItems)) {
             if ($ref instanceof \stdClass) {
                 if (PHP_VERSION_ID < 70100 && '' === $key) {
-                    throw new Exception('Empty property name is not supported by PHP <7.1',
+                    throw new JsonPointerException('Empty property name is not supported by PHP <7.1',
                         Exception::EMPTY_PROPERTY_NAME_UNSUPPORTED);
                 }
 
                 $vars = (array)$ref;
                 if (self::arrayKeyExists($key, $vars)) {
                     $ref = self::arrayGet($key, $vars);
                 } else {
-                    throw new Exception('Key not found: ' . $key);
+                    throw new JsonPointerException('Key not found: ' . $key);
                 }
             } elseif (is_array($ref)) {
                 if (self::arrayKeyExists($key, $ref)) {
                     $ref = $ref[$key];
                 } else {
-                    throw new Exception('Key not found: ' . $key);
+                    throw new JsonPointerException('Key not found: ' . $key);
                 }
             } elseif (is_object($ref)) {
                 if (isset($ref->$key)) {
                     $ref = $ref->$key;
                 } else {
-                    throw new Exception('Key not found: ' . $key);
+                    throw new JsonPointerException('Key not found: ' . $key);
                 }
             } else {
-                throw new Exception('Key not found: ' . $key);
+                throw new JsonPointerException('Key not found: ' . $key);
             }
         }
         return $ref;
@@ -260,19 +260,19 @@ public static function remove(&$holder, $pathItems, $flags = 0)
                 if (property_exists($ref, $key)) {
                     $ref = &$ref->$key;
                 } else {
-                    throw new Exception('Key not found: ' . $key);
+                    throw new JsonPointerException('Key not found: ' . $key);
                 }
             } elseif (is_object($ref)) {
                 if (isset($ref->$key)) {
                     $ref = &$ref->$key;
                 } else {
-                    throw new Exception('Key not found: ' . $key);
+                    throw new JsonPointerException('Key not found: ' . $key);
                 }
             } else {
                 if (array_key_exists($key, $ref)) {
                     $ref = &$ref[$key];
                 } else {
-                    throw new Exception('Key not found: ' . $key);
+                    throw new JsonPointerException('Key not found: ' . $key);
                 }
             }
         }

src/JsonPointerException.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Swaggest\JsonDiff;
+
+class JsonPointerException extends Exception {}

tests/src/JsonPointerTest.php

@@ -5,6 +5,7 @@
 
 use Swaggest\JsonDiff\Exception;
 use Swaggest\JsonDiff\JsonPointer;
+use Swaggest\JsonDiff\JsonPointerException;
 
 class JsonPointerTest extends \PHPUnit_Framework_TestCase
 {
@@ -30,7 +31,7 @@ public function testProcess()
 
         try {
             $this->assertSame('null', json_encode(JsonPointer::get($json, JsonPointer::splitPath('/l1/l2/non-existent'))));
-        } catch (Exception $exception) {
+        } catch (JsonPointerException $exception) {
             $this->assertSame('Key not found: non-existent', $exception->getMessage());
         }
 
@@ -89,7 +90,7 @@ public function testGetSetDeleteObject()
         try {
             JsonPointer::get($s, ['one', 'two']);
             $this->fail('Exception expected');
-        } catch (Exception $e) {
+        } catch (JsonPointerException $e) {
             $this->assertEquals('Key not found: two', $e->getMessage());
         }
         $this->assertEquals(null, $s->one->two);