feat: add support for any_value() (#323)

Author: martin-georgiev

.github/workflows/sloth.yml

@@ -36,6 +36,5 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           interval: 10
           ignored: |
-            Auto Request Review
             CodeRabbit
             Scrutinizer

docs/AVAILABLE-FUNCTIONS-AND-OPERATORS.md

@@ -30,6 +30,7 @@
 |---|---|---|
 | all | ALL_OF | `MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\All` |
 | any | ANY_OF | `MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Any` |
+| any_value | ANY_VALUE | `MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\AnyValue` |
 | array_agg | ARRAY_AGG | `MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayAgg` |
 | array_append | ARRAY_APPEND | `MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayAppend` |
 | array_cat | ARRAY_CAT | `MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayCat` |

docs/INTEGRATING-WITH-DOCTRINE.md

@@ -70,6 +70,10 @@ $configuration->addCustomStringFunction('INT8RANGE', MartinGeorgiev\Doctrine\ORM
 $configuration->addCustomStringFunction('NUMRANGE', MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Numrange::class);
 $configuration->addCustomStringFunction('TSRANGE', MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Tsrange::class);
 $configuration->addCustomStringFunction('TSTZRANGE', MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Tstzrange::class);
+# Register array value extracting functions
+$configuration->addCustomStringFunction('ALL_OF', MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\All::class);
+$configuration->addCustomStringFunction('ANY_OF', MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Any::class);
+$configuration->addCustomStringFunction('ANY_VALUE', MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\AnyValue::class);
 
 $em = EntityManager::create($dbParams, $configuration);
 ```

docs/INTEGRATING-WITH-LARAVEL.md

@@ -86,6 +86,7 @@ return [
 
         # array and string specific functions
         'IN_ARRAY' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\InArray::class,
+        'ANY_VALUE' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\AnyValue::class,
         'ARRAY' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Arr::class,
         'ARRAY_APPEND' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayAppend::class,
         'ARRAY_CARDINALITY' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayCardinality::class,

docs/INTEGRATING-WITH-SYMFONY.md

@@ -64,7 +64,7 @@ doctrine:
                         # alternative implementation of ALL() and ANY() where subquery is not required, useful for arrays
                         ALL_OF: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\All
                         ANY_OF: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Any
-
+                        
                         # operators for working with array and json(b) data
                         GREATEST: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Greatest
                         LEAST: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Least
@@ -79,6 +79,7 @@ doctrine:
                         
                         # array and string specific functions
                         IN_ARRAY: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\InArray
+                        ANY_VALUE: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\AnyValue
                         ARRAY: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Arr
                         ARRAY_APPEND: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayAppend
                         ARRAY_CARDINALITY: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\ArrayCardinality

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

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
+
+/**
+ * Implementation of PostgreSQL ANY_VALUE().
+ *
+ * @see https://www.postgresql.org/docs/16/functions-aggregate.html
+ * @since 3.0
+ *
+ * @author Martin Georgiev <martin.georgiev@gmail.com>
+ */
+class AnyValue extends BaseFunction
+{
+    protected function customizeFunction(): void
+    {
+        $this->setFunctionPrototype('any_value(%s)');
+        $this->addNodeMapping('StringPrimary');
+    }
+}

tests/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/AnyValueTest.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
+
+use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsArrays;
+use Fixtures\MartinGeorgiev\Doctrine\Entity\ContainsTexts;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\AnyValue;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Arr;
+
+class AnyValueTest extends TestCase
+{
+    protected function getStringFunctions(): array
+    {
+        return [
+            'ANY_VALUE' => AnyValue::class,
+            'ARRAY' => Arr::class,
+        ];
+    }
+
+    protected function getExpectedSqlStatements(): array
+    {
+        return [
+            'from array field' => 'SELECT any_value(c0_.array1) AS sclr_0 FROM ContainsArrays c0_',
+            'from text field' => 'SELECT any_value(c0_.text1) AS sclr_0 FROM ContainsTexts c0_',
+            'from list of integers' => "SELECT any_value(ARRAY['red', 'green', 'blue']) AS sclr_0 FROM ContainsTexts c0_",
+        ];
+    }
+
+    protected function getDqlStatements(): array
+    {
+        return [
+            'from array field' => \sprintf('SELECT ANY_VALUE(e.array1) FROM %s e', ContainsArrays::class),
+            'from text field' => \sprintf('SELECT ANY_VALUE(e.text1) FROM %s e', ContainsTexts::class),
+            'from list of integers' => \sprintf("SELECT ANY_VALUE(ARRAY('red', 'green', 'blue')) FROM %s e", ContainsTexts::class),
+        ];
+    }
+}