Add option addFieldFilter([]) to the QueryBuilder

Signed-off-by: davidarendsen <davidarendsen@hey.com>

src/Exception/FunctionInvalidInputException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Exception;
+
+use Exception;
+
+class FunctionInvalidInputException extends Exception
+{
+}

src/Functions/Filter.php

@@ -2,22 +2,49 @@
 
 namespace Arendsen\FluxQueryBuilder\Functions;
 
+use Arendsen\FluxQueryBuilder\Exception\FunctionInvalidInputException;
 use Arendsen\FluxQueryBuilder\Expression\KeyValue;
 
 class Filter extends Base
 {
     /**
-     * @var KeyValue $keyValue
+     * @var mixed $filter
      */
-    private $keyValue;
+    private $filter;
 
-    public function __construct(KeyValue $keyValue)
+    public function __construct($filter)
     {
-        $this->keyValue = $keyValue;
+        $this->filter = $filter;
     }
 
     public function __toString()
     {
-        return '|> filter(fn: (r) => ' . $this->keyValue . ') ';
+        return '|> filter(fn: (r) => ' . $this->format() . ') ';
+    }
+
+    /**
+     * @throws FunctionInvalidInputException
+     */
+    protected function format(): string
+    {
+        if ($this->filter instanceof KeyValue) {
+            return $this->filter->__toString();
+        } elseif (is_array($this->filter)) {
+            $filterCounter = 0;
+            $filterString = '';
+            foreach ($this->filter as $filter) {
+                if ($filterCounter > 0) {
+                    $filterString .= ' or ';
+                }
+
+                $filterString .= 'r._field == "' . $filter . '"';
+
+                $filterCounter++;
+            }
+
+            return $filterString;
+        }
+
+        throw new FunctionInvalidInputException('Filter input is incorrect.');
     }
 }

src/QueryBuilder.php

@@ -91,6 +91,15 @@ class QueryBuilder
         return $this;
     }
 
+    public function addFieldFilter(array $fields): QueryBuilder
+    {
+        $this->addToQueryArray(
+            self::FLUX_PART_FILTERS,
+            new Filter($fields)
+        );
+        return $this;
+    }
+
     public function addRange(DateTime $start, ?DateTime $stop = null): QueryBuilder
     {
         $this->addRequiredData(self::REQUIRED_INPUT_RANGE, [$start, $stop]);

tests/Functions/FilterFunctionTest.php

@@ -22,4 +22,13 @@ final class FilterFunctionTest extends TestCase
 
         $this->assertEquals($expression->__toString(), $query);
     }
+
+    public function testFieldFilter()
+    {
+        $expression = new Filter(['user', 'field2', 'field3']);
+
+        $query = '|> filter(fn: (r) => r._field == "user" or r._field == "field2" or r._field == "field3") ';
+
+        $this->assertEquals($expression->__toString(), $query);
+    }
 }

tests/Generic/QueryBuilderTest.php

@@ -100,7 +100,7 @@ final class QueryBuilderTest extends TestCase
         $queryBuilder->fromBucket('test_bucket')
             ->fromMeasurement('test_measurement')
             ->addRangeStart(new DateTime('2022-08-12 17:31:00'))
-            ->addFilter(KeyValue::setEqualTo('_field', 'username'))
+            ->addFieldFilter(['username', 'ip'])
             ->addMap('r with name: r.user')
             ->addGroup(['_field', 'ip'])
             ->addReduce(['count' => new MathType('accumulator.count + 1')], ['count' => 0])
@@ -108,9 +108,9 @@ final class QueryBuilderTest extends TestCase
 
         $expectedQuery = 'from(bucket: "test_bucket") |> range(start: time(v: 2022-08-12T17:31:00Z)) ' .
             '|> reduce(fn: (r, accumulator) => ({count: accumulator.count + 1}), identity: {count: 0}) ' .
-            '|> filter(fn: (r) => r._measurement == "test_measurement") |> filter(fn: (r) => r._field == "username") ' .
+            '|> filter(fn: (r) => r._measurement == "test_measurement") |> filter(fn: (r) => ' .
-            '|> filter(fn: (r) => r.count >= 1 and r.count2 >= 2) |> map(fn: (r) => ({ r with name: r.user })) ' .
+            'r._field == "username" or r._field == "ip") |> filter(fn: (r) => r.count >= 1 and r.count2 >= 2) ' .
-            '|> group(columns: ["_field", "ip"], mode: "by") ';
+            '|> map(fn: (r) => ({ r with name: r.user })) |> group(columns: ["_field", "ip"], mode: "by") ';
 
         $this->assertEquals($expectedQuery, $queryBuilder->build());
     }