Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added filtering support for collections #97

Merged
merged 3 commits into from
Jun 1, 2020
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
1 change: 1 addition & 0 deletions lib/query.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
library query;

export 'package:json_api/src/query/fields.dart';
export 'package:json_api/src/query/filter.dart';
export 'package:json_api/src/query/include.dart';
export 'package:json_api/src/query/page.dart';
export 'package:json_api/src/query/query_parameters.dart';
Expand Down
30 changes: 30 additions & 0 deletions lib/src/query/filter.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import 'package:json_api/src/query/query_parameters.dart';

/// Query parameters defining Filter
/// @see https://jsonapi.org/recommendations/#filtering
class Filter extends QueryParameters {
/// The [filter] argument maps the resource type to a list of filters.
///
/// Example:
/// ```dart
/// Filter({'articles': ['title', 'body'], 'people': ['name']}).addTo(url);
/// ```
/// encodes to
/// ```
/// ?filter[articles]=title,body&filter[people]=name
/// ```
Filter(Map<String, List<String>> filter)
: _filter = {...filter},
super(filter.map((k, v) => MapEntry('filter[$k]', v.join(','))));

/// Extracts the requested filter from the [uri].
static Filter fromUri(Uri uri) => Filter(uri.queryParameters
.map((k, v) => MapEntry(_regex.firstMatch(k)?.group(1), v.split(',')))
..removeWhere((k, v) => k == null));

List<String> operator [](String key) => _filter[key];

static final _regex = RegExp(r'^filter\[(.+)\]$');

final Map<String, List<String>> _filter;
}
23 changes: 23 additions & 0 deletions test/unit/query/filter_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import 'package:json_api/src/query/filter.dart';
import 'package:test/test.dart';

void main() {
test('Can decode url', () {
final uri = Uri.parse(
'/articles?include=author&filter%5Barticles%5D=title%2Cbody&filter%5Bpeople%5D=name');
final filter = Filter.fromUri(uri);
expect(filter['articles'], ['title', 'body']);
expect(filter['people'], ['name']);
});

test('Can add to uri', () {
final filter = Filter({
'articles': ['title', 'body'],
'people': ['name']
});
final uri = Uri.parse('/articles');

expect(filter.addToUri(uri).toString(),
'/articles?filter%5Barticles%5D=title%2Cbody&filter%5Bpeople%5D=name');
});
}