Introduce PathException for JsonPatch

This exception is thrown in JsonPatch::apply whenever a JsonPointer
call fails.

Author: Silvan-WMDE

src/JsonPatch.php

@@ -61,7 +61,7 @@ public static function import(array $data)
             }
 
             if (!is_object($operation)) {
-                throw new Exception( 'Invalid patch operation - should be a JSON object' );
+                throw new Exception('Invalid patch operation - should be a JSON object');
             }
 
             if (!isset($operation->op)) {
@@ -145,32 +145,32 @@ public function apply(&$original, $stopOnError = true)
         $errors = array();
         foreach ($this->operations as $operation) {
             try {
-                $pathItems = JsonPointer::splitPath($operation->path);
+                $pathItems = $this->splitPath($operation, 'path');
                 switch (true) {
                     case $operation instanceof Add:
-                        JsonPointer::add($original, $pathItems, $operation->value, $this->flags);
+                        $this->add($operation, $original, $pathItems, $operation->value);
                         break;
                     case $operation instanceof Copy:
-                        $fromItems = JsonPointer::splitPath($operation->from);
-                        $value = JsonPointer::get($original, $fromItems);
-                        JsonPointer::add($original, $pathItems, $value, $this->flags);
+                        $fromItems = $this->splitPath($operation, 'from');
+                        $value = $this->get($operation, 'from', $original, $fromItems);
+                        $this->add($operation, $original, $pathItems, $value);
                         break;
                     case $operation instanceof Move:
-                        $fromItems = JsonPointer::splitPath($operation->from);
-                        $value = JsonPointer::get($original, $fromItems);
-                        JsonPointer::remove($original, $fromItems, $this->flags);
-                        JsonPointer::add($original, $pathItems, $value, $this->flags);
+                        $fromItems = $this->splitPath($operation, 'from');
+                        $value = $this->get($operation, 'from', $original, $fromItems);
+                        $this->remove($operation, 'from', $original, $fromItems);
+                        $this->add($operation, $original, $pathItems, $value);
                         break;
                     case $operation instanceof Remove:
-                        JsonPointer::remove($original, $pathItems, $this->flags);
+                        $this->remove($operation, 'path', $original, $pathItems);
                         break;
                     case $operation instanceof Replace:
-                        JsonPointer::get($original, $pathItems);
-                        JsonPointer::remove($original, $pathItems, $this->flags);
-                        JsonPointer::add($original, $pathItems, $operation->value, $this->flags);
+                        $this->get($operation, 'path', $original, $pathItems);
+                        $this->remove($operation, 'path', $original, $pathItems);
+                        $this->add($operation, $original, $pathItems, $operation->value);
                         break;
                     case $operation instanceof Test:
-                        $value = JsonPointer::get($original, $pathItems);
+                        $value = $this->get($operation, 'path', $original, $pathItems);
                         $diff = new JsonDiff($operation->value, $value,
                             JsonDiff::STOP_ON_DIFF);
                         if ($diff->getDiffCnt() !== 0) {
@@ -188,4 +188,41 @@ public function apply(&$original, $stopOnError = true)
         }
         return $errors;
     }
+
+    private function splitPath(OpPath $operation, $field)
+    {
+        try {
+            return JsonPointer::splitPath($operation->$field);
+        } catch (Exception $exception) {
+            throw new PathException($exception->getMessage(), $operation, $field, $exception->getCode());
+        }
+    }
+
+    private function add(OpPath $operation, &$original, array $pathItems, $value)
+    {
+        try {
+            JsonPointer::add($original, $pathItems, $value, $this->flags);
+        } catch (Exception $exception) {
+            throw new PathException($exception->getMessage(), $operation, 'path', $exception->getCode());
+        }
+    }
+
+    private function get(OpPath $operation, $field, $original, array $pathItems)
+    {
+        try {
+            return JsonPointer::get($original, $pathItems);
+        } catch (Exception $exception) {
+            throw new PathException($exception->getMessage(), $operation, $field, $exception->getCode());
+        }
+    }
+
+    private function remove($operation, $field, &$original, array $pathItems)
+    {
+        try {
+            JsonPointer::remove($original, $pathItems, $this->flags);
+        } catch (Exception $exception) {
+            throw new PathException($exception->getMessage(), $operation, $field, $exception->getCode());
+        }
+    }
+
 }

src/PathException.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Swaggest\JsonDiff;
+
+
+use Throwable;
+
+class PathException extends Exception
+{
+    /** @var object */
+    private $operation;
+
+	/** @var string */
+	private $field;
+
+	/**
+	 * @param string $message
+	 * @param object $operation
+	 * @param string $field
+     * @param int $code
+     * @param Throwable|null $previous
+     */
+    public function __construct(
+		$message,
+        $operation,
+		$field,
+        $code = 0,
+        Throwable $previous = null
+    )
+    {
+        parent::__construct($message, $code, $previous);
+        $this->operation = $operation;
+		$this->field = $field;
+	}
+
+    /**
+     * @return object
+     */
+    public function getOperation()
+    {
+        return $this->operation;
+    }
+
+	/**
+	 * @return string
+	 */
+	public function getField()
+	{
+		return $this->field;
+	}
+}

tests/src/JsonPatchTest.php

@@ -7,6 +7,7 @@
 use Swaggest\JsonDiff\JsonPatch;
 use Swaggest\JsonDiff\MissingFieldException;
 use Swaggest\JsonDiff\PatchTestOperationFailedException;
+use Swaggest\JsonDiff\PathException;
 use Swaggest\JsonDiff\UnknownOperationException;
 
 class JsonPatchTest extends \PHPUnit_Framework_TestCase
@@ -174,4 +175,25 @@ public function testTestOperationFailed()
         $this->assertSame($actualValue, $testError->getActualValue());
     }
 
+	public function testPathException()
+	{
+		$data = new \stdClass();
+		$patch = new JsonPatch();
+
+		$operation1 = new JsonPatch\Add('/some/path', 22);
+		$patch->op($operation1);
+
+		$operation2 = new JsonPatch\Move('/target', '/source');
+		$patch->op($operation2);
+
+		$errors = $patch->apply($data, false);
+
+		$this->assertInstanceOf(PathException::class, $errors[0]);
+		$this->assertSame($operation1, $errors[0]->getOperation());
+		$this->assertSame('path', $errors[0]->getField());
+
+		$this->assertInstanceOf(PathException::class, $errors[1]);
+		$this->assertSame($operation2, $errors[1]->getOperation());
+		$this->assertSame('from', $errors[1]->getField());
+	}
 }