PS-2536 Support for comparison operators in subscription filters

Author: pepamartinec

composer.json

@@ -28,6 +28,7 @@
         "php": "^7.4",
         "ext-json": "*",
         "guzzlehttp/guzzle": "^6.3|^7.2",
+        "myclabs/php-enum": "^1.8",
         "psr/log": "^1.1",
         "symfony/validator": "^5.2"
     },

src/Requests/PostSubscription/Filter.php

@@ -10,21 +10,26 @@ class Filter implements JsonSerializable
 {
     private string $field;
     private string $value;
+    private ?FilterOperator $operator;
 
-    public function __construct(string $field, string $value)
+    public function __construct(string $field, string $value, ?FilterOperator $operator = null)
     {
         $this->field = $field;
         $this->value = $value;
+        $this->operator = $operator;
     }
 
-    /**
-     * @return mixed
-     */
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
-        return [
+        $data = [
             'field' => $this->field,
             'value' => $this->value,
         ];
+
+        if ($this->operator !== null) {
+            $data['operator'] = $this->operator->getValue();
+        }
+
+        return $data;
     }
 }

src/Requests/PostSubscription/FilterOperator.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\NotificationClient\Requests\PostSubscription;
+
+use DomainException;
+use MyCLabs\Enum\Enum;
+
+/**
+ * @method static self EQUAL()
+ * @method static self LESS_THAN()
+ * @method static self GREATER_THAN()
+ * @method static self LESS_THAN_OR_EQUAL()
+ * @method static self GREATER_THAN_OR_EQUAL()
+ *
+ * @phpstan-extends Enum<string>
+ */
+class FilterOperator extends Enum
+{
+    // phpcs:disable SlevomatCodingStandard.Classes.UnusedPrivateElements
+    private const EQUAL = '=='; // can't be called EQUALS because there is a method called `equals` on base Enum class
+    private const LESS_THAN = '<';
+    private const GREATER_THAN = '>';
+    private const LESS_THAN_OR_EQUAL = '<=';
+    private const GREATER_THAN_OR_EQUAL = '>=';
+    // phpcs:enable SlevomatCodingStandard.Classes.UnusedPrivateElements
+}

tests/Requests/PostSubscription/FilterOperatorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\NotificationClient\Tests\Requests\PostSubscription;
+
+use Keboola\NotificationClient\Requests\PostSubscription\FilterOperator;
+use PHPUnit\Framework\TestCase;
+
+class FilterOperatorTest extends TestCase
+{
+    /**
+     * @dataProvider provideOperatorValues
+     */
+    public function testOperatorValues(FilterOperator $operator, string $expectedValue): void
+    {
+        self::assertSame($expectedValue, $operator->getValue());
+    }
+
+    public function provideOperatorValues(): iterable
+    {
+        yield 'equals' => [FilterOperator::EQUAL(), '=='];
+        yield 'less than' => [FilterOperator::LESS_THAN(), '<'];
+        yield 'greater than' => [FilterOperator::GREATER_THAN(), '>'];
+        yield 'less than or equals' => [FilterOperator::LESS_THAN_OR_EQUAL(), '<='];
+        yield 'greater than or equals' => [FilterOperator::GREATER_THAN_OR_EQUAL(), '>='];
+    }
+}

tests/Requests/PostSubscription/FilterTest.php

@@ -5,6 +5,7 @@
 namespace Keboola\NotificationClient\Tests\Requests\PostSubscription;
 
 use Keboola\NotificationClient\Requests\PostSubscription\Filter;
+use Keboola\NotificationClient\Requests\PostSubscription\FilterOperator;
 use PHPUnit\Framework\TestCase;
 
 class FilterTest extends TestCase
@@ -20,4 +21,17 @@ public function testJsonSerialize(): void
             $filter->jsonSerialize()
         );
     }
+
+    public function testJsonSerializeWithOperator(): void
+    {
+        $filter = new Filter('someName', 'someValue', FilterOperator::GREATER_THAN_OR_EQUAL());
+        self::assertSame(
+            [
+                'field' => 'someName',
+                'value' => 'someValue',
+                'operator' => '>=',
+            ],
+            $filter->jsonSerialize()
+        );
+    }
 }