Remove JsonSerializable interface

Author: nyamsprod

README.md

@@ -140,14 +140,10 @@ $topLevelDomains->getIANADomain('com');
 To instantiate each domain resolver you can use the following named constructor:
 
 - `fromString`: instantiate the resolver from a inline string representing the data source;
-- `fromJsonString`: instantiate the resolver from a json string representing the data source;
 - `fromPath`: instantiate the resolver from a local path or online URL by relying on `fopen`;
 
 **If the instantiation does not work an exception will be thrown.**
 
-Once instantiated, you can always convert the data source in a json encoded string as both
-resolver exposes the `JsonSerialize` method.
-
 **WARNING:**
 
 **You should never resolve domain name this way in production, without, at 

src/PublicSuffixList.php

@@ -4,17 +4,8 @@
 
 namespace Pdp;
 
-use JsonSerializable;
-
-interface PublicSuffixList extends DomainNameResolver, JsonSerializable
+interface PublicSuffixList extends DomainNameResolver
 {
-    /**
-     * Returns an array representation of the Public Suffix List Rules JSON serializable.
-     *
-     * @return array<string, array<array>>
-     */
-    public function jsonSerialize(): array;
-
     /**
      * Returns PSL info for a given domain against the PSL rules for cookie domain detection.
      *

src/Storage/ResourceUri.php renamed to src/ResourceUri.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Pdp\Storage;
+namespace Pdp;
 
 interface ResourceUri
 {

src/Rules.php

@@ -4,7 +4,6 @@
 
 namespace Pdp;
 
-use JsonException;
 use SplTempFileObject;
 use TypeError;
 use function array_pop;
@@ -13,16 +12,13 @@
 use function fclose;
 use function fopen;
 use function gettype;
-use function is_array;
 use function is_object;
 use function is_string;
-use function json_decode;
 use function method_exists;
 use function preg_match;
 use function stream_get_contents;
 use function strpos;
 use function substr;
-use const JSON_THROW_ON_ERROR;
 
 final class Rules implements PublicSuffixList
 {
@@ -190,21 +186,6 @@ private static function addRule(array $list, array $ruleParts): array
         return $list;
     }
 
-    public static function fromJsonString(string $jsonString): self
-    {
-        try {
-            $data = json_decode($jsonString, true, 512, JSON_THROW_ON_ERROR);
-        } catch (JsonException $exception) {
-            throw UnableToLoadPublicSuffixList::dueToInvalidJson($exception);
-        }
-
-        if (!is_array($data[self::ICANN_DOMAINS]) || !is_array($data[self::PRIVATE_DOMAINS])) {
-            throw UnableToLoadPublicSuffixList::dueToCorruptedSection();
-        }
-
-        return new self($data);
-    }
-
     /**
      * @param array{rules:array{ICANN_DOMAINS:array,PRIVATE_DOMAINS:array}} $properties
      */
@@ -213,14 +194,6 @@ public static function __set_state(array $properties): self
         return new self($properties['rules']);
     }
 
-    /**
-     * @return array<string, array<array>>
-     */
-    public function jsonSerialize(): array
-    {
-        return $this->rules;
-    }
-
     /**
      * @param mixed $host a type that supports instantiating a Domain from.
      */

src/RulesTest.php

@@ -61,40 +61,6 @@ public function testFromStringThrowsOnTypeError(): void
         Rules::fromString(new DateTimeImmutable());
     }
 
-    /**
-     * @covers ::jsonSerialize
-     * @covers ::fromJsonString
-     */
-    public function testJsonMethods(): void
-    {
-        /** @var string $data */
-        $data = json_encode(self::$rules);
-
-        self::assertEquals(self::$rules, Rules::fromJsonString($data));
-    }
-
-    /**
-     * @covers ::fromJsonString
-     * @covers \Pdp\UnableToLoadPublicSuffixList
-     */
-    public function testJsonStringFailsWithInvalidJson(): void
-    {
-        $this->expectException(UnableToLoadPublicSuffixList::class);
-
-        Rules::fromJsonString('');
-    }
-
-    /**
-     * @covers ::fromJsonString
-     * @covers \Pdp\UnableToLoadPublicSuffixList
-     */
-    public function testJsonStringFailsWithMissingIndexesCollection(): void
-    {
-        $this->expectException(UnableToLoadPublicSuffixList::class);
-
-        Rules::fromJsonString('{"ICANN_DOMAINS":"foo","PRIVATE_DOMAINS":"bar"}');
-    }
-
     public function testDomainInternalPhpMethod(): void
     {
         $generateRules = eval('return '.var_export(self::$rules, true).';');

src/Storage/PsrStorageFactory.php

@@ -4,6 +4,7 @@
 
 namespace Pdp\Storage;
 
+use Pdp\ResourceUri;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\SimpleCache\CacheInterface;

src/TopLevelDomainList.php

@@ -8,12 +8,11 @@
 use DateTimeImmutable;
 use Iterator;
 use IteratorAggregate;
-use JsonSerializable;
 
 /**
  * @extends IteratorAggregate<string>
  */
-interface TopLevelDomainList extends Countable, DomainNameResolver, IteratorAggregate, JsonSerializable
+interface TopLevelDomainList extends Countable, DomainNameResolver, IteratorAggregate
 {
     /**
      * Returns the Version ID.
@@ -40,13 +39,6 @@ public function isEmpty(): bool;
      */
     public function getIterator(): Iterator;
 
-    /**
-     * Returns an array representation of the list.
-     *
-     * @return array{version:string, records:array<string>, lastUpdated:string}
-     */
-    public function jsonSerialize(): array;
-
     /**
      * Returns PSL info for a given domain against the PSL rules for ICANN domain detection.
      *

src/TopLevelDomains.php

@@ -7,25 +7,21 @@
 use DateTimeImmutable;
 use DateTimeInterface;
 use Iterator;
-use JsonException;
 use SplTempFileObject;
 use TypeError;
 use function array_flip;
-use function array_keys;
 use function count;
 use function fclose;
 use function fopen;
 use function gettype;
 use function in_array;
 use function is_object;
 use function is_string;
-use function json_decode;
 use function method_exists;
 use function preg_match;
 use function stream_get_contents;
 use function strpos;
 use function trim;
-use const JSON_THROW_ON_ERROR;
 
 final class TopLevelDomains implements TopLevelDomainList
 {
@@ -185,24 +181,6 @@ private static function extractRootZone(string $content): string
         return $tld->toString();
     }
 
-    public static function fromJsonString(string $jsonString): self
-    {
-        try {
-            $data = json_decode($jsonString, true, 512, JSON_THROW_ON_ERROR);
-        } catch (JsonException $exception) {
-            throw UnableToLoadTopLevelDomainList::dueToInvalidJson($exception);
-        }
-
-        if (!isset($data['records'], $data['version'], $data['lastUpdated'])) {
-            throw UnableToLoadTopLevelDomainList::dueToInvalidHashMap();
-        }
-
-        /** @var DateTimeImmutable $lastUpdated */
-        $lastUpdated = DateTimeImmutable::createFromFormat(DateTimeInterface::ATOM, $data['lastUpdated']);
-
-        return new self(array_flip($data['records']), $data['version'], $lastUpdated);
-    }
-
     /**
      * @param array{records:array<string, int>, version:string, lastUpdated:DateTimeImmutable} $properties
      */
@@ -241,18 +219,6 @@ public function getIterator(): Iterator
         }
     }
 
-    /**
-     * @return array{version:string, records:array<string>, lastUpdated:string}
-     */
-    public function jsonSerialize(): array
-    {
-        return [
-            'version' => $this->version,
-            'records' => array_keys($this->records),
-            'lastUpdated' => $this->lastUpdated->format(DateTimeInterface::ATOM),
-        ];
-    }
-
     /**
      * @param mixed $host a type that supports instantiating a Domain from.
      */

src/TopLevelDomainsTest.php

@@ -9,7 +9,6 @@
 use PHPUnit\Framework\TestCase;
 use TypeError;
 use function dirname;
-use function json_encode;
 
 /**
  * @coversDefaultClass \Pdp\TopLevelDomains
@@ -145,40 +144,6 @@ public function testSetState(): void
         self::assertEquals(self::$topLevelDomains, $topLevelDomains);
     }
 
-    /**
-     * @covers ::jsonSerialize
-     * @covers ::fromJsonString
-     */
-    public function testJsonMethods(): void
-    {
-        /** @var string $data */
-        $data = json_encode(self::$topLevelDomains);
-
-        self::assertEquals(self::$topLevelDomains, TopLevelDomains::fromJsonString($data));
-    }
-
-    /**
-     * @covers ::fromJsonString
-     * @covers \Pdp\UnableToLoadTopLevelDomainList
-     */
-    public function testJsonStringFailsWithInvalidJson(): void
-    {
-        $this->expectException(UnableToLoadTopLevelDomainList::class);
-
-        TopLevelDomains::fromJsonString('');
-    }
-
-    /**
-     * @covers ::fromJsonString
-     * @covers \Pdp\UnableToLoadTopLevelDomainList
-     */
-    public function testJsonStringFailsWithMissingIndexes(): void
-    {
-        $this->expectException(UnableToLoadTopLevelDomainList::class);
-
-        TopLevelDomains::fromJsonString('{"foo":"bar"}');
-    }
-
     public function testGetterProperties(): void
     {
         $topLevelDomains = TopLevelDomains::fromPath(dirname(__DIR__).'/test_data/root_zones.dat');
@@ -190,7 +155,6 @@ public function testGetterProperties(): void
             $topLevelDomains->lastUpdated()
         );
         self::assertFalse($topLevelDomains->isEmpty());
-        self::assertArrayHasKey('lastUpdated', $topLevelDomains->jsonSerialize());
     }
 
     public function testIterator(): void