Add DIALECT option

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased v2.x]
 
+### Added
+
+- Add `DIALECT` option from RediSearch `2.4.3`
+
 ### Changed
 
 - (dev) Update version and rules of PHP-CS-Fixer and PHPStan

src/Redis/Command/AbstractCommand.php

@@ -32,7 +32,7 @@
  */
 abstract class AbstractCommand implements Command
 {
-    public const MAX_IMPLEMENTED_VERSION = '2.0.12';
+    public const MAX_IMPLEMENTED_VERSION = '2.4.3';
     public const MIN_IMPLEMENTED_VERSION = '2.0.0';
 
     /**

src/Redis/Command/Aggregate.php

@@ -31,6 +31,7 @@
 use MacFJA\RediSearch\Redis\Command\AggregateCommand\SortByOption;
 use MacFJA\RediSearch\Redis\Command\AggregateCommand\WithCursor;
 use MacFJA\RediSearch\Redis\Command\Option\CommandOption;
+use MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption as CV;
 use MacFJA\RediSearch\Redis\Command\Option\FlagOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamedOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamelessOption;
@@ -63,6 +64,7 @@ public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VE
             'limit' => new LimitOption(),
             'filter' => [],
             'cursor' => new WithCursor(),
+            'dialect' => CV::isNumeric(new NamedOption('DIALECT', null, '>=2.4.3')),
         ], $rediSearchVersion);
     }
 
@@ -156,6 +158,13 @@ public function setLoad(string ...$field): self
         return $this;
     }
 
+    public function setDialect(int $version): self
+    {
+        $this->options['dialect']->setValue($version);
+
+        return $this;
+    }
+
     public function setWithCursor(?int $count = null, ?int $maxIdle = null): self
     {
         $this->options['cursor']

src/Redis/Command/ConfigSet.php

@@ -33,7 +33,8 @@ public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VE
             'action' => new FlagOption('SET', true, '>=2.0.0'),
             'options' => [
                 CustomValidatorOption::allowedValues(new NamelessOption(null, '>=2.0.0 <2.0.6'), ['NOGC', 'MAXEXPANSIONS', 'TIMEOUT', 'ON_TIMEOUT', 'MIN_PHONETIC_TERM_LEN']),
-                CustomValidatorOption::allowedValues(new NamelessOption(null, '>=2.0.6'), ['NOGC', 'MINPREFIX', 'MAXEXPANSIONS', 'MAXFILTEREXPANSION', 'TIMEOUT', 'ON_TIMEOUT', 'MIN_PHONETIC_TERM_LEN']),
+                CustomValidatorOption::allowedValues(new NamelessOption(null, '>=2.0.6 < 2.4.3'), ['NOGC', 'MINPREFIX', 'MAXEXPANSIONS', 'MAXFILTEREXPANSION', 'TIMEOUT', 'ON_TIMEOUT', 'MIN_PHONETIC_TERM_LEN']),
+                CustomValidatorOption::allowedValues(new NamelessOption(null, '>=2.4.3'), ['NOGC', 'MINPREFIX', 'MAXEXPANSIONS', 'TIMEOUT', 'ON_TIMEOUT', 'MIN_PHONETIC_TERM_LEN', 'DEFAULT_DIALECT']),
             ],
             'value' => new NamelessOption(null, '>=2.0.0'),
         ], $rediSearchVersion);

src/Redis/Command/Explain.php

@@ -21,6 +21,8 @@
 
 namespace MacFJA\RediSearch\Redis\Command;
 
+use MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption as CV;
+use MacFJA\RediSearch\Redis\Command\Option\NamedOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamelessOption;
 
 /**
@@ -33,6 +35,7 @@ public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VE
         parent::__construct([
             'index' => new NamelessOption(null, '>=2.0.0'),
             'query' => new NamelessOption(null, '>=2.0.0'),
+            'dialect' => CV::isNumeric(new NamedOption('DIALECT', null, '>=2.4.3')),
         ], $rediSearchVersion);
     }
 
@@ -50,6 +53,13 @@ public function setQuery(string $query): self
         return $this;
     }
 
+    public function setDialect(int $version): self
+    {
+        $this->options['dialect']->setValue($version);
+
+        return $this;
+    }
+
     public function getId(): string
     {
         return 'FT.EXPLAIN';

src/Redis/Command/Search.php

@@ -77,6 +77,7 @@ public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VE
                 'payload' => new NamedOption('PAYLOAD', null, '>=2.0.0'),
                 'sortby' => new SortByOption(),
                 'limit' => new LimitOption(),
+                'dialect' => CV::isNumeric(new NamedOption('DIALECT', null, '>=2.4.3')),
             ],
             $rediSearchVersion
         );
@@ -301,6 +302,13 @@ public function getSize(): ?int
         return $limit->getSize();
     }
 
+    public function setDialect(int $version): self
+    {
+        $this->options['dialect']->setValue($version);
+
+        return $this;
+    }
+
     /**
      * @param mixed $data
      *

src/Redis/Command/SpellCheck.php

@@ -24,6 +24,7 @@
 use function is_array;
 use MacFJA\RediSearch\Exception\UnexpectedServerResponseException;
 use MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption;
+use MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption as CV;
 use MacFJA\RediSearch\Redis\Command\Option\NamedOption;
 use MacFJA\RediSearch\Redis\Command\Option\NamelessOption;
 use MacFJA\RediSearch\Redis\Command\SpellCheckCommand\TermsOption;
@@ -41,6 +42,7 @@ public function __construct(string $rediSearchVersion = self::MIN_IMPLEMENTED_VE
                 new NamedOption('DISTANCE', null, '>=2.0.0'),
                 Validator::intVal()->between(1, 4)
             ),
+            'dialect' => CV::isNumeric(new NamedOption('DIALECT', null, '>=2.4.3')),
             'terms' => [],
         ], $rediSearchVersion);
     }
@@ -66,6 +68,13 @@ public function setDistance(int $distance): self
         return $this;
     }
 
+    public function setDialect(int $version): self
+    {
+        $this->options['dialect']->setValue($version);
+
+        return $this;
+    }
+
     public function addTerms(string $dictionary, bool $isExcluding = false): self
     {
         $terms = new TermsOption();

tests/Redis/Command/AggregateTest.php

@@ -123,7 +123,7 @@ public function testSizeOptions(): void
 
     public function testFullOption(): void
     {
-        $command = new Aggregate();
+        $command = new Aggregate(Aggregate::MAX_IMPLEMENTED_VERSION);
         $command
             ->setIndex('idx')
             ->setQuery('@text1:"hello world"')
@@ -137,6 +137,7 @@ public function testFullOption(): void
             ->setLimit(12, 35)
             ->addApply('@timestamp - (@timestamp % 86400)', 'day')
             ->setWithCursor(20, 30)
+            ->setDialect(2)
             ;
 
         static::assertSame([
@@ -150,6 +151,7 @@ public function testFullOption(): void
             'LIMIT', 12, 35,
             'FILTER', "@name=='foo' && @age < 20",
             'WITHCURSOR', 'COUNT', 20, 'MAXIDLE', 30,
+            'DIALECT', 2,
         ], $command->getArguments());
     }
 

tests/Redis/Command/ExplainCliTest.php

@@ -31,6 +31,9 @@
  * @covers \MacFJA\RediSearch\Redis\Command\ExplainCli
  *
  * @uses \MacFJA\RediSearch\Redis\Command\Option\AbstractCommandOption
+ * @uses \MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption
+ * @uses \MacFJA\RediSearch\Redis\Command\Option\DecoratedOptionTrait
+ * @uses \MacFJA\RediSearch\Redis\Command\Option\NamedOption
  * @uses \MacFJA\RediSearch\Redis\Command\Option\NamelessOption
  *
  * @internal
@@ -45,15 +48,17 @@ public function testGetId(): void
 
     public function testFullOption(): void
     {
-        $command = new ExplainCli();
+        $command = new ExplainCli(ExplainCli::MAX_IMPLEMENTED_VERSION);
         $command
             ->setIndex('idx')
             ->setQuery('@text1:"hello world"')
+            ->setDialect(2)
             ;
 
         static::assertSame([
             'idx',
             '@text1:"hello world"',
+            'DIALECT', 2,
         ], $command->getArguments());
     }
 }

tests/Redis/Command/ExplainTest.php

@@ -30,6 +30,9 @@
  * @covers \MacFJA\RediSearch\Redis\Command\Explain
  *
  * @uses \MacFJA\RediSearch\Redis\Command\Option\AbstractCommandOption
+ * @uses \MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption
+ * @uses \MacFJA\RediSearch\Redis\Command\Option\DecoratedOptionTrait
+ * @uses \MacFJA\RediSearch\Redis\Command\Option\NamedOption
  * @uses \MacFJA\RediSearch\Redis\Command\Option\NamelessOption
  *
  * @internal
@@ -44,15 +47,17 @@ public function testGetId(): void
 
     public function testFullOption(): void
     {
-        $command = new Explain();
+        $command = new Explain(Explain::MAX_IMPLEMENTED_VERSION);
         $command
             ->setIndex('idx')
             ->setQuery('@text1:"hello world"')
+            ->setDialect(2)
             ;
 
         static::assertSame([
             'idx',
             '@text1:"hello world"',
+            'DIALECT', 2,
         ], $command->getArguments());
     }
 }

tests/Redis/Command/SearchTest.php

@@ -102,6 +102,7 @@ public function testFullOption(): void
             ->setPayload('foobar')
             ->setSortBy('@num1', 'ASC')
             ->setLimit(12, 10)
+            ->setDialect(2)
             ;
 
         static::assertSame([
@@ -128,6 +129,7 @@ public function testFullOption(): void
             'PAYLOAD', 'foobar',
             'SORTBY', '@num1', 'ASC',
             'LIMIT', 12, 10,
+            'DIALECT', 2,
         ], $command->getArguments());
     }
 

tests/Redis/Command/SpellCheckTest.php

@@ -36,6 +36,7 @@
  **
  * @uses \MacFJA\RediSearch\Redis\Command\Option\AbstractCommandOption
  * @uses \MacFJA\RediSearch\Redis\Command\Option\CustomValidatorOption
+ * @uses \MacFJA\RediSearch\Redis\Command\Option\DecoratedOptionTrait
  * @uses \MacFJA\RediSearch\Redis\Command\Option\NamelessOption
  * @uses \MacFJA\RediSearch\Redis\Command\Option\NamedOption
  *
@@ -51,19 +52,21 @@ public function testGetId(): void
 
     public function testFullOption(): void
     {
-        $command = new SpellCheck();
+        $command = new SpellCheck(SpellCheck::MAX_IMPLEMENTED_VERSION);
         $command
             ->setIndex('idx')
             ->setQuery('@text1:"hello world"')
             ->setDistance(2)
             ->addTerms('badword', true)
             ->addTerms('cities', false)
+            ->setDialect(2)
             ;
 
         static::assertSame([
             'idx',
             '@text1:"hello world"',
             'DISTANCE', 2,
+            'DIALECT', 2,
             'TERMS', 'EXCLUDE', 'badword',
             'TERMS', 'INCLUDE', 'cities',
         ], $command->getArguments());