Initial commit

Author: brookesb91

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,75 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+build/
+
+# Android related
+**/android/**/gradle-wrapper.jar
+**/android/.gradle
+**/android/captures/
+**/android/gradlew
+**/android/gradlew.bat
+**/android/local.properties
+**/android/**/GeneratedPluginRegistrant.java
+
+# iOS/XCode related
+**/ios/**/*.mode1v3
+**/ios/**/*.mode2v3
+**/ios/**/*.moved-aside
+**/ios/**/*.pbxuser
+**/ios/**/*.perspectivev3
+**/ios/**/*sync/
+**/ios/**/.sconsign.dblite
+**/ios/**/.tags*
+**/ios/**/.vagrant/
+**/ios/**/DerivedData/
+**/ios/**/Icon?
+**/ios/**/Pods/
+**/ios/**/.symlinks/
+**/ios/**/profile
+**/ios/**/xcuserdata
+**/ios/.generated/
+**/ios/Flutter/App.framework
+**/ios/Flutter/Flutter.framework
+**/ios/Flutter/Flutter.podspec
+**/ios/Flutter/Generated.xcconfig
+**/ios/Flutter/ephemeral
+**/ios/Flutter/app.flx
+**/ios/Flutter/app.zip
+**/ios/Flutter/flutter_assets/
+**/ios/Flutter/flutter_export_environment.sh
+**/ios/ServiceDefinitions.json
+**/ios/Runner/GeneratedPluginRegistrant.*
+
+# Exceptions to above rules.
+!**/ios/**/default.mode1v3
+!**/ios/**/default.mode2v3
+!**/ios/**/default.pbxuser
+!**/ios/**/default.perspectivev3

.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: 4cc385b4b84ac2f816d939a49ea1f328c4e0b48e
+  channel: stable
+
+project_type: package

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.

LICENSE

@@ -0,0 +1 @@
+TODO: Add your license here.

README.md

@@ -0,0 +1,55 @@
+TODO: Put a short description of the package here that helps potential users
+know whether this package might be useful for them.
+
+## Features
+
+TODO: List what your package can do. Maybe include images, gifs, or videos.
+
+## Getting started
+
+TODO: List prerequisites and provide or point to information on how to
+start using the package.
+
+## Usage
+
+### Basic Usage
+
+Define your view routes.
+
+```dart
+import 'package:view_router/view_router.dart';
+
+final Routes routes = {
+  '/': (_) => HomePage(),
+  '/profile': (_) => ProfilePage()
+};
+```
+
+Create a `ViewRouter` and add to your `MaterialApp` as the `onGenerateRoute` callback.
+
+```dart
+
+class App extends StatelessWidget {
+  // This widget is the root of your application.
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: 'My App',
+      onGenerateRoute: ViewRouter(routes),
+      initialRoute: '/',
+    );
+  }
+}
+```
+
+Navigate using the navigator.
+
+```dart
+Navigator.of(context).pushNamed('/profile');
+```
+
+## Additional information
+
+TODO: Tell users more about the package: where to find more information, how to
+contribute to the package, how to file issues, what response they can expect
+from the package authors, and more.

analysis_options.yaml

@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

lib/parse_route_uri.dart

@@ -0,0 +1,78 @@
+import 'package:flutter/material.dart';
+import 'package:view_router/routes.dart';
+
+/// Extract query parameters from a named route and generate
+/// the page route, supplying the parameters as arguments.
+///
+/// Example:
+///
+/// Initial route settings:
+///
+/// name: `/profile?id=123`,
+/// arguments: `null`
+///
+/// After:
+///
+/// name: `/profile`,
+/// arguments: `{ id: '123' }`
+Route<dynamic>? parseRouteUri(Routes routes, RouteSettings settings) {
+  final Uri uri = Uri.parse(settings.name ?? '/');
+  final Map<String, String> params = uri.queryParameters;
+
+  final String path = uri.path;
+
+  if (routes.containsKey(path)) {
+    // If the path can be immediately found, return it.
+    return MaterialPageRoute(
+        builder: routes[path]!,
+        settings: settings.copyWith(arguments: params, name: path));
+  } else {
+    // Otherwise, the route may not have been found due
+    // to it containing dynamic parameters. Figure that out here.
+
+    // Only get routes that have named parameters.
+    final routesWithNamedParams = routes.keys
+        .where((element) => RegExp(r":\w{1,}").hasMatch(element))
+        .toList();
+
+    routesWithNamedParams.sort((a, b) => a.length.compareTo(b.length));
+
+    // RegExp(r"^:\w{1,}") for finding named parameters in paths.
+    final segments = path.split('/').toList();
+
+    for (var route in routesWithNamedParams) {
+      final parts = route.split('/');
+
+      if (parts.length != segments.length) {
+        // Lengths do not match.
+        continue;
+      }
+
+      bool? matches;
+      final Map<String, String> namedParams = {};
+
+      for (var i in segments.asMap().keys) {
+        if (matches == false) continue;
+
+        final isDynamic = RegExp(r":\w{1,}").hasMatch(parts[i]);
+
+        matches = segments[i] == parts[i] || isDynamic;
+
+        if (matches && isDynamic) {
+          final name = parts[i].substring(1);
+          final value = segments[i];
+          namedParams[name] = value;
+        }
+
+        if (i == parts.length - 1 && matches == true) {
+          // at last segment and fully matched
+          params.addAll(namedParams);
+
+          return MaterialPageRoute(
+              builder: routes[route]!,
+              settings: settings.copyWith(arguments: params, name: route));
+        }
+      }
+    }
+  }
+}

lib/routes.dart

@@ -0,0 +1,3 @@
+import 'package:flutter/material.dart';
+
+typedef Routes = Map<String, Widget Function(BuildContext)>;

lib/view.dart

@@ -0,0 +1,18 @@
+import 'package:flutter/material.dart';
+
+/// Build a widget using the given builder which is supplied
+/// with the query parameters parsed from the current named route.
+///
+/// Example:
+///
+/// ```
+/// static MyViewWidget route(BuildContext context) {
+///   return view(context, (args) => MyViewWidget(id: args['id']));
+/// }
+/// ```
+Widget view(
+    BuildContext context, Widget Function(Map<String, String>) builder) {
+  final args =
+      ModalRoute.of(context)!.settings.arguments as Map<String, String>;
+  return builder.call(args);
+}

lib/view_router.dart

@@ -0,0 +1,18 @@
+library view_router;
+
+import 'package:flutter/material.dart';
+import 'package:view_router/parse_route_uri.dart';
+import 'package:view_router/routes.dart';
+
+export 'package:view_router/routes.dart';
+export 'package:view_router/view.dart';
+
+/// A view router that parses named routes as URIs, supplying
+/// any query parameters as arguments.
+class ViewRouter {
+  final Routes routes;
+
+  ViewRouter({required this.routes});
+
+  call(RouteSettings settings) => parseRouteUri(routes, settings);
+}