Fix on facet + more UT

MacFJA · MacFJA · commit 084375713a6b · 2021-03-13T20:03:05.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Aggregation SortBy allow 0 (not limit) as value for Max
 - Fix helper removing _"nullish"_ values (`array_filter` is too lax by default)
 - Fix order in fields creation not being correct
+- Don't allow empty facet in search query
 
 ### Deprecated
 
diff --git a/src/Search/Exception/NotEnoughTermsException.php b/src/Search/Exception/NotEnoughTermsException.php
@@ -0,0 +1,26 @@
+<?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\Search\Exception;
+
+class NotEnoughTermsException extends \MacFJA\RediSearch\Words\Exception\NotEnoughTermsException
+{
+}
diff --git a/src/Search/QueryBuilder/TagFacet.php b/src/Search/QueryBuilder/TagFacet.php
@@ -22,7 +22,10 @@
 namespace MacFJA\RediSearch\Search\QueryBuilder;
 
 use function array_map;
+use function count;
+use MacFJA\RediSearch\Helper\DataHelper;
 use MacFJA\RediSearch\Helper\EscapeHelper;
+use MacFJA\RediSearch\Search\Exception\NotEnoughTermsException;
 use function sprintf;
 
 class TagFacet implements PartialQuery
@@ -35,6 +38,7 @@ class TagFacet implements PartialQuery
 
     public function __construct(string $field, string ...$orValues)
     {
+        DataHelper::assert(count($orValues) > 0, NotEnoughTermsException::class);
         $this->field = $field;
         $this->orValues = $orValues;
     }
diff --git a/src/Search/QueryBuilder/TextFacet.php b/src/Search/QueryBuilder/TextFacet.php
@@ -23,7 +23,9 @@
 
 use function array_map;
 use function count;
+use MacFJA\RediSearch\Helper\DataHelper;
 use MacFJA\RediSearch\Helper\EscapeHelper;
+use MacFJA\RediSearch\Search\Exception\NotEnoughTermsException;
 use function reset;
 use function sprintf;
 use function strpos;
@@ -42,6 +44,7 @@ class TextFacet implements PartialQuery
 
     public function __construct(string $field, string ...$orValues)
     {
+        DataHelper::assert(count($orValues) > 0, NotEnoughTermsException::class);
         $this->field = $field;
         $this->orValues = $orValues;
     }
diff --git a/tests/Search/QueryBuilder/GeoFacetTest.php b/tests/Search/QueryBuilder/GeoFacetTest.php
@@ -0,0 +1,81 @@
+<?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 Tests\MacFJA\RediSearch\Search\QueryBuilder;
+
+use MacFJA\RediSearch\Search\Exception\UnknownUnitException;
+use MacFJA\RediSearch\Search\GeoFilter;
+use MacFJA\RediSearch\Search\QueryBuilder\GeoFacet;
+use MacFJA\RediSearch\Search\QueryBuilder\PartialQuery;
+use function PHPUnit\Framework\assertFalse;
+use function PHPUnit\Framework\assertSame;
+use PHPUnit\Framework\TestCase;
+use Tests\MacFJA\RediSearch\support\Assertion;
+
+/**
+ * @coversDefaultClass \MacFJA\RediSearch\Search\QueryBuilder\GeoFacet
+ * @covers ::__construct
+ *
+ * @uses \MacFJA\RediSearch\Helper\EscapeHelper
+ * @uses \MacFJA\RediSearch\Helper\DataHelper
+ * @uses \MacFJA\RediSearch\Search\QueryBuilder\OrGroup
+ * @uses \MacFJA\RediSearch\Search\QueryBuilder\Word
+ * @uses \MacFJA\RediSearch\Search\Exception\UnknownUnitException
+ */
+class GeoFacetTest extends TestCase
+{
+    use Assertion;
+
+    /**
+     * @covers ::render
+     */
+    public function testNominal(): void
+    {
+        self::assertSameRender('@foobar:[-74.044502 40.689247 40.000000 km]', new GeoFacet('foobar', -74.044502, 40.689247, 40, GeoFilter::UNIT_KILOMETERS));
+    }
+
+    /**
+     * @covers \MacFJA\RediSearch\Search\Exception\UnknownUnitException
+     */
+    public function testUnknownUnit(): void
+    {
+        $this->expectException(UnknownUnitException::class);
+        $this->expectExceptionMessage('The unit "bar" is not valid.');
+
+        new GeoFacet('foo', 0, 0, 0, 'bar');
+    }
+
+    /**
+     * @covers ::includeSpace
+     */
+    public function testIncludeSpace(): void
+    {
+        assertFalse((new GeoFacet('foo', 0, 0, 0, 'm'))->includeSpace());
+    }
+
+    /**
+     * @covers ::priority
+     */
+    public function testPriority(): void
+    {
+        assertSame(PartialQuery::PRIORITY_NORMAL, (new GeoFacet('foo', 0, 0, 0, 'm'))->priority());
+    }
+}
diff --git a/tests/Search/QueryBuilder/TagFacetTest.php b/tests/Search/QueryBuilder/TagFacetTest.php
@@ -0,0 +1,84 @@
+<?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 Tests\MacFJA\RediSearch\Search\QueryBuilder;
+
+use MacFJA\RediSearch\Search\Exception\NotEnoughTermsException;
+use MacFJA\RediSearch\Search\QueryBuilder\PartialQuery;
+use MacFJA\RediSearch\Search\QueryBuilder\TagFacet;
+use function PHPUnit\Framework\assertFalse;
+use function PHPUnit\Framework\assertSame;
+use PHPUnit\Framework\TestCase;
+use Tests\MacFJA\RediSearch\support\Assertion;
+
+/**
+ * @coversDefaultClass \MacFJA\RediSearch\Search\QueryBuilder\TagFacet
+ * @covers ::__construct
+ *
+ * @uses \MacFJA\RediSearch\Helper\EscapeHelper
+ * @uses \MacFJA\RediSearch\Helper\DataHelper
+ * @uses \MacFJA\RediSearch\Search\QueryBuilder\OrGroup
+ * @uses \MacFJA\RediSearch\Search\QueryBuilder\Word
+ */
+class TagFacetTest extends TestCase
+{
+    use Assertion;
+
+    /**
+     * @covers ::render
+     */
+    public function testNominal(): void
+    {
+        self::assertSameRender('@foobar:{hello}', new TagFacet('foobar', 'hello'));
+        self::assertSameRender('@foobar:{hello|world}', new TagFacet('foobar', 'hello', 'world'));
+        self::assertSameRender('@foobar:{hello world}', new TagFacet('foobar', 'hello world'));
+        self::assertSameRender('@foobar:{hello\|world}', new TagFacet('foobar', 'hello|world'));
+    }
+
+    /**
+     * @covers \MacFJA\RediSearch\Search\Exception\NotEnoughTermsException
+     *
+     * @uses \MacFJA\RediSearch\Words\Exception\NotEnoughTermsException
+     */
+    public function testNotEnoughValues(): void
+    {
+        $this->expectException(NotEnoughTermsException::class);
+        $this->expectExceptionMessage('You must have at least one term');
+
+        new TagFacet('foobar');
+    }
+
+    /**
+     * @covers ::includeSpace
+     */
+    public function testIncludeSpace(): void
+    {
+        assertFalse((new TagFacet('foo', 'bar'))->includeSpace());
+    }
+
+    /**
+     * @covers ::priority
+     */
+    public function testPriority(): void
+    {
+        assertSame(PartialQuery::PRIORITY_NORMAL, (new TagFacet('foo', 'bar'))->priority());
+    }
+}
diff --git a/tests/Search/QueryBuilder/TextFacetTest.php b/tests/Search/QueryBuilder/TextFacetTest.php
@@ -0,0 +1,84 @@
+<?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 Tests\MacFJA\RediSearch\Search\QueryBuilder;
+
+use MacFJA\RediSearch\Search\Exception\NotEnoughTermsException;
+use MacFJA\RediSearch\Search\QueryBuilder\PartialQuery;
+use MacFJA\RediSearch\Search\QueryBuilder\TextFacet;
+use function PHPUnit\Framework\assertFalse;
+use function PHPUnit\Framework\assertSame;
+use PHPUnit\Framework\TestCase;
+use Tests\MacFJA\RediSearch\support\Assertion;
+
+/**
+ * @coversDefaultClass \MacFJA\RediSearch\Search\QueryBuilder\TextFacet
+ * @covers ::__construct
+ *
+ * @uses \MacFJA\RediSearch\Helper\EscapeHelper
+ * @uses \MacFJA\RediSearch\Helper\DataHelper
+ * @uses \MacFJA\RediSearch\Search\QueryBuilder\OrGroup
+ * @uses \MacFJA\RediSearch\Search\QueryBuilder\Word
+ */
+class TextFacetTest extends TestCase
+{
+    use Assertion;
+
+    /**
+     * @covers ::render
+     */
+    public function testNominal(): void
+    {
+        self::assertSameRender('@foobar:hello', new TextFacet('foobar', 'hello'));
+        self::assertSameRender('@foobar:(hello|world)', new TextFacet('foobar', 'hello', 'world'));
+        self::assertSameRender('@foobar:(hello world)', new TextFacet('foobar', 'hello world'));
+        self::assertSameRender('@foobar:hello\|world', new TextFacet('foobar', 'hello|world'));
+    }
+
+    /**
+     * @covers \MacFJA\RediSearch\Search\Exception\NotEnoughTermsException
+     *
+     * @uses \MacFJA\RediSearch\Words\Exception\NotEnoughTermsException
+     */
+    public function testNotEnoughValues(): void
+    {
+        $this->expectException(NotEnoughTermsException::class);
+        $this->expectExceptionMessage('You must have at least one term');
+
+        new TextFacet('foobar');
+    }
+
+    /**
+     * @covers ::includeSpace
+     */
+    public function testIncludeSpace(): void
+    {
+        assertFalse((new TextFacet('foo', 'bar'))->includeSpace());
+    }
+
+    /**
+     * @covers ::priority
+     */
+    public function testPriority(): void
+    {
+        assertSame(PartialQuery::PRIORITY_NORMAL, (new TextFacet('foo', 'bar'))->priority());
+    }
+}
diff --git a/tests/support/Assertion.php b/tests/support/Assertion.php
@@ -24,6 +24,7 @@
 use function implode;
 use function is_subclass_of;
 use MacFJA\RediSearch\PartialQuery;
+use MacFJA\RediSearch\Search\QueryBuilder\PartialQuery as RenderablePartialQuery;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 
@@ -36,4 +37,12 @@ private static function assertSameQuery(string $expected, PartialQuery $partialQ
         }
         self::assertSame($expected, implode(' ', $partialQuery->getQueryParts()));
     }
+
+    private static function assertSameRender(string $expected, RenderablePartialQuery $partialQuery): void
+    {
+        if (!is_subclass_of(self::class, TestCase::class)) {
+            throw new RuntimeException();
+        }
+        self::assertSame($expected, $partialQuery->render());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`use function implode;`
`25`	`25`	`use function is_subclass_of;`
`26`	`26`	`use MacFJA\RediSearch\PartialQuery;`
	`27`	`+use MacFJA\RediSearch\Search\QueryBuilder\PartialQuery as RenderablePartialQuery;`
`27`	`28`	`use PHPUnit\Framework\TestCase;`
`28`	`29`	`use RuntimeException;`
`29`	`30`
`@@ -36,4 +37,12 @@ private static function assertSameQuery(string $expected, PartialQuery $partialQ`
`36`	`37`	`}`
`37`	`38`	`self::assertSame($expected, implode(' ', $partialQuery->getQueryParts()));`
`38`	`39`	`}`
	`40`	`+`
	`41`	`+ private static function assertSameRender(string $expected, RenderablePartialQuery $partialQuery): void`
	`42`	`+ {`
	`43`	`+ if (!is_subclass_of(self::class, TestCase::class)) {`
	`44`	`+ throw new RuntimeException();`
	`45`	`+ }`
	`46`	`+ self::assertSame($expected, $partialQuery->render());`
	`47`	`+ }`
`39`	`48`	`}`