Skip to content

Commit

Permalink
Add support for custom range key and refactor addRange in a trait
Browse files Browse the repository at this point in the history
  • Loading branch information
@SosthenG
SosthenG committed Sep 26, 2024
1 parent e2cb89b commit b8312a0
Show file tree
Hide file tree
Showing 6 changed files with 118 additions and 97 deletions.
32 changes: 1 addition & 31 deletions src/Aggregation/GeoDistance.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

namespace Elastica\Aggregation;

use Elastica\Exception\InvalidException;

/**
* Class GeoDistance.
*
Expand All @@ -14,6 +12,7 @@
class GeoDistance extends AbstractAggregation
{
use Traits\KeyedTrait;
use Traits\RangeTrait;

public const DISTANCE_TYPE_ARC = 'arc';
public const DISTANCE_TYPE_PLANE = 'plane';
Expand Down Expand Up @@ -56,35 +55,6 @@ public function setOrigin($origin): self
return $this->setParam('origin', $origin);
}

/**
* Add a distance range to this aggregation.
*
* @param int|null $fromValue a distance
* @param int|null $toValue a distance
*
* @throws InvalidException
*
* @return $this
*/
public function addRange(?int $fromValue = null, ?int $toValue = null): self
{
if (null === $fromValue && null === $toValue) {
throw new InvalidException('Either fromValue or toValue must be set. Both cannot be null.');
}

$range = [];

if (null !== $fromValue) {
$range['from'] = $fromValue;
}

if (null !== $toValue) {
$range['to'] = $toValue;
}

return $this->addParam('ranges', $range);
}

/**
* Set the unit of distance measure for this aggregation.
*
Expand Down
38 changes: 8 additions & 30 deletions src/Aggregation/IpRange.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

namespace Elastica\Aggregation;

use Elastica\Exception\InvalidException;

/**
* Class IpRange.
*
Expand All @@ -14,6 +12,7 @@
class IpRange extends AbstractAggregation
{
use Traits\KeyedTrait;
use Traits\RangeTrait;

/**
* @param string $name the name of this aggregation
Expand All @@ -38,42 +37,21 @@ public function setField(string $field): self
}

/**
* Add an ip range to this aggregation.
*
* @param string|null $fromValue a valid ipv4 address. Low end of this range, exclusive (greater than)
* @param string|null $toValue a valid ipv4 address. High end of this range, exclusive (less than)
* Add an ip range in the form of a CIDR mask.
*
* @throws InvalidException
* @param string $mask a valid CIDR mask
* @param string|null $key customized key value
*
* @return $this
*/
public function addRange(?string $fromValue = null, ?string $toValue = null): self
public function addMaskRange(string $mask, ?string $key = null): self
{
if (null === $fromValue && null === $toValue) {
throw new InvalidException('Either fromValue or toValue must be set. Both cannot be null.');
}
$range = ['mask' => $mask];

$range = [];
if (null !== $fromValue) {
$range['from'] = $fromValue;
}

if (null !== $toValue) {
$range['to'] = $toValue;
if (null !== $key) {
$range['key'] = $key;
}

return $this->addParam('ranges', $range);
}

/**
* Add an ip range in the form of a CIDR mask.
*
* @param string $mask a valid CIDR mask
*
* @return $this
*/
public function addMaskRange(string $mask): self
{
return $this->addParam('ranges', ['mask' => $mask]);
}
}
37 changes: 1 addition & 36 deletions src/Aggregation/Range.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

namespace Elastica\Aggregation;

use Elastica\Exception\InvalidException;

/**
* Class Range.
*
Expand All @@ -14,38 +12,5 @@
class Range extends AbstractSimpleAggregation
{
use Traits\KeyedTrait;

/**
* Add a range to this aggregation.
*
* @param float|int|string|null $fromValue low end of this range, exclusive (greater than or equal to)
* @param float|int|string|null $toValue high end of this range, exclusive (less than)
* @param string|null $key customized key value
*
* @throws InvalidException
*
* @return $this
*/
public function addRange($fromValue = null, $toValue = null, ?string $key = null): self
{
if (null === $fromValue && null === $toValue) {
throw new InvalidException('Either fromValue or toValue must be set. Both cannot be null.');
}

$range = [];

if (null !== $fromValue) {
$range['from'] = $fromValue;
}

if (null !== $toValue) {
$range['to'] = $toValue;
}

if (null !== $key) {
$range['key'] = $key;
}

return $this->addParam('ranges', $range);
}
use Traits\RangeTrait;
}
44 changes: 44 additions & 0 deletions src/Aggregation/Traits/RangeTrait.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

declare(strict_types=1);

namespace Elastica\Aggregation\Traits;

use Elastica\Exception\InvalidException;

trait RangeTrait
{
/**
* Add a range to this aggregation.
*
* @param float|int|string|null $fromValue low end of this range, exclusive (greater than or equal to)
* @param float|int|string|null $toValue high end of this range, exclusive (less than)
* @param string|null $key customized key value
*
* @throws InvalidException
*
* @return $this
*/
public function addRange($fromValue = null, $toValue = null, ?string $key = null): self
{
if (null === $fromValue && null === $toValue) {
throw new InvalidException('Either fromValue or toValue must be set. Both cannot be null.');
}

$range = [];

if (null !== $fromValue) {
$range['from'] = $fromValue;
}

if (null !== $toValue) {
$range['to'] = $toValue;
}

if (null !== $key) {
$range['key'] = $key;
}

return $this->addParam('ranges', $range);
}
}
31 changes: 31 additions & 0 deletions tests/Aggregation/GeoDistanceTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,37 @@ public function testGeoDistanceKeyedAggregation(): void
$this->assertSame($expected, \array_keys($results['buckets']));
}

/**
* @group unit
*/
public function testGeoDistanceAggregationWithKey(): void
{
$agg = new GeoDistance('geo', 'location', ['lat' => 32.804654, 'lon' => -117.242594]);
$agg->addRange(null, 10, 'first');
$agg->addRange(10, null, 'second');
$agg->setUnit('mi');

$expected = [
'geo_distance' => [
'field' => 'location',
'origin' => ['lat' => 32.804654, 'lon' => -117.242594],
'unit' => 'mi',
'ranges' => [
[
'to' => 10,
'key' => 'first',
],
[
'from' => 10,
'key' => 'second',
],
],
],
];

$this->assertEquals($expected, $agg->toArray());
}

protected function _getIndexForTest(): Index
{
$index = $this->_createIndex();
Expand Down
33 changes: 33 additions & 0 deletions tests/Aggregation/IpRangeTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,39 @@ public function testIpRangeKeyedAggregation(): void
$this->assertSame($expected, \array_keys($results['buckets']));
}

/**
* @group unit
*/
public function testIpRangeAggregationWithKey(): void
{
$agg = new IpRange('ip', 'address');
$agg->addRange('192.168.1.101', null, 'first');
$agg->addRange(null, '192.168.1.200', 'second');
$agg->addMaskRange('192.168.1.0/24', 'mask');

$expected = [
'ip_range' => [
'field' => 'address',
'ranges' => [
[
'from' => '192.168.1.101',
'key' => 'first',
],
[
'to' => '192.168.1.200',
'key' => 'second',
],
[
'mask' => '192.168.1.0/24',
'key' => 'mask',
],
],
],
];

$this->assertEquals($expected, $agg->toArray());
}

protected function _getIndexForTest(): Index
{
$index = $this->_createIndex();
Expand Down

0 comments on commit b8312a0

Please sign in to comment.