Add test on completeness of fields and terms in facets (+ UT)

Author: MacFJA

src/Query/Builder/FieldFacet.php

@@ -21,6 +21,8 @@
 
 namespace MacFJA\RediSearch\Query\Builder;
 
+use function count;
+use MacFJA\RediSearch\Exception\NotEnoughFieldsException;
 use MacFJA\RediSearch\Query\Escaper;
 
 class FieldFacet implements QueryElement
@@ -35,6 +37,9 @@ class FieldFacet implements QueryElement
      */
     public function __construct(array $fields, QueryElement $element)
     {
+        if (0 === count($fields)) {
+            throw new NotEnoughFieldsException();
+        }
         $this->fields = array_map([Escaper::class, 'escapeFieldName'], $fields);
         $this->element = $element;
     }

src/Query/Builder/GeoFacet.php

@@ -21,6 +21,8 @@
 
 namespace MacFJA\RediSearch\Query\Builder;
 
+use function count;
+use MacFJA\RediSearch\Exception\NotEnoughFieldsException;
 use MacFJA\RediSearch\Exception\UnknownUnitException;
 use MacFJA\RediSearch\Redis\Command\SearchCommand\GeoFilterOption;
 use Respect\Validation\Rules\In;
@@ -32,6 +34,9 @@ class GeoFacet extends FieldFacet
      */
     public function __construct(array $fields, float $lon, float $lat, float $radius, string $unit)
     {
+        if (0 === count($fields)) {
+            throw new NotEnoughFieldsException();
+        }
         if (!(new In(GeoFilterOption::UNITS))->validate($unit)) {
             throw new UnknownUnitException($unit);
         }

src/Query/Builder/NumericFacet.php

@@ -22,6 +22,7 @@
 namespace MacFJA\RediSearch\Query\Builder;
 
 use function is_array;
+use MacFJA\RediSearch\Exception\NotEnoughFieldsException;
 use MacFJA\RediSearch\Redis\Command\SearchCommand\NumericRangeTrait;
 
 class NumericFacet extends FieldFacet
@@ -33,9 +34,13 @@ class NumericFacet extends FieldFacet
      */
     public function __construct($fields, ?float $min, ?float $max, bool $isMinInclusive = true, bool $isMaxInclusive = true)
     {
+        if (empty($fields)) {
+            throw new NotEnoughFieldsException();
+        }
         if (!is_array($fields)) {
             $fields = [$fields];
         }
+
         $bounds = self::renderBound($min, $max, $isMinInclusive, $isMaxInclusive);
         $group = new EncapsulationGroup('[', ']', AndGroup::fromStrings(...$bounds));
         parent::__construct($fields, $group);

src/Query/Builder/TagFacet.php

@@ -21,10 +21,21 @@
 
 namespace MacFJA\RediSearch\Query\Builder;
 
+use function count;
+use MacFJA\RediSearch\Exception\NotEnoughFieldsException;
+use MacFJA\RediSearch\Exception\NotEnoughTermsException;
+
 class TagFacet extends FieldFacet
 {
     public function __construct(array $fields, string ...$values)
     {
+        if (0 === count($fields)) {
+            throw new NotEnoughFieldsException();
+        }
+        if (0 === count($values)) {
+            throw new NotEnoughTermsException();
+        }
+
         $orGroup = new OrGroup(array_map(static function (string $value): QueryElement {
             return new Word($value);
         }, $values));

src/Query/Builder/TextFacet.php

@@ -22,6 +22,8 @@
 namespace MacFJA\RediSearch\Query\Builder;
 
 use function count;
+use MacFJA\RediSearch\Exception\NotEnoughFieldsException;
+use MacFJA\RediSearch\Exception\NotEnoughTermsException;
 
 class TextFacet extends FieldFacet
 {
@@ -30,6 +32,13 @@ class TextFacet extends FieldFacet
      */
     public function __construct(array $fields, string ...$values)
     {
+        if (0 === count($fields)) {
+            throw new NotEnoughFieldsException();
+        }
+        if (0 === count($values)) {
+            throw new NotEnoughTermsException();
+        }
+
         $orGroup = new OrGroup(array_map(static function (string $value): QueryElement {
             return new ExactMatch($value);
         }, $values));

tests/Query/Builder/IncompleteFacetTest.php

@@ -0,0 +1,106 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright MacFJA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace MacFJA\RediSearch\tests\Query\Builder;
+
+use MacFJA\RediSearch\Exception\NotEnoughFieldsException;
+use MacFJA\RediSearch\Exception\NotEnoughTermsException;
+use MacFJA\RediSearch\Query\Builder\FieldFacet;
+use MacFJA\RediSearch\Query\Builder\GeoFacet;
+use MacFJA\RediSearch\Query\Builder\NumericFacet;
+use MacFJA\RediSearch\Query\Builder\RawElement;
+use MacFJA\RediSearch\Query\Builder\TagFacet;
+use MacFJA\RediSearch\Query\Builder\TextFacet;
+use MacFJA\RediSearch\Redis\Command\SearchCommand\GeoFilterOption;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \MacFJA\RediSearch\Exception\NotEnoughFieldsException
+ * @covers \MacFJA\RediSearch\Exception\NotEnoughTermsException
+ *
+ * @covers \MacFJA\RediSearch\Query\Builder\FieldFacet
+ * @covers \MacFJA\RediSearch\Query\Builder\GeoFacet
+ * @covers \MacFJA\RediSearch\Query\Builder\NumericFacet
+ * @covers \MacFJA\RediSearch\Query\Builder\TagFacet
+ * @covers \MacFJA\RediSearch\Query\Builder\TextFacet
+ *
+ * @uses  \MacFJA\RediSearch\Query\Builder\RawElement
+ *
+ * @internal
+ */
+class IncompleteFacetTest extends TestCase
+{
+    public function testTagFacetMissingTerms(): void
+    {
+        $this->expectException(NotEnoughTermsException::class);
+        $this->expectExceptionMessage('You must have at least one term');
+
+        new TagFacet(['text']);
+    }
+
+    public function testTagFacetMissingFields(): void
+    {
+        $this->expectException(NotEnoughFieldsException::class);
+        $this->expectExceptionMessage('You must have at least one field');
+
+        new TagFacet([], 'foo');
+    }
+
+    public function testTextFacetMissingTerms(): void
+    {
+        $this->expectException(NotEnoughTermsException::class);
+        $this->expectExceptionMessage('You must have at least one term');
+
+        new TextFacet(['text']);
+    }
+
+    public function testTextFacetMissingFields(): void
+    {
+        $this->expectException(NotEnoughFieldsException::class);
+        $this->expectExceptionMessage('You must have at least one field');
+
+        new TextFacet([], 'foo');
+    }
+
+    public function testNumericFacetMissingFields(): void
+    {
+        $this->expectException(NotEnoughFieldsException::class);
+        $this->expectExceptionMessage('You must have at least one field');
+
+        new NumericFacet([], 0, null);
+    }
+
+    public function testGeoFacetMissingFields(): void
+    {
+        $this->expectException(NotEnoughFieldsException::class);
+        $this->expectExceptionMessage('You must have at least one field');
+
+        new GeoFacet([], 0, 0, 5, GeoFilterOption::UNIT_METERS);
+    }
+
+    public function testFieldFacetMissingFields(): void
+    {
+        $this->expectException(NotEnoughFieldsException::class);
+        $this->expectExceptionMessage('You must have at least one field');
+
+        new FieldFacet([], new RawElement(''));
+    }
+}