Merge branch 'main' of https://github.com/predis/predis

src/ClientContextInterface.php

@@ -15,6 +15,7 @@ namespace Predis;
 use Predis\Command\Argument\Geospatial\ByInterface;
 use Predis\Command\Argument\Geospatial\FromInterface;
 use Predis\Command\Argument\Search\CreateArguments;
+use Predis\Command\Argument\Search\DropArguments;
 use Predis\Command\Argument\Search\Schema;
 use Predis\Command\Argument\Search\SearchArguments;
 use Predis\Command\Argument\Server\LimitOffsetCount;
@@ -91,6 +92,10 @@ use Predis\Command\Redis\Container\FUNCTIONS;
  * @method $this ftaliasdel(string $alias)
  * @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 ftdictdump(string $dict)
+ * @method $this ftdropindex(string $index, ?DropArguments $arguments = null)
  * @method $this ftinfo(string $index)
  * @method $this ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method $this get($key)

src/ClientInterface.php

@@ -15,6 +15,7 @@ namespace Predis;
 use Predis\Command\Argument\Geospatial\ByInterface;
 use Predis\Command\Argument\Geospatial\FromInterface;
 use Predis\Command\Argument\Search\CreateArguments;
+use Predis\Command\Argument\Search\DropArguments;
 use Predis\Command\Argument\Search\Schema;
 use Predis\Command\Argument\Search\SearchArguments;
 use Predis\Command\Argument\Server\LimitOffsetCount;
@@ -100,6 +101,10 @@ use Predis\Response\Status;
  * @method Status            ftaliasdel(string $alias)
  * @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             ftdictdump(string $dict)
+ * @method Status            ftdropindex(string $index, ?DropArguments $arguments = null)
  * @method array             ftinfo(string $index)
  * @method array             ftsearch(string $index, string $query, ?SearchArguments $arguments = null)
  * @method string|null       get(string $key)

src/Command/Argument/Search/DropArguments.php

@@ -0,0 +1,43 @@
+<?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\Argument\Search;
+
+use Predis\Command\Argument\ArrayableArgument;
+
+class DropArguments implements ArrayableArgument
+{
+    /**
+     * @var array
+     */
+    protected $arguments = [];
+
+    /**
+     * Drop operation that, if set, deletes the actual document hashes.
+     *
+     * @return $this
+     */
+    public function dd(): self
+    {
+        $this->arguments[] = 'DD';
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function toArray(): array
+    {
+        return $this->arguments;
+    }
+}

src/Command/Redis/Search/FTDICTADD.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.dictadd/
+ *
+ * Add terms to a dictionary.
+ */
+class FTDICTADD extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FT.DICTADD';
+    }
+}

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';
+    }
+}

src/Command/Redis/Search/FTDICTDUMP.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.dictdump/
+ *
+ * Dump all terms in the given dictionary.
+ */
+class FTDICTDUMP extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FT.DICTDUMP';
+    }
+}

src/Command/Redis/Search/FTDROPINDEX.php

@@ -0,0 +1,38 @@
+<?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;
+
+class FTDROPINDEX extends RedisCommand
+{
+    public function getId()
+    {
+        return 'FT.DROPINDEX';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        [$index] = $arguments;
+        $commandArguments = [];
+
+        if (!empty($arguments[1])) {
+            $commandArguments = $arguments[1]->toArray();
+        }
+
+        parent::setArguments(array_merge(
+            [$index],
+            $commandArguments
+        ));
+    }
+}

tests/Predis/Command/Argument/Search/DropArgumentsTest.php

@@ -0,0 +1,38 @@
+<?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\Argument\Search;
+
+use PHPUnit\Framework\TestCase;
+
+class DropArgumentsTest extends TestCase
+{
+    /**
+     * @var DropArguments
+     */
+    private $arguments;
+
+    protected function setUp(): void
+    {
+        $this->arguments = new DropArguments();
+    }
+
+    /**
+     * @return void
+     */
+    public function testCreatesArgumentsWithLanguageModifier(): void
+    {
+        $this->arguments->dd();
+
+        $this->assertSame(['DD'], $this->arguments->toArray());
+    }
+}

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

@@ -0,0 +1,70 @@
+<?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 FTDICTADD_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FTDICTADD::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FTDICTADD';
+    }
+
+    /**
+     * @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
+     * @return void
+     * @requiresRediSearchVersion >= 1.4.0
+     */
+    public function testAddTermsIntoGivenDictionary(): void
+    {
+        $redis = $this->getClient();
+
+        $actualResponse = $redis->ftdictadd('dict', 'foo', 'bar');
+
+        $this->assertSame(2, $actualResponse);
+    }
+}

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,
+            ],
+        ];
+    }
+}

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

@@ -0,0 +1,86 @@
+<?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;
+use Predis\Response\ServerException;
+
+class FTDICTDUMP_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FTDICTDUMP::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FTDICTDUMP';
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testFilterArguments(): void
+    {
+        $actualArguments = ['dict'];
+        $expectedArguments = ['dict'];
+
+        $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.4.0
+     */
+    public function testDumpTermsFromGivenDictionary(): void
+    {
+        $redis = $this->getClient();
+
+        $redis->ftdictadd('dict', 'foo', 'bar');
+
+        $this->assertSame(['bar', 'foo'], $redis->ftdictdump('dict'));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRediSearchVersion >= 1.4.0
+     */
+    public function testThrowsExceptionOnNonExistingDictionary(): void
+    {
+        $redis = $this->getClient();
+
+        $this->expectException(ServerException::class);
+        $this->expectExceptionMessage('could not open dict key');
+
+        $redis->ftdictdump('dict');
+    }
+}

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

@@ -0,0 +1,102 @@
+<?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\Argument\Search\DropArguments;
+use Predis\Command\Argument\Search\Schema;
+use Predis\Command\Redis\PredisCommandTestCase;
+use Predis\Response\ServerException;
+
+class FTDROPINDEX_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return FTDROPINDEX::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'FTDROPINDEX';
+    }
+
+    /**
+     * @group disconnected
+     * @dataProvider argumentsProvider
+     */
+    public function testFilterArguments(array $actualArguments, array $expectedArguments): void
+    {
+        $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 >= 2.0.0
+     */
+    public function testDropRemovesGivenIndex(): void
+    {
+        $redis = $this->getClient();
+
+        $schema = new Schema();
+        $schema->addTextField('text_field');
+
+        $this->assertEquals('OK', $redis->ftcreate('index', $schema));
+        $this->assertEquals('OK', $redis->ftdropindex('index'));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRediSearchVersion >= 2.0.0
+     */
+    public function testThrowsExceptionOnNonExistingIndex(): void
+    {
+        $redis = $this->getClient();
+
+        $this->expectException(ServerException::class);
+        $this->expectExceptionMessage('Unknown Index name');
+
+        $redis->ftdropindex('index');
+    }
+
+    public function argumentsProvider(): array
+    {
+        return [
+            'with default arguments' => [
+                ['index'],
+                ['index'],
+            ],
+            'with DD modifier' => [
+                ['index', (new DropArguments())->dd()],
+                ['index', 'DD'],
+            ],
+        ];
+    }
+}