Hosterra/flux-querybuilder
Hosterra/flux-querybuilder
1
0
Fork 0
Code Issues Pull requests Releases 2 Packages Activity

Add DateTime required param for Range functions

Browse source 
Signed-off-by: davidarendsen <davidarendsen@hey.com>
This commit is contained in:
davidarendsen 2022-08-12 21:25:03 +00:00
commit 95e71624d5
5 changed files with 33 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -20,7 +20,7 @@ use Arendsen\FluxQueryBuilder\Expression\KeyValue;
$queryBuilder = new QueryBuilder();
$queryBuilder->fromBucket('test_bucket')
->fromMeasurement('test_measurement')
->addRangeStart('-3h')
->addRangeStart(new DateTime('3 hours ago'))
->addFilter(
KeyValue::setEqualTo('_field', 'username')
->orEqualTo('_field', 'email')

16
src/Functions/Range.php
View file

@ -18,10 +18,10 @@ class Range extends Base {
*/
private $stop;
public function __construct(array $settings)
public function __construct(DateTime $start, ?DateTime $stop = null)
{
$this->start = isset($settings['start']) ? $settings['start'] : null;
$this->stop = isset($settings['stop']) ? $settings['stop'] : null;
$this->start = Formatters::dateTimeToString($start);
$this->stop = $stop ? Formatters::dateTimeToString($stop) : null;
}
public function __toString()
@ -31,16 +31,6 @@ class Range extends Base {
throw new FunctionRequiredSettingMissingException('Range', 'Start setting is required!');
}
if($this->start instanceof DateTime)
{
$this->start = Formatters::dateTimeToString($this->start);
}
if($this->stop instanceof DateTime)
{
$this->stop = Formatters::dateTimeToString($this->stop);
}
$settingsString = 'start: ' . $this->start;
if($this->stop)
{

21
src/QueryBuilder.php
View file

@ -91,32 +91,25 @@ class QueryBuilder {
return $this;
}
public function addRange(array $range): QueryBuilder
public function addRange(DateTime $start, ?DateTime $stop = null): QueryBuilder
{
$this->addRequiredData(self::REQUIRED_INPUT_RANGE, $range);
$this->addRequiredData(self::REQUIRED_INPUT_RANGE, [$start, $stop]);
$this->addToQuery(
self::FLUX_PART_RANGE,
new Range($range)
new Range($start, $stop)
);
return $this;
}
/**
* @param string|DateTime $rangeStart
*/
public function addRangeStart($rangeStart): QueryBuilder
public function addRangeStart(DateTime $start): QueryBuilder
{
$this->addRange(['start' => $rangeStart]);
$this->addRange($start);
return $this;
}
/**
* @param string|DateTime $start
* @param string|DateTime $stop
*/
public function addRangeInBetween($start, $stop)
public function addRangeInBetween(DateTime $start, DateTime $stop)
{
$this->addRange(['start' => $start, 'stop' => $stop]);
$this->addRange($start, $stop);
return $this;
}

29
tests/Functions/RangeFunctionTest.php
View file

@ -10,40 +10,37 @@ final class RangeFunctionTest extends TestCase {
public function testOnlyStartOption()
{
$expression = new Range(['start' => '-360h']);
$expression = new Range(
new DateTime('2022-08-12 18:00:00')
);
$query = '|> range(start: -360h) ';
$query = '|> range(start: time(v: 2022-08-12T18:00:00Z)) ';
$this->assertEquals($query, $expression->__toString());
}
public function testWithStopOption()
{
$expression = new Range(['start' => '-360h', 'stop' => 'now()']);
$expression = new Range(
new DateTime('2022-08-12 18:00:00'),
new DateTime('2022-08-12 20:00:00')
);
$query = '|> range(start: -360h, stop: now()) ';
$query = '|> range(start: time(v: 2022-08-12T18:00:00Z), stop: time(v: 2022-08-12T20:00:00Z)) ';
$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'),
]);
$expression = new Range(
new DateTime('2022-08-12 17:31:00'),
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);
$expression = new Range(['stop' => 'now()']);
$expression->__toString();
}
}

16
tests/QueryBuilderTest.php
View file

@ -33,18 +33,20 @@ final class QueryBuilderTest extends TestCase {
'bucket' => 'example_bucket',
],
'test_measurement',
'-360h',
new DateTime('2022-08-12 23:05:00'),
null,
'from(bucket: "example_bucket") |> range(start: -360h) |> filter(fn: (r) => r._measurement == "test_measurement") '
'from(bucket: "example_bucket") |> range(start: time(v: 2022-08-12T23:05:00Z)) ' .
'|> filter(fn: (r) => r._measurement == "test_measurement") '
],
'query with filter' => [
[
'bucket' => 'example_bucket',
],
'test_measurement',
'-360h',
new DateTime('2022-08-12 20:05:00'),
KeyValue::setEqualTo('user', 'username'),
'from(bucket: "example_bucket") |> range(start: -360h) |> filter(fn: (r) => r._measurement == "test_measurement") ' .
'from(bucket: "example_bucket") |> range(start: time(v: 2022-08-12T20:05:00Z)) ' .
'|> filter(fn: (r) => r._measurement == "test_measurement") ' .
'|> filter(fn: (r) => r.user == "username") '
],
];
@ -66,7 +68,7 @@ final class QueryBuilderTest extends TestCase {
$queryBuilder->fromMeasurement($measurement);
}
if($range) {
$queryBuilder->addRange($range);
$queryBuilder->addRangeStart($range['start']);
}
$queryBuilder->build();
@ -76,10 +78,10 @@ final class QueryBuilderTest extends TestCase {
{
return [
'without from data' => [
null, 'test_measurement', ['start' => '-360h'],
null, 'test_measurement', ['start' => new DateTime('2022-08-12 20:05:00')],
],
'without measurement data' => [
['from' => 'test_bucket'], null, ['start' => '-360h'],
['from' => 'test_bucket'], null, ['start' => new DateTime('2022-08-12 20:05:00')],
],
'without range data' => [
['from' => 'test_bucket'], 'test_measurement', null,