Skip to content

Commit 8c2aac4

Browse files
vladvildanovvladvildanov
authored
Added GEOSHAPE field and test polygon search (#1467)
* Added GEOSHAPE field and test polygon search * Added version restriction for test * Added edge to stack amtrix * Added same values assertion * Codestyle changes
1 parent 5d22ed7 commit 8c2aac4

File tree

3 files changed

+237
-0
lines changed

3 files changed

+237
-0
lines changed

‎src/Command/Argument/Search/SchemaFields/GeoShapeField.php

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Argument\Search\SchemaFields;
14+
15+
class GeoShapeField extends AbstractField
16+
{
17+
public const COORD_FLAT = 'FLAT';
18+
19+
/**
20+
* @param string $identifier
21+
* @param string $alias
22+
* @param bool|string $sortable
23+
* @param bool $noIndex
24+
* @param string|null $coordSystem Constants that represents available systems available on a class level.
25+
*/
26+
public function __construct(
27+
string $identifier,
28+
string $alias = '',
29+
$sortable = self::NOT_SORTABLE,
30+
bool $noIndex = false,
31+
?string $coordSystem = null
32+
) {
33+
$this->fieldArguments[] = $identifier;
34+
35+
if ($alias !== '') {
36+
$this->fieldArguments[] = 'AS';
37+
$this->fieldArguments[] = $alias;
38+
}
39+
40+
$this->fieldArguments[] = 'GEOSHAPE';
41+
42+
if (null !== $coordSystem) {
43+
$this->fieldArguments[] = $coordSystem;
44+
}
45+
46+
if ($sortable === self::SORTABLE) {
47+
$this->fieldArguments[] = 'SORTABLE';
48+
} elseif ($sortable === self::SORTABLE_UNF) {
49+
$this->fieldArguments[] = 'SORTABLE';
50+
$this->fieldArguments[] = 'UNF';
51+
}
52+
53+
if ($noIndex) {
54+
$this->fieldArguments[] = 'NOINDEX';
55+
}
56+
}
57+
}

‎tests/Predis/Command/Argument/Search/SchemaFields/GeoShapeFieldTest.php

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Predis package.
5+
*
6+
* (c) 2009-2020 Daniele Alessandri
7+
* (c) 2021-2023 Till Krüss
8+
*
9+
* For the full copyright and license information, please view the LICENSE
10+
* file that was distributed with this source code.
11+
*/
12+
13+
namespace Predis\Command\Argument\Search\SchemaFields;
14+
15+
use PHPUnit\Framework\TestCase;
16+
17+
class GeoShapeFieldTest extends TestCase
18+
{
19+
/**
20+
* @dataProvider geoFieldsProvider
21+
* @param array $arguments
22+
* @param array $expectedSchema
23+
* @return void
24+
*/
25+
public function testReturnsCorrectFieldArgumentsArray(
26+
array $arguments,
27+
array $expectedSchema
28+
): void {
29+
$this->assertSame($expectedSchema, (new GeoShapeField(...$arguments))->toArray());
30+
}
31+
32+
public function geoFieldsProvider(): array
33+
{
34+
return [
35+
'with default arguments' => [
36+
['field_name'],
37+
['field_name', 'GEOSHAPE'],
38+
],
39+
'with alias' => [
40+
['field_name', 'fn'],
41+
['field_name', 'AS', 'fn', 'GEOSHAPE'],
42+
],
43+
'with sortable - no UNF' => [
44+
['field_name', '', AbstractField::SORTABLE],
45+
['field_name', 'GEOSHAPE', 'SORTABLE'],
46+
],
47+
'with sortable - with UNF' => [
48+
['field_name', '', AbstractField::SORTABLE_UNF],
49+
['field_name', 'GEOSHAPE', 'SORTABLE', 'UNF'],
50+
],
51+
'with NOINDEX modifier' => [
52+
['field_name', '', AbstractField::NOT_SORTABLE, true],
53+
['field_name', 'GEOSHAPE', 'NOINDEX'],
54+
],
55+
'with FLAT modifier' => [
56+
['field_name', '', AbstractField::NOT_SORTABLE, false, GeoShapeField::COORD_FLAT],
57+
['field_name', 'GEOSHAPE', 'FLAT'],
58+
],
59+
];
60+
}
61+
}

‎tests/Predis/Command/Redis/Search/FTSEARCH_Test.php

+119
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
namespace Predis\Command\Redis\Search;
1414

1515
use Predis\Command\Argument\Search\CreateArguments;
16+
use Predis\Command\Argument\Search\SchemaFields\AbstractField;
17+
use Predis\Command\Argument\Search\SchemaFields\GeoShapeField;
1618
use Predis\Command\Argument\Search\SchemaFields\NumericField;
1719
use Predis\Command\Argument\Search\SchemaFields\TextField;
1820
use Predis\Command\Argument\Search\SearchArguments;
@@ -125,6 +127,123 @@ public function testSearchValuesByHashIndex(): void
125127
$this->assertSame($expectedResponse, $actualResponse);
126128
}
127129

130+
/**
131+
* @group connected
132+
* @group relay-resp3
133+
* @return void
134+
* @requiresRediSearchVersion >= 2.9.0
135+
*/
136+
public function testGeoSearchQueriesIntersectsAndDisjoint(): void
137+
{
138+
$redis = $this->getClient();
139+
140+
$redis->hset('geo:doc_point1', 'g', 'POINT (10 10)');
141+
$redis->hset('geo:doc_point2', 'g', 'POINT (50 50)');
142+
$redis->hset('geo:doc_polygon1', 'g', 'POLYGON ((20 20, 25 35, 35 25, 20 20))');
143+
$redis->hset('geo:doc_polygon2', 'g', 'POLYGON ((60 60, 65 75, 70 70, 65 55, 60 60))');
144+
145+
$ftCreateArguments = new CreateArguments();
146+
$ftCreateArguments->prefix(['geo:']);
147+
148+
$schema = [
149+
new GeoShapeField('g', '', AbstractField::NOT_SORTABLE, false, GeoShapeField::COORD_FLAT),
150+
];
151+
152+
$ftCreateResponse = $redis->ftcreate('idx_geo', $schema, $ftCreateArguments);
153+
$this->assertEquals('OK', $ftCreateResponse);
154+
155+
$ftSearchArguments = new SearchArguments();
156+
$ftSearchArguments->params(['shape', 'POLYGON ((15 15, 75 15, 50 70, 20 40, 15 15))']);
157+
$ftSearchArguments->noContent();
158+
$ftSearchArguments->dialect(3);
159+
160+
$actualResponse = $redis->ftsearch('idx_geo', '@g:[intersects $shape]', $ftSearchArguments);
161+
$this->assertSameValues(
162+
[
163+
2,
164+
'geo:doc_polygon1',
165+
'geo:doc_point2',
166+
], $actualResponse
167+
);
168+
169+
$actualResponse = $redis->ftsearch('idx_geo', '@g:[disjoint $shape]', $ftSearchArguments);
170+
$this->assertSameValues(
171+
[
172+
2,
173+
'geo:doc_polygon2',
174+
'geo:doc_point1',
175+
], $actualResponse
176+
);
177+
}
178+
179+
/**
180+
* @group connected
181+
* @group relay-resp3
182+
* @return void
183+
* @requiresRediSearchVersion >= 2.9.0
184+
*/
185+
public function testGeoSearchQueriesContainsAndWithin(): void
186+
{
187+
$redis = $this->getClient();
188+
189+
$redis->hset('geo:doc_point1', 'g', 'POINT (10 10)');
190+
$redis->hset('geo:doc_point2', 'g', 'POINT (50 50)');
191+
$redis->hset('geo:doc_polygon1', 'g', 'POLYGON ((20 20, 25 35, 35 25, 20 20))');
192+
$redis->hset('geo:doc_polygon2', 'g', 'POLYGON ((60 60, 65 75, 70 70, 65 55, 60 60))');
193+
194+
$ftCreateArguments = new CreateArguments();
195+
$ftCreateArguments->prefix(['geo:']);
196+
197+
$schema = [
198+
new GeoShapeField('g', '',
199+
AbstractField::NOT_SORTABLE, false, GeoShapeField::COORD_FLAT
200+
),
201+
];
202+
203+
$ftCreateResponse = $redis->ftcreate('idx_geo', $schema, $ftCreateArguments);
204+
$this->assertEquals('OK', $ftCreateResponse);
205+
206+
$ftSearchArguments = new SearchArguments();
207+
$ftSearchArguments->params(['shape', 'POINT(25 25)']);
208+
$ftSearchArguments->noContent();
209+
$ftSearchArguments->dialect(3);
210+
211+
$actualResponse = $redis->ftsearch('idx_geo', '@g:[contains $shape]', $ftSearchArguments);
212+
$this->assertSameValues(
213+
[
214+
1,
215+
'geo:doc_polygon1',
216+
], $actualResponse
217+
);
218+
219+
$ftSearchArguments = new SearchArguments();
220+
$ftSearchArguments->params(['shape', 'POLYGON((24 24, 24 26, 25 25, 24 24))']);
221+
$ftSearchArguments->noContent();
222+
$ftSearchArguments->dialect(3);
223+
224+
$actualResponse = $redis->ftsearch('idx_geo', '@g:[contains $shape]', $ftSearchArguments);
225+
$this->assertSameValues(
226+
[
227+
1,
228+
'geo:doc_polygon1',
229+
], $actualResponse
230+
);
231+
232+
$ftSearchArguments = new SearchArguments();
233+
$ftSearchArguments->params(['shape', 'POLYGON((15 15, 75 15, 50 70, 20 40, 15 15))']);
234+
$ftSearchArguments->noContent();
235+
$ftSearchArguments->dialect(3);
236+
237+
$actualResponse = $redis->ftsearch('idx_geo', '@g:[within $shape]', $ftSearchArguments);
238+
$this->assertSameValues(
239+
[
240+
2,
241+
'geo:doc_polygon1',
242+
'geo:doc_point2',
243+
], $actualResponse
244+
);
245+
}
246+
128247
public function argumentsProvider(): array
129248
{
130249
return [

0 commit comments

Comments
 (0)