Extended RediSearch support by implementing FT.SUGDEL command (#1183)

* Added support for new arguments for BITPOS, BITCOUNT commands (#1045)

* Added support for new arguments for EXPIRE, EXPIREAT commands (#1046)

* Extended core support by implementing SORT_RO command (#1044)

* Added support for SORT_RO command

* Codestyle fixes

* Added command description

---------

Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>

* fix deprecated call

* Added support for container commands (#1049)

* Added support for container commands FUNCTION LOAD, FUNCTION DELETE and FCALL

* Changed ContainerInterface and AbstractContainer

* Re-implement logic of abstract methods

---------

Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>

* Added stream commands to KeyPrefixProcessor (#1051)

Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>

* Fix return type of ReplicationInterface::getSlaves (#1111)

* Codestyle fixes

* Changed return annotation

* Added support for FT.SUGDEL command

---------

Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local>
Co-authored-by: Till Krüss <till@kruss.io>
Co-authored-by: Stephan <glaubinix@users.noreply.github.com>

src/ClientContextInterface.php

@@ -108,6 +108,7 @@ use Predis\Command\Container\Search\FTCONFIG;
  * @method $this ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method $this ftspellcheck(string $index, string $query, ?SearchArguments $arguments = null)
  * @method $this ftsugadd(string $key, string $string, float $score, ?SugAddArguments $arguments = null)
+ * @method $this ftsugdel(string $key, string $string)
  * @method $this ftsyndump(string $index)
  * @method $this ftsynupdate(string $index, string $synonymGroupId, ?SynUpdateArguments $arguments = null, string ...$terms)
  * @method $this fttagvals(string $index, string $fieldName)

src/ClientInterface.php

@@ -117,6 +117,7 @@ use Predis\Response\Status;
  * @method array             ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method array             ftspellcheck(string $index, string $query, ?SearchArguments $arguments = null)
  * @method int               ftsugadd(string $key, string $string, float $score, ?SugAddArguments $arguments = null)
+ * @method int               ftsugdel(string $key, string $string)
  * @method array             ftsyndump(string $index)
  * @method Status            ftsynupdate(string $index, string $synonymGroupId, ?SynUpdateArguments $arguments = null, string ...$terms)
  * @method array             fttagvals(string $index, string $fieldName)

src/Command/Redis/Search/FTSUGDEL.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.sugdel/
+ *
+ * Delete a string from a suggestion index.
+ */
+class FTSUGDEL extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FT.SUGDEL';
+    }
+}

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

@@ -0,0 +1,85 @@
+<?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;
+
+/**
+ * @group commands
+ * @group realm-stack
+ */
+class FTSUGDEL_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FTSUGDEL::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FTSUGDEL';
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testFilterArguments(): void
+    {
+        $actualArguments = ['key', 'string'];
+        $expectedArguments = ['key', 'string'];
+
+        $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
+     * @return void
+     * @requiresRediSearchVersion >= 1.0.0
+     */
+    public function testRemovesSuggestionFromGivenSuggestionIndex(): void
+    {
+        $redis = $this->getClient();
+
+        $this->assertSame(1, $redis->ftsugadd('key', 'string', 1));
+        $this->assertSame(1, $redis->ftsugdel('key', 'string'));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRediSearchVersion >= 1.0.0
+     */
+    public function testReturnsZeroOnNonExistingSuggestionIndex(): void
+    {
+        $redis = $this->getClient();
+
+        $this->assertSame(0, $redis->ftsugdel('key', 'string'));
+    }
+}