feat: add support for json scalar types

Author: arg2009

src/JsonDiff.php

@@ -58,7 +58,11 @@ class JsonDiff
      */
     private $calculateMinimalDiffOfListArrayAction;
 
-    public function __construct(array $original, array $new, string $startingPath = '')
+    /**
+     * @param array|bool|float|int|string|null $original
+     * @param array|bool|float|int|string|null $new
+     */
+    public function __construct($original, $new, string $startingPath = '')
     {
         $this->keysAdded = collect();
         $this->keysRemoved = collect();
@@ -75,8 +79,21 @@ public function __construct(array $original, array $new, string $startingPath =
         $this->calculateMinimalDiffOfListArrayAction = $this->serviceContainer
             ->make(CalculateMinimalDiffOfListArrayAction::class);
 
-        // Arrays are the same, no differences
-        if (empty($original) && empty($new)) {
+        // No differences
+        if ($original === $new) {
+            return;
+        }
+
+        // If either is not an array, just a value change occurred
+        if (! is_array($original) || ! is_array($new)) {
+            $this->valuesChanged->push(
+                new ValueChange(
+                    $startingPath,
+                    $original,
+                    $new
+                )
+            );
+
             return;
         }
 
@@ -183,26 +200,41 @@ public function addRemovedKey(string $path, $name, $value): self
         return $this;
     }
 
+    /**
+     * @return Collection<KeyAdded>
+     */
     public function getKeysAdded(): Collection
     {
         return $this->keysAdded;
     }
 
+    /**
+     * @return Collection<KeyRemoved>
+     */
     public function getKeysRemoved(): Collection
     {
         return $this->keysRemoved;
     }
 
+    /**
+     * @return Collection<ValueAdded>
+     */
     public function getValuesAdded(): Collection
     {
         return $this->valuesAdded;
     }
 
+    /**
+     * @return Collection<ValueRemoved>
+     */
     public function getValuesRemoved(): Collection
     {
         return $this->valuesRemoved;
     }
 
+    /**
+     * @return Collection<ValueChange>
+     */
     public function getValuesChanged(): Collection
     {
         return $this->valuesChanged;

tests/Feature/JsonDiffTest.php

@@ -523,4 +523,92 @@ public function test_remove_nested_element_between_jsons(): void
         $jsonDiff = new JsonDiff($original, $new);
 //        dd($jsonDiff->getKeysRemoved());
     }
+
+    public function test_json_diff_with_scalar_types(): void
+    {
+        $dataSets = [
+            'string' => [
+                'original' => 'Original String',
+                'new' => 'New String',
+                'changes' => 1,
+            ],
+            'number' => [
+                'original' => 1,
+                'new' => 2,
+                'changes' => 1,
+            ],
+            'boolean' => [
+                'original' => true,
+                'new' => false,
+                'changes' => 1,
+            ],
+            'null' => [
+                'original' => null,
+                'new' => null,
+                'changes' => 0,
+            ],
+        ];
+
+        // Compare same data types
+        foreach ($dataSets as $dataSet) {
+            $jsonDiff = new JsonDiff($dataSet['original'], $dataSet['new']);
+            $this->assertCount($dataSet['changes'], $jsonDiff->getValuesChanged());
+            $this->assertSame($dataSet['changes'], $jsonDiff->getNumberOfChanges());
+            $this->assertCount(0, $jsonDiff->getKeysAdded());
+            $this->assertCount(0, $jsonDiff->getKeysRemoved());
+            $this->assertCount(0, $jsonDiff->getValuesAdded());
+            $this->assertCount(0, $jsonDiff->getValuesRemoved());
+
+            if (! $dataSet['changes']) {
+                continue;
+            }
+
+            /** @var ValueChange $valueChange */
+            $valueChange = $jsonDiff->getValuesChanged()->first();
+            $this->assertSame(
+                $dataSet['original'],
+                $valueChange->getOldValue()
+            );
+            $this->assertSame(
+                $dataSet['new'],
+                $valueChange->getNewValue()
+            );
+            $this->assertSame(
+                '',
+                $valueChange->getPath()
+            );
+        }
+
+        // Compare different data types
+        foreach ($dataSets as $dataType => $dataSet) {
+            foreach ($dataSets as $subDataType => $subDataSet) {
+                if ($dataType === $subDataType) {
+                    continue;
+                }
+
+                $jsonDiff = new JsonDiff($dataSet['original'], $subDataSet['original']);
+                $this->assertCount(1, $jsonDiff->getValuesChanged());
+                $this->assertSame(1, $jsonDiff->getNumberOfChanges());
+                $this->assertCount(0, $jsonDiff->getKeysAdded());
+                $this->assertCount(0, $jsonDiff->getKeysRemoved());
+                $this->assertCount(0, $jsonDiff->getValuesAdded());
+                $this->assertCount(0, $jsonDiff->getValuesRemoved());
+
+                /** @var ValueChange $valueChange */
+                $valueChange = $jsonDiff->getValuesChanged()->first();
+                $this->assertSame(
+                    $dataSet['original'],
+                    $valueChange->getOldValue()
+                );
+                $this->assertSame(
+                    $subDataSet['original'],
+                    $valueChange->getNewValue()
+                );
+                $this->assertSame(
+                    '',
+                    $valueChange->getPath()
+                );
+            }
+        }
+    }
 }