Add DateTime option to Range function

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

src/Formatters.php

@@ -2,6 +2,8 @@
 
 namespace Arendsen\FluxQueryBuilder;
 
+use DateTime;
+
 class Formatters {
 
     public static function valueToString($value): string
@@ -38,4 +40,8 @@ class Formatters {
         return implode(', ', $array);
     }
 
+    public static function dateTimeToString(DateTime $dateTime): string {
+		return 'time(v: ' . $dateTime->format('Y-m-d\TH:i:s\Z') . ')';
+	}
+
 }

src/Functions/Range.php

@@ -3,30 +3,48 @@
 namespace Arendsen\FluxQueryBuilder\Functions;
 
 use Arendsen\FluxQueryBuilder\Exception\FunctionRequiredSettingMissingException;
+use Arendsen\FluxQueryBuilder\Formatters;
+use DateTime;
 
 class Range extends Base {
 
     /**
-     * @var array $settings
+     * @var mixed $start
      */
-    private $settings;
+    private $start;
+
+    /**
+     * @var mixed $stop
+     */
+    private $stop;
 
     public function __construct(array $settings)
     {
-        $this->settings = $settings;
+        $this->start = isset($settings['start']) ? $settings['start'] : null;
+        $this->stop = isset($settings['stop']) ? $settings['stop'] : null;
     }
 
     public function __toString()
     {
-        if(!isset($this->settings['start']))
+        if(!$this->start)
         {
             throw new FunctionRequiredSettingMissingException('Range', 'Start setting is required!');
         }
 
-        $settingsString = 'start: ' . $this->settings['start'];
+        if($this->start instanceof DateTime)
-        if(isset($this->settings['stop']))
         {
-            $settingsString .= ', stop: ' . $this->settings['stop'];
+            $this->start = Formatters::dateTimeToString($this->start);
+        }
+
+        if($this->stop instanceof DateTime)
+        {
+            $this->stop = Formatters::dateTimeToString($this->stop);
+        }
+
+        $settingsString = 'start: ' . $this->start;
+        if($this->stop)
+        {
+            $settingsString .= ', stop: ' . $this->stop;
         }
 
         return '|> range(' . $settingsString . ') ';

src/QueryBuilder.php

@@ -2,6 +2,8 @@
 
 namespace Arendsen\FluxQueryBuilder;
 
+use DateTime;
+use Exception;
 use Arendsen\FluxQueryBuilder\Expression\KeyValue;
 use Arendsen\FluxQueryBuilder\Functions\Filter;
 use Arendsen\FluxQueryBuilder\Functions\From;
@@ -11,7 +13,6 @@ use Arendsen\FluxQueryBuilder\Functions\Sort;
 use Arendsen\FluxQueryBuilder\Functions\Map;
 use Arendsen\FluxQueryBuilder\Functions\Group;
 use Arendsen\FluxQueryBuilder\Functions\Limit;
-use Exception;
 
 class QueryBuilder {
 
@@ -100,12 +101,25 @@ class QueryBuilder {
         return $this;
     }
 
-    public function addRangeStart(string $rangeStart): QueryBuilder
+    /**
+     * @param string|DateTime $rangeStart
+     */
+    public function addRangeStart($rangeStart): QueryBuilder
     {
         $this->addRange(['start' => $rangeStart]);
         return $this;
     }
 
+    /**
+     * @param string|DateTime $start
+     * @param string|DateTime $stop
+     */
+    public function addRangeInBetween($start, $stop)
+    {
+        $this->addRange(['start' => $start, 'stop' => $stop]);
+        return $this;
+    }
+
     public function addReduce(array $settings, array $identity): QueryBuilder
     {
         $this->addToQueryArray(

tests/FormattersTest.php

@@ -18,4 +18,13 @@ final class FormattersTest extends TestCase {
         $this->assertEquals($expected, Formatters::toFluxArrayString($array));
     }
 
+    public function testDateTimeToString()
+    {
+        $dateTime = new DateTime('2022-08-12 17:31:00');
+
+        $expected = 'time(v: 2022-08-12T17:31:00Z)';
+
+        $this->assertEquals($expected, Formatters::dateTimeToString($dateTime));
+    }
+
 }

tests/Functions/RangeFunctionTest.php

@@ -2,6 +2,7 @@
 declare(strict_types=1);
 
 use Arendsen\FluxQueryBuilder\Exception\FunctionRequiredSettingMissingException;
+use Arendsen\FluxQueryBuilder\Formatters;
 use Arendsen\FluxQueryBuilder\Functions\Range;
 use PHPUnit\Framework\TestCase;
 
@@ -25,6 +26,18 @@ final class RangeFunctionTest extends TestCase {
         $this->assertEquals($query, $expression->__toString());
     }
 
+    public function testRangeInBetween()
+    {
+        $expression = new Range([
+            'start' => new DateTime('2022-08-12 17:31:00'),
+            'stop' => new DateTime('2022-08-12 18:31:00'),
+        ]);
+
+        $expected = '|> range(start: time(v: 2022-08-12T17:31:00Z), stop: time(v: 2022-08-12T18:31:00Z)) ';
+
+        $this->assertEquals($expected, $expression->__toString());
+    }
+
     public function testThrowsExceptionWhenStartIsMissing()
     {
         $this->expectException(FunctionRequiredSettingMissingException::class);

tests/QueryBuilderTest.php

@@ -92,14 +92,14 @@ final class QueryBuilderTest extends TestCase {
         $queryBuilder = new QueryBuilder();
         $queryBuilder->fromBucket('test_bucket')
             ->fromMeasurement('test_measurement')
-		    ->addRangeStart('-3h')
+		    ->addRangeStart(new DateTime('2022-08-12 17:31:00'))
             ->addFilter(KeyValue::setEqualTo('_field', 'username'))
             ->addMap('r with name: r.user')
             ->addGroup(['_field', 'ip'])
             ->addReduce(['count' => 'accumulator.count + 1'], ['count' => 0])
             ->addFilter(KeyValue::setGreaterOrEqualTo('count', 1)->andGreaterOrEqualTo('count2', 2));
 
-        $expectedQuery = 'from(bucket: "test_bucket") |> range(start: -3h) ' . 
+        $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.count >= 1 and r.count2 >= 2) |> map(fn: (r) => ({ r with name: r.user })) ' .