chore: update linter and apply new rules (#12)

* chore: update linter and apply new rules

* update example to support new linter rules

Author: jeroen-meijer

analysis_options.yaml

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

example/analysis_options.yaml

@@ -1,4 +1,4 @@
-include: package:very_good_analysis/analysis_options.yaml
+include: package:very_good_analysis/analysis_options.2.3.0.yaml
 linter:
   rules:
     public_member_api_docs: false

example/lib/app.dart

@@ -1,7 +1,6 @@
+import 'package:example/ui/ui.dart';
 import 'package:flutter/material.dart';
 
-import 'ui/ui.dart';
-
 class App extends StatelessWidget {
   const App({Key? key}) : super(key: key);
 

example/lib/ui/home_screen.dart

@@ -3,9 +3,14 @@ import 'dart:io';
 import 'package:example/ui/ui.dart';
 import 'package:flutter/material.dart';
 
-class HomeScreen extends StatelessWidget {
+class HomeScreen extends StatefulWidget {
   const HomeScreen({Key? key}) : super(key: key);
 
+  @override
+  _HomeScreenState createState() => _HomeScreenState();
+}
+
+class _HomeScreenState extends State<HomeScreen> {
   Future<void> _showPincodeScreen(BuildContext context) async {
     final result = await Navigator.of(context).push(PincodeScreen.route());
 
@@ -17,14 +22,16 @@ class HomeScreen extends StatelessWidget {
       snackBarContent = 'Pincode is "$result" 🔒';
     }
 
-    ScaffoldMessenger.of(context)
-      ..removeCurrentSnackBar()
-      ..showSnackBar(
-        SnackBar(
-          behavior: SnackBarBehavior.floating,
-          content: Text(snackBarContent),
-        ),
-      );
+    if (mounted) {
+      ScaffoldMessenger.of(context)
+        ..removeCurrentSnackBar()
+        ..showSnackBar(
+          SnackBar(
+            behavior: SnackBarBehavior.floating,
+            content: Text(snackBarContent),
+          ),
+        );
+    }
   }
 
   Future<void> _showQuizDialog(BuildContext context) async {
@@ -40,14 +47,16 @@ class HomeScreen extends StatelessWidget {
       snackBarContent = 'Hamburger all the way! 🍔';
     }
 
-    ScaffoldMessenger.of(context)
-      ..removeCurrentSnackBar()
-      ..showSnackBar(
-        SnackBar(
-          behavior: SnackBarBehavior.floating,
-          content: Text(snackBarContent),
-        ),
-      );
+    if (mounted) {
+      ScaffoldMessenger.of(context)
+        ..removeCurrentSnackBar()
+        ..showSnackBar(
+          SnackBar(
+            behavior: SnackBarBehavior.floating,
+            content: Text(snackBarContent),
+          ),
+        );
+    }
   }
 
   @override
@@ -64,17 +73,15 @@ class HomeScreen extends StatelessWidget {
           textAlign: TextAlign.center,
           child: SingleChildScrollView(
             child: Padding(
-              padding: const EdgeInsets.all(32.0),
+              padding: const EdgeInsets.all(32),
               child: Column(
-                crossAxisAlignment: CrossAxisAlignment.center,
                 mainAxisAlignment: MainAxisAlignment.center,
-                mainAxisSize: MainAxisSize.max,
                 children: [
                   Text(
                     'This is an example app showcasing the Mockingjay library.',
                     style: theme.textTheme.headline6,
                   ),
-                  const SizedBox(height: 8.0),
+                  const SizedBox(height: 8),
                   Text.rich(
                     TextSpan(
                       children: [
@@ -97,7 +104,7 @@ class HomeScreen extends StatelessWidget {
                     ),
                     style: TextStyle(color: theme.disabledColor),
                   ),
-                  const SizedBox(height: 32.0),
+                  const SizedBox(height: 32),
                   TextButton.icon(
                     key: const Key('homeScreen_showPincodeScreen_textButton'),
                     onPressed: () => _showPincodeScreen(context),

example/lib/ui/pincode_screen.dart

@@ -62,24 +62,21 @@ class _PincodeScreenState extends State<PincodeScreen> {
           textAlign: TextAlign.center,
           child: SingleChildScrollView(
             child: Padding(
-              padding: const EdgeInsets.all(32.0),
+              padding: const EdgeInsets.all(32),
               child: Column(
-                crossAxisAlignment: CrossAxisAlignment.center,
                 mainAxisAlignment: MainAxisAlignment.center,
-                mainAxisSize: MainAxisSize.max,
                 children: [
                   const Text('Enter a pincode to continue.'),
-                  const SizedBox(height: 32.0),
+                  const SizedBox(height: 32),
                   TextField(
                     autofocus: true,
                     minLines: 1,
-                    maxLines: 1,
                     maxLength: 6,
                     maxLengthEnforcement: MaxLengthEnforcement.enforced,
                     obscureText: true,
                     style: TextStyle(
                       fontFamily: monospaceFontFamily,
-                      fontSize: 48.0,
+                      fontSize: 48,
                     ),
                     decoration: InputDecoration(
                       errorText: _errorText,

example/pubspec.yaml

@@ -8,16 +8,20 @@ environment:
   flutter: ">=1.17.0"
 
 dependencies:
+  bloc: ^7.0.0
+  equatable: ^2.0.3
   flutter:
     sdk: flutter
+  flutter_bloc: ^7.1.0
 
 dev_dependencies:
+  bloc_test: ^8.1.0
   flutter_test:
     sdk: flutter
-  mocktail: ^0.1.4
-  very_good_analysis: 2.1.2
   mockingjay:
     path: ../
+  mocktail: ^0.1.4
+  very_good_analysis: ^2.3.0
 
 flutter:
   uses-material-design: true

lib/src/mock_navigator.dart

@@ -29,7 +29,7 @@ class MockNavigatorProvider extends Navigator {
 
   @override
   RouteFactory? get onGenerateRoute {
-    return (_) => MaterialPageRoute(builder: (_) => child);
+    return (_) => MaterialPageRoute<dynamic>(builder: (_) => child);
   }
 }
 
@@ -41,7 +41,7 @@ class MockNavigator extends Mock
     implements NavigatorState {
   /// {@macro mock_navigator}
   MockNavigator() {
-    registerFallbackValue(_FakeRoute());
+    registerFallbackValue(_FakeRoute<dynamic>());
   }
 }
 
@@ -64,10 +64,10 @@ class _MockNavigatorState extends NavigatorState {
 
   final MockNavigator _navigator;
 
-  Widget? _child;
+  late Widget _child;
 
   @override
-  Widget build(BuildContext context) => _child!;
+  Widget build(BuildContext context) => _child;
 
   @override
   Future<T?> push<T extends Object?>(Route<T> route) {

pubspec.yaml

@@ -1,5 +1,6 @@
 name: mockingjay
-description: A package that makes it easy to mock, test and verify navigation calls in Flutter.
+description: A package that makes it easy to mock, test and verify navigation
+  calls in Flutter.
 version: 0.1.0
 homepage: https://github.com/VeryGoodOpenSource/mockingjay
 
@@ -10,10 +11,10 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  test: ^1.16.8
   mocktail: ^0.1.4
+  test: ^1.16.8
 
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  very_good_analysis: ^2.1.2
+  very_good_analysis: ^2.3.0

test/src/example_test.dart

@@ -19,7 +19,7 @@ class MyHomePage extends StatelessWidget {
 class MySettingsPage extends StatelessWidget {
   const MySettingsPage({Key? key}) : super(key: key);
 
-  static Route route() {
+  static Route<void> route() {
     return MaterialPageRoute(
       builder: (_) => const MySettingsPage(),
       settings: const RouteSettings(name: '/settings'),

test/src/matchers_test.dart

@@ -2,6 +2,19 @@ import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:mockingjay/mockingjay.dart';
 
+Future<void> expectToFail(
+  dynamic actual,
+  Matcher matcher, {
+  required String withMessage,
+}) async {
+  try {
+    await expectLater(actual, matcher);
+    fail('TestFailure expected but not thrown');
+  } on TestFailure catch (error) {
+    expect(error.message, contains(withMessage));
+  }
+}
+
 void main() {
   group('Matchers', () {
     group('isRoute', () {
@@ -14,66 +27,72 @@ void main() {
 
       group('without arguments', () {
         test('matches any route', () {
-          expect(createRoute(), isRoute());
-          expect(createRoute<String>(), isRoute());
-          expect(createRoute('/test'), isRoute());
-          expect(createRoute<String>('/test'), isRoute());
+          expect(createRoute<dynamic>(), isRoute<dynamic>());
+          expect(createRoute<String>(), isRoute<dynamic>());
+          expect(createRoute<dynamic>('/test'), isRoute<dynamic>());
+          expect(createRoute<String>('/test'), isRoute<dynamic>());
         });
 
         test('does not match anything that is not a route', () {
-          expectToFail(1, isRoute(), withMessage: 'is not a route');
-          expectToFail('a', isRoute(), withMessage: 'is not a route');
-          expectToFail(null, isRoute(), withMessage: 'is not a route');
+          expectToFail(1, isRoute<dynamic>(), withMessage: 'is not a route');
+          expectToFail('a', isRoute<dynamic>(), withMessage: 'is not a route');
+          expectToFail(null, isRoute<dynamic>(), withMessage: 'is not a route');
           expectToFail(
             const SizedBox(),
-            isRoute(),
+            isRoute<dynamic>(),
             withMessage: 'is not a route',
           );
         });
       });
 
       group('with name argument', () {
         test('matches any route with correct name', () {
-          expect(createRoute('/test'), isRoute(named: '/test'));
-          expect(createRoute<String>('/test'), isRoute(named: '/test'));
+          expect(
+            createRoute<dynamic>('/test'),
+            isRoute<dynamic>(named: '/test'),
+          );
+          expect(
+            createRoute<String>('/test'),
+            isRoute<dynamic>(named: '/test'),
+          );
         });
 
         test('does not match anything that is not a route with that name', () {
           expectToFail(
-            createRoute(),
-            isRoute(named: '/test'),
+            createRoute<dynamic>(),
+            isRoute<dynamic>(named: '/test'),
             withMessage:
                 'is a route with the wrong name (actually, no name at all)',
           );
           expectToFail(
             createRoute<String>(),
-            isRoute(named: '/test'),
+            isRoute<dynamic>(named: '/test'),
             withMessage:
                 'is a route with the wrong name (actually, no name at all)',
           );
           expectToFail(
-            createRoute('/other_name'),
-            isRoute(named: '/test'),
+            createRoute<dynamic>('/other_name'),
+            isRoute<dynamic>(named: '/test'),
             withMessage: 'is a route with the wrong name ("/other_name")',
           );
           expectToFail(
             1,
-            isRoute(named: '/test'),
+            isRoute<dynamic>(named: '/test'),
             withMessage: 'is not a route',
           );
           expectToFail(
             'a',
-            isRoute(named: '/test'),
+            isRoute<dynamic>(named: '/test'),
             withMessage: 'is not a route',
           );
           expectToFail(
             null,
-            isRoute(named: '/test'),
+            isRoute<dynamic>(named: '/test'),
             withMessage: 'is not a route',
           );
           expectToFail(
             const SizedBox(),
-            isRoute(named: '/test'),
+            isRoute<dynamic>(named: '/test'),
             withMessage: 'is not a route',
           );
         });
@@ -87,13 +106,13 @@ void main() {
 
         test('does not match anything that is not a route of that type', () {
           expectToFail(
-            createRoute(),
+            createRoute<dynamic>(),
             isRoute<String>(),
             withMessage:
                 'is a route of the wrong type (MaterialPageRoute<dynamic>)',
           );
           expectToFail(
-            createRoute('/test'),
+            createRoute<dynamic>('/test'),
             isRoute<String>(),
             withMessage:
                 'is a route of the wrong type (MaterialPageRoute<dynamic>)',
@@ -116,14 +135,14 @@ void main() {
 
         test('does not match anything that is not a route of that type', () {
           expectToFail(
-            createRoute(),
+            createRoute<dynamic>(),
             isRoute<String>(named: '/test'),
             withMessage:
                 'is a route of the wrong type (MaterialPageRoute<dynamic>) '
                 'and name (actually, no name at all)',
           );
           expectToFail(
-            createRoute('/test'),
+            createRoute<dynamic>('/test'),
             isRoute<String>(named: '/test'),
             withMessage:
                 'is a route of the wrong type (MaterialPageRoute<dynamic>)',
@@ -159,16 +178,3 @@ void main() {
     });
   });
 }
-
-Future<void> expectToFail(
-  dynamic actual,
-  Matcher matcher, {
-  required String withMessage,
-}) async {
-  try {
-    await expectLater(actual, matcher);
-    fail('TestFailure expected but not thrown');
-  } on TestFailure catch (error) {
-    expect(error.message, contains(withMessage));
-  }
-}