Add filters of Between, EqualsEmpty and EqualsNull

README.md

@@ -94,7 +94,10 @@ Filter could be composed with:
 
 - `All`
 - `Any`
+- `Between`
 - `Equals`
+- `EqualsEmpty`
+- `EqualsNull`
 - `GreaterThan`
 - `GreaterThanOrEqual`
 - `In`

src/Reader/Filter/Between.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Reader\Filter;
+
+use InvalidArgumentException;
+
+use function gettype;
+use function is_scalar;
+
+final class Between implements FilterInterface
+{
+    private string $field;
+
+    /**
+     * @var bool|float|int|string
+     */
+    private $firstValue;
+
+    /**
+     * @var bool|float|int|string
+     */
+    private $secondValue;
+
+    /**
+     * @param string $field
+     * @param bool|float|int|string $firstValue
+     * @param bool|float|int|string $secondValue
+     */
+    public function __construct(string $field, $firstValue, $secondValue)
+    {
+        $this->field = $field;
+
+        $this->validateValue($firstValue);
+        $this->validateValue($secondValue);
+
+        $this->firstValue = $firstValue;
+        $this->secondValue = $secondValue;
+    }
+
+    public function toArray(): array
+    {
+        return [self::getOperator(), $this->field, $this->firstValue, $this->secondValue];
+    }
+
+    public static function getOperator(): string
+    {
+        return 'between';
+    }
+
+    /**
+     * @param mixed $value
+     */
+    private function validateValue($value): void
+    {
+        if (!is_scalar($value)) {
+            throw new InvalidArgumentException(sprintf(
+                'The value should be scalar. The %s is received.',
+                gettype($value),
+            ));
+        }
+    }
+}

src/Reader/Filter/EqualsEmpty.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Reader\Filter;
+
+final class EqualsEmpty implements FilterInterface
+{
+    private string $field;
+
+    public function __construct(string $field)
+    {
+        $this->field = $field;
+    }
+
+    public function toArray(): array
+    {
+        return [self::getOperator(), $this->field];
+    }
+
+    public static function getOperator(): string
+    {
+        return 'empty';
+    }
+}

src/Reader/Filter/EqualsNull.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Reader\Filter;
+
+final class EqualsNull implements FilterInterface
+{
+    private string $field;
+
+    public function __construct(string $field)
+    {
+        $this->field = $field;
+    }
+
+    public function toArray(): array
+    {
+        return [self::getOperator(), $this->field];
+    }
+
+    public static function getOperator(): string
+    {
+        return 'null';
+    }
+}

src/Reader/Iterable/Processor/Between.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Reader\Iterable\Processor;
+
+use InvalidArgumentException;
+use Yiisoft\Data\Reader\Filter\FilterProcessorInterface;
+
+use function array_key_exists;
+
+class Between implements IterableProcessorInterface, FilterProcessorInterface
+{
+    public function getOperator(): string
+    {
+        return \Yiisoft\Data\Reader\Filter\Between::getOperator();
+    }
+
+    public function match(array $item, array $arguments, array $filterProcessors): bool
+    {
+        if (count($arguments) !== 3) {
+            throw new InvalidArgumentException('$arguments should contain exactly three elements.');
+        }
+
+        [$field, $firstValue, $secondValue] = $arguments;
+        return array_key_exists($field, $item) && $item[$field] >= $firstValue && $item[$field] <= $secondValue;
+    }
+}

src/Reader/Iterable/Processor/EqualsEmpty.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Reader\Iterable\Processor;
+
+use InvalidArgumentException;
+use Yiisoft\Data\Reader\Filter\FilterProcessorInterface;
+
+class EqualsEmpty implements IterableProcessorInterface, FilterProcessorInterface
+{
+    public function getOperator(): string
+    {
+        return \Yiisoft\Data\Reader\Filter\EqualsEmpty::getOperator();
+    }
+
+    public function match(array $item, array $arguments, array $filterProcessors): bool
+    {
+        if (count($arguments) !== 1) {
+            throw new InvalidArgumentException('$arguments should contain exactly one element.');
+        }
+
+        [$field] = $arguments;
+        return empty($item[$field]);
+    }
+}

src/Reader/Iterable/Processor/EqualsNull.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Reader\Iterable\Processor;
+
+use InvalidArgumentException;
+use Yiisoft\Data\Reader\Filter\FilterProcessorInterface;
+
+use function array_key_exists;
+
+class EqualsNull implements IterableProcessorInterface, FilterProcessorInterface
+{
+    public function getOperator(): string
+    {
+        return \Yiisoft\Data\Reader\Filter\EqualsNull::getOperator();
+    }
+
+    public function match(array $item, array $arguments, array $filterProcessors): bool
+    {
+        if (count($arguments) !== 1) {
+            throw new InvalidArgumentException('$arguments should contain exactly one element.');
+        }
+
+        [$field] = $arguments;
+        return array_key_exists($field, $item) && $item[$field] === null;
+    }
+}

tests/Reader/FilterProcessorTest.php

@@ -7,7 +7,10 @@
 use InvalidArgumentException;
 use Yiisoft\Data\Reader\Iterable\IterableDataReader;
 use Yiisoft\Data\Reader\Iterable\Processor\All;
+use Yiisoft\Data\Reader\Iterable\Processor\Between;
 use Yiisoft\Data\Reader\Iterable\Processor\Equals;
+use Yiisoft\Data\Reader\Iterable\Processor\EqualsEmpty;
+use Yiisoft\Data\Reader\Iterable\Processor\EqualsNull;
 use Yiisoft\Data\Reader\Iterable\Processor\GreaterThan;
 use Yiisoft\Data\Reader\Iterable\Processor\GreaterThanOrEqual;
 use Yiisoft\Data\Reader\Iterable\Processor\In;
@@ -77,7 +80,10 @@ public function match(array $item, array $arguments, array $filterProcessors): b
     public function invalidFiltersArrayDataProvider(): array
     {
         return [
+            'betweenArgumentsTooSmall' => [new Between(), ['id'], []],
             'equalsArgumentsTooSmall' => [new Equals(), ['id'], []],
+            'equalsEmptyArgumentsTooSmall' => [new EqualsEmpty(), [], []],
+            'equalsNullArgumentsTooSmall' => [new EqualsNull(), [], []],
             'greaterThanArgumentsTooSmall' => [new GreaterThan(), ['id'], []],
             'greaterThanOrEqualArgumentsTooSmall' => [new GreaterThanOrEqual(), ['id'], []],
             'lessThanArgumentsTooSmall' => [new LessThan(), ['id'], []],

tests/Reader/FilterTest.php

@@ -7,7 +7,10 @@
 use InvalidArgumentException;
 use Yiisoft\Data\Reader\Filter\All;
 use Yiisoft\Data\Reader\Filter\Any;
+use Yiisoft\Data\Reader\Filter\Between;
 use Yiisoft\Data\Reader\Filter\Equals;
+use Yiisoft\Data\Reader\Filter\EqualsEmpty;
+use Yiisoft\Data\Reader\Filter\EqualsNull;
 use Yiisoft\Data\Reader\Filter\FilterInterface;
 use Yiisoft\Data\Reader\Filter\GreaterThan;
 use Yiisoft\Data\Reader\Filter\GreaterThanOrEqual;
@@ -23,10 +26,22 @@ final class FilterTest extends TestCase
     public function filterDataProvider(): array
     {
         return [
+            'Between' => [
+                new Between('test', 42, 44),
+                ['between', 'test', 42, 44],
+            ],
             'Equals' => [
                 new Equals('test', 42),
                 ['=', 'test', 42],
             ],
+            'EqualsEmpty' => [
+                new EqualsEmpty('test'),
+                ['empty', 'test'],
+            ],
+            'EqualsNull' => [
+                new EqualsNull('test'),
+                ['null', 'test'],
+            ],
             'In' => [
                 new In('test', [1, 2, 3]),
                 ['in', 'test', [1, 2, 3]],

tests/Reader/Iterable/Processor/BetweenTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Tests\Reader\Iterable\Processor;
+
+use PHPUnit\Framework\TestCase;
+use Yiisoft\Data\Reader\Iterable\Processor\Between;
+
+final class BetweenTest extends TestCase
+{
+    public function dataBase(): array
+    {
+        return [
+            [true, ['weight', 42, 47]],
+            [true, ['weight', 45, 45]],
+            [true, ['weight', 45, 46]],
+            [false, ['weight', 46, 47]],
+            [false, ['weight', 46, 45]],
+            [false, ['age', 42, 47]],
+        ];
+    }
+
+    /**
+     * @dataProvider dataBase
+     */
+    public function testBase(bool $expected, array $arguments): void
+    {
+        $processor = new Between();
+
+        $item = [
+            'id' => 1,
+            'weight' => 45,
+        ];
+
+        $this->assertSame($expected, $processor->match($item, $arguments, []));
+    }
+}

tests/Reader/Iterable/Processor/EqualsEmptyTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Tests\Reader\Iterable\Processor;
+
+use PHPUnit\Framework\TestCase;
+use Yiisoft\Data\Reader\Iterable\Processor\EqualsEmpty;
+
+final class EqualsEmptyTest extends TestCase
+{
+    public function dataBase(): array
+    {
+        return [
+            [true, ['value' => null]],
+            [true, ['value' => false]],
+            [true, ['value' => 0]],
+            [true, ['value' => 0.0]],
+            [true, ['value' => '']],
+            [false, ['value' => 42]],
+            [false, ['value' => true]],
+            [true, ['not-exist' => 42]],
+        ];
+    }
+
+    /**
+     * @dataProvider dataBase
+     */
+    public function testBase(bool $expected, array $item): void
+    {
+        $this->assertSame($expected, (new EqualsEmpty())->match($item, ['value'], []));
+    }
+}

tests/Reader/Iterable/Processor/EqualsNullTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Data\Tests\Reader\Iterable\Processor;
+
+use PHPUnit\Framework\TestCase;
+use Yiisoft\Data\Reader\Iterable\Processor\EqualsNull;
+
+final class EqualsNullTest extends TestCase
+{
+    public function dataBase(): array
+    {
+        return [
+            [true, ['value' => null]],
+            [false, ['value' => false]],
+            [false, ['value' => true]],
+            [false, ['value' => 0]],
+            [false, ['value' => 0.0]],
+            [false, ['value' => 42]],
+            [false, ['value' => '']],
+            [false, ['value' => 'null']],
+            [false, ['not-exist' => null]],
+        ];
+    }
+
+    /**
+     * @dataProvider dataBase
+     */
+    public function testBase(bool $expected, array $item): void
+    {
+        $this->assertSame($expected, (new EqualsNull())->match($item, ['value'], []));
+    }
+}