From bc35a2658396992eb3e72369f6f4c59e17a252c5 Mon Sep 17 00:00:00 2001
From: Sergei Predvoditelev <sergei@predvoditelev.ru>
Date: Sat, 24 Feb 2024 14:33:47 +0300
Subject: [PATCH] Remove `EqualsEmpty` filter

---
 CHANGELOG.md                                  |  1 +
 README.md                                     |  1 -
 src/Reader/Filter/EqualsEmpty.php             | 30 ---------
 .../FilterHandler/EqualsEmptyHandler.php      | 36 -----------
 src/Reader/Iterable/IterableDataReader.php    |  2 -
 tests/Reader/Filter/EqualsEmptyTest.php       | 18 ------
 .../IterableHandler/EqualsEmptyTest.php       | 64 -------------------
 7 files changed, 1 insertion(+), 151 deletions(-)
 delete mode 100644 src/Reader/Filter/EqualsEmpty.php
 delete mode 100644 src/Reader/Iterable/FilterHandler/EqualsEmptyHandler.php
 delete mode 100644 tests/Reader/Filter/EqualsEmptyTest.php
 delete mode 100644 tests/Reader/IterableHandler/EqualsEmptyTest.php

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b7f1dd8b..8e7f9fed 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -22,6 +22,7 @@
   not found (@vjik)
 - Enh #161: Add more specified psalm annotations to `CountableDataInterface::count()`,
   `PaginatorInterface::getCurrentPageSize()` and `OffsetPaginator::getTotalItems()` (@vjik)
+- Chg #166: Remove `EqualsEmpty` filter (@vjik)
 
 ## 1.0.1 January 25, 2023
 
diff --git a/README.md b/README.md
index d5bfc58a..0f459ac1 100644
--- a/README.md
+++ b/README.md
@@ -116,7 +116,6 @@ Filter could be composed with:
 - `Any`
 - `Between`
 - `Equals`
-- `EqualsEmpty`
 - `EqualsNull`
 - `GreaterThan`
 - `GreaterThanOrEqual`
diff --git a/src/Reader/Filter/EqualsEmpty.php b/src/Reader/Filter/EqualsEmpty.php
deleted file mode 100644
index 5ed330ff..00000000
--- a/src/Reader/Filter/EqualsEmpty.php
+++ /dev/null
@@ -1,30 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Yiisoft\Data\Reader\Filter;
-
-use Yiisoft\Data\Reader\FilterInterface;
-
-/**
- * `EqualsEmpty` filter defines a criteria for ensuring field value is empty.
- */
-final class EqualsEmpty implements FilterInterface
-{
-    /**
-     * @param string $field Name of the field to check.
-     */
-    public function __construct(private string $field)
-    {
-    }
-
-    public function toCriteriaArray(): array
-    {
-        return [self::getOperator(), $this->field];
-    }
-
-    public static function getOperator(): string
-    {
-        return 'empty';
-    }
-}
diff --git a/src/Reader/Iterable/FilterHandler/EqualsEmptyHandler.php b/src/Reader/Iterable/FilterHandler/EqualsEmptyHandler.php
deleted file mode 100644
index 948ee976..00000000
--- a/src/Reader/Iterable/FilterHandler/EqualsEmptyHandler.php
+++ /dev/null
@@ -1,36 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Yiisoft\Data\Reader\Iterable\FilterHandler;
-
-use InvalidArgumentException;
-use Yiisoft\Data\Reader\Filter\EqualsEmpty;
-use Yiisoft\Data\Reader\FilterAssert;
-use Yiisoft\Data\Reader\Iterable\IterableFilterHandlerInterface;
-
-use function count;
-
-/**
- * `EqualsEmpty` iterable filter handler checks that the item's field value is empty.
- */
-final class EqualsEmptyHandler implements IterableFilterHandlerInterface
-{
-    public function getOperator(): string
-    {
-        return EqualsEmpty::getOperator();
-    }
-
-    public function match(array|object $item, array $arguments, array $iterableFilterHandlers): bool
-    {
-        if (count($arguments) !== 1) {
-            throw new InvalidArgumentException('$arguments should contain exactly one element.');
-        }
-
-        [$field] = $arguments;
-        FilterAssert::fieldIsString($field);
-
-        /** @var string $field */
-        return empty($item[$field]);
-    }
-}
diff --git a/src/Reader/Iterable/IterableDataReader.php b/src/Reader/Iterable/IterableDataReader.php
index aa62fa01..2cd12f01 100644
--- a/src/Reader/Iterable/IterableDataReader.php
+++ b/src/Reader/Iterable/IterableDataReader.php
@@ -17,7 +17,6 @@
 use Yiisoft\Data\Reader\Iterable\FilterHandler\AnyHandler;
 use Yiisoft\Data\Reader\Iterable\FilterHandler\BetweenHandler;
 use Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsHandler;
-use Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsEmptyHandler;
 use Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsNullHandler;
 use Yiisoft\Data\Reader\Iterable\FilterHandler\GreaterThanHandler;
 use Yiisoft\Data\Reader\Iterable\FilterHandler\GreaterThanOrEqualHandler;
@@ -73,7 +72,6 @@ public function __construct(private iterable $data)
             new AnyHandler(),
             new BetweenHandler(),
             new EqualsHandler(),
-            new EqualsEmptyHandler(),
             new EqualsNullHandler(),
             new GreaterThanHandler(),
             new GreaterThanOrEqualHandler(),
diff --git a/tests/Reader/Filter/EqualsEmptyTest.php b/tests/Reader/Filter/EqualsEmptyTest.php
deleted file mode 100644
index 898140b5..00000000
--- a/tests/Reader/Filter/EqualsEmptyTest.php
+++ /dev/null
@@ -1,18 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Yiisoft\Data\Tests\Reader\Filter;
-
-use Yiisoft\Data\Reader\Filter\EqualsEmpty;
-use Yiisoft\Data\Tests\TestCase;
-
-final class EqualsEmptyTest extends TestCase
-{
-    public function testToArray(): void
-    {
-        $filter = new EqualsEmpty('test');
-
-        $this->assertSame(['empty', 'test'], $filter->toCriteriaArray());
-    }
-}
diff --git a/tests/Reader/IterableHandler/EqualsEmptyTest.php b/tests/Reader/IterableHandler/EqualsEmptyTest.php
deleted file mode 100644
index 37b32358..00000000
--- a/tests/Reader/IterableHandler/EqualsEmptyTest.php
+++ /dev/null
@@ -1,64 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Yiisoft\Data\Tests\Reader\IterableHandler;
-
-use InvalidArgumentException;
-use PHPUnit\Framework\Attributes\DataProvider;
-use Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsEmptyHandler;
-use Yiisoft\Data\Tests\TestCase;
-
-final class EqualsEmptyTest extends TestCase
-{
-    public static function matchDataProvider(): array
-    {
-        return [
-            [true, ['value' => null]],
-            [true, ['value' => false]],
-            [true, ['value' => 0]],
-            [true, ['value' => 0.0]],
-            [true, ['value' => '0']],
-            [true, ['value' => '']],
-            [false, ['value' => 42]],
-            [false, ['value' => '1']],
-            [false, ['value' => true]],
-        ];
-    }
-
-    #[DataProvider('matchDataProvider')]
-    public function testMatch(bool $expected, array $item): void
-    {
-        $this->assertSame($expected, (new EqualsEmptyHandler())->match($item, ['value'], []));
-    }
-
-    public static function invalidCountArgumentsDataProvider(): array
-    {
-        return [
-            'zero' => [[]],
-            'two' => [[1, 2]],
-            'three' => [[1, 2, 3]],
-            'four' => [[1, 2, 3, 4]],
-        ];
-    }
-
-    #[DataProvider('invalidCountArgumentsDataProvider')]
-    public function testMatchFailForInvalidCountArguments($arguments): void
-    {
-        $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('$arguments should contain exactly one element.');
-
-        (new EqualsEmptyHandler())->match(['id' => 1], $arguments, []);
-    }
-
-    #[DataProvider('invalidStringValueDataProvider')]
-    public function testMatchFailForInvalidFieldValue($field): void
-    {
-        $type = get_debug_type($field);
-
-        $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage("The field should be string. The $type is received.");
-
-        (new EqualsEmptyHandler())->match(['id' => 1], [$field], []);
-    }
-}