Escape special characters in tag field filters (#78)

Author: ethanhann

src/Index.php

@@ -313,11 +313,12 @@ protected function makeQueryBuilder(): QueryBuilder
     /**
      * @param string $fieldName
      * @param array $values
+     * @param array|null $charactersToEscape
      * @return QueryBuilderInterface
      */
-    public function tagFilter(string $fieldName, array $values): QueryBuilderInterface
+    public function tagFilter(string $fieldName, array $values, array $charactersToEscape = null): QueryBuilderInterface
     {
-        return $this->makeQueryBuilder()->tagFilter($fieldName, $values);
+        return $this->makeQueryBuilder()->tagFilter($fieldName, $values, $charactersToEscape);
     }
 
     /**

src/Query/Builder.php

@@ -128,9 +128,20 @@ public function verbatim(): BuilderInterface
         return $this;
     }
 
-    public function tagFilter(string $fieldName, array $values): BuilderInterface
+    public function tagFilter(string $fieldName, array $values, array $charactersToEscape = null): BuilderInterface
     {
-        $separatedValues = implode('|', $values);
+        if ($charactersToEscape == null) {
+            $charactersToEscape = [' ', '-'];
+        }
+        $escapedValues = [];
+        foreach ($values as $value) {
+            $escapedValue = $value;
+            foreach ($charactersToEscape as $character) {
+                $escapedValue = str_replace($character, "\\$character", $escapedValue);
+            }
+            $escapedValues[] = $escapedValue;
+        }
+        $separatedValues = implode('|', $escapedValues);
         $this->tagFilters[] = "@$fieldName:{{$separatedValues}}";
         return $this;
     }

src/Query/BuilderInterface.php

@@ -18,7 +18,7 @@ public function noStopWords(): BuilderInterface;
     public function withPayloads(): BuilderInterface;
     public function withScores(): BuilderInterface;
     public function verbatim(): BuilderInterface;
-    public function tagFilter(string $fieldName, array $values): BuilderInterface;
+    public function tagFilter(string $fieldName, array $values, array $charactersToEscape = null): BuilderInterface;
     public function numericFilter(string $fieldName, $min, $max = null): BuilderInterface;
     public function geoFilter(string $fieldName, float $longitude, float $latitude, float $radius, string $distanceUnit = 'km'): BuilderInterface;
     public function sortBy(string $fieldName, $order = 'ASC'): BuilderInterface;

tests/RediSearch/IndexTest.php

@@ -523,9 +523,17 @@ public function testAddDocumentWithTagField()
             'name' => 'Bar',
             'color' => 'blue',
         ]);
+        $index->add([
+            'name' => 'Baz',
+            'color' => 'sky blue',
+        ]);
+        $index->add([
+            'name' => 'Qux',
+            'color' => 'sugar-cookie',
+        ]);
 
         $result = $index
-            ->tagFilter('color', ['blue'])
+            ->tagFilter('color', ['sugar-cookie'])
             ->search();
 
         $this->assertEquals(1, $result->getCount());