Merge pull request #51 from nubank/fix-for-flutter-122

Fixes for Flutter 1.22 Navigator 2.0

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.7.0
+- [BREAKING] Rename classes to avoid conflicts with Flutter 1.22 Router Widget
+  - `Router` was renamed to `NuRouter`
+  - The `NuRouter` annotation was renamed to `nuRouter` const or `customNuRouter` function
+
 ## 0.6.2
 - Fix NPE exception when a old instance of router tries calling some methods on it's nuvigator
 

example/lib/samples/modules/composer/navigation/composer_routes.dart

@@ -5,8 +5,8 @@ import 'package:nuvigator/nuvigator.dart';
 
 part 'composer_routes.g.dart';
 
-@NuRouter()
-class ComposerRouter extends Router {
+@nuRouter
+class ComposerRouter extends NuRouter {
   @override
   String get deepLinkPrefix => '/composer';
 

example/lib/samples/modules/composer/screens/text_composer_screen.dart

@@ -63,7 +63,6 @@ class _TextComposerScreenState extends State<TextComposerScreen> {
               tag: 'HERO',
               child: FlutterLogo(
                 size: 48,
-                colors: Colors.deepPurple,
               ),
             ),
           ],

example/lib/samples/modules/friend_request/navigation/friend_request_router.dart

@@ -7,8 +7,8 @@ import '../../composer/navigation/composer_routes.dart';
 
 part 'friend_request_router.g.dart';
 
-@NuRouter()
-class FriendRequestRouter extends Router {
+@nuRouter
+class FriendRequestRouter extends NuRouter {
   FriendRequestRouter();
 
   @NuRoute()
@@ -23,7 +23,7 @@ class FriendRequestRouter extends Router {
   ScreenRoute<void> success() => ScreenRoute(
       builder: (context) => SuccessScreen(
             closeFlow: () => nuvigator.closeFlow(),
-            toComposeText: () => Router.of<SamplesRouter>(context)
+            toComposeText: () => NuRouter.of<SamplesRouter>(context)
                 .composerRouter
                 .pushReplacementToComposeText(),
           ),

example/lib/samples/modules/friend_request/screens/success_screen.dart

@@ -32,7 +32,6 @@ class SuccessScreen extends StatelessWidget {
                   tag: 'HERO',
                   child: FlutterLogo(
                     size: 96,
-                    colors: Colors.deepPurple,
                   ),
                 ),
                 Text(

example/lib/samples/navigation/samples_router.dart

@@ -10,8 +10,8 @@ import '../bloc/samples_bloc.dart';
 
 part 'samples_router.g.dart';
 
-@NuRouter()
-class SamplesRouter extends Router {
+@nuRouter
+class SamplesRouter extends NuRouter {
   @override
   String get deepLinkPrefix => 'deepprefix';
 
@@ -34,8 +34,8 @@ class SamplesRouter extends Router {
         ),
       );
 
-  @NuRouter()
-  final composerRouter = ComposerRouter();
+  @nuRouter
+  final ComposerRouter composerRouter = ComposerRouter();
 
   @override
   WrapperFn get screensWrapper => (BuildContext context, Widget child) {
@@ -49,5 +49,5 @@ class SamplesRouter extends Router {
   Map<RouteDef, ScreenRouteBuilder> get screensMap => _$screensMap;
 
   @override
-  List<Router> get routers => _$routers;
+  List<NuRouter> get routers => _$routers;
 }

example/lib/samples/screens/home_screen.dart

@@ -10,7 +10,7 @@ class HomeScreen extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     final bloc = Provider.of<SamplesBloc>(context);
-    final router = Router.of<SamplesRouter>(context);
+    final router = NuRouter.of<SamplesRouter>(context);
     final headingStle = Theme.of(context).textTheme.headline3;
     final toggleStyle = Theme.of(context).textTheme.bodyText1;
 
@@ -27,7 +27,6 @@ class HomeScreen extends StatelessWidget {
                 const Hero(
                   tag: 'HERO',
                   child: FlutterLogo(
-                    colors: Colors.deepPurple,
                     size: 96,
                   ),
                 ),

lib/builder.dart

@@ -9,7 +9,7 @@ import 'package:source_gen/source_gen.dart';
 
 import 'builder/builder_library.dart';
 
-class NuvigatorGenerator extends GeneratorForAnnotation<NuRouter> {
+class NuvigatorGenerator extends GeneratorForAnnotation<NuRouterAnnotation> {
   @override
   FutureOr<String> generateForAnnotatedElement(
       Element element, ConstantReader annotation, BuildStep buildStep) {

lib/builder/builder_library.dart

@@ -26,7 +26,7 @@ class BuilderLibrary extends BaseBuilder {
       (b) => b
         ..name = '_\$routers'
         ..type = MethodType.getter
-        ..returns = refer('List<Router>')
+        ..returns = refer('List<NuRouter>')
         ..lambda = true
         ..body = Code('[$code]'),
     );

lib/builder/helpers.dart

@@ -10,7 +10,7 @@ List<DartType> getGenericTypes(DartType type) {
 }
 
 const nuRouteChecker = TypeChecker.fromRuntime(NuRoute);
-const nuRouterChecker = TypeChecker.fromRuntime(NuRouter);
+const nuRouterChecker = TypeChecker.fromRuntime(NuRouterAnnotation);
 
 String capitalize(String s) => s[0].toUpperCase() + s.substring(1);
 

lib/nuvigator.dart

@@ -2,8 +2,8 @@ library nuvigator;
 
 export 'src/annotations.dart';
 export 'src/helpers.dart';
+export 'src/nurouter.dart';
 export 'src/nuvigator.dart';
-export 'src/router.dart';
 export 'src/screen_route.dart';
 export 'src/screen_type.dart';
 export 'src/screen_types/cupertino_screen_type.dart';

lib/src/annotations.dart

@@ -61,13 +61,20 @@
 ///
 /// Obs: The [routeNamePrefix] is only used by the routes class to compose the
 /// route names.
-class NuRouter {
-  const NuRouter({this.routerName, this.routeNamePrefix});
+class NuRouterAnnotation {
+  const NuRouterAnnotation({this.routerName, this.routeNamePrefix});
 
   final String routerName;
   final String routeNamePrefix;
 }
 
+NuRouterAnnotation customNuRouter(
+        {String routeNamePrefix, String routerName}) =>
+    NuRouterAnnotation(
+        routeNamePrefix: routeNamePrefix, routerName: routerName);
+
+const nuRouter = NuRouterAnnotation();
+
 /// Annotation used to define a route.
 ///
 /// You can set a [routeName], [deepLink] and [pushMethods].

lib/src/router.dart → lib/src/nurouter.dart

@@ -10,7 +10,7 @@ typedef ScreenRouteBuilder = ScreenRoute Function(RouteSettings settings);
 
 String deepLinkString(Uri url) => url.host + url.path;
 
-typedef HandleDeepLinkFn = Future<dynamic> Function(Router router, Uri uri,
+typedef HandleDeepLinkFn = Future<dynamic> Function(NuRouter router, Uri uri,
     [bool isFromNative, dynamic args]);
 
 Map<String, String> extractDeepLinkParameters(
@@ -38,8 +38,8 @@ class RouteEntry {
   bool operator ==(Object other) => other is RouteEntry && other.key == key;
 }
 
-abstract class Router {
-  static T of<T extends Router>(
+abstract class NuRouter {
+  static T of<T extends NuRouter>(
     BuildContext context, {
     bool nullOk = false,
     bool rootRouter = false,
@@ -73,14 +73,14 @@ abstract class Router {
 
   WrapperFn get screensWrapper => null;
 
-  List<Router> get routers => [];
+  List<NuRouter> get routers => [];
 
   Map<RouteDef, ScreenRouteBuilder> get screensMap => {};
 
   String get deepLinkPrefix => '';
 
   /// Get the specified router that can be grouped in this router
-  T getRouter<T extends Router>() {
+  T getRouter<T extends NuRouter>() {
     if (this is T) return this;
     for (final router in routers) {
       final r = router.getRouter<T>();
@@ -93,7 +93,7 @@ abstract class Router {
     final screen = _getScreen(settings);
     if (screen != null) return screen;
 
-    for (Router router in routers) {
+    for (NuRouter router in routers) {
       final screen = router.getScreen(settings);
       if (screen != null) return screen.wrapWith(screensWrapper);
     }
@@ -107,7 +107,7 @@ abstract class Router {
     if (prefixRegex.hasMatch(deepLink)) {
       final routeEntry = _getRouteEntryForDeepLink(deepLink);
       if (routeEntry != null) return routeEntry;
-      for (final Router router in routers) {
+      for (final NuRouter router in routers) {
         final newDeepLink = deepLink.replaceFirst(thisDeepLinkPrefix, '');
         final subRouterEntry = router.getRouteEntryForDeepLink(newDeepLink);
         if (subRouterEntry != null) {

lib/src/nuvigator.dart

@@ -2,11 +2,11 @@ import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:nuvigator/nuvigator.dart';
 
-import 'router.dart';
+import 'nurouter.dart';
 
 typedef ObserverBuilder = NavigatorObserver Function();
 
-NuvigatorState _tryToFindNuvigatorForRouter<T extends Router>(
+NuvigatorState _tryToFindNuvigatorForRouter<T extends NuRouter>(
     NuvigatorState nuvigatorState) {
   if (nuvigatorState == null) return null;
   final nuvigatorRouterForType = nuvigatorState.router.getRouter<T>();
@@ -52,7 +52,7 @@ class NuvigatorStateTracker extends NavigatorObserver {
   }
 }
 
-class Nuvigator<T extends Router> extends Navigator {
+class Nuvigator<T extends NuRouter> extends Navigator {
   Nuvigator({
     @required this.router,
     String initialRoute,
@@ -142,13 +142,13 @@ class Nuvigator<T extends Router> extends Navigator {
     return this;
   }
 
-  static NuvigatorState ofRouter<T extends Router>(BuildContext context) {
+  static NuvigatorState ofRouter<T extends NuRouter>(BuildContext context) {
     final NuvigatorState closestNuvigator =
         context.findAncestorStateOfType<NuvigatorState>();
     return _tryToFindNuvigatorForRouter<T>(closestNuvigator);
   }
 
-  static NuvigatorState<T> of<T extends Router>(
+  static NuvigatorState<T> of<T extends NuRouter>(
     BuildContext context, {
     bool rootNuvigator = false,
     bool nullOk = false,
@@ -176,7 +176,7 @@ class Nuvigator<T extends Router> extends Navigator {
   }
 }
 
-class NuvigatorState<T extends Router> extends NavigatorState
+class NuvigatorState<T extends NuRouter> extends NavigatorState
     with WidgetsBindingObserver {
   NuvigatorState get rootNuvigator =>
       Nuvigator.of(context, rootNuvigator: true) ?? this;
@@ -190,7 +190,7 @@ class NuvigatorState<T extends Router> extends NavigatorState
 
   NuvigatorStateTracker stateTracker;
 
-  R getRouter<R extends Router>() => router.getRouter<R>();
+  R getRouter<R extends NuRouter>() => router.getRouter<R>();
 
   List<ObserverBuilder> _collectObservers() {
     if (isNested) {
@@ -343,7 +343,7 @@ class NuvigatorState<T extends Router> extends NavigatorState
 
   bool get isRoot => this == rootNuvigator;
 
-  Router get rootRouter => rootNuvigator.router;
+  NuRouter get rootRouter => rootNuvigator.router;
 
   @override
   Widget build(BuildContext context) {

pubspec.yaml

@@ -1,6 +1,6 @@
 name: nuvigator
 description: A powerful and strongly typed routing abstraction over Flutter navigator, providing some new features and an easy way to define routers with code generation.
-version: 0.6.2
+version: 0.7.0
 
 homepage: https://github.com/nubank/nuvigator
 

test/fixtures/test_router.dart

@@ -3,8 +3,8 @@ import 'package:nuvigator/nuvigator.dart';
 
 part 'test_router.g.dart';
 
-@NuRouter()
-class TestRouter extends Router {
+@nuRouter
+class TestRouter extends NuRouter {
   @NuRoute(deepLink: 'home')
   ScreenRoute<void> home() => ScreenRoute(
         builder: (context) => const Text('Home'),

test/helpers.dart

@@ -3,7 +3,7 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:nuvigator/nuvigator.dart';
 
-class TestRouter extends Router {
+class TestRouter extends NuRouter {
   @override
   Map<RouteDef, ScreenRouteBuilder> get screensMap => {
         RouteDef('firstScreen', deepLink: 'test/simple'): (_) => ScreenRoute(
@@ -20,7 +20,7 @@ class TestRouter extends Router {
       };
 }
 
-class TestRouterWPrefix extends Router {
+class TestRouterWPrefix extends NuRouter {
   @override
   String get deepLinkPrefix => 'prefix/';
 
@@ -40,7 +40,7 @@ class TestRouterWPrefix extends Router {
       };
 }
 
-class TestRouterWWrapper extends Router {
+class TestRouterWWrapper extends NuRouter {
   @override
   Map<RouteDef, ScreenRouteBuilder> get screensMap => {
         RouteDef('firstScreen', deepLink: 'test/simple'): (_) => ScreenRoute(
@@ -57,14 +57,14 @@ class TestRouterWWrapper extends Router {
       };
 }
 
-class GroupTestRouter extends Router {
+class GroupTestRouter extends NuRouter {
   @override
   String get deepLinkPrefix => 'group/';
 
   TestRouter testRouter = TestRouter();
 
   @override
-  List<Router> get routers => [
+  List<NuRouter> get routers => [
         testRouter,
       ];
 
@@ -85,10 +85,10 @@ class MockNuvigator extends NuvigatorState {
   String routePushed;
   Object argumentsPushed;
   @override
-  final Router router;
+  final NuRouter router;
 
   @override
-  NuvigatorState<Router> get rootNuvigator => this;
+  NuvigatorState<NuRouter> get rootNuvigator => this;
 
   @override
   Future<T> pushNamed<T extends Object>(String routeName,
@@ -107,7 +107,7 @@ class TestWidget extends StatelessWidget {
   }
 }
 
-Widget testApp(Router router, String initialRoute, [WrapperFn wrapper]) {
+Widget testApp(NuRouter router, String initialRoute, [WrapperFn wrapper]) {
   return MaterialApp(
     builder: Nuvigator(
       router: router,
@@ -117,7 +117,8 @@ Widget testApp(Router router, String initialRoute, [WrapperFn wrapper]) {
   );
 }
 
-Future pumpApp(WidgetTester tester, Router router, String initialRoute) async {
+Future pumpApp(
+    WidgetTester tester, NuRouter router, String initialRoute) async {
   await tester.pumpWidget(MaterialApp(
     title: 'Test Nuvigator',
     builder: Nuvigator(