feat: support custom all method mark

medz · Sep 9, 2024 · 89a1772 · 89a1772
1 parent 1f3df61
commit 89a1772
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 12 deletions.
diff --git a/lib/src/context.dart b/lib/src/context.dart
@@ -2,12 +2,18 @@ import '_internal/node_impl.dart';
 import 'types.dart';
 
 final class _ContextImpl<T> implements RouterContext<T> {
+  _ContextImpl(this.allMethodMark);
+
   @override
   final Node<T> root = NodeImpl("<root>");
 
   @override
   late final Map<String, Node<T>> static = {};
+
+  @override
+  final String allMethodMark;
 }
 
 /// Creates a new router context.
-RouterContext<T> createRouter<T>() => _ContextImpl<T>();
+RouterContext<T> createRouter<T>({String allMethodMark = '*'}) =>
+    _ContextImpl<T>(allMethodMark);
diff --git a/lib/src/operations/find_all_routes.dart b/lib/src/operations/find_all_routes.dart
@@ -31,7 +31,7 @@ Iterable<MethodData<T>> _findAllMethodData<T>(
   // 0. wildcard
   if (node.wildcard?.methods
       case final Map<String, List<MethodData<T>>> methodMap) {
-    final values = methodMap[method] ?? methodMap[''];
+    final values = methodMap[method] ?? methodMap[ctx.allMethodMark];
     if (values != null && values.isNotEmpty) {
       results.addAll(values);
     }
@@ -42,10 +42,11 @@ Iterable<MethodData<T>> _findAllMethodData<T>(
     results.addAll(_findAllMethodData(ctx, node, method, segments, index + 1));
     if (node.methods case final Map<String, List<MethodData<T>>> methodMap
         when index == segments.length) {
-      final values = methodMap[method] ?? methodMap[''];
-      if (values != null &&
-          values.firstOrNull?.params?.lastOrNull?.optional == true) {
-        results.addAll(values);
+      final values = methodMap[method] ?? methodMap[ctx.allMethodMark];
+      final optionalValues =
+          values?.where((e) => e.params?.any((e) => e.optional) == true);
+      if (optionalValues != null) {
+        results.addAll(optionalValues);
       }
     }
   }
@@ -58,7 +59,7 @@ Iterable<MethodData<T>> _findAllMethodData<T>(
   // 3. ends.
   if (node.methods case final Map<String, List<MethodData<T>>> methodMap
       when index == segments.length) {
-    final values = methodMap[method] ?? methodMap[''];
+    final values = methodMap[method] ?? methodMap[ctx.allMethodMark];
     if (values != null && values.isNotEmpty) {
       results.addAll(values);
     }

diff --git a/lib/src/operations/find_route.dart b/lib/src/operations/find_route.dart
@@ -14,7 +14,7 @@ MatchedRoute<T>? findRoute<T>(
   // 0. global static matched.
   if (ctx.static[normalizedPath]
       case Node<T>(methods: final Map<String, List<MethodData<T>>> methodMap)) {
-    final values = methodMap[method] ?? methodMap[''];
+    final values = methodMap[method] ?? methodMap[ctx.allMethodMark];
     if (values?.firstOrNull?.data case final data when data is T) {
       return MatchedRoute(data: data);
     }
@@ -40,14 +40,16 @@ Iterable<MethodData<T>>? _lookupTree<T>(
   // 0. Ends
   if (index == segments.length) {
     if (node.methods != null) {
-      final values = node.methods?[method] ?? node.methods?[''];
+      final values = node.methods?[method] ?? node.methods?[ctx.allMethodMark];
       if (values != null) return values;
     }
 
     // Fallback to dynamic for last child (/test and /test/ matches /test/*)
     if (node.param case Node<T>(methods: final methodMap)
         when methodMap != null) {
-      final values = methodMap[method] ?? methodMap[''];
+      final values = methodMap[method] ?? methodMap[ctx.allMethodMark];
+
+      // The reason for only checking first here is that findRoute only returns the first match.
       if (values != null &&
           values.firstOrNull?.params?.lastOrNull?.optional == true) {
         return values;
@@ -56,7 +58,9 @@ Iterable<MethodData<T>>? _lookupTree<T>(
 
     if (node.wildcard case Node<T>(methods: final methodMap)
         when methodMap != null) {
-      final values = methodMap[method] ?? methodMap[''];
+      final values = methodMap[method] ?? methodMap[ctx.allMethodMark];
+
+      // The reason for only checking first here is that findRoute only returns the first match.
       if (values != null &&
           values.firstOrNull?.params?.lastOrNull?.optional == true) {
         return values;
@@ -83,7 +87,7 @@ Iterable<MethodData<T>>? _lookupTree<T>(
   // 3. wildcard
   if (node.wildcard case Node<T>(methods: final methodMap)
       when methodMap != null) {
-    return methodMap[method] ?? methodMap[''];
+    return methodMap[method] ?? methodMap[ctx.allMethodMark];
   }
 
   // No match

diff --git a/lib/src/types.dart b/lib/src/types.dart
@@ -5,6 +5,9 @@ abstract interface class RouterContext<T> {
 
   /// all path segment is statice nodes.
   Map<String, Node<T>> get static;
+
+  /// Defined all http method mark.
+  String get allMethodMark;
 }
 
 /// Method data params metadata.