Illustrate proper usage of the exclusion system. Add ability to change original.

Author: Keoghan

src/JsonDiff.php

@@ -30,9 +30,21 @@ public function __construct($original = '')
      */
     public function exclude($value)
     {
-        $value = ! $value ? [] : $value;
+        if (! empty($value)) {
+            $this->exclude = is_array($value) ? $value : [$value];
+        }
 
-        $this->exclude = is_array($value) ? $value : [$value];
+        return $this;
+    }
+
+    /**
+     * Clear our exclusions
+     *
+     * @return $this
+     */
+    public function clearExclusions()
+    {
+        $this->exclude = [];
 
         return $this;
     }
@@ -51,6 +63,20 @@ public function setDivider($divider = null)
         return $this;
     }
 
+    /**
+     * Allow us to set the original json for comparison
+     *
+     * @param $value
+     *
+     * @return $this
+     */
+    public function setOriginal($value)
+    {
+        $this->original = $value;
+
+        return $this;
+    }
+
     /**
      * Simple factory method for cleaner usage
      *
@@ -70,10 +96,10 @@ public static function original($original)
      * @param string $new
      * @param array  $exclude
      *
-     * @return array
+     * @return \Konsulting\JsonDiffResult
      * @throws \Konsulting\Exceptions\JsonDecodeFailed
      */
-    public static function compare($original, $new, $exclude = [])
+    public static function compare($original, $new, $exclude = null)
     {
         return static::original($original)->exclude($exclude)->compareTo($new);
     }

tests/Unit/JsonDiffTest.php

@@ -24,6 +24,15 @@ public function it_diffs_simple_json_and_removes_a_column()
         $this->assertEquals(['a' => 1], $diff->compareTo('{"a":"1","b":"2"}')->added);
     }
 
+    /** @test */
+    public function we_can_change_the_original()
+    {
+        $diff = new JsonDiff('{}');
+        $diff->setOriginal('{"a":"1"}');
+
+        $this->assertFalse($diff->compareTo('{"a":"1"}')->changed);
+    }
+
     /** @test */
     public function it_decodes_to_an_array_properly()
     {
@@ -96,4 +105,66 @@ public function it_successfully_diffs_the_stub_files()
         $this->assertEquals(json_decode(stub('diff.json'), true), $result->diff);
         $this->assertTrue($result->changed);
     }
+
+    /** @test */
+    public function it_ignores_keys()
+    {
+        $original = '[
+            {
+                "name": "Keoghan",
+                "email": "[email protected]",
+                "cost": 0
+            }
+        ]';
+
+        $compareTo = '[
+            {
+                "name": "Keoghan",
+                "email": "[email protected]",
+                "cost": 100
+            }
+        ]';
+
+        $diff = new JsonDiff($original);
+
+        $this->assertFalse($diff->exclude(['cost'])->compareTo($compareTo)->changed);
+
+        $this->assertFalse((new JsonDiff)->setOriginal($original)->exclude(['cost'])->compareTo($compareTo)->changed);
+        $this->assertFalse(JsonDiff::compare($original, $compareTo, ['cost'])->changed);
+    }
+
+    /** @test */
+    public function it_ignores_deep_keys()
+    {
+        $original = '[
+            {
+                "name": "Keoghan",
+                "email": "[email protected]",
+                "cost": {
+                    "nested": {
+                        "price": 0
+                    }
+                }
+            }
+        ]';
+
+        $compareTo = '[
+            {
+                "name": "Keoghan",
+                "email": "[email protected]",
+                "cost": {
+                    "nested": {
+                        "price": 100
+                    }
+                }
+            }
+        ]';
+
+        $diff = new JsonDiff($original);
+
+        $this->assertFalse($diff->exclude(['price'])->compareTo($compareTo)->changed);
+
+        $this->assertFalse((new JsonDiff)->setOriginal($original)->exclude(['price'])->compareTo($compareTo)->changed);
+        $this->assertFalse(JsonDiff::compare($original, $compareTo, ['price'])->changed);
+    }
 }