refactor(dart_frog_gen): buildRouteConfiguration (felangel#6)

.github/workflows/dart_frog_gen.yaml

@@ -21,3 +21,4 @@ jobs:
     uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
     with:
       working_directory: packages/dart_frog_gen
+      min_coverage: 0

packages/dart_frog_gen/lib/dart_frog_gen.dart

@@ -1,4 +1,5 @@
 /// Code generation tooling for package:dart_frog
 library dart_frog_gen;
 
+export 'src/build_route_configuration.dart';
 export 'src/path_to_route.dart';

packages/dart_frog_gen/lib/src/build_route_configuration.dart

@@ -0,0 +1,276 @@
+import 'dart:io';
+
+import 'package:dart_frog_gen/dart_frog_gen.dart';
+import 'package:path/path.dart' as path;
+
+/// Build a [RouteConfiguration] based on the provided root project [directory].
+RouteConfiguration buildRouteConfiguration(Directory directory) {
+  final routesDirectory = Directory(
+    path.join(Directory.current.path, 'routes'),
+  );
+
+  if (!routesDirectory.existsSync()) {
+    throw Exception('Could not find directory ${routesDirectory.path}');
+  }
+
+  final globalMiddlewareFile = File(
+    path.join(routesDirectory.path, '_middleware.dart'),
+  );
+  final globalMiddleware = globalMiddlewareFile.existsSync()
+      ? MiddlewareFile(
+          name: 'm0',
+          path: path.join(
+            '..',
+            path.relative(globalMiddlewareFile.path).replaceAll(r'\', '/'),
+          ),
+        )
+      : null;
+
+  final middleware = <MiddlewareFile>[
+    if (globalMiddleware != null) globalMiddleware
+  ];
+  final routes = <RouteFile>[];
+  final directories = _getRouteDirectories(
+    routesDirectory,
+    onRoute: routes.add,
+    onMiddleware: middleware.add,
+  );
+
+  return RouteConfiguration(
+    globalMiddleware: globalMiddleware,
+    middleware: middleware,
+    directories: directories,
+    routes: routes,
+  );
+}
+
+List<RouteDirectory> _getRouteDirectories(
+  Directory directory, {
+  void Function(RouteFile route)? onRoute,
+  void Function(MiddlewareFile route)? onMiddleware,
+  int depth = 0,
+}) {
+  final _depth = depth + 1;
+  final directories = <RouteDirectory>[];
+  final entities = directory.listSync();
+  final directorySegment = directory.path.split('routes').last;
+  final directoryPath = directorySegment.startsWith('/')
+      ? directorySegment
+      : '/$directorySegment';
+
+  final files = <RouteFile>[];
+  var fileDepth = _depth;
+  entities.where((e) => e.isRoute).cast<File>().forEach((entity) {
+    final filePath = path.join(
+      '..',
+      path.relative(entity.path).replaceAll(r'\', '/'),
+    );
+    final fileRoute = pathToRoute(filePath).split(directoryPath).last;
+    final route = RouteFile(
+      name: 'r$fileDepth',
+      path: filePath,
+      route: fileRoute.isEmpty
+          ? '/'
+          : fileRoute.startsWith('/')
+              ? fileRoute
+              : '/$fileRoute',
+    );
+    onRoute?.call(route);
+    files.add(route);
+    fileDepth++;
+  });
+
+  // Only add nested middleware -- global middleware is added separately.
+  MiddlewareFile? middleware;
+  if (_depth > 1) {
+    final _middleware = File(path.join(directory.path, '_middleware.dart'));
+    if (_middleware.existsSync()) {
+      final middlewarePath = path.join(
+        '..',
+        path.relative(_middleware.path).replaceAll(r'\', '/'),
+      );
+      middleware = MiddlewareFile(name: 'm$_depth', path: middlewarePath);
+      onMiddleware?.call(middleware);
+    }
+  }
+
+  directories.add(
+    RouteDirectory(
+      name: 'd$depth',
+      path: directoryPath,
+      middleware: middleware,
+      files: files,
+    ),
+  );
+
+  entities.whereType<Directory>().forEach((entity) {
+    directories.addAll(
+      _getRouteDirectories(
+        entity,
+        onRoute: onRoute,
+        onMiddleware: onMiddleware,
+        depth: _depth,
+      ),
+    );
+  });
+
+  return directories;
+}
+
+extension on FileSystemEntity {
+  bool get isRoute {
+    return this is File &&
+        path.basename(this.path).endsWith('.dart') &&
+        path.basename(this.path) != '_middleware.dart';
+  }
+}
+
+/// {@template route_configuration}
+/// An object containing all route configuration metadata
+/// required to generate a dart frog server.
+/// {@endtemplate}
+class RouteConfiguration {
+  /// {@macro route_configuration}
+  const RouteConfiguration({
+    this.globalMiddleware,
+    required this.middleware,
+    required this.directories,
+    required this.routes,
+  });
+
+  /// Optional global middleware.
+  final MiddlewareFile? globalMiddleware;
+
+  /// List of all nested middleware.
+  /// Top-level middleware is excluded (see [globalMiddleware]).
+  final List<MiddlewareFile> middleware;
+
+  /// List of all route directories.
+  /// Sorted from leaf nodes to root.
+  final List<RouteDirectory> directories;
+
+  /// List of all route files.
+  final List<RouteFile> routes;
+}
+
+/// {@template route_directory}
+/// A class containing metadata regarding a route directory.
+/// {@endtemplate}
+class RouteDirectory {
+  /// {@macro route_directory}
+  const RouteDirectory({
+    required this.name,
+    required this.path,
+    required this.middleware,
+    required this.files,
+  });
+
+  /// The alias for the current directory.
+  final String name;
+
+  /// The path (route) which will be used to mount routers.
+  final String path;
+
+  /// Optional middleware for the provided router.
+  final MiddlewareFile? middleware;
+
+  /// A list of nested route files within the directory.
+  final List<RouteFile> files;
+
+  /// Create a copy of the current instance and override zero or more values.
+  RouteDirectory copyWith({
+    String? name,
+    String? path,
+    MiddlewareFile? middleware,
+    List<RouteFile>? files,
+  }) {
+    return RouteDirectory(
+      name: name ?? this.name,
+      path: path ?? this.path,
+      middleware: middleware ?? this.middleware,
+      files: files ?? this.files,
+    );
+  }
+
+  /// Convert the current instance to a `Map<String, dynamic>`.
+  Map<String, dynamic> toJson() {
+    return <String, dynamic>{
+      'name': name,
+      'path': path,
+      'middleware': middleware?.toJson(),
+      'files': files.map((f) => f.toJson()).toList(),
+    };
+  }
+}
+
+/// {@template route_file}
+/// A class containing metadata regarding a route directory.
+/// {@endtemplate}
+class RouteFile {
+  /// {@macro route_file}
+  const RouteFile({
+    required this.name,
+    required this.path,
+    required this.route,
+  });
+
+  /// The alias for the current directory.
+  final String name;
+
+  /// The import path for the current instance.
+  final String path;
+
+  /// The route used by router instances.
+  final String route;
+
+  /// Create a copy of the current instance and override zero or more values.
+  RouteFile copyWith({String? name, String? path, String? route}) {
+    return RouteFile(
+      name: name ?? this.name,
+      path: path ?? this.path,
+      route: route ?? this.route,
+    );
+  }
+
+  /// Convert the current instance to a `Map<String, dynamic>`.
+  Map<String, dynamic> toJson() {
+    return <String, dynamic>{
+      'name': name,
+      'path': path,
+      'route': route,
+    };
+  }
+}
+
+/// {@template middleware_file}
+/// A class containing metadata regarding a route directory.
+/// {@endtemplate}
+class MiddlewareFile {
+  /// {@macro middleware_file}
+  const MiddlewareFile({
+    required this.name,
+    required this.path,
+  });
+
+  /// The alias for the current directory.
+  final String name;
+
+  /// The import path for the current instance.
+  final String path;
+
+  /// Create a copy of the current instance and override zero or more values.
+  MiddlewareFile copyWith({String? name, String? path}) {
+    return MiddlewareFile(
+      name: name ?? this.name,
+      path: path ?? this.path,
+    );
+  }
+
+  /// Convert the current instance to a `Map<String, dynamic>`.
+  Map<String, dynamic> toJson() {
+    return <String, dynamic>{
+      'name': name,
+      'path': path,
+    };
+  }
+}

packages/dart_frog_gen/pubspec.yaml

@@ -6,6 +6,9 @@ publish_to: none
 environment:
   sdk: ">=2.16.0 <3.0.0"
 
+dependencies:
+  path: ^1.8.1
+
 dev_dependencies:
   mocktail: ^0.2.0
   test: ^1.19.2