[JsonPath] Introduce JsonCrawlerFactory

alexandre-daubois · alexandre-daubois · commit 66e242909ef0 · 2025-03-30T17:08:37.000+02:00
diff --git a/src/Symfony/Component/JsonPath/CrawlerFactoryInterface.php b/src/Symfony/Component/JsonPath/CrawlerFactoryInterface.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+interface CrawlerFactoryInterface
+{
+    /**
+     * @param string|resource $data
+     */
+    public function createFromData(mixed $data): CrawlerInterface;
+}
diff --git a/src/Symfony/Component/JsonPath/CrawlerInterface.php b/src/Symfony/Component/JsonPath/CrawlerInterface.php
@@ -19,7 +19,7 @@
  *
  * @experimental
  */
-interface JsonCrawlerInterface
+interface CrawlerInterface
 {
     /**
      * @return list<array|string|float|int|bool|null>
diff --git a/src/Symfony/Component/JsonPath/JsonCrawler.php b/src/Symfony/Component/JsonPath/JsonCrawler.php
@@ -28,7 +28,7 @@
  *
  * @experimental
  */
-final class JsonCrawler implements JsonCrawlerInterface
+final class JsonCrawler implements CrawlerInterface
 {
     private const RFC9535_FUNCTIONS = [
         'length' => true,
@@ -40,12 +40,14 @@ final class JsonCrawler implements JsonCrawlerInterface
 
     /**
      * @param resource|string $raw
+     *
+     * @throws \TypeError When the input is not a string or a resource
      */
     public function __construct(
         private readonly mixed $raw,
     ) {
         if (!\is_string($raw) && !\is_resource($raw)) {
-            throw new InvalidArgumentException(\sprintf('Expected string or resource, got "%s".', get_debug_type($raw)));
+            throw new \TypeError(\sprintf('Expected string or resource, got "%s".', get_debug_type($raw)));
         }
     }
 
diff --git a/src/Symfony/Component/JsonPath/JsonCrawlerFactory.php b/src/Symfony/Component/JsonPath/JsonCrawlerFactory.php
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ *
+ * @experimental
+ */
+final class JsonCrawlerFactory implements CrawlerFactoryInterface
+{
+    /**
+     * @throws \TypeError When the data is not a string or a resource
+     */
+    public function createFromData(mixed $data): JsonCrawler
+    {
+        return new JsonCrawler($data);
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Tests/JsonCrawlerFactoryTest.php b/src/Symfony/Component/JsonPath/Tests/JsonCrawlerFactoryTest.php
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonPath\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\JsonPath\JsonCrawler;
+use Symfony\Component\JsonPath\JsonCrawlerFactory;
+
+class JsonCrawlerFactoryTest extends TestCase
+{
+    public function testCreateCrawler()
+    {
+        $factory = new JsonCrawlerFactory();
+        $crawler = $factory->createFromData('{"foo": "bar"}');
+
+        $this->assertInstanceOf(JsonCrawler::class, $crawler);
+        $this->assertSame(['bar'], $crawler->find('$.foo'), '->createFromData() provides data to the crawler');
+    }
+}
diff --git a/src/Symfony/Component/JsonPath/Tests/JsonCrawlerTest.php b/src/Symfony/Component/JsonPath/Tests/JsonCrawlerTest.php
@@ -22,7 +22,7 @@ class JsonCrawlerTest extends TestCase
 {
     public function testNotStringOrResourceThrows()
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(\TypeError::class);
         $this->expectExceptionMessage('Expected string or resource, got "int".');
 
         new JsonCrawler(42);

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*`
`20`	`20`	`* @experimental`
`21`	`21`	`*/`
`22`		`-interface JsonCrawlerInterface`
	`22`	`+interface CrawlerInterface`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`	`25`	`* @return list<array\|string\|float\|int\|bool\|null>`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`*`
`29`	`29`	`* @experimental`
`30`	`30`	`*/`
`31`		`-final class JsonCrawler implements JsonCrawlerInterface`
	`31`	`+final class JsonCrawler implements CrawlerInterface`
`32`	`32`	`{`
`33`	`33`	`private const RFC9535_FUNCTIONS = [`
`34`	`34`	`'length' => true,`
`@@ -40,12 +40,14 @@ final class JsonCrawler implements JsonCrawlerInterface`
`40`	`40`
`41`	`41`	`/**`
`42`	`42`	`* @param resource\|string $raw`
	`43`	`+ *`
	`44`	`+ * @throws \TypeError When the input is not a string or a resource`
`43`	`45`	`*/`
`44`	`46`	`public function __construct(`
`45`	`47`	`private readonly mixed $raw,`
`46`	`48`	`) {`
`47`	`49`	`if (!\is_string($raw) && !\is_resource($raw)) {`
`48`		`- throw new InvalidArgumentException(\sprintf('Expected string or resource, got "%s".', get_debug_type($raw)));`
	`50`	`+ throw new \TypeError(\sprintf('Expected string or resource, got "%s".', get_debug_type($raw)));`
`49`	`51`	`}`
`50`	`52`	`}`
`51`	`53`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class JsonCrawlerTest extends TestCase`
`22`	`22`	`{`
`23`	`23`	`public function testNotStringOrResourceThrows()`
`24`	`24`	`{`
`25`		`- $this->expectException(InvalidArgumentException::class);`
	`25`	`+ $this->expectException(\TypeError::class);`
`26`	`26`	`$this->expectExceptionMessage('Expected string or resource, got "int".');`
`27`	`27`
`28`	`28`	`new JsonCrawler(42);`