feat(#401): improve JSON field extraction by adding index support

Author: martin-georgiev

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonGetField.php

@@ -4,9 +4,19 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\Lexer;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\QueryException;
+use Doctrine\ORM\Query\TokenType;
+use MartinGeorgiev\Utils\DoctrineOrm;
+
 /**
  * Implementation of PostgreSQL json field retrieval, filtered by key (using ->).
  *
+ * Supports both string keys for object property access and integer indices for array element access:
+ * - JSON_GET_FIELD(json_column, 'property_name') -> json_column->'property_name'
+ * - JSON_GET_FIELD(json_column, 0) -> json_column->0
+ *
  * @see https://www.postgresql.org/docs/9.4/static/functions-json.html
  * @since 0.1
  *
@@ -17,7 +27,22 @@ class JsonGetField extends BaseFunction
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('(%s -> %s)');
-        $this->addNodeMapping('StringPrimary');
-        $this->addNodeMapping('StringPrimary');
+    }
+
+    protected function feedParserWithNodes(Parser $parser): void
+    {
+        $shouldUseLexer = DoctrineOrm::isPre219();
+
+        // Parse first parameter (always StringPrimary for the JSON column)
+        $this->nodes[0] = $parser->StringPrimary();
+        $parser->match($shouldUseLexer ? Lexer::T_COMMA : TokenType::T_COMMA);
+
+        // Parse second parameter - try ArithmeticPrimary first, then StringPrimary
+        try {
+            $this->nodes[1] = $parser->ArithmeticPrimary();
+        } catch (QueryException) {
+            // If ArithmeticPrimary fails (e.g., when encountering a string), try StringPrimary
+            $this->nodes[1] = $parser->StringPrimary();
+        }
     }
 }

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonGetFieldAsInteger.php

@@ -7,17 +7,19 @@
 /**
  * Implementation of PostgreSQL json field retrieval as integer, filtered by key (using ->> and type casting to BIGINT).
  *
+ * Supports both string keys for object property access and integer indices for array element access:
+ * - JSON_GET_FIELD_AS_INTEGER(json_column, 'property_name') -> CAST(json_column->>'property_name' as BIGINT)
+ * - JSON_GET_FIELD_AS_INTEGER(json_column, 0) -> CAST(json_column->>0 as BIGINT)
+ *
  * @see https://www.postgresql.org/docs/9.4/static/functions-json.html
  * @since 0.3
  *
  * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
-class JsonGetFieldAsInteger extends BaseFunction
+class JsonGetFieldAsInteger extends JsonGetField
 {
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('CAST(%s ->> %s as BIGINT)');
-        $this->addNodeMapping('StringPrimary');
-        $this->addNodeMapping('StringPrimary');
     }
 }

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonGetFieldAsText.php

@@ -7,17 +7,19 @@
 /**
  * Implementation of PostgreSQL json field retrieval as text, filtered by key (using ->>).
  *
+ * Supports both string keys for object property access and integer indices for array element access:
+ * - JSON_GET_FIELD_AS_TEXT(json_column, 'property_name') -> json_column->>'property_name'
+ * - JSON_GET_FIELD_AS_TEXT(json_column, 0) -> json_column->>0
+ *
  * @see https://www.postgresql.org/docs/9.4/static/functions-json.html
  * @since 0.1
  *
  * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
-class JsonGetFieldAsText extends BaseFunction
+class JsonGetFieldAsText extends JsonGetField
 {
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('(%s ->> %s)');
-        $this->addNodeMapping('StringPrimary');
-        $this->addNodeMapping('StringPrimary');
     }
 }

tests/Unit/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonGetFieldAsIntegerTest.php

@@ -5,28 +5,34 @@
 namespace Tests\Unit\MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
 use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsJsons;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\JsonGetField;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\JsonGetFieldAsInteger;
 
 class JsonGetFieldAsIntegerTest extends TestCase
 {
     protected function getStringFunctions(): array
     {
         return [
+            'JSON_GET_FIELD' => JsonGetField::class,
             'JSON_GET_FIELD_AS_INTEGER' => JsonGetFieldAsInteger::class,
         ];
     }
 
     protected function getExpectedSqlStatements(): array
     {
         return [
-            "SELECT CAST(c0_.object1 ->> 'rank' as BIGINT) AS sclr_0 FROM ContainsJsons c0_",
+            'extracts field as integer' => "SELECT CAST(c0_.object1 ->> 'rank' as BIGINT) AS sclr_0 FROM ContainsJsons c0_",
+            'extracts array element as integer' => 'SELECT CAST(c0_.object1 ->> 0 as BIGINT) AS sclr_0 FROM ContainsJsons c0_',
+            'extracts nested array element as integer' => "SELECT CAST((c0_.object1 -> 'scores') ->> 1 as BIGINT) AS sclr_0 FROM ContainsJsons c0_",
         ];
     }
 
     protected function getDqlStatements(): array
     {
         return [
-            \sprintf("SELECT JSON_GET_FIELD_AS_INTEGER(e.object1, 'rank') FROM %s e", ContainsJsons::class),
+            'extracts field as integer' => \sprintf("SELECT JSON_GET_FIELD_AS_INTEGER(e.object1, 'rank') FROM %s e", ContainsJsons::class),
+            'extracts array element as integer' => \sprintf('SELECT JSON_GET_FIELD_AS_INTEGER(e.object1, 0) FROM %s e', ContainsJsons::class),
+            'extracts nested array element as integer' => \sprintf("SELECT JSON_GET_FIELD_AS_INTEGER(JSON_GET_FIELD(e.object1, 'scores'), 1) FROM %s e", ContainsJsons::class),
         ];
     }
 }

tests/Unit/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonGetFieldAsTextTest.php

@@ -5,28 +5,34 @@
 namespace Tests\Unit\MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
 use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsJsons;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\JsonGetField;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\JsonGetFieldAsText;
 
 class JsonGetFieldAsTextTest extends TestCase
 {
     protected function getStringFunctions(): array
     {
         return [
+            'JSON_GET_FIELD' => JsonGetField::class,
             'JSON_GET_FIELD_AS_TEXT' => JsonGetFieldAsText::class,
         ];
     }
 
     protected function getExpectedSqlStatements(): array
     {
         return [
-            "SELECT (c0_.object1 ->> 'country') AS sclr_0 FROM ContainsJsons c0_",
+            'extracts field as text' => "SELECT (c0_.object1 ->> 'country') AS sclr_0 FROM ContainsJsons c0_",
+            'extracts array element as text' => 'SELECT (c0_.object1 ->> 0) AS sclr_0 FROM ContainsJsons c0_',
+            'extracts nested array element as text' => "SELECT ((c0_.object1 -> 'tags') ->> 1) AS sclr_0 FROM ContainsJsons c0_",
         ];
     }
 
     protected function getDqlStatements(): array
     {
         return [
-            \sprintf("SELECT JSON_GET_FIELD_AS_TEXT(e.object1, 'country') FROM %s e", ContainsJsons::class),
+            'extracts field as text' => \sprintf("SELECT JSON_GET_FIELD_AS_TEXT(e.object1, 'country') FROM %s e", ContainsJsons::class),
+            'extracts array element as text' => \sprintf('SELECT JSON_GET_FIELD_AS_TEXT(e.object1, 0) FROM %s e', ContainsJsons::class),
+            'extracts nested array element as text' => \sprintf("SELECT JSON_GET_FIELD_AS_TEXT(JSON_GET_FIELD(e.object1, 'tags'), 1) FROM %s e", ContainsJsons::class),
         ];
     }
 }

tests/Unit/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonGetFieldTest.php

@@ -21,6 +21,9 @@ protected function getExpectedSqlStatements(): array
         return [
             'extracts top-level field from json' => "SELECT (c0_.object1 -> 'key') AS sclr_0 FROM ContainsJsons c0_",
             'extracts nested field from json' => "SELECT ((c0_.object1 -> 'nested') -> 'key') AS sclr_0 FROM ContainsJsons c0_",
+            'extracts array element by index' => 'SELECT (c0_.object1 -> 0) AS sclr_0 FROM ContainsJsons c0_',
+            'extracts nested array element by index' => "SELECT ((c0_.object1 -> 'tags') -> 1) AS sclr_0 FROM ContainsJsons c0_",
+            'extracts field from array element by index' => "SELECT ((c0_.object1 -> 0) -> 'name') AS sclr_0 FROM ContainsJsons c0_",
         ];
     }
 
@@ -29,6 +32,9 @@ protected function getDqlStatements(): array
         return [
             'extracts top-level field from json' => \sprintf("SELECT JSON_GET_FIELD(e.object1, 'key') FROM %s e", ContainsJsons::class),
             'extracts nested field from json' => \sprintf("SELECT JSON_GET_FIELD(JSON_GET_FIELD(e.object1, 'nested'), 'key') FROM %s e", ContainsJsons::class),
+            'extracts array element by index' => \sprintf('SELECT JSON_GET_FIELD(e.object1, 0) FROM %s e', ContainsJsons::class),
+            'extracts nested array element by index' => \sprintf("SELECT JSON_GET_FIELD(JSON_GET_FIELD(e.object1, 'tags'), 1) FROM %s e", ContainsJsons::class),
+            'extracts field from array element by index' => \sprintf("SELECT JSON_GET_FIELD(JSON_GET_FIELD(e.object1, 0), 'name') FROM %s e", ContainsJsons::class),
         ];
     }
 }