feat: isValidPatch should also accept PatchOperationList

Internally, this is already implemented - it just required a change to
the typehint for `isValidPatch`.

I've refactored the existing `isValidPatch` tests to use a DataProvider
to make the overlap between examples for strings and DTOs clearer. As
part of this I added a couple of new examples of valid / invalid string
patches. This is because some of the existing string cases (missing
params / structural issues) cannot happen with DTOs.

Author: acoulton

src/FastJsonPatch.php

@@ -166,10 +166,10 @@ public function apply(string|PatchOperationList $patch): void
 
     /**
      * Tells if the json patch is syntactically valid
-     * @param string $patch
+     * @param string|PatchOperationList $patch
      * @return bool
      */
-    public function isValidPatch(string $patch): bool
+    public function isValidPatch(string|PatchOperationList $patch): bool
     {
         try {
             foreach ($this->patchIterator($patch) as $op => $p) {

tests/FastJsonPatchTest.php

@@ -76,23 +76,64 @@
 #[UsesClass(Test::class)]
 final class FastJsonPatchTest extends JsonPatchCompliance
 {
-    public function testValidPatch(): void
-    {
-        $FastJsonPatch = FastJsonPatch::fromJson('{"foo":"bar"}');
-        $this->assertTrue($FastJsonPatch->isValidPatch('[{"op":"test","path":"/foo","value":"bar"}]'));
-    }
-
-    public function testInvalidPatch(): void
+    /**
+     * @return array<string, array{string|PatchOperationList, bool}>
+     */
+    public static function isValidPatchProvider(): array
     {
-        $FastJsonPatch = FastJsonPatch::fromJson('{"foo":"bar"}');
-        $this->assertFalse($FastJsonPatch->isValidPatch('{"op":"test","path":"/foo","value":"bar"}'));
-        $this->assertFalse($FastJsonPatch->isValidPatch('[{"op":"add"}]'));
+        return [
+            'string patch - valid' => [
+                '[{"op":"test","path":"/foo","value":"bar"}]',
+                true,
+            ],
+            'string patch - valid (despite test not matching)' => [
+                '[{"op":"test","path":"/foo","value":"not this"}]',
+                true,
+            ],
+            'string patch - valid (despite unknown path)' => [
+                '[{"op":"test","path":"/nonexistent-path","value":"any"}]',
+                true,
+            ],
+            'string patch - invalid (is not list)' => [
+                '{"op":"test","path":"/foo","value":"bar"}',
+                false,
+            ],
+            'string patch - invalid (missing parameter for op)' => [
+                '[{"op":"add"}]',
+                false,
+            ],
+            'string patch - invalid (unknown op)' => [
+                '[{"op":"unknown","path":"/foo","value":"bar"}]',
+                false,
+            ],
+            'string patch - invalid (invalid path)' => [
+                '[{"op":"remove","path":"not a path"}]',
+                false,
+            ],
+            'DTO patch - valid' => [
+                new PatchOperationList(new Test(path: '/foo', value: 'bar')),
+                true,
+            ],
+            'DTO patch - valid (despite test not matching)' => [
+                new PatchOperationList(new Test(path: '/foo', value: 'not this')),
+                true,
+            ],
+            'DTO patch - valid (despite unknown path)' => [
+                new PatchOperationList(new Test(path: '/nonexistent-path', value: 'any')),
+                true,
+            ],
+            'DTO patch - invalid (invalid path)' => [
+                new PatchOperationList(new Remove(path: 'not a path')),
+                false,
+            ],
+        ];
     }
 
-    public function testUnknownPatchOperation(): void
+    #[DataProvider('isValidPatchProvider')]
+    public function testIsValidPatch(string|PatchOperationList $patch, bool $expect): void
     {
         $FastJsonPatch = FastJsonPatch::fromJson('{"foo":"bar"}');
-        $this->assertFalse($FastJsonPatch->isValidPatch('[{"op":"unknown","path":"/foo","value":"bar"}]'));
+        $this->assertSame($expect, $FastJsonPatch->isValidPatch($patch));
     }
 
     /**