Skip to content

[go_router_builder] Add support for Iterable, List and Set to TypedGoRoute #2679

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.

Sign up for GitHub

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

Merged
auto-submit merged 12 commits into from
Feb 23, 2023
Merged

[go_router_builder] Add support for Iterable, List and Set to TypedGoRoute #2679

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b2c18aa
fixes #108437 support for iterable, list and set
Skogsfrae Oct 5, 2022
280c8dd
fixes #108437 url encoding for iterable, list and set
Skogsfrae Oct 5, 2022
a083136
fixes #108437 tests
Skogsfrae Oct 5, 2022
32a4f8a
format and analysis fix
Skogsfrae Oct 5, 2022
3dee0f0
fix string encoding
Skogsfrae Oct 5, 2022
94b1497
format
Skogsfrae Oct 5, 2022
48cbcf7
removed unused helper name
Skogsfrae Oct 14, 2022
f1d39c6
fix nullability checks for query params encoding
Skogsfrae Nov 23, 2022
5a52fc0
fix all_types.dart for new go router version
Skogsfrae Feb 7, 2023
5f604cd
rebased to upstream
Skogsfrae Feb 17, 2023
1d74193
version
Skogsfrae Feb 22, 2023
a6a0e1a
missing file regeneration
Skogsfrae Feb 22, 2023
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
Next Next commit
fixes #108437 support for iterable, list and set
  • Loading branch information
@Skogsfrae
Skogsfrae committed Feb 22, 2023
commit b2c18aa5e63a9dbb4c2ca01ea839663c8655c4ac
54 changes: 54 additions & 0 deletions packages/go_router_builder/example/lib/all_types.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ part 'all_types.g.dart';
path: 'enhanced-enum-route/:requiredEnumField'),
TypedGoRoute<StringRoute>(path: 'string-route/:requiredStringField'),
TypedGoRoute<UriRoute>(path: 'uri-route/:requiredUriField'),
TypedGoRoute<IterableRoute>(path: 'iterable-route'),
])
@immutable
class AllTypesBaseRoute extends GoRouteData {
Expand Down Expand Up @@ -290,6 +291,59 @@ class UriRoute extends GoRouteData {
);
}

class IterableRoute extends GoRouteData {
IterableRoute({
this.intIterableField,
this.doubleIterableField,
this.stringIterableField,
this.boolIterableField,
this.enumIterableField,
this.intListField,
this.doubleListField,
this.stringListField,
this.boolListField,
this.enumListField,
this.intSetField,
this.doubleSetField,
this.stringSetField,
this.boolSetField,
this.enumSetField,
});

final Iterable<int>? intIterableField;
Copy link
Contributor

@chunhtai chunhtai Nov 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to modulalize this to be a class. I imagine someone would like to do this

class IterableRoute extends GoRouteData {
  IterableRoute({
    this.myField
  })
  final MyCustomField? myField;
}

abstract class CustomField<T> {
  Iterable<T> value;
  bool get isQueryParameter;
  String get queryParameterName;
}

class MyCustomField extend CustomField<List<int>> {
   MyCustomField();

   @override
    bool get isQueryParameter => true;
    @override
    String get queryParameterName => 'some-name' ;
}

The idea is to be able to choose the query parameter name.

Copy link
Contributor

@chunhtai chunhtai Nov 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Skogsfrae WDYT about this? The main concern is the query parameter names are hardcoded which I imagine people would ask for customized query parameter names in the future. Although this is not something we have to fix now, but the current API, as it is written, may not be able the extend to support this feature.

final List<int>? intListField;
final Set<int>? intSetField;

final Iterable<double>? doubleIterableField;
final List<double>? doubleListField;
final Set<double>? doubleSetField;

final Iterable<String>? stringIterableField;
final List<String>? stringListField;
final Set<String>? stringSetField;

final Iterable<bool>? boolIterableField;
final List<bool>? boolListField;
final Set<bool>? boolSetField;

final Iterable<SportDetails>? enumIterableField;
final List<SportDetails>? enumListField;
final Set<SportDetails>? enumSetField;

@override
Widget build(BuildContext context) => BasePage<Iterable<int>>(
dataTitle: 'UriRoute',
param: const <int>[],
queryParam: intIterableField,
);

Widget drawerTile(BuildContext context) => ListTile(
title: const Text('UriRoute'),
onTap: () => go(context),
selected: GoRouter.of(context).location == location,
);
}

class BasePage<T> extends StatelessWidget {
const BasePage({
required this.dataTitle,
Expand Down
75 changes: 75 additions & 0 deletions packages/go_router_builder/example/lib/all_types.g.dart
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

47 changes: 47 additions & 0 deletions packages/go_router_builder/lib/src/type_helpers.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ const String durationDecoderHelperName = r'_$duractionConverter';
/// The name of the generated, private helper for converting [String] to [Enum].
const String enumExtensionHelperName = r'_$fromName';

/// The name of the generated, private helper for converting [String] to [Enum].
Copy link
Contributor

@chunhtai chunhtai Oct 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be incorrect?

const String iterableDecoderHelperName = r'_$iterableConverter';

/// The property/parameter name used to represent the `extra` data that may
/// be passed to a route.
const String extraFieldName = r'$extra';
Expand All @@ -38,6 +41,7 @@ const List<_TypeHelper> _helpers = <_TypeHelper>[
_TypeHelperNum(),
_TypeHelperString(),
_TypeHelperUri(),
_TypeHelperIterable(),
];

/// Returns the decoded [String] value for [element], if its type is supported.
Expand Down Expand Up @@ -253,6 +257,49 @@ class _TypeHelperUri extends _TypeHelperWithHelper {
const TypeChecker.fromRuntime(Uri).isAssignableFromType(type);
}

class _TypeHelperIterable extends _TypeHelper {
const _TypeHelperIterable();

@override
String _decode(ParameterElement parameterElement) {
if (parameterElement.type is ParameterizedType) {
final DartType iterableType =
(parameterElement.type as ParameterizedType).typeArguments.first;

String entriesTypeMapper = '(e) => e';
for (final _TypeHelper helper in _helpers) {
if (helper._matchesType(iterableType) &&
helper is _TypeHelperWithHelper) {
entriesTypeMapper = helper.helperName(iterableType);
}
}

String iterableCaster = '';
if (const TypeChecker.fromRuntime(List)
.isAssignableFromType(parameterElement.type)) {
iterableCaster = '.toList()';
} else if (const TypeChecker.fromRuntime(Set)
.isAssignableFromType(parameterElement.type)) {
iterableCaster = '.toSet()';
}

return '''
state.queryParametersAll[
${escapeDartString(parameterElement.name.kebab)}]
?.map($entriesTypeMapper)$iterableCaster''';
}
return '''
state.queryParametersAll[${escapeDartString(parameterElement.name.kebab)}]''';
}

@override
String _encode(String fieldName, DartType type) => fieldName;

@override
bool _matchesType(DartType type) =>
const TypeChecker.fromRuntime(Iterable).isAssignableFromType(type);
}

abstract class _TypeHelperWithHelper extends _TypeHelper {
const _TypeHelperWithHelper();

Expand Down