Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/DataSource/Processors/Collection/Pipelines/Filters.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public function handle(Collection $collection, Closure $next): Collection
$results = $collection;

foreach ($filters as $bagKey => $record) {
if (! FilterBag::isRecord($record) || ! FilterBag::isActive($record)) {
if (! FilterBag::isRecord($record)) {
continue;
}

Expand All @@ -48,6 +48,12 @@ public function handle(Collection $collection, Closure $next): Collection
continue;
}

$record = FilterBag::forDefinition($definition, $record);

if (! FilterBag::isActive($record)) {
continue;
}

$sqlField = FilterBag::sqlField($definition, $bagKey);
$filterType = $record['type'];
$value = $record['value'] ?? null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public function apply(EloquentBuilder|QueryBuilder $query): EloquentBuilder|Quer
}

foreach ($filters as $bagKey => $record) {
if (! FilterBag::isRecord($record) || ! FilterBag::isActive($record)) {
if (! FilterBag::isRecord($record)) {
continue;
}

Expand All @@ -43,6 +43,12 @@ public function apply(EloquentBuilder|QueryBuilder $query): EloquentBuilder|Quer
continue;
}

$record = FilterBag::forDefinition($filter, $record);

if (! FilterBag::isActive($record)) {
continue;
}

$sqlField = FilterBag::sqlField($filter, $bagKey);
$filterType = $record['type'];
$value = $record['value'] ?? null;
Expand Down
8 changes: 7 additions & 1 deletion src/DataSource/Processors/Scout/Pipelines/Filters.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public function handle(ScoutBuilder $builder, Closure $next): ScoutBuilder
}

foreach ($filters as $bagKey => $record) {
if (! FilterBag::isRecord($record) || ! FilterBag::isActive($record)) {
if (! FilterBag::isRecord($record)) {
continue;
}

Expand All @@ -37,6 +37,12 @@ public function handle(ScoutBuilder $builder, Closure $next): ScoutBuilder
continue;
}

$record = FilterBag::forDefinition($filter, $record);

if (! FilterBag::isActive($record)) {
continue;
}

$builder->where(FilterBag::sqlField($filter, $bagKey), $record['value'] ?? null);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/FilterBuilder/FilterBuilderHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ private function shapeFor(string $type, array $row): array|int|string|null
return match ($type) {
'input_text' => [
'selected' => $row['operator'],
'value' => $row['value'],
'value' => $this->scalarValue($row['value']),
'searchMorphs' => $this->component->searchMorphs(),
],
'number' => match ($row['operator']) {
Expand Down
30 changes: 30 additions & 0 deletions src/Support/FilterBag.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,36 @@ public static function isActive(array $record): bool
return filled($value);
}

/**
* @param array{type: string, value?: mixed, op?: mixed} $record
* @return array{type: string, value?: mixed, op?: mixed}
*/
public static function forDefinition(mixed $definition, array $record): array
{
$type = data_get($definition, 'key');

if (is_string($type) && $type !== '') {
$record['type'] = self::normalizeType($type);
}

$value = $record['value'] ?? null;

if (is_array($value) && ! self::acceptsArray($record['type'], array_is_list($value))) {
$record['value'] = null;
}

return $record;
}

private static function acceptsArray(string $type, bool $list): bool
{
return match ($type) {
'number', 'date', 'datetime', 'multi_select' => true,
'select', 'boolean' => $list,
default => false,
};
}

public static function isValuelessOperator(mixed $operator): bool
{
return in_array($operator, self::VALUELESS_OPERATORS, true);
Expand Down
2 changes: 2 additions & 0 deletions src/Turbine.php
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,8 @@ private function buildState(): State
{
return State::fromArray(array_merge($this->requestState, [
'primaryKey' => $this->primaryKey,
'primaryKeyAlias' => null,
'columns' => [],
'tableName' => $this->tableName,
'setUp' => $this->buildSetUp(),
]));
Expand Down
14 changes: 14 additions & 0 deletions tests/Feature/FilterBuilderHandlerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,17 @@ function makeFilterBuilderContext(array $fbState = []): ArrayGridContext

expect($filtered)->toHaveCount(2);
});

it('reads a text condition value as a single value', function () {
$ctx = makeFilterBuilderContext([
'match' => 'and',
'rows' => [
['column' => 'name', 'operator' => 'is', 'value' => ['price' => 10], 'boolean' => 'and'],
],
]);

$query = Dish::query();
(new FilterBuilderHandler($ctx))->apply($query);

expect($query->toSql())->not->toContain('"name"."price"');
});
13 changes: 12 additions & 1 deletion tests/Feature/FiltersTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace PowerComponents\Turbine\Tests\Feature;

use PowerComponents\Turbine\Components\Filters\{FilterBoolean, FilterMultiSelect, FilterNumber, FilterSelect};
use PowerComponents\Turbine\Components\Filters\{FilterBoolean, FilterInputText, FilterMultiSelect, FilterNumber, FilterSelect};
use PowerComponents\Turbine\DataSource\ProcessDataSource;

/**
Expand Down Expand Up @@ -45,3 +45,14 @@ function pgFilter(string $type, string $field, mixed $value, array $filters): in

expect($total)->toBe(5);
});

it('reads a filter record with the type its definition declares', function () {
expect(pgFilter('number', 'name', 'Sushi', [new FilterSelect('name')]))->toBe(1)
->and(pgFilter('select', 'price', ['start' => 30], [new FilterNumber('price')]))->toBe(2);
});

it('ignores a keyed filter value the declared type does not take', function () {
expect(pgFilter('select', 'name', ['price' => 10], [new FilterInputText('name')]))->toBe(5)
->and(pgFilter('select', 'name', ['price' => 10], [new FilterSelect('name')]))->toBe(5)
->and(pgFilter('boolean', 'in_stock', ['price' => 10], [new FilterBoolean('in_stock')]))->toBe(5);
});
15 changes: 15 additions & 0 deletions tests/Feature/TurbineTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,21 @@ function turbineGrid(array $state = []): Turbine
->and($response->meta->pagination->total)->toBe(2);
});

it('keeps the row key server-side when the request names another one', function () {
$response = turbineGrid(['primaryKeyAlias' => 'in_stock'])->envelope();

expect($response->data[0])->not->toHaveKey('in_stock');
});

it('resolves columns from the grid definition, not the request', function () {
$response = turbineGrid(['columns' => [['field' => 'other']], 'multiSort' => true])
->columns(fn () => [Column::make('Id', 'id'), Column::make('Name', 'name')])
->envelope();

expect($response->data[0])->toHaveKeys(['id', 'name', 'price'])
->and($response->data[0])->not->toHaveKey('in_stock');
});

it('produces a JSON response', function () {
$response = turbineGrid()->toResponse();

Expand Down
Loading