Merge pull request #1 from CillianMyles/null-safety

Null Safety

Author: CillianMyles

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.9.0-nullsafety.0] - 2021/03/07
+
+* Migrate library to use sound null safety
+
 ## [0.0.3] - 2021/02/13
 
 * Initial release v3 (better description => improved pub.dev score)

README.md

@@ -1,19 +1,20 @@
-# TapCanvas
+# 🚰 TapCanvas
 
 Detect taps outside the currently defined widget and provide a callback when taps occur.
 
-## Example 
+## Example
 
 ```dart
 void main() {
   runApp(const MyApp());
 }
 
 class MyApp extends StatelessWidget {
-  const MyApp({Key key}) : super(key: key);
+  const MyApp({Key? key}) : super(key: key);
 
   @override
-  Widget build(BuildContext context) => MaterialApp(
+  Widget build(BuildContext context) =>
+      MaterialApp(
         title: 'Tap Canvas Demo',
         theme: ThemeData(
           primarySwatch: Colors.grey,
@@ -27,7 +28,7 @@ class MyApp extends StatelessWidget {
 }
 
 class DemoPage extends StatefulWidget {
-  const DemoPage({Key key}) : super(key: key);
+  const DemoPage({Key? key}) : super(key: key);
 
   @override
   DemoPageState createState() => DemoPageState();
@@ -56,7 +57,8 @@ class DemoPageState extends State<DemoPage> {
   }
 
   @override
-  Widget build(BuildContext context) => TapCanvas(
+  Widget build(BuildContext context) =>
+      TapCanvas(
         child: Row(
           children: [
             Container(
@@ -108,16 +110,3 @@ class DemoPageState extends State<DemoPage> {
       );
 }
 ```
-
-## TODOs
-
-- [ ] Create better demo app to show off use case
-- [x] Add documentation for public classes / methods
-- [x] Add test coverage
-- [ ] Add more convenience widgets e.g. `TapOutsideDismissFocusWidget`
-- [x] Example to README
-- [x] Install guide (handled by pub.dev)
-- [ ] Screenshots / GIF of demo
-- [ ] Automate tests
-- [ ] Display code coverage % badge
-- [x] Upload to pub.dev

example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -6,7 +6,7 @@ void main() {
 }
 
 class MyApp extends StatelessWidget {
-  const MyApp({Key key}) : super(key: key);
+  const MyApp({Key? key}) : super(key: key);
 
   @override
   Widget build(BuildContext context) => MaterialApp(
@@ -23,7 +23,7 @@ class MyApp extends StatelessWidget {
 }
 
 class DemoPage extends StatefulWidget {
-  const DemoPage({Key key}) : super(key: key);
+  const DemoPage({Key? key}) : super(key: key);
 
   @override
   DemoPageState createState() => DemoPageState();

example/lib/main.dart

@@ -7,14 +7,14 @@ packages:
       name: characters
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0-nullsafety.5"
+    version: "1.1.0"
   collection:
     dependency: transitive
     description:
       name: collection
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.15.0-nullsafety.5"
+    version: "1.15.0"
   cupertino_icons:
     dependency: "direct main"
     description:
@@ -33,7 +33,7 @@ packages:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0-nullsafety.6"
+    version: "1.3.0"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -52,14 +52,14 @@ packages:
       name: typed_data
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0-nullsafety.5"
+    version: "1.3.0"
   vector_math:
     dependency: transitive
     description:
       name: vector_math
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.0-nullsafety.5"
+    version: "2.1.0"
 sdks:
-  dart: ">=2.12.0-0 <3.0.0"
+  dart: ">=2.12.0 <3.0.0"
   flutter: ">=1.17.0"

example/pubspec.lock

@@ -4,10 +4,10 @@ publish_to: 'none'
 version: 1.0.0+1
 
 environment:
-  sdk: ">=2.7.0 <3.0.0"
+  sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
-  cupertino_icons: "^1.0.2"
+  cupertino_icons: ^1.0.2
   flutter:
     sdk: flutter
   tap_canvas:

example/pubspec.yaml

@@ -12,10 +12,9 @@ import 'package:tap_canvas/src/tap_outside_detector_widget.dart';
 /// such that it could lower the area of "taps outside" tracking.
 class TapCanvas extends StatefulWidget {
   const TapCanvas({
-    @required this.child,
-    Key key,
-  })  : assert(child != null),
-        super(key: key);
+    required this.child,
+    Key? key,
+  }) : super(key: key);
 
   final Widget child;
 

lib/src/tap_canvas.dart

@@ -10,16 +10,14 @@ import 'package:tap_canvas/src/tap_canvas.dart';
 @immutable
 class TapOffsetProvider extends InheritedWidget {
   const TapOffsetProvider({
-    @required this.stream,
-    @required Widget child,
-    Key key,
-  })  : assert(stream != null),
-        assert(child != null),
-        super(key: key, child: child);
+    required this.stream,
+    required Widget child,
+    Key? key,
+  }) : super(key: key, child: child);
 
   final Stream<Offset> stream;
 
-  static TapOffsetProvider of(BuildContext context) =>
+  static TapOffsetProvider? of(BuildContext context) =>
       context.dependOnInheritedWidgetOfExactType<TapOffsetProvider>();
 
   @override

lib/src/tap_offset_provider.dart

@@ -11,25 +11,23 @@ import 'package:tap_canvas/src/tap_offset_provider.dart';
 /// focus and text input when something outside of it is interacted with.
 class TapOutsideDetectorWidget extends StatefulWidget {
   const TapOutsideDetectorWidget({
-    @required this.child,
-    @required this.onTappedOutside,
+    required this.child,
+    required this.onTappedOutside,
     this.onTappedInside,
-    Key key,
-  })  : assert(child != null),
-        assert(onTappedOutside != null),
-        super(key: key);
+    Key? key,
+  }) : super(key: key);
 
   final Widget child;
   final VoidCallback onTappedOutside;
-  final VoidCallback onTappedInside;
+  final VoidCallback? onTappedInside;
 
   @override
   _TapOutsideDetectorWidgetState createState() =>
       _TapOutsideDetectorWidgetState();
 }
 
 class _TapOutsideDetectorWidgetState extends State<TapOutsideDetectorWidget> {
-  StreamSubscription<Offset> _tapOffsetSubscription;
+  StreamSubscription<Offset>? _tapOffsetSubscription;
 
   @override
   void dispose() {
@@ -41,7 +39,7 @@ class _TapOutsideDetectorWidgetState extends State<TapOutsideDetectorWidget> {
   void didChangeDependencies() {
     super.didChangeDependencies();
     _tapOffsetSubscription ??=
-        TapOffsetProvider?.of(context)?.stream?.listen(_handleTap);
+        TapOffsetProvider?.of(context)?.stream.listen(_handleTap);
   }
 
   void _handleTap(Offset position) {

lib/src/tap_outside_detector_widget.dart

@@ -7,49 +7,49 @@ packages:
       name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.5.0-nullsafety.3"
+    version: "2.5.0"
   boolean_selector:
     dependency: transitive
     description:
       name: boolean_selector
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.0-nullsafety.3"
+    version: "2.1.0"
   characters:
     dependency: transitive
     description:
       name: characters
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0-nullsafety.5"
+    version: "1.1.0"
   charcode:
     dependency: transitive
     description:
       name: charcode
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0-nullsafety.3"
+    version: "1.2.0"
   clock:
     dependency: transitive
     description:
       name: clock
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0-nullsafety.3"
+    version: "1.1.0"
   collection:
     dependency: transitive
     description:
       name: collection
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.15.0-nullsafety.5"
+    version: "1.15.0"
   fake_async:
     dependency: transitive
     description:
       name: fake_async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0-nullsafety.3"
+    version: "1.2.0"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -60,27 +60,41 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
+  flutter_test_ui:
+    dependency: "direct dev"
+    description:
+      name: flutter_test_ui
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.0-nullsafety.0"
   matcher:
     dependency: transitive
     description:
       name: matcher
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.12.10-nullsafety.3"
+    version: "0.12.10"
   meta:
     dependency: transitive
     description:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0-nullsafety.6"
+    version: "1.3.0"
+  mocktail:
+    dependency: "direct dev"
+    description:
+      name: mocktail
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.0.2-dev.2"
   path:
     dependency: transitive
     description:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0-nullsafety.3"
+    version: "1.8.0"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -92,56 +106,56 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0-nullsafety.4"
+    version: "1.8.0"
   stack_trace:
     dependency: transitive
     description:
       name: stack_trace
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.10.0-nullsafety.6"
+    version: "1.10.0"
   stream_channel:
     dependency: transitive
     description:
       name: stream_channel
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.0-nullsafety.3"
+    version: "2.1.0"
   string_scanner:
     dependency: transitive
     description:
       name: string_scanner
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0-nullsafety.3"
+    version: "1.1.0"
   term_glyph:
     dependency: transitive
     description:
       name: term_glyph
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0-nullsafety.3"
+    version: "1.2.0"
   test_api:
     dependency: transitive
     description:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.2.19-nullsafety.6"
+    version: "0.2.19"
   typed_data:
     dependency: transitive
     description:
       name: typed_data
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0-nullsafety.5"
+    version: "1.3.0"
   vector_math:
     dependency: transitive
     description:
       name: vector_math
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.0-nullsafety.5"
+    version: "2.1.0"
 sdks:
-  dart: ">=2.12.0-0.0 <3.0.0"
+  dart: ">=2.12.0 <3.0.0"
   flutter: ">=1.17.0"