Merge pull request #15 from jsonCarmock/add-merge-patch

Add JSON Merge Patch support #13

Author: vearutop

.gitattributes

@@ -11,3 +11,4 @@
 /phpunit.xml export-ignore
 /changelog.md export-ignore
 /Makefile export-ignore
+/.gitlab-ci.yml

.gitlab-ci.yml

@@ -0,0 +1,39 @@
+before_script:
+- apt-get update -yqq
+- apt-get install git unzip -yqq
+- curl https://composer.github.io/installer.sig | tr -d '\n' > installer.sig
+- php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+- php -r "if (hash_file('SHA384', 'composer-setup.php') === file_get_contents('installer.sig')) { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
+- php composer-setup.php
+- php -r "unlink('composer-setup.php'); unlink('installer.sig');"
+- php composer.phar install --prefer-dist --no-ansi --no-interaction --no-progress
+
+test:5.6:
+  image: php:5.6
+  script:
+  - pecl install xdebug-2.5.5
+  - docker-php-ext-enable xdebug
+  - vendor/bin/phpunit --configuration phpunit.xml -v --coverage-text --colors=never --stderr
+
+test:7.0:
+  image: php:7.0
+  script:
+  - pecl install xdebug
+  - docker-php-ext-enable xdebug
+  - vendor/bin/phpunit --configuration phpunit.xml -v --coverage-text --colors=never --stderr
+
+test:7.1:
+  image: php:7.1
+  script:
+  - pecl install xdebug
+  - docker-php-ext-enable xdebug
+  - vendor/bin/phpunit --configuration phpunit.xml -v --coverage-text --colors=never --stderr
+
+test:7.2:
+  image: php:7.2
+  script:
+  - pecl install xdebug
+  - docker-php-ext-enable xdebug
+  - vendor/bin/phpunit --configuration phpunit.xml -v --coverage-text --colors=never --stderr
+  - curl https://github.com/phpstan/phpstan/releases/download/0.9.2/phpstan.phar -sLo ./phpstan.phar
+  - php phpstan.phar analyze -l 7 ./src

.travis.yml

@@ -20,7 +20,7 @@ cache:
 # execute any number of scripts before the test run, custom env's are available as variables
 before_script:
   - composer install --dev --no-interaction --prefer-dist
-  - if [[ $(phpenv version-name) =~ 7.2 ]] ; then test -f $HOME/.composer/cache/phpstan.phar || wget https://github.com/phpstan/phpstan/releases/download/0.9.1/phpstan.phar -O $HOME/.composer/cache/phpstan.phar; fi
+  - if [[ $(phpenv version-name) =~ 7.2 ]] ; then test -f $HOME/.composer/cache/phpstan.phar || wget https://github.com/phpstan/phpstan/releases/download/0.9.2/phpstan.phar -O $HOME/.composer/cache/phpstan.phar; fi
   - if [[ $(phpenv version-name) =~ 7.2 ]] ; then test -f $HOME/.composer/cache/ocular.phar || wget https://scrutinizer-ci.com/ocular.phar -O $HOME/.composer/cache/ocular.phar; fi
   - if [[ $(phpenv version-name) =~ 7.2 ]] ; then test -f $HOME/.composer/cache/cctr || wget https://codeclimate.com/downloads/test-reporter/test-reporter-0.1.4-linux-amd64 -O $HOME/.composer/cache/cctr && chmod +x $HOME/.composer/cache/cctr; fi
   - if [[ $(phpenv version-name) =~ 7.2 ]] ; then $HOME/.composer/cache/cctr before-build; fi

README.md

@@ -13,6 +13,7 @@ A PHP implementation for finding unordered diff between two `JSON` documents.
  * To detect breaking changes by analyzing removals and changes from original `JSON`.
  * To keep original order of object sets (for example `swagger.json` [parameters](https://swagger.io/docs/specification/describing-parameters/) list).
  * To make and apply JSON Patches, specified in [RFC 6902](http://tools.ietf.org/html/rfc6902) from the IETF.
+ * To make and apply JSON Merge Patches, specified in [RFC 7386](https://tools.ietf.org/html/rfc7386) from the IETF.
  * To retrieve and modify data by [JSON Pointer](http://tools.ietf.org/html/rfc6901).
  * To recursively replace by JSON value.
 
@@ -55,11 +56,23 @@ $r = new JsonDiff(
 );
 ```
 
+Available options:
+ * `REARRANGE_ARRAYS` is an option to enable arrays rearrangement to minimize the difference.
+ * `STOP_ON_DIFF` is an option to improve performance by stopping comparison when a difference is found.
+ * `JSON_URI_FRAGMENT_ID` is an option to use URI Fragment Identifier Representation (example: "#/c%25d"). If not set default JSON String Representation (example: "/c%d").
+ * `SKIP_JSON_PATCH` is an option to improve performance by not building JsonPatch for this diff.
+ * `SKIP_JSON_MERGE_PATCH` is an option to improve performance by not building JSON Merge Patch value for this diff.
+
+Options can be combined, e.g. `JsonDiff::REARRANGE_ARRAYS + JsonDiff::STOP_ON_DIFF`.
+
 On created object you have several handy methods.
 
 #### `getPatch`
 Returns [`JsonPatch`](#jsonpatch) of difference
 
+#### `getMergePatch`
+Returns [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) value of difference
+
 #### `getRearranged`
 Returns new value, rearranged with original order.
 
@@ -137,6 +150,11 @@ Gets value from data at path specified `JSON Pointer` string.
 #### `remove`
 Removes value from data at path specified by segments.
 
+### `JsonMergePatch`
+
+#### `apply`
+Applies patch to `JSON`-decoded data.
+
 ### `JsonValueReplace`
 
 #### `process`

composer.json

@@ -1,32 +1,35 @@
 {
-    "name": "swaggest/json-diff",
-    "description": "JSON diff/rearrange/patch/pointer library for PHP",
-    "type": "library",
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Viacheslav Poturaev",
-            "email": "vearutop@gmail.com"
-        }
-    ],
-    "require-dev": {
-        "phpunit/phpunit": "^4.8.23",
-        "phpunit/php-code-coverage": "2.2.4",
-        "codeclimate/php-test-reporter": "^0.4.0"
-    },
-    "autoload": {
-        "psr-4": {
-            "Swaggest\\JsonDiff\\": "src/"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Swaggest\\JsonDiff\\Tests\\": "tests/src"
-        }
-    },
-    "config": {
-        "platform": {
-            "php": "5.4.45"
-        }
+  "name": "swaggest/json-diff",
+  "description": "JSON diff/rearrange/patch/pointer library for PHP",
+  "type": "library",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Viacheslav Poturaev",
+      "email": "vearutop@gmail.com"
     }
+  ],
+  "require": {
+    "ext-json": "*"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^4.8.23",
+    "phpunit/php-code-coverage": "2.2.4",
+    "codeclimate/php-test-reporter": "^0.4.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Swaggest\\JsonDiff\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Swaggest\\JsonDiff\\Tests\\": "tests/src"
+    }
+  },
+  "config": {
+    "platform": {
+      "php": "5.4.45"
+    }
+  }
 }

composer.lock

@@ -9,19 +9,41 @@
 
 class JsonDiff
 {
+    /**
+     * REARRANGE_ARRAYS is an option to enable arrays rearrangement to minimize the difference.
+     */
     const REARRANGE_ARRAYS = 1;
+
+    /**
+     * STOP_ON_DIFF is an option to improve performance by stopping comparison when a difference is found.
+     */
     const STOP_ON_DIFF = 2;
 
     /**
-     * Use URI Fragment Identifier Representation will be used (example: "#/c%25d").
+     * JSON_URI_FRAGMENT_ID is an option to use URI Fragment Identifier Representation (example: "#/c%25d").
      * If not set default JSON String Representation (example: "/c%d").
      */
     const JSON_URI_FRAGMENT_ID = 4;
 
+    /**
+     * SKIP_JSON_PATCH is an option to improve performance by not building JsonPatch for this diff.
+     */
+    const SKIP_JSON_PATCH = 8;
+
+    /**
+     * SKIP_JSON_MERGE_PATCH is an option to improve performance by not building JSON Merge Patch value for this diff.
+     */
+    const SKIP_JSON_MERGE_PATCH = 16;
+
     private $options = 0;
     private $original;
     private $new;
 
+    /**
+     * @var mixed Merge patch container
+     */
+    private $merge;
+
     private $added;
     private $addedCnt = 0;
     private $addedPaths = array();
@@ -44,15 +66,16 @@ class JsonDiff
     private $jsonPatch;
 
     /**
-     * Processor constructor.
      * @param mixed $original
      * @param mixed $new
      * @param int $options
      * @throws Exception
      */
     public function __construct($original, $new, $options = 0)
     {
-        $this->jsonPatch = new JsonPatch();
+        if (!($options & self::SKIP_JSON_PATCH)) {
+            $this->jsonPatch = new JsonPatch();
+        }
 
         $this->original = $original;
         $this->new = $new;
@@ -63,6 +86,9 @@ public function __construct($original, $new, $options = 0)
         }
 
         $this->rearranged = $this->rearrange();
+        if (($new !== null) && $this->merge === null) {
+            $this->merge = new \stdClass();
+        }
     }
 
     /**
@@ -182,6 +208,15 @@ public function getPatch()
         return $this->jsonPatch;
     }
 
+    /**
+     * Returns JSON Merge Patch value of difference
+     */
+    public function getMergePatch()
+    {
+        return $this->merge;
+
+    }
+
     /**
      * @return array|null|object|\stdClass
      * @throws Exception
@@ -199,6 +234,8 @@ private function rearrange()
      */
     private function process($original, $new)
     {
+        $merge = !($this->options & self::SKIP_JSON_MERGE_PATCH);
+
         if (
             (!$original instanceof \stdClass && !is_array($original))
             || (!$new instanceof \stdClass && !is_array($new))
@@ -210,12 +247,17 @@ private function process($original, $new)
                 }
                 $this->modifiedPaths [] = $this->path;
 
-                $this->jsonPatch->op(new Test($this->path, $original));
-                $this->jsonPatch->op(new Replace($this->path, $new));
+                if ($this->jsonPatch !== null) {
+                    $this->jsonPatch->op(new Test($this->path, $original));
+                    $this->jsonPatch->op(new Replace($this->path, $new));
+                }
 
                 JsonPointer::add($this->modifiedOriginal, $this->pathItems, $original);
                 JsonPointer::add($this->modifiedNew, $this->pathItems, $new);
 
+                if ($merge) {
+                    JsonPointer::add($this->merge, $this->pathItems, $new, JsonPointer::RECURSIVE_KEY_CREATION);
+                }
             }
             return $new;
         }
@@ -234,6 +276,15 @@ private function process($original, $new)
         $isArray = is_array($original);
         $removedOffset = 0;
 
+        if ($merge && is_array($new) && !is_array($original)) {
+            $merge = false;
+            JsonPointer::add($this->merge, $this->pathItems, $new);
+        } elseif ($merge  && $new instanceof \stdClass && !$original instanceof \stdClass) {
+            $merge = false;
+            JsonPointer::add($this->merge, $this->pathItems, $new);
+        }
+
+        $isUriFragment = (bool)($this->options & self::JSON_URI_FRAGMENT_ID);
         foreach ($originalKeys as $key => $originalValue) {
             if ($this->options & self::STOP_ON_DIFF) {
                 if ($this->modifiedCnt || $this->addedCnt || $this->removedCnt) {
@@ -247,7 +298,7 @@ private function process($original, $new)
             if ($isArray && is_int($actualKey)) {
                 $actualKey -= $removedOffset;
             }
-            $this->path .= '/' . JsonPointer::escapeSegment($actualKey, $this->options & self::JSON_URI_FRAGMENT_ID);
+            $this->path .= '/' . JsonPointer::escapeSegment((string)$actualKey, $isUriFragment);
             $this->pathItems[] = $actualKey;
 
             if (array_key_exists($key, $newArray)) {
@@ -263,9 +314,15 @@ private function process($original, $new)
                     $removedOffset++;
                 }
 
-                $this->jsonPatch->op(new Remove($this->path));
+                if ($this->jsonPatch !== null) {
+                    $this->jsonPatch->op(new Remove($this->path));
+                }
 
                 JsonPointer::add($this->removed, $this->pathItems, $originalValue);
+                if ($merge) {
+                    JsonPointer::add($this->merge, $this->pathItems, null);
+                }
+
             }
             $this->path = $path;
             $this->pathItems = $pathItems;
@@ -278,13 +335,19 @@ private function process($original, $new)
                 return null;
             }
             $newOrdered[$key] = $value;
-            $path = $this->path . '/' . JsonPointer::escapeSegment($key, $this->options & self::JSON_URI_FRAGMENT_ID);
+            $path = $this->path . '/' . JsonPointer::escapeSegment($key, $isUriFragment);
             $pathItems = $this->pathItems;
             $pathItems[] = $key;
             JsonPointer::add($this->added, $pathItems, $value);
+            if ($merge) {
+                JsonPointer::add($this->merge, $pathItems, $value);
+            }
+
             $this->addedPaths [] = $path;
 
-            $this->jsonPatch->op(new Add($path, $value));
+            if ($this->jsonPatch !== null) {
+                $this->jsonPatch->op(new Add($path, $value));
+            }
 
         }
 
@@ -302,6 +365,7 @@ private function rearrangeArray(array $original, array $new)
         $uniqueIdx = array();
 
         // find unique key for all items
+        /** @var mixed[string]  $f */
         $f = get_object_vars($first);
         foreach ($f as $key => $value) {
             if (is_array($value) || $value instanceof \stdClass) {

src/JsonDiff.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Swaggest\JsonDiff;
+
+
+class JsonMergePatch
+{
+    public static function apply(&$original, $patch)
+    {
+        if (null === $patch) {
+            $original = null;
+        } elseif (is_object($patch)) {
+            foreach (get_object_vars($patch) as $key => $val) {
+                if ($val === null) {
+                    unset($original->$key);
+                } else {
+                    if (!is_object($original)) {
+                        $original = new \stdClass();
+                    }
+                    $branch = &$original->$key;
+                    if (null === $branch) {
+                        $branch = new \stdClass();
+                    }
+                    self::apply($branch, $val);
+                }
+            }
+        } else {
+            $original = $patch;
+        }
+    }
+}

src/JsonMergePatch.php

@@ -30,6 +30,7 @@ public function __construct($search, $replace, $pathFilter = null)
      * Recursively replaces all nodes equal to `search` value with `replace` value.
      * @param mixed $data
      * @return mixed
+     * @throws Exception
      */
     public function process($data)
     {

src/JsonValueReplace.php

@@ -0,0 +1,190 @@
+[
+  {
+    "doc": {
+      "a": "b"
+    },
+    "patch": {
+      "a": "c"
+    },
+    "expected": {
+      "a": "c"
+    }
+  },
+  {
+    "doc": {
+      "a": "b"
+    },
+    "patch": {
+      "b": "c"
+    },
+    "expected": {
+      "a": "b",
+      "b": "c"
+    }
+  },
+  {
+    "doc": {
+      "a": "b"
+    },
+    "patch": {
+      "a": null
+    },
+    "expected": {}
+  },
+  {
+    "doc": {
+      "a": "b",
+      "b": "c"
+    },
+    "patch": {
+      "a": null
+    },
+    "expected": {
+      "b": "c"
+    }
+  },
+  {
+    "doc": {
+      "a": [
+        "b"
+      ]
+    },
+    "patch": {
+      "a": "c"
+    },
+    "expected": {
+      "a": "c"
+    }
+  },
+  {
+    "doc": {
+      "a": "c"
+    },
+    "patch": {
+      "a": [
+        "b"
+      ]
+    },
+    "expected": {
+      "a": [
+        "b"
+      ]
+    }
+  },
+  {
+    "doc": {
+      "a": {
+        "b": "c"
+      }
+    },
+    "patch": {
+      "a": {
+        "b": "d",
+        "c": null
+      }
+    },
+    "expected": {
+      "a": {
+        "b": "d"
+      }
+    }
+  },
+  {
+    "doc": {
+      "a": [
+        {
+          "b": "c"
+        }
+      ]
+    },
+    "patch": {
+      "a": [
+        1
+      ]
+    },
+    "expected": {
+      "a": [
+        1
+      ]
+    }
+  },
+  {
+    "doc": [
+      "a",
+      "b"
+    ],
+    "patch": [
+      "c",
+      "d"
+    ],
+    "expected": [
+      "c",
+      "d"
+    ]
+  },
+  {
+    "doc": {
+      "a": "b"
+    },
+    "patch": [
+      "c"
+    ],
+    "expected": [
+      "c"
+    ]
+  },
+  {
+    "doc": {
+      "a": "foo"
+    },
+    "patch": null,
+    "expected": null
+  },
+  {
+    "doc": {
+      "a": "foo"
+    },
+    "patch": "bar",
+    "expected": "bar"
+  },
+  {
+    "doc": {
+      "e": null
+    },
+    "patch": {
+      "a": 1
+    },
+    "expected": {
+      "e": null,
+      "a": 1
+    }
+  },
+  {
+    "doc": [
+      1,
+      2
+    ],
+    "patch": {
+      "a": "b",
+      "c": null
+    },
+    "expected": {
+      "a": "b"
+    }
+  },
+  {
+    "doc": {},
+    "patch": {
+      "a": {
+        "bb": {
+          "ccc": null
+        }
+      }
+    },
+    "expected": {
+      "a": {
+        "bb": {}
+      }
+    }
+  }
+]

tests/assets/merge-patch.json

@@ -18,4 +18,29 @@ public function testStopOnDiff()
         $this->assertSame(1, $diff->getDiffCnt());
     }
 
+    /**
+     * @throws \Swaggest\JsonDiff\Exception
+     */
+    public function testSkipPatch()
+    {
+        $original = (object)(array("root" => (object)array("a" => 1, "b" => 2)));
+        $new = (object)(array("root" => (object)array("b" => 3, "c" => 4)));
+
+        $diff = new JsonDiff($original, $new, JsonDiff::SKIP_JSON_PATCH);
+        $this->assertSame(null, $diff->getPatch());
+        $this->assertSame(3, $diff->getDiffCnt());
+        $this->assertSame(1, $diff->getAddedCnt());
+        $this->assertSame(1, $diff->getRemovedCnt());
+        $this->assertSame(1, $diff->getModifiedCnt());
+
+        $diff = new JsonDiff($original, $new, JsonDiff::REARRANGE_ARRAYS);
+        $this->assertEquals('[{"op":"remove","path":"/root/a"},{"value":2,"op":"test","path":"/root/b"},{"value":3,"op":"replace","path":"/root/b"},{"value":4,"op":"add","path":"/root/c"}]',
+            json_encode($diff->getPatch(), JSON_UNESCAPED_SLASHES));
+        $this->assertSame(3, $diff->getDiffCnt());
+        $this->assertSame(1, $diff->getAddedCnt());
+        $this->assertSame(1, $diff->getRemovedCnt());
+        $this->assertSame(1, $diff->getModifiedCnt());
+
+    }
+
 }

tests/src/DiffTest.php

@@ -0,0 +1,293 @@
+<?php
+
+namespace Swaggest\JsonDiff\Tests;
+
+
+use Swaggest\JsonDiff\Exception;
+use Swaggest\JsonDiff\JsonDiff;
+use Swaggest\JsonDiff\JsonMergePatch;
+
+class MergePatchTest extends \PHPUnit_Framework_TestCase
+{
+
+    public function testSimple()
+    {
+        $case = json_decode(<<<'JSON'
+  {
+    "doc": {},
+    "patch": {
+      "a": {
+        "bb": {
+          "ccc": null
+        }
+      }
+    },
+    "expected": {
+      "a": {
+        "bb": {}
+      }
+    }
+  }
+JSON
+        );
+        $doc = $case->doc;
+        $patch = $case->patch;
+        $expected = $case->expected;
+
+        JsonMergePatch::apply($doc, $patch);
+
+        $this->assertEquals($expected, $doc);
+    }
+
+    public function test13()
+    {
+        $case = json_decode(<<<'JSON'
+{
+    "doc": [
+        1,
+        2
+    ],
+    "patch": {
+        "a": "b",
+        "c": null
+    },
+    "expected": {
+        "a": "b"
+    }
+}
+JSON
+        );
+        $doc = $case->doc;
+        $patch = $case->patch;
+        $expected = $case->expected;
+
+        JsonMergePatch::apply($doc, $patch);
+
+        $this->assertEquals($expected, $doc);
+
+    }
+
+    public function testGetMergePatch()
+    {
+        $case = json_decode(<<<'JSON'
+{
+    "doc": {
+        "a": {
+            "b": "c"
+        }
+    },
+    "patch": {
+        "a": {
+            "b": "d",
+            "c": null
+        }
+    },
+    "expected": {
+        "a": {
+            "b": "d"
+        }
+    }
+}
+JSON
+        );
+        $doc = $case->doc;
+        $expected = $case->expected;
+        $diff = new JsonDiff($doc, $expected);
+        $mergePatch = $diff->getMergePatch();
+        JsonMergePatch::apply($doc, $mergePatch);
+
+        $this->assertEquals($expected, $doc, 'Apply created failed: ' . json_encode(
+                [
+                    "test" => $case,
+                    "patch" => $mergePatch,
+                    "result" => $doc,
+                ], JSON_UNESCAPED_SLASHES + JSON_PRETTY_PRINT));
+
+    }
+
+
+    public function testGetMergePatchOfArray()
+    {
+        $case = json_decode(<<<'JSON'
+{
+    "doc": {
+        "a": "b"
+    },
+    "patch": [
+        "c"
+    ],
+    "expected": [
+        "c"
+    ]
+}
+JSON
+        );
+        $doc = $case->doc;
+        $expected = $case->expected;
+        $diff = new JsonDiff($doc, $expected);
+        $mergePatch = $diff->getMergePatch();
+        JsonMergePatch::apply($doc, $mergePatch);
+
+        $this->assertEquals($expected, $doc, 'Apply created failed: ' . json_encode(
+                [
+                    "test" => $case,
+                    "patch" => $mergePatch,
+                    "result" => $doc,
+                ], JSON_UNESCAPED_SLASHES + JSON_PRETTY_PRINT));
+
+    }
+
+
+    public function testSame()
+    {
+        $case = json_decode(<<<'JSON'
+{
+    "doc": {
+        "a": {
+            "b": "d"
+        }
+    },
+    "patch": {
+        "a": {
+            "b": "d"
+        }
+    },
+    "expected": {
+        "a": {
+            "b": "d"
+        }
+    }
+}
+JSON
+        );
+        $doc = $case->doc;
+        $expected = $case->expected;
+        $diff = new JsonDiff($doc, $expected);
+        //print_r($diff->getPatch());
+        $mergePatch = $diff->getMergePatch();
+        JsonMergePatch::apply($doc, $mergePatch);
+
+        $this->assertEquals($expected, $doc, 'Apply created failed: ' . json_encode(
+                [
+                    "test" => $case,
+                    "patch" => $mergePatch,
+                    "result" => $doc,
+                ], JSON_UNESCAPED_SLASHES + JSON_PRETTY_PRINT));
+
+    }
+
+    public function testArraySwap()
+    {
+        $case = json_decode(<<<'JSON'
+{
+    "doc": [
+        "a",
+        "b"
+    ],
+    "patch": [
+        "c",
+        "d"
+    ],
+    "expected": [
+        "c",
+        "d"
+    ]
+}
+JSON
+        );
+        $doc = $case->doc;
+        $expected = $case->expected;
+        $diff = new JsonDiff($doc, $expected);
+        //print_r($diff->getPatch());
+        $mergePatch = $diff->getMergePatch();
+        JsonMergePatch::apply($doc, $mergePatch);
+
+        $this->assertEquals($expected, $doc, 'Apply created failed: ' . json_encode(
+                [
+                    "test" => $case,
+                    "patch" => $mergePatch,
+                    "result" => $doc,
+                ], JSON_UNESCAPED_SLASHES + JSON_PRETTY_PRINT));
+
+
+    }
+
+
+    /**
+     * @dataProvider specTestsProvider
+     */
+    public function testSpec($case)
+    {
+        $this->doTest($case);
+    }
+
+    public function specTestsProvider()
+    {
+        return $this->provider(__DIR__ . '/../assets/merge-patch.json');
+    }
+
+    protected function provider($path)
+    {
+        $cases = json_decode(file_get_contents($path));
+
+        $testCases = array();
+        foreach ($cases as $i => $case) {
+            if (!isset($case->comment)) {
+                $comment = 'unknown' . $i;
+            } else {
+                $comment = $case->comment;
+            }
+
+            $testCases[$comment] = array(
+                'case' => $case,
+            );
+        }
+        return $testCases;
+    }
+
+    protected function doTest($case)
+    {
+        $case = clone $case;
+
+        if (!is_object($case->doc)) {
+            $doc = $case->doc;
+        } else {
+            $doc = clone $case->doc;
+        }
+        $patch = $case->patch;
+        $expected = isset($case->expected) ? $case->expected : null;
+        $jsonOptions = JSON_UNESCAPED_SLASHES + JSON_PRETTY_PRINT;
+
+
+        JsonMergePatch::apply($doc, $patch);
+        $this->assertEquals($expected, $doc, 'Apply failed: ' . json_encode(
+                [
+                    "test" => $case,
+                    "result" => $doc,
+                ], $jsonOptions));
+
+        if (!is_object($case->doc)) {
+            $doc = $case->doc;
+        } else {
+            $doc = clone $case->doc;
+        }
+        try {
+            $diff = new JsonDiff($doc, $expected);
+            $mergePatch = $diff->getMergePatch();
+        } catch (Exception $exception) {
+            $mergePatch = $exception->getMessage();
+        }
+        JsonMergePatch::apply($doc, $mergePatch);
+
+        $this->assertEquals($expected, $doc, 'Apply created failed: ' . json_encode(
+                [
+                    "test" => $case,
+                    "patch" => $mergePatch,
+                    "result" => $doc,
+                ], $jsonOptions));
+
+
+    }
+
+
+}

tests/src/MergePatchTest.php

@@ -8,6 +8,9 @@
 
 class RearrangeTest extends \PHPUnit_Framework_TestCase
 {
+    /**
+     * @throws \Swaggest\JsonDiff\Exception
+     */
     public function testKeepOrder()
     {
         $originalJson = <<<'JSON'

tests/src/RearrangeTest.php

@@ -56,7 +56,8 @@ protected function provider($path)
         return $testCases;
     }
 
-    protected function doTest($case) {
+    protected function doTest($case)
+    {
         $case = clone $case;
 
         if (isset($case->disabled) && $case->disabled) {