feat: initial project

Author: jeroen-meijer

.gitignore

@@ -0,0 +1,78 @@
+# 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/
+pubspec.lock
+
+# 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/app.flx
+**/ios/Flutter/app.zip
+**/ios/Flutter/flutter_assets/
+**/ios/Flutter/flutter_export_environment.sh
+**/ios/ServiceDefinitions.json
+**/ios/Runner/GeneratedPluginRegistrant.*
+
+# Test related
+coverage
+
+# 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: adc687823a831bbebe28bdccfac1a628ca621513
+  channel: stable
+
+project_type: package

CHANGELOG.md

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

LICENSE

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

README.md

@@ -0,0 +1,18 @@
+# mock_navigator
+
+An experimental package that attempts to make it easy to mock Flutter's navigator routes.
+
+## Usage
+
+TODO
+
+## Getting Started
+
+This project is a starting point for a Dart
+[package](https://flutter.dev/developing-packages/),
+a library module containing code that can be shared easily across
+multiple Flutter or Dart projects.
+
+For help getting started with Flutter, view our
+[online documentation](https://flutter.dev/docs), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

analysis_options.yaml

@@ -0,0 +1 @@
+include: package:very_good_analysis/analysis_options.yaml

lib/mock_navigator.dart

@@ -0,0 +1,75 @@
+/// An experimental package that attempts to make it easy to mock Flutter's
+/// navigator routes.
+library mock_navigator;
+
+import 'package:flutter/material.dart';
+import 'package:mocktail/mocktail.dart' as mocktail;
+import 'package:mockito/mockito.dart' as mockito;
+
+/// A template fake route, useful for registering fallbacks when using the
+/// `mocktail` package.
+class FakeRoute<T> extends mocktail.Fake implements Route<T> {}
+
+/// {@template mock_navigator_provider}
+/// The widget that provides an instance of a [MockNavigator].
+/// {@endtemplate}
+class MockNavigatorProvider extends Navigator {
+  /// {@macro mock_navigator_provider}
+  const MockNavigatorProvider({
+    Key? key,
+    required this.child,
+    required this.navigator,
+  }) : super(key: key);
+
+  /// The [MockNavigator] used to mock navigation calls.
+  final MockNavigator navigator;
+
+  /// The [Widget] to render.
+  final Widget child;
+
+  @override
+  NavigatorState createState() {
+    return _MockNavigatorState(navigator: navigator)..child = child;
+  }
+
+  @override
+  RouteFactory? get onGenerateRoute {
+    return (_) => MaterialPageRoute(builder: (_) => child);
+  }
+}
+
+/// The navigator of which the behavior can be defined through using either the
+/// [MocktailNavigator] or [MockitoNavigator].a
+abstract class MockNavigator implements NavigatorState {}
+
+/// The navigator of which the behavior can be defined through mocking using the
+/// `mocktail` package.
+class MocktailNavigator extends mocktail.Mock
+    with _DiagnosticStringMixin
+    implements MockNavigator {}
+
+/// The navigator of which the behavior can be defined through mocking using the
+/// `mockito` package.
+class MockitoNavigator extends mocktail.Mock
+    with _DiagnosticStringMixin
+    implements MockNavigator {}
+
+mixin _DiagnosticStringMixin on Object {
+  @override
+  String toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) {
+    return super.toString();
+  }
+}
+
+class _MockNavigatorState extends NavigatorState {
+  _MockNavigatorState({required this.navigator});
+
+  MockNavigator navigator;
+  Widget? child;
+
+  @override
+  Future<T?> push<T extends Object?>(Route<T> route) => navigator.push(route);
+
+  @override
+  Widget build(BuildContext context) => child!;
+}

pubspec.yaml

@@ -0,0 +1,21 @@
+name: mock_navigator
+description: An experimental package that attempts to make it easy to mock
+  Flutter's navigator routes.
+version: 0.0.1
+homepage: https://github.com/jeroen-meijer/mock_navigator
+
+environment:
+  sdk: ">=2.12.0 <3.0.0"
+  flutter: ">=1.17.0"
+
+dependencies:
+  flutter:
+    sdk: flutter
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  coverage: 1.0.2
+  mockito: 5.0.5
+  mocktail: 0.1.1
+  very_good_analysis: 2.0.3

test/mock_navigator_test.dart

@@ -0,0 +1,65 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+import 'package:mock_navigator/mock_navigator.dart';
+import 'package:mocktail/mocktail.dart';
+
+extension on WidgetTester {
+  Future<void> pumpTest(Widget widget) async {
+    await pumpWidget(
+      MaterialApp(
+        title: 'Mock Navigator Test',
+        home: Scaffold(
+          body: widget,
+        ),
+      ),
+    );
+  }
+}
+
+void main() {
+  group('MockNavigator', () {
+    late MockNavigator navigator;
+
+    setUpAll(() {
+      registerFallbackValue<Route<Object?>>(FakeRoute<Object?>());
+    });
+
+    setUp(() {
+      navigator = MocktailNavigator();
+    });
+
+    testWidgets('mocks .push calls', (tester) async {
+      var pushCalled = 0;
+
+      when(() => navigator.push(any())).thenAnswer((_) async {
+        pushCalled++;
+        return null;
+      });
+
+      await tester.pumpTest(
+        MockNavigatorProvider(
+          navigator: navigator,
+          child: Builder(
+            builder: (context) {
+              return TextButton(
+                onPressed: () {
+                  Navigator.of(context).push(
+                    MaterialPageRoute(
+                      builder: (_) => const Text('I should not build.'),
+                    ),
+                  );
+                },
+                child: const Text('Trigger'),
+              );
+            },
+          ),
+        ),
+      );
+
+      await tester.tap(find.byType(TextButton));
+
+      expect(pushCalled, equals(1));
+    });
+  });
+}