Add Flux from() and filter() methods

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

.gitignore

@@ -1,5 +1,6 @@
 composer.phar
 /vendor/
+.phpunit.result.cache
 
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file

composer.json

@@ -0,0 +1,26 @@
+{
+    "name": "arendsen/fluxquerybuilder",
+    "description": "Generating Flux queries",
+    "keywords": [
+        "influxdb",
+        "flux"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "David Arendsen",
+            "email": "davidarendsen@hey.com"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Arendsen\\FluxQueryBuilder\\": "src/"
+        }
+    },
+    "require": {
+        "php": ">=7.2"
+    },
+    "require-dev": {
+		"phpunit/phpunit": "^8"
+	}
+}

phpunit.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<phpunit bootstrap="./vendor/autoload.php">
+
+    <testsuites>
+        <testsuite name="The project's test suite">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+
+</phpunit>

src/Expression/Base.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Expression;
+
+abstract class Base {
+
+	/**
+	 * @throws ExpressionNotImplementedException
+	 */
+	public function __toString()
+    {
+		throw new ExpressionNotImplementedException('__toString', get_class($this));
+	}
+
+}

src/Expression/ExpressionNotImplementedException.php

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

src/Expression/Filter/AndExpression.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Expression\Filter;
+
+use Arendsen\FluxQueryBuilder\Expression\Base;
+
+class AndExpression extends Base {
+
+    /**
+     * @var string $key
+     */
+    private $key;
+
+    /**
+     * @var string $value
+     */
+    private $value;
+
+    public function __construct(string $key, string $value)
+    {
+        $this->key = $key;
+        $this->value = $value;
+    }
+
+    public function __toString()
+    {
+        return 'and r.' . $this->key . ' == "' . $this->value . '"';
+    }
+
+}

src/Expression/Filter/Measurement.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Expression\Filter;
+
+use Arendsen\FluxQueryBuilder\Expression\Base;
+
+class Measurement extends Base {
+
+    /**
+     * @var array $measurement
+     */
+    private $measurement;
+
+    public function __construct(string $measurement)
+    {
+        $this->measurement = $measurement;
+    }
+
+    public function __toString()
+    {
+        return 'r._measurement == "' . $this->measurement . '"';
+    }
+
+}

src/Expression/Filter/OrExpression.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Expression\Filter;
+
+use Arendsen\FluxQueryBuilder\Expression\Base;
+
+class OrExpression extends Base {
+
+    /**
+     * @var string $key
+     */
+    private $key;
+
+    /**
+     * @var string $value
+     */
+    private $value;
+
+    public function __construct(string $key, string $value)
+    {
+        $this->key = $key;
+        $this->value = $value;
+    }
+
+    public function __toString()
+    {
+        return 'or r.' . $this->key . ' == "' . $this->value . '"';
+    }
+
+}

src/Function/Base.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Function;
+
+abstract class Base {
+
+	/**
+	 * @throws FunctionNotImplementedException
+	 */
+	public function __toString()
+    {
+		throw new FunctionNotImplementedException('__toString', get_class($this));
+	}
+
+}

src/Function/Filter.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Function;
+
+class Filter extends Base {
+
+    /**
+     * @var array $settings
+     */
+    private $settings;
+
+    public function __construct(array $settings)
+    {
+        $this->settings = $settings;
+    }
+
+    public function __toString()
+    {
+        return '|> filter(fn: (r) => ' . implode(' ', $this->settings) . ') ';
+    }
+
+}

src/Function/From.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder\Function;
+
+class From extends Base {
+
+    /**
+     * @var array $settings
+     */
+    private $settings;
+
+    public function __construct(array $settings)
+    {
+        $this->settings = $settings;
+    }
+
+    public function __toString()
+    {
+        return 'from(' . implode(', ', $this->format($this->settings)) . ') ';
+    }
+
+    protected function format(array $settings)
+    {
+        array_walk($settings, function(&$value, $key) {
+			$value = $key . ': ' . (is_string($value) ? '"' . $value . '"' : $value);
+		});
+
+        return $settings;
+    }
+
+}

src/Function/FunctionNotImplementedException.php

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

src/QueryBuilder.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Arendsen\FluxQueryBuilder;
+
+class QueryBuilder {
+
+    /**
+     * @var array $from
+     */
+    private $from;
+
+    /**
+     * @var string $measurement
+     */
+    private $measurement;
+
+    /**
+     * @var array $range
+     */
+    private $range;
+    
+    public function from(array $from): QueryBuilder
+    {
+        $this->from = $from;
+        return $this;
+    }
+
+    public function fromBucket(string $bucket): QueryBuilder {
+        $this->from = ['bucket' => $bucket];
+        return $this;
+    }
+
+    public function fromMeasurement(string $measurement): QueryBuilder
+    {
+        $this->measurement = $measurement;
+        return $this;
+    }
+
+    public function addRange(array $range): QueryBuilder
+    {
+        $this->range = $range;
+        return $this;
+    }
+
+    public function addRangeStart(string $rangeStart): QueryBuilder
+    {
+        $this->range = ['start' => $rangeStart];
+        return $this;
+    }
+
+    public function build(): string
+    {
+        //TODO: build the query dynamically here
+        return 'from(bucket: "test_bucket", host: "host", org: "example-org", token: "token") |> ';
+    }
+
+}

tests/Expression/FilterExpressionTest.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+use Arendsen\FluxQueryBuilder\Expression\Filter\AndExpression;
+use Arendsen\FluxQueryBuilder\Expression\Filter\OrExpression;
+use Arendsen\FluxQueryBuilder\Expression\Filter\Measurement;
+use Arendsen\FluxQueryBuilder\Function\Filter;
+use PHPUnit\Framework\TestCase;
+
+final class FilterFunctionTest extends TestCase {
+
+    public function testSimpleFilter()
+    {
+        $expression = new Filter([
+            new Measurement('test_measurement'),
+            new AndExpression('_field', 'user'),
+            new OrExpression('_field', 'field2'),
+            'and r.user == "my_username"',
+        ]);
+
+        $query = '|> filter(fn: (r) => r._measurement == "test_measurement" and r._field == "user" or ' . 
+            'r._field == "field2" and r.user == "my_username") ';
+
+        $this->assertEquals($expression->__toString(), $query);
+    }
+
+}

tests/Expression/FromExpressionTest.php

@@ -0,0 +1,38 @@
+<?php
+declare(strict_types=1);
+
+use Arendsen\FluxQueryBuilder\Function\From;
+use PHPUnit\Framework\TestCase;
+
+final class FromExpressionTest extends TestCase {
+
+    /**
+     * @dataProvider somethingProvider
+     */
+    public function testSomething($settings, $query)
+    {
+        $expression = new From($settings);
+
+        $this->assertEquals($expression->__toString(), $query);
+    }
+
+    public function somethingProvider(): array
+    {
+        return [
+            'from bucket' => [
+                [
+                    'bucket' => 'test-bucket',
+                ],
+                'from(bucket: "test-bucket") '
+            ],
+            'from bucket and host' => [
+                [
+                    'bucket' => 'test-bucket',
+                    'host' => 'test',
+                ],
+                'from(bucket: "test-bucket", host: "test") '
+            ],
+        ];
+    }
+
+}

tests/QueryBuilderTest.php

@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+use PHPUnit\Framework\TestCase;
+use Arendsen\FluxQueryBuilder\QueryBuilder;
+
+final class QueryBuilderTest extends TestCase {
+
+    /**
+     * @dataProvider somethingProvider
+     */
+    public function testSomething($bucket, $measurement, $range, $expectedQuery)
+    {
+        $queryBuilder = new QueryBuilder();
+        $queryBuilder->from($bucket)
+            ->fromMeasurement($measurement)
+			->addRangeStart($range);
+
+        $this->assertEquals($queryBuilder->build(), $expectedQuery);
+    }
+
+    public function somethingProvider(): array
+    {
+        return [
+            'case 1' => [
+                [
+                    'bucket' => 'example-bucket', 
+                    'host' => 'host', 
+                    'org' => 'example-org', 
+                    'token' => 'token'
+                ],
+                'test_measurement',
+                '-360h',
+                'from(bucket: "test_bucket", host: "host", org: "example-org", token: "token") |> '
+            ],
+        ];
+    }
+
+}