PR suggestion applyToRoute > applies

VeryGoodOpenSource · Jun 23, 2023 · 5adeff5 · 5adeff5
1 parent b4886bc
commit 5adeff5
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 15 deletions.
diff --git a/examples/basic_authentication/routes/users/[id].dart b/examples/basic_authentication/routes/users/[id].dart
@@ -1,7 +1,7 @@
 import 'dart:io';
 
+import 'package:basic_authentication/user_repository.dart';
 import 'package:dart_frog/dart_frog.dart';
-import 'package:example/user_repository.dart';
 
 Future<Response> onRequest(RequestContext context, String id) async {
   return switch (context.request.method) {

diff --git a/examples/basic_authentication/routes/users/_middleware.dart b/examples/basic_authentication/routes/users/_middleware.dart
@@ -1,6 +1,6 @@
+import 'package:basic_authentication/user_repository.dart';
 import 'package:dart_frog/dart_frog.dart';
 import 'package:dart_frog_auth/dart_frog_auth.dart';
-import 'package:example/user_repository.dart';
 
 Future<User?> Function(String, String) userFromCredentials(
   UserRepository repository,
@@ -17,7 +17,7 @@ Handler middleware(Handler handler) {
       .use(
         basicAuthentication<User>(
           userFromCredentials: userFromCredentials(userRepository),
-          applyToRoute: (RequestContext context) async =>
+          applies: (RequestContext context) async =>
               context.request.method != HttpMethod.post,
         ),
       );

diff --git a/examples/basic_authentication/routes/users/index.dart b/examples/basic_authentication/routes/users/index.dart
@@ -1,7 +1,7 @@
 import 'dart:io';
 
+import 'package:basic_authentication/user_repository.dart';
 import 'package:dart_frog/dart_frog.dart';
-import 'package:example/user_repository.dart';
 
 Future<Response> onRequest(RequestContext context) async {
   return switch (context.request.method) {

diff --git a/examples/basic_authentication/test/lib/user_repostiroy_test.dart b/examples/basic_authentication/test/lib/user_repostiroy_test.dart
@@ -1,6 +1,6 @@
 // ignore_for_file: prefer_const_constructors
 
-import 'package:example/user_repository.dart';
+import 'package:basic_authentication/user_repository.dart';
 import 'package:test/test.dart';
 
 void main() {

diff --git a/examples/basic_authentication/test/routes/users/[id]_test.dart b/examples/basic_authentication/test/routes/users/[id]_test.dart
@@ -2,8 +2,8 @@
 
 import 'dart:io';
 
+import 'package:basic_authentication/user_repository.dart';
 import 'package:dart_frog/dart_frog.dart';
-import 'package:example/user_repository.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:test/test.dart';
 

diff --git a/examples/basic_authentication/test/routes/users/index_test.dart b/examples/basic_authentication/test/routes/users/index_test.dart
@@ -2,8 +2,8 @@
 
 import 'dart:io';
 
+import 'package:basic_authentication/user_repository.dart';
 import 'package:dart_frog/dart_frog.dart';
-import 'package:example/user_repository.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:test/test.dart';
 

diff --git a/packages/dart_frog_auth/README.md b/packages/dart_frog_auth/README.md
@@ -177,7 +177,7 @@ only an authenticated user would be allowed to change this information.
 
 To accomplish that, we need the middleware to apply authentication to all routes except `POST`.
 
-Such behavior is possible with the use of the `applyToRoute` optional predicate:
+Such behavior is possible with the use of the `applies` optional predicate:
 
 ```dart
 Handler middleware(Handler handler) {
@@ -189,7 +189,7 @@ Handler middleware(Handler handler) {
       .use(
         basicAuthentication<User>(
           userFromCredentials: userFromCredentials(userRepository),
-          applyToRoute: (RequestContext context) async =>
+          applies: (RequestContext context) async =>
               context.request.method != HttpMethod.post,
         ),
       );

diff --git a/packages/dart_frog_auth/lib/src/dart_frog_auth.dart b/packages/dart_frog_auth/lib/src/dart_frog_auth.dart
@@ -48,10 +48,10 @@ Future<bool> _defaultApplyToRoute(RequestContext context) async => true;
 /// apply to the route and the call will have authentication validation.
 Middleware basicAuthentication<T extends Object>({
   required Future<T?> Function(String, String) userFromCredentials,
-  ApplyToRoute applyToRoute = _defaultApplyToRoute,
+  ApplyToRoute applies = _defaultApplyToRoute,
 }) =>
     (handler) => (context) async {
-          if (!await applyToRoute(context)) {
+          if (!await applies(context)) {
             return handler(context);
           }
 
@@ -91,10 +91,10 @@ Middleware basicAuthentication<T extends Object>({
 /// apply to the route and the call will have no authentication validation.
 Middleware bearerAuthentication<T extends Object>({
   required Future<T?> Function(String) userFromToken,
-  ApplyToRoute applyToRoute = _defaultApplyToRoute,
+  ApplyToRoute applies = _defaultApplyToRoute,
 }) =>
     (handler) => (context) async {
-          if (!await applyToRoute(context)) {
+          if (!await applies(context)) {
             return handler(context);
           }
 

diff --git a/packages/dart_frog_auth/test/src/dart_frog_auth_test.dart b/packages/dart_frog_auth/test/src/dart_frog_auth_test.dart
@@ -117,7 +117,7 @@ void main() {
           called = true;
           return user;
         },
-        applyToRoute: (_) async => false,
+        applies: (_) async => false,
       );
 
       await middleware((_) async => Response())(context);
@@ -227,7 +227,7 @@ void main() {
           called = true;
           return user;
         },
-        applyToRoute: (_) async => false,
+        applies: (_) async => false,
       );
 
       await middleware((_) async => Response())(context);