Fix #75: Improve Sort, finalize processors (#95)

yiisoft · Apr 13, 2022 · 0c0121e · 0c0121e
1 parent 474c127
commit 0c0121e
Show file tree

Hide file tree

Showing 16 changed files with 90 additions and 22 deletions.
diff --git a/src/Reader/Iterable/Processor/All.php b/src/Reader/Iterable/Processor/All.php
@@ -6,7 +6,7 @@
 
 use function in_array;
 
-class All extends GroupProcessor
+final class All extends GroupProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/Any.php b/src/Reader/Iterable/Processor/Any.php
@@ -6,7 +6,7 @@
 
 use function in_array;
 
-class Any extends GroupProcessor
+final class Any extends GroupProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/Between.php b/src/Reader/Iterable/Processor/Between.php
@@ -12,7 +12,7 @@
 use function array_key_exists;
 use function count;
 
-class Between implements IterableProcessorInterface, FilterProcessorInterface
+final class Between implements IterableProcessorInterface, FilterProcessorInterface
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/Equals.php b/src/Reader/Iterable/Processor/Equals.php
@@ -6,7 +6,7 @@
 
 use DateTimeInterface;
 
-class Equals extends CompareProcessor
+final class Equals extends CompareProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/EqualsEmpty.php b/src/Reader/Iterable/Processor/EqualsEmpty.php
@@ -10,7 +10,7 @@
 
 use function count;
 
-class EqualsEmpty implements IterableProcessorInterface, FilterProcessorInterface
+final class EqualsEmpty implements IterableProcessorInterface, FilterProcessorInterface
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/EqualsNull.php b/src/Reader/Iterable/Processor/EqualsNull.php
@@ -11,7 +11,7 @@
 use function array_key_exists;
 use function count;
 
-class EqualsNull implements IterableProcessorInterface, FilterProcessorInterface
+final class EqualsNull implements IterableProcessorInterface, FilterProcessorInterface
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/GreaterThan.php b/src/Reader/Iterable/Processor/GreaterThan.php
@@ -6,7 +6,7 @@
 
 use DateTimeInterface;
 
-class GreaterThan extends CompareProcessor
+final class GreaterThan extends CompareProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/GreaterThanOrEqual.php b/src/Reader/Iterable/Processor/GreaterThanOrEqual.php
@@ -6,7 +6,7 @@
 
 use DateTimeInterface;
 
-class GreaterThanOrEqual extends CompareProcessor
+final class GreaterThanOrEqual extends CompareProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/In.php b/src/Reader/Iterable/Processor/In.php
@@ -7,7 +7,7 @@
 use function in_array;
 use function is_array;
 
-class In extends CompareProcessor
+final class In extends CompareProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/LessThan.php b/src/Reader/Iterable/Processor/LessThan.php
@@ -6,7 +6,7 @@
 
 use DateTimeInterface;
 
-class LessThan extends CompareProcessor
+final class LessThan extends CompareProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/LessThanOrEqual.php b/src/Reader/Iterable/Processor/LessThanOrEqual.php
@@ -6,7 +6,7 @@
 
 use DateTimeInterface;
 
-class LessThanOrEqual extends CompareProcessor
+final class LessThanOrEqual extends CompareProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/Like.php b/src/Reader/Iterable/Processor/Like.php
@@ -7,7 +7,7 @@
 use function is_string;
 use function stripos;
 
-class Like extends CompareProcessor
+final class Like extends CompareProcessor
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Iterable/Processor/Not.php b/src/Reader/Iterable/Processor/Not.php
@@ -14,7 +14,7 @@
 use function is_string;
 use function sprintf;
 
-class Not implements IterableProcessorInterface, FilterProcessorInterface
+final class Not implements IterableProcessorInterface, FilterProcessorInterface
 {
     public function getOperator(): string
     {

diff --git a/src/Reader/Sort.php b/src/Reader/Sort.php
@@ -58,6 +58,11 @@ final class Sort
      */
     private bool $ignoreExtraFields;
 
+    /**
+     * @var bool Whether to add default sorting when forming criteria.
+     */
+    private bool $withDefaultSorting = true;
+
     /**
      * @var array Logical fields to order by in form of [name => direction].
      * @psalm-var TOrder
@@ -128,7 +133,7 @@ private function __construct(bool $ignoreExtraFields, array $config)
      * ]
      * ```
      *
-     * The name field is a virtual field name that consists of two real fields, `first_name` amd `last_name`. Virtual
+     * The name field is a virtual field name that consists of two real fields, `first_name` and `last_name`. Virtual
      * field name is used in order string or order array while real fields are used in final sorting criteria.
      *
      * Each configuration has the following options:
@@ -172,7 +177,7 @@ public static function only(array $config): self
      * ]
      * ```
      *
-     * The name field is a virtual field name that consists of two real fields, `first_name` amd `last_name`. Virtual
+     * The name field is a virtual field name that consists of two real fields, `first_name` and `last_name`. Virtual
      * field name is used in order string or order array while real fields are used in final sorting criteria.
      *
      * Each configuration has the following options:
@@ -193,7 +198,7 @@ public static function any(array $config = []): self
      *
      * The string consists of comma-separated field names.
      * If the name is prefixed with `-`, field order is descending.
-     * Otherwise the order is ascending.
+     * Otherwise, the order is ascending.
      *
      * @param string $orderString Logical fields order as comma-separated string.
      *
@@ -230,6 +235,18 @@ public function withOrder(array $order): self
         return $new;
     }
 
+    /**
+     * Formation of criteria without default sorting.
+     *
+     * @return self
+     */
+    public function withoutDefaultSorting(): self
+    {
+        $new = clone $this;
+        $new->withDefaultSorting = false;
+        return $new;
+    }
+
     /**
      * @psalm-return TOrder
      */
@@ -243,7 +260,7 @@ public function getOrder(): array
      *
      * The string consists of comma-separated field names.
      * If the name is prefixed with `-`, field order is descending.
-     * Otherwise the order is ascending.
+     * Otherwise, the order is ascending.
      *
      * @return string An order string.
      */
@@ -284,8 +301,10 @@ public function getCriteria(): array
             }
         }
 
-        foreach ($config as $fieldConfig) {
-            $criteria += $fieldConfig[$fieldConfig['default']];
+        if ($this->withDefaultSorting) {
+            foreach ($config as $fieldConfig) {
+                $criteria += $fieldConfig[$fieldConfig['default']];
+            }
         }
 
         return $criteria;

diff --git a/tests/Reader/Iterable/IterableDataReaderTest.php b/tests/Reader/Iterable/IterableDataReaderTest.php
@@ -5,6 +5,7 @@
 namespace Yiisoft\Data\Tests\Reader\Iterable;
 
 use ArrayIterator;
+use DateTimeInterface;
 use Generator;
 use InvalidArgumentException;
 use RuntimeException;
@@ -392,14 +393,37 @@ public function testCustomEqualsProcessor(): void
 
         $dataReader = (new IterableDataReader(self::DEFAULT_DATASET))
             ->withSort($sort)
-            ->withFilterProcessors(new class () extends \Yiisoft\Data\Reader\Iterable\Processor\Equals {
+            ->withFilterProcessors(new class () extends \Yiisoft\Data\Reader\Iterable\Processor\CompareProcessor {
+                public function getOperator(): string
+                {
+                    return \Yiisoft\Data\Reader\Filter\Equals::getOperator();
+                }
+
+                protected function compare($itemValue, $argumentValue): bool
+                {
+                    if (!$itemValue instanceof DateTimeInterface) {
+                        return $itemValue == $argumentValue;
+                    }
+
+                    return $argumentValue instanceof DateTimeInterface
+                        && $itemValue->getTimestamp() === $argumentValue->getTimestamp();
+                }
+
                 public function match(array $item, array $arguments, array $filterProcessors): bool
                 {
-                    [$field,] = $arguments;
+                    if (count($arguments) !== 2) {
+                        throw new InvalidArgumentException('$arguments should contain exactly two elements.');
+                    }
+
+                    [$field, $value] = $arguments;
+                    FilterDataValidationHelper::assertFieldIsString($field);
+
                     if ($item[$field] === 2) {
                         return true;
                     }
-                    return parent::match($item, $arguments, $filterProcessors);
+
+                    /** @var string $field */
+                    return array_key_exists($field, $item) && $this->compare($item[$field], $value);
                 }
             });
 

diff --git a/tests/Reader/SortTest.php b/tests/Reader/SortTest.php
@@ -229,4 +229,29 @@ public function testGetCriteriaWithShortFieldSyntax(): void
             'id' => SORT_ASC,
         ], $sort->getCriteria());
     }
+
+    public function testWithoutDefaultSortingWhenFormingCriteria(): void
+    {
+        $sort = Sort::only([
+            'a',
+            'b' => [
+                'asc' => ['bee' => SORT_ASC],
+                'desc' => ['bee' => SORT_DESC],
+                'default' => 'asc',
+            ],
+        ])
+            ->withOrder(
+                [
+                    'b' => 'desc',
+                ]
+            )
+            ->withoutDefaultSorting();
+
+        $this->assertSame(
+            [
+                'bee' => SORT_DESC,
+            ],
+            $sort->getCriteria()
+        );
+    }
 }