Skip to content

Commit

Permalink
Merge pull request #223 from phackwer/master
Browse files Browse the repository at this point in the history 
Renames Router to ModularRouter to avoid conflicts with Flutter
  • Loading branch information
@jacobaraujo7
jacobaraujo7 committed Aug 21, 2020
2 parents ed32c65 + 4ba6116 commit c9f4a7b
Show file tree
Hide file tree
Showing 12 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion flutter_modular/lib/src/interfaces/child_module.dart
View file
Expand Up @@ -6,7 +6,7 @@ import '../routers/router.dart';
abstract class ChildModule {
List<Bind> _binds;
List<Bind> get binds;
List<Router> get routers;
List<ModularRouter> get routers;

ChildModule() {
_binds = binds;
Expand Down
8 changes: 4 additions & 4 deletions flutter_modular/lib/src/modular_base.dart
View file
Expand Up @@ -210,7 +210,7 @@ class Modular {
}

@visibleForTesting
static bool searchRoute(Router router, String routeNamed, String path) {
static bool searchRoute(ModularRouter router, String routeNamed, String path) {
if (routeNamed.split('/').length != path.split('/').length) {
return false;
}
Expand Down Expand Up @@ -279,7 +279,7 @@ class Modular {

static List<RouteGuard> _masterRouteGuards;

static Router _searchInModule(
static ModularRouter _searchInModule(
ChildModule module, String routerName, String path) {
path = "/$path".replaceAll('//', '/');
final routers = module.routers;
Expand All @@ -293,7 +293,7 @@ class Modular {
_masterRouteGuards = route.guards;
var _routerName =
('$routerName${route.routerName}/').replaceFirst('//', '/');
Router router;
ModularRouter router;
if (_routerName == path || _routerName == "$path/") {
final guard = _verifyGuard(route.guards, path);
if (guard != null) {
Expand Down Expand Up @@ -358,7 +358,7 @@ class Modular {
}

@visibleForTesting
static Router selectRoute(String path, [ChildModule module]) {
static ModularRouter selectRoute(String path, [ChildModule module]) {
if (path.isEmpty) {
throw Exception("Router can not be empty");
}
Expand Down
12 changes: 6 additions & 6 deletions flutter_modular/lib/src/routers/router.dart
View file
Expand Up @@ -15,7 +15,7 @@ _debugPrintModular(String text) {
}
}

class Router<T> {
class ModularRouter<T> {
///
/// Paramenter name: [routerName]
///
Expand Down Expand Up @@ -173,7 +173,7 @@ class Router<T> {
final RouteBuilder<T> routeGenerator;
final String modulePath;

Router(
ModularRouter(
this.routerName, {
this.module,
this.child,
Expand Down Expand Up @@ -218,7 +218,7 @@ class Router<T> {
TransitionType.leftToRightWithFade: leftToRightWithFade,
};

Router<T> copyWith(
ModularRouter<T> copyWith(
{Widget Function(BuildContext context, ModularArguments args) child,
String routerName,
ChildModule module,
Expand All @@ -228,7 +228,7 @@ class Router<T> {
RouteBuilder routeGenerator,
String modulePath,
CustomTransition customTransition}) {
return Router<T>(
return ModularRouter<T>(
routerName ?? this.routerName,
child: child ?? this.child,
module: module ?? this.module,
Expand All @@ -241,8 +241,8 @@ class Router<T> {
);
}

static List<Router> group({
@required List<Router> routes,
static List<ModularRouter> group({
@required List<ModularRouter> routes,
List<RouteGuard> guards,
TransitionType transition,
CustomTransition customTransition,
Expand Down
4 changes: 2 additions & 2 deletions flutter_modular/lib/src/widgets/module_widget.dart
View file
Expand Up @@ -48,7 +48,7 @@ abstract class WidgetModule extends StatelessWidget implements ChildModule {
}

@override
List<Router> get routers => null;
List<ModularRouter> get routers => null;

@override
Widget build(BuildContext context) {
Expand All @@ -70,7 +70,7 @@ class _FakeModule extends ChildModule {
List<Bind> get binds => bindsInject;

@override
List<Router> get routers => null;
List<ModularRouter> get routers => null;
}

class ModularProvider extends StatefulWidget {
Expand Down
4 changes: 2 additions & 2 deletions flutter_modular/lib/src/widgets/widget_module.dart
View file
Expand Up @@ -48,7 +48,7 @@ abstract class WidgetModule extends StatelessWidget implements ChildModule {
}

@override
List<Router> get routers => null;
List<ModularRouter> get routers => null;

@override
Widget build(BuildContext context) {
Expand All @@ -70,7 +70,7 @@ class _FakeModule extends ChildModule {
List<Bind> get binds => bindsInject;

@override
List<Router> get routers => null;
List<ModularRouter> get routers => null;
}

class ModularProvider extends StatefulWidget {
Expand Down
22 changes: 11 additions & 11 deletions flutter_modular/test/abstract_router_test.dart
View file
Expand Up @@ -7,12 +7,12 @@ class DynamicModule extends ChildModule {
List<Bind> get binds => [];

@override
List<Router> get routers => [
Router('/', child: (_, __) => Container()),
Router('/home', child: (_, __) => Container()),
Router('/product', child: (_, __) => Container()),
Router('/product/:id', child: (_, __) => Container()),
Router('/:id', child: (_, __) => Container()),
List<ModularRouter> get routers => [
ModularRouter('/', child: (_, __) => Container()),
ModularRouter('/home', child: (_, __) => Container()),
ModularRouter('/product', child: (_, __) => Container()),
ModularRouter('/product/:id', child: (_, __) => Container()),
ModularRouter('/:id', child: (_, __) => Container()),
];
}

Expand All @@ -22,23 +22,23 @@ main() {
});

group("Dynamic router", () {
test('Test Get Router', () {
test('Test Get ModularRouter', () {
var router = Modular.selectRoute("/");
expect(router.routerName, "/");
});
test('Test Get Router dynamic', () {
test('Test Get ModularRouter dynamic', () {
var router = Modular.selectRoute("/1");
expect(router.routerName, "/:id");
});
test('Test Get Router home', () {
test('Test Get ModularRouter home', () {
var router = Modular.selectRoute("/home");
expect(router.routerName, "/home");
});

test('Test Get Router product', () {
test('Test Get ModularRouter product', () {
expect(Modular.selectRoute("/product")?.routerName, "/product");
});
test('Test Get Router product id', () {
test('Test Get ModularRouter product id', () {
var router = Modular.selectRoute("/product/1");
expect(router.routerName, "/product/:id");
});
Expand Down
12 changes: 6 additions & 6 deletions flutter_modular/test/app/app_module.dart
View file
Expand Up @@ -18,21 +18,21 @@ class AppModule extends MainModule {
];

@override
List<Router> get routers => [
Router(
List<ModularRouter> get routers => [
ModularRouter(
"/forbidden",
child: (_, args) => ForbiddenWidget(),
guards: [MyGuard()],
transition: TransitionType.fadeIn,
),
Router(
ModularRouter(
"/",
module: HomeModule(),
transition: TransitionType.fadeIn,
),
Router("/home", module: HomeModule()),
Router("/prod", module: ProductModule()),
Router("/homeTwo", module: HomeModule(), guards: [MyGuard()]),
ModularRouter("/home", module: HomeModule()),
ModularRouter("/prod", module: ProductModule()),
ModularRouter("/homeTwo", module: HomeModule(), guards: [MyGuard()]),
];

@override
Expand Down
14 changes: 7 additions & 7 deletions flutter_modular/test/app/modules/home/home_module.dart
View file
Expand Up @@ -18,22 +18,22 @@ class HomeModule extends ChildModule {
];

@override
List<Router> get routers => [
Router(
List<ModularRouter> get routers => [
ModularRouter(
"/",
child: (_, args) => HomeWidget(),
transition: TransitionType.fadeIn,
),
Router(
ModularRouter(
"/forbidden2",
child: (_, args) => ForbiddenWidget(),
transition: TransitionType.fadeIn,
guards: [MyGuard()],
),
Router("/list/:id/:id2", child: (_, args) => HomeWidget()),
Router("/product", module: ProductModule()),
Router("/arguments", child: (_, args) => ArgumentsPage(id: args.data)),
Router("/modularArguments", child: (_, args) => ModularArgumentsPage()),
ModularRouter("/list/:id/:id2", child: (_, args) => HomeWidget()),
ModularRouter("/product", module: ProductModule()),
ModularRouter("/arguments", child: (_, args) => ArgumentsPage(id: args.data)),
ModularRouter("/modularArguments", child: (_, args) => ModularArgumentsPage()),
];
}

Expand Down
6 changes: 3 additions & 3 deletions flutter_modular/test/app/modules/product/product_module.dart
View file
Expand Up @@ -10,9 +10,9 @@ class ProductModule extends ChildModule {
];

@override
List<Router> get routers => [
Router("/:test", child: (_, args) => DetailsPage(id: 1)),
Router("/product", child: (_, args) => ProductPage()),
List<ModularRouter> get routers => [
ModularRouter("/:test", child: (_, args) => DetailsPage(id: 1)),
ModularRouter("/product", child: (_, args) => ProductPage()),
];
}

Expand Down
4 changes: 2 additions & 2 deletions flutter_modular/test/modular_stack_overflow_test.dart
View file
Expand Up @@ -30,7 +30,7 @@ class ModuleStackOverflowMock extends ChildModule {
];

@override
List<Router> get routers => [];
List<ModularRouter> get routers => [];
}

class ObjectController {
Expand All @@ -56,7 +56,7 @@ class ModuleStackOverflowMockNotError extends ChildModule {
];

@override
List<Router> get routers => [];
List<ModularRouter> get routers => [];
}

class HomeController {
Expand Down
32 changes: 16 additions & 16 deletions flutter_modular/test/modular_test.dart
View file
Expand Up @@ -9,12 +9,12 @@ void main() {
});

group("Group router", () {
test('Test Get Router', () {
expect(Modular.selectRoute("/"), isA<Router>());
test('Test Get ModularRouter', () {
expect(Modular.selectRoute("/"), isA<ModularRouter>());
});
test('Test Get module Router', () {
expect(Modular.selectRoute("home/"), isA<Router>());
expect(Modular.selectRoute("/home/"), isA<Router>());
test('Test Get module ModularRouter', () {
expect(Modular.selectRoute("home/"), isA<ModularRouter>());
expect(Modular.selectRoute("/home/"), isA<ModularRouter>());
var router = Modular.selectRoute("/home");
expect(router.routerName, '/');
});
Expand All @@ -30,9 +30,9 @@ void main() {
'/home/list/(.*?)/item/(.*?)');
});

test('search object Router to url', () {
test('search object ModularRouter to url', () {
var router =
Router('/home/list/:id', child: (_, __) => SizedBox.shrink());
ModularRouter('/home/list/:id', child: (_, __) => SizedBox.shrink());

expect(
Modular.searchRoute(router, "/home/list/:id", "/home/list/1"), true);
Expand All @@ -47,48 +47,48 @@ void main() {

expect(
Modular.searchRoute(
Router('/home/list', child: (_, __) => SizedBox.shrink()),
ModularRouter('/home/list', child: (_, __) => SizedBox.shrink()),
"/home/list",
"/home/list/1"),
false);
});

test('search object Router to url String', () {
test('search object ModularRouter to url String', () {
var router =
Router('/home/list/:id', child: (_, __) => SizedBox.shrink());
ModularRouter('/home/list/:id', child: (_, __) => SizedBox.shrink());

expect(
Modular.searchRoute(router, "/home/list/:id", "/home/list/01"), true);
expect(router.params['id'], "01");

expect(
Modular.searchRoute(
Router('/home/list', child: (_, __) => SizedBox.shrink()),
ModularRouter('/home/list', child: (_, __) => SizedBox.shrink()),
"/home/list",
"/home/list/01"),
false);
});

test('router with params get', () {
expect(Modular.selectRoute("/list/1/2"), isA<Router>());
expect(Modular.selectRoute("/list/1/2"), isA<ModularRouter>());
expect(Modular.selectRoute("/home/test"), null);
});
test('router with params get multiple', () {
var a = Modular.selectRoute("/home/list/1/2");
expect(a, isA<Router>());
expect(a, isA<ModularRouter>());
});
test('router with params get multiple 2 modules', () {
expect(Modular.selectRoute("/home/product/"), isA<Router>());
expect(Modular.selectRoute("/home/product/"), isA<ModularRouter>());
});

test('modulePath', () {
var router = Modular.selectRoute("/home/product/");

expect(router, isA<Router>());
expect(router, isA<ModularRouter>());
expect(router.modulePath, "/home/product");

router = Modular.selectRoute("/home/product/1");
expect(router, isA<Router>());
expect(router, isA<ModularRouter>());
expect(router.modulePath, "/home/product");
});

Expand Down
10 changes: 5 additions & 5 deletions flutter_modular/test/routers/router_test.dart
View file
Expand Up @@ -7,22 +7,22 @@ class TestModule extends ChildModule {
List<Bind> get binds => [];

@override
List<Router> get routers => [];
List<ModularRouter> get routers => [];

}

void main() {
test('throws assertionError routeName is null', () {
expect(() => Router(null), throwsAssertionError);
expect(() => ModularRouter(null), throwsAssertionError);
});

test('throws ArgumentError if module or child was not provide', () {
expect(() => Router('/'), throwsArgumentError);
expect(() => ModularRouter('/'), throwsArgumentError);
});

test('throws ArgumentError if both the module and child was provided', () {
expect(() {
Router('/',
ModularRouter('/',
module: TestModule(),
child: (_, __) => SizedBox.shrink()
);
Expand All @@ -31,7 +31,7 @@ void main() {

test('throws ArgumentError if transaction is null', () {
expect(() {
Router('/',
ModularRouter('/',
child: (_, __) => SizedBox.shrink(),
transition: null,
);
Expand Down

0 comments on commit c9f4a7b

Please sign in to comment.