feat: Make it easier to serialize/unserialize a SymbolsRegistry (#915)

Author: theofidry

phpstan.neon.dist

@@ -58,3 +58,5 @@ parameters:
           path: 'tests/AutoReview/GAE2ECollector.php'
         - message: '#normalizeSymbolsRegistryReference#'
           path: 'tests/Console/Command/AddInspectCommandIntegrationTest.php'
+        - message: '#unserialize#'
+          path: 'src/Symbol/SymbolsRegistry.php'

src/Symbol/SymbolsRegistry.php

@@ -18,6 +18,8 @@
 use PhpParser\Node\Name\FullyQualified;
 use function array_values;
 use function count;
+use function serialize;
+use function unserialize;
 
 final class SymbolsRegistry implements Countable
 {
@@ -31,6 +33,9 @@ final class SymbolsRegistry implements Countable
      */
     private array $recordedClasses = [];
 
+    /**
+     * @param self[] $symbolsRegistries
+     */
     public static function createFromRegistries(array $symbolsRegistries): self
     {
         $symbolsRegistry = new self();
@@ -42,6 +47,19 @@ public static function createFromRegistries(array $symbolsRegistries): self
         return $symbolsRegistry;
     }
 
+    public static function unserialize(string $serialized): self
+    {
+        return unserialize(
+            $serialized,
+            ['allowed_classes' => [self::class]],
+        );
+    }
+
+    public function serialize(): string
+    {
+        return serialize($this);
+    }
+
     public function merge(self $symbolsRegistry): void
     {
         foreach ($symbolsRegistry->getRecordedFunctions() as [$original, $alias]) {

tests/Symbol/SymbolsRegistryTest.php

@@ -50,6 +50,25 @@ public function test_it_records_functions_and_classes(
         );
     }
 
+    /**
+     * @dataProvider provideRecords
+     *
+     * @param array<array{FullyQualified, FullyQualified}> $functions
+     * @param array<array{FullyQualified, FullyQualified}> $classes
+     */
+    public function test_it_can_be_serialized_and_unserialized(
+        array $functions,
+        array $classes,
+    ): void {
+        $registry = self::createRegistry($functions, $classes);
+
+        $unserializedRegistry = SymbolsRegistry::unserialize(
+            $registry->serialize(),
+        );
+
+        self::assertEquals($unserializedRegistry, $registry);
+    }
+
     public static function provideRecords(): iterable
     {
         $main = new FullyQualified('PHPUnit\main');