Add casting for Finder. (#342)

Add casting for Finder filter
FriendsOfCake · Feb 26, 2024 · c75326b · c75326b
1 parent 27c0686
commit c75326b
Show file tree

Hide file tree

Showing 20 changed files with 268 additions and 40 deletions.
diff --git a/.phive/phars.xml b/.phive/phars.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-    <phar name="phpstan" version="1.10.14" installed="1.10.14" location="./tools/phpstan" copy="false"/>
+    <phar name="phpstan" version="1.10.59" installed="1.10.59" location="./tools/phpstan" copy="false"/>
     <phar name="psalm" version="5.10.0" installed="5.10.0" location="./tools/psalm" copy="false"/>
 </phive>
diff --git a/docs/filters-and-examples.md b/docs/filters-and-examples.md
@@ -238,6 +238,10 @@ The following options are supported by all filters except `Callback` and `Finder
 
 - `options` (`array`, defaults to `[]`) Additional options to pass to the finder.
 
+- `cast` (`array`, defaults to `[]`) Additional casts to be used on the (mapped
+  field values. You can use `'int'`, `'bool'`, `'float'`, etc as strings. You can also
+  use callable functions like `function ($value) { ... }` for more complex scenarios.
+
 ## Filtering by `belongsToMany` and `hasMany` associations
 
 If you want to filter values related to a `belongsToMany` or `hasMany` association,

diff --git a/phpstan.neon b/phpstan.neon
@@ -1,5 +1,5 @@
 parameters:
-    level: 7
+    level: 8
     checkMissingIterableValueType: false
     checkGenericClassInNonGenericObjectType: false
     paths:

diff --git a/src/Model/Filter/Base.php b/src/Model/Filter/Base.php
@@ -20,7 +20,7 @@ abstract class Base
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [];
 
@@ -200,9 +200,9 @@ public function value(): mixed
     }
 
     /**
-     * @return array|string|null
+     * @return mixed
      */
-    protected function passedValue(): string|array|null
+    protected function passedValue(): mixed
     {
         if (!isset($this->_args[$this->name()])) {
             return null;

diff --git a/src/Model/Filter/Boolean.php b/src/Model/Filter/Boolean.php
@@ -10,7 +10,7 @@ class Boolean extends Base
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'mode' => 'OR',

diff --git a/src/Model/Filter/Compare.php b/src/Model/Filter/Compare.php
@@ -10,7 +10,7 @@ class Compare extends Base
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'operator' => '>=',
@@ -20,7 +20,7 @@ class Compare extends Base
     /**
      * Allowed operators.
      *
-     * @var array
+     * @var array<string>
      */
     protected array $_operators = [
         '>=', '<=', '<', '>',

diff --git a/src/Model/Filter/Escaper/DefaultEscaper.php b/src/Model/Filter/Escaper/DefaultEscaper.php
@@ -12,7 +12,7 @@ class DefaultEscaper implements EscaperInterface
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'fromWildCardAny' => '%',

diff --git a/src/Model/Filter/Escaper/SqlserverEscaper.php b/src/Model/Filter/Escaper/SqlserverEscaper.php
@@ -8,7 +8,7 @@ class SqlserverEscaper extends DefaultEscaper
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'fromWildCardAny' => '%',

diff --git a/src/Model/Filter/Exists.php b/src/Model/Filter/Exists.php
@@ -10,7 +10,7 @@ class Exists extends Base
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'mode' => 'OR',

diff --git a/src/Model/Filter/Finder.php b/src/Model/Filter/Finder.php
@@ -3,14 +3,17 @@
 
 namespace Search\Model\Filter;
 
+use Closure;
+
 class Finder extends Base
 {
     /**
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'map' => [],
         'options' => [],
+        'cast' => [],
     ];
 
     /**
@@ -37,6 +40,21 @@ public function process(): bool
         foreach ($map as $to => $from) {
             $args[$to] = $args[$from] ?? null;
         }
+        $casts = $this->getConfig('cast');
+        foreach ($casts as $field => $toType) {
+            $value = $args[$field] ?? null;
+            if ($value === null) {
+                continue;
+            }
+
+            if ($toType instanceof Closure) {
+                $value = $toType($value);
+            } else {
+                settype($value, $toType);
+            }
+
+            $args[$field] = $value;
+        }
 
         $options = $this->getConfig('options');
         $args += $options;

diff --git a/src/Model/Filter/Like.php b/src/Model/Filter/Like.php
@@ -22,7 +22,7 @@ class Like extends Base
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'before' => false,

diff --git a/src/Model/Filter/Value.php b/src/Model/Filter/Value.php
@@ -12,7 +12,7 @@ class Value extends Base
     /**
      * Default configuration.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'mode' => 'OR',

diff --git a/tests/TestApp/Model/Table/FinderArticlesTable.php b/tests/TestApp/Model/Table/FinderArticlesTable.php
@@ -45,4 +45,40 @@ public function findSlugged(SelectQuery $query, string $slug): SelectQuery
     {
         return $query->where(['title' => $slug]);
     }
+
+    /**
+     * Requires nullable slug key to be present in $options array.
+     *
+     * @param \Cake\ORM\Query\SelectQuery $query
+     * @param string|null $slug
+     * @return \Cake\ORM\Query\SelectQuery
+     */
+    public function findSluggedNullable(SelectQuery $query, ?string $slug): SelectQuery
+    {
+        return $query->where(['title IS' => $slug]);
+    }
+
+    /**
+     * Requires uid key to be present in $options array.
+     *
+     * @param \Cake\ORM\Query\SelectQuery $query
+     * @param int $uid
+     * @return \Cake\ORM\Query\SelectQuery
+     */
+    public function findUser(SelectQuery $query, int $uid): SelectQuery
+    {
+        return $query->where(['user_id' => $uid]);
+    }
+
+    /**
+     * Requires nullable uid key to be present in $options array.
+     *
+     * @param \Cake\ORM\Query\SelectQuery $query
+     * @param int|null $uid
+     * @return \Cake\ORM\Query\SelectQuery
+     */
+    public function findUserNullable(SelectQuery $query, ?int $uid): SelectQuery
+    {
+        return $query->where(['user_id IS' => $uid]);
+    }
 }
diff --git a/tests/TestCase/Model/Filter/BaseTest.php b/tests/TestCase/Model/Filter/BaseTest.php
@@ -105,7 +105,7 @@ public function testConstructNonEmptyNameArgument($nonEmptyValue)
             $this->Manager,
             ['fields' => 'fields']
         );
-        $this->assertEquals($filter->name(), $nonEmptyValue);
+        $this->assertSame($filter->name(), $nonEmptyValue);
     }
 
     /**
@@ -144,13 +144,13 @@ public function testValue()
         );
 
         $filter->setArgs(['fields' => 'value']);
-        $this->assertEquals('value', $filter->value());
+        $this->assertSame('value', $filter->value());
 
         $filter->setArgs(['other_field' => 'value']);
-        $this->assertEquals('default', $filter->value());
+        $this->assertSame('default', $filter->value());
 
         $filter->setArgs(['fields' => ['value1', 'value2']]);
-        $this->assertEquals('default', $filter->value());
+        $this->assertSame('default', $filter->value());
     }
 
     /**

diff --git a/tests/TestCase/Model/Filter/BooleanTest.php b/tests/TestCase/Model/Filter/BooleanTest.php
@@ -31,7 +31,7 @@ public function testProcessWithFlagOn()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -53,7 +53,7 @@ public function testProcessWithFlagOff()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [false],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -75,7 +75,7 @@ public function testProcessWithStringFlagTrue()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -97,7 +97,7 @@ public function testProcessWithStringFlagFalse()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [false],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -119,7 +119,7 @@ public function testProcessWithBooleanFlagTrue()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -141,7 +141,7 @@ public function testProcessWithBooleanFlagFalse()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [false],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -163,7 +163,7 @@ public function testProcessWithStringFlag1()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -185,7 +185,7 @@ public function testProcessWithStringFlag0()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [false],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -207,7 +207,7 @@ public function testProcessWithIntegerFlag1()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -226,7 +226,7 @@ public function testProcessWithIntegerFlag0()
             '/WHERE Articles\.is_active = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [false],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -285,7 +285,7 @@ public function testProcessMultiField()
             '/WHERE \(Articles\.is_active = :c0 OR Articles\.other = :c1\)$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true, true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -310,7 +310,7 @@ public function testProcessMultiFieldWithAndMode()
             '/WHERE \(Articles\.is_active = :c0 AND Articles\.other = :c1\)$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true, true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -332,7 +332,7 @@ public function testProcessDefaultFallbackForDisallowedMultiValue()
             '/WHERE Articles\.is_active = :c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [true],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );

diff --git a/tests/TestCase/Model/Filter/CallbackTest.php b/tests/TestCase/Model/Filter/CallbackTest.php
@@ -36,7 +36,7 @@ public function testProcess()
             '/WHERE title = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             ['test'],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );

diff --git a/tests/TestCase/Model/Filter/ExistsTest.php b/tests/TestCase/Model/Filter/ExistsTest.php
@@ -74,7 +74,7 @@ public function testProcessWithFlagOnNotNullable()
             '/WHERE Articles\.number != \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [''],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );
@@ -100,7 +100,7 @@ public function testProcessWithFlagOffNotNullable()
             '/WHERE Articles\.number = \:c0$/',
             $filter->getQuery()->sql()
         );
-        $this->assertEquals(
+        $this->assertSame(
             [''],
             Hash::extract($filter->getQuery()->getValueBinder()->bindings(), '{s}.value')
         );