Implement a custom JSON serializer on top of the existing one to remove static properties from data files

Signed-off-by: William Desportes <williamdes@wdes.fr>

Author: williamdes

phpstan-baseline.neon

@@ -850,6 +850,11 @@ parameters:
 			count: 1
 			path: src/Tools/ContextGenerator.php
 
+		-
+			message: "#^Method PhpMyAdmin\\\\SqlParser\\\\Tools\\\\CustomJsonSerializer\\:\\:extractObjectData\\(\\) has parameter \\$ref with generic class ReflectionClass but does not specify its types\\: T$#"
+			count: 1
+			path: src/Tools/CustomJsonSerializer.php
+
 		-
 			message: "#^Argument of an invalid type array\\<int, string\\>\\|false supplied for foreach, only iterables are supported\\.$#"
 			count: 1

psalm-baseline.xml

@@ -1148,6 +1148,18 @@
       <code>++$i !== $count</code>
     </RedundantCondition>
   </file>
+  <file src="src/Tools/CustomJsonSerializer.php">
+    <MixedAssignment occurrences="2">
+      <code>$data[$property]</code>
+      <code>$data[$property]</code>
+    </MixedAssignment>
+    <MoreSpecificImplementedParamType occurrences="1">
+      <code>$properties</code>
+    </MoreSpecificImplementedParamType>
+    <PropertyNotSetInConstructor occurrences="1">
+      <code>CustomJsonSerializer</code>
+    </PropertyNotSetInConstructor>
+  </file>
   <file src="src/Tools/TestGenerator.php">
     <MixedOperand occurrences="1">
       <code>$debug</code>

src/Tools/CustomJsonSerializer.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\SqlParser\Tools;
+
+use ReflectionClass;
+use ReflectionException;
+use Zumba\JsonSerializer\JsonSerializer;
+
+use function in_array;
+
+/**
+ * Used for .out files generation
+ */
+class CustomJsonSerializer extends JsonSerializer
+{
+    public const SKIP_PROPERTIES = [
+        'ALLOWED_KEYWORDS',
+        'GROUP_OPTIONS',
+        'END_OPTIONS',
+        'KEYWORD_PARSERS',
+        'STATEMENT_PARSERS',
+        'KEYWORD_NAME_INDICATORS',
+        'OPERATOR_NAME_INDICATORS',
+        'DEFAULT_DELIMITER',
+        'PARSER_METHODS',
+        'OPTIONS',
+        'CLAUSES',
+        'DB_OPTIONS',
+        'DELIMITERS',
+        'JOINS',
+        'FIELDS_OPTIONS',
+        'LINES_OPTIONS',
+        'TRIGGER_OPTIONS',
+        'FUNC_OPTIONS',
+        'TABLE_OPTIONS',
+        'FIELD_OPTIONS',
+        'DATA_TYPE_OPTIONS',
+        'REFERENCES_OPTIONS',
+        'KEY_OPTIONS',
+        'VIEW_OPTIONS',
+        'EVENT_OPTIONS',
+        'USER_OPTIONS',
+    ];
+
+    /**
+     * Extract the object data
+     *
+     * @param  object          $value
+     * @param  ReflectionClass $ref
+     * @param  string[]        $properties
+     *
+     * @return array<string,mixed>
+     */
+    protected function extractObjectData($value, $ref, $properties)
+    {
+        $data = [];
+        foreach ($properties as $property) {
+            if (in_array($property, self::SKIP_PROPERTIES, true)) {
+                continue;
+            }
+
+            try {
+                $propRef = $ref->getProperty($property);
+                $propRef->setAccessible(true);
+                $data[$property] = $propRef->getValue($value);
+            } catch (ReflectionException $e) {
+                $data[$property] = $value->$property;
+            }
+        }
+
+        return $data;
+    }
+}

src/Tools/TestGenerator.php

@@ -12,7 +12,6 @@
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\Token;
 use PhpMyAdmin\SqlParser\UtfString;
-use Zumba\JsonSerializer\JsonSerializer;
 
 use function file_exists;
 use function file_get_contents;
@@ -170,7 +169,7 @@ public static function build($type, $input, $output, $debug = null, $ansi = fals
 
         // unset mode, reset to default every time, to be sure
         Context::setMode();
-        $serializer = new JsonSerializer();
+        $serializer = new CustomJsonSerializer();
         // Writing test's data.
         $encoded = $serializer->serialize($test);
 

tests/TestCase.php

@@ -11,8 +11,8 @@
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\Token;
 use PhpMyAdmin\SqlParser\TokensList;
+use PhpMyAdmin\SqlParser\Tools\CustomJsonSerializer;
 use PHPUnit\Framework\TestCase as BaseTestCase;
-use Zumba\JsonSerializer\JsonSerializer;
 
 use function file_get_contents;
 use function str_contains;
@@ -96,7 +96,7 @@ public function getData(string $name): array
         $serializedData = file_get_contents('tests/data/' . $name . '.out');
         $this->assertIsString($serializedData);
 
-        $serializer = new JsonSerializer();
+        $serializer = new CustomJsonSerializer();
         $data = $serializer->unserialize($serializedData);
 
         $this->assertIsArray($data);