Extended RediSearch support by implementing FT.DICTDEL support (#1156)

* add support for CF.ADDNX

* fix key name

* fix wrong command

* Pulling changes

* Added support for FT.CREATE command

* Fixed tests to choose correct DB

* Added test coverage

* Revert changes for missing commands

* Added data types enums, added methods default assignments

* Fixed vector field, removed default assignments, fixed tests

* Added constants enum for Sortable argument, renamed arguments object

* Codestyle fixes

* Rename test class

* Added support for FT.DICTADD command

* Added support for FT.DICTDEL command

---------

Co-authored-by: shacharPash <shachar.pashchur@redis.com>
Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>

src/ClientContextInterface.php

@@ -92,6 +92,7 @@ use Predis\Command\Redis\Container\FUNCTIONS;
  * @method $this ftaliasupdate(string $alias, string $index)
  * @method $this ftcreate(string $index, Schema $schema, ?CreateArguments $arguments = null)
  * @method $this ftdictadd(string $dict, ...$term)
+ * @method $this ftdictdel(string $dict, ...$term)
  * @method $this ftinfo(string $index)
  * @method $this ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method $this get($key)

src/ClientInterface.php

@@ -101,6 +101,7 @@ use Predis\Response\Status;
  * @method Status            ftaliasupdate(string $alias, string $index)
  * @method Status            ftcreate(string $index, Schema $schema, ?CreateArguments $arguments = null)
  * @method int               ftdictadd(string $dict, ...$term)
+ * @method int               ftdictdel(string $dict, ...$term)
  * @method array             ftinfo(string $index)
  * @method array             ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method string|null       get(string $key)

src/Command/Redis/Search/FTDICTDEL.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\Search;
+
+use Predis\Command\Command as RedisCommand;
+
+/**
+ * @see https://redis.io/commands/ft.dictdel/
+ *
+ * Delete terms from a dictionary.
+ */
+class FTDICTDEL extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FT.DICTDEL';
+    }
+}

tests/Predis/Command/Redis/Search/FTDICTDEL_Test.php

@@ -0,0 +1,98 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\Search;
+
+use Predis\Command\Redis\PredisCommandTestCase;
+
+class FTDICTDEL_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FTDICTDEL::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FTDICTDEL';
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testFilterArguments(): void
+    {
+        $actualArguments = ['dict', 'foo', 'bar'];
+        $expectedArguments = ['dict', 'foo', 'bar'];
+
+        $command = $this->getCommand();
+        $command->setArguments($actualArguments);
+
+        $this->assertSameValues($expectedArguments, $command->getArguments());
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testParseResponse(): void
+    {
+        $this->assertSame(1, $this->getCommand()->parseResponse(1));
+    }
+
+    /**
+     * @group connected
+     * @dataProvider dictionariesProvider
+     * @param  array $addArguments
+     * @param  array $deleteArguments
+     * @param  int   $expectedResponse
+     * @return void
+     * @requiresRediSearchVersion >= 1.4.0
+     */
+    public function testRemovesTermsFromGivenDictionary(
+        array $addArguments,
+        array $deleteArguments,
+        int $expectedResponse
+    ): void {
+        $redis = $this->getClient();
+
+        $redis->ftdictadd(...$addArguments);
+
+        $this->assertSame($expectedResponse, $redis->ftdictdel(...$deleteArguments));
+    }
+
+    public function dictionariesProvider(): array
+    {
+        return [
+            'removes existing term' => [
+                ['dict', 'foo', 'bar'],
+                ['dict', 'foo'],
+                1,
+            ],
+            'removes non-existing term' => [
+                ['dict', 'foo', 'bar'],
+                ['dict', 'baz'],
+                0,
+            ],
+            'removes from non-existing dict' => [
+                ['dict', 'foo', 'bar'],
+                ['dict123', 'baz'],
+                0,
+            ],
+        ];
+    }
+}