Changes timestamp to nullable

Author: mvanbeusekom

geocoding_platform_interface/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 5.0.0
+
+- **BREAKING CHANGES:**
+  - Changes the `Location.timestamp` field to allow `null` values. Not all 
+    platforms (e.g. Android) specify a timestamp indicating when the 
+    coordinates for an address where resolved.
+
 ## 4.0.0
 
 - **BREAKING CHANGES:**

geocoding_platform_interface/analysis_options.yaml

@@ -3,8 +3,21 @@ include: package:flutter_lints/flutter.yaml
 analyzer:
   exclude:
     # Ignore generated files
-    - '**/*.g.dart'
-    - 'lib/src/generated/*.dart'
+    - "**/*.g.dart"
+    - "lib/src/generated/*.dart"
 linter:
   rules:
-    - public_member_api_docs
+    - always_declare_return_types
+    - always_put_control_body_on_new_line
+    - always_specify_types
+    - avoid_bool_literals_in_conditional_expressions
+    - avoid_void_async
+    - directives_ordering
+    - eol_at_end_of_file
+    - exhaustive_cases
+    - prefer_final_in_for_each
+    - prefer_final_locals
+    - prefer_relative_imports
+    - public_member_api_docs
+    - require_trailing_commas
+    - unawaited_futures

geocoding_platform_interface/lib/legacy/src/models/location.dart

@@ -55,7 +55,7 @@ class Location {
     }
 
     final Map<dynamic, dynamic> locationMap = message;
-    final timestamp = DateTime.fromMillisecondsSinceEpoch(
+    final DateTime timestamp = DateTime.fromMillisecondsSinceEpoch(
       locationMap['timestamp'].toInt(),
       isUtc: true,
     );
@@ -75,7 +75,7 @@ class Location {
 
   /// Converts the [Location] instance into a [Map] instance that can be
   /// serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, dynamic>{
     'latitude': latitude,
     'longitude': longitude,
     'timestamp': timestamp.millisecondsSinceEpoch,

geocoding_platform_interface/lib/legacy/src/models/placemark.dart

@@ -131,7 +131,7 @@ class Placemark {
 
   /// Converts the [Placemark] instance into a [Map] instance that can be
   /// serialized to JSON.
-  Map<String, dynamic> toJson() => {
+  Map<String, dynamic> toJson() => <String, dynamic>{
     'name': name,
     'street': street,
     'isoCountryCode': isoCountryCode,

geocoding_platform_interface/lib/src/types/location.dart

@@ -10,7 +10,7 @@ class Location {
   const Location({
     required this.latitude,
     required this.longitude,
-    required this.timestamp,
+    this.timestamp,
   });
 
   /// The latitude associated with the placemark.
@@ -20,7 +20,10 @@ class Location {
   final double longitude;
 
   /// The UTC timestamp the coordinates have been requested.
-  final DateTime timestamp;
+  ///
+  /// If `null`, the time the coordinates have been determined is not known or
+  /// not provided by the platform (e.g. on Android).
+  final DateTime? timestamp;
 
   @override
   bool operator ==(Object other) =>

geocoding_platform_interface/pubspec.yaml

@@ -3,7 +3,7 @@ description: A common platform interface for the geocoding plugin.
 homepage: https://github.com/baseflow/flutter-geocoding/tree/main/geocoding_platform_interface
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 4.0.0
+version: 5.0.0
 
 environment:
   sdk: ^3.8.1

geocoding_platform_interface/test/legacy/geocoding_platform_interface_test.dart

@@ -33,7 +33,7 @@ void main() {
     });
 
     test('Can be mocked with `implements`', () {
-      final mock = MockGeocodingPlatform();
+      final MockGeocodingPlatform mock = MockGeocodingPlatform();
       GeocodingPlatform.instance = mock;
     });
 
@@ -42,7 +42,7 @@ void main() {
       'Default implementation of locationFromAddress should throw unimplemented error',
       () {
         // Arrange
-        final geocodingPlatform = ExtendsGeocodingPlatform();
+        final ExtendsGeocodingPlatform geocodingPlatform = ExtendsGeocodingPlatform();
 
         // Act & Assert
         expect(
@@ -57,7 +57,7 @@ void main() {
       'Default implementation of isPresent should throw unimplemented error',
       () {
         // Arrange
-        final geocodingPlatform = ExtendsGeocodingPlatform();
+        final ExtendsGeocodingPlatform geocodingPlatform = ExtendsGeocodingPlatform();
 
         // Act & Assert
         expect(() => geocodingPlatform.isPresent(), throwsUnimplementedError);
@@ -69,7 +69,7 @@ void main() {
       'Default implementation of placemarkFromCoordinates should throw unimplemented error',
       () {
         // Arrange
-        final geocodingPlatform = ExtendsGeocodingPlatform();
+        final ExtendsGeocodingPlatform geocodingPlatform = ExtendsGeocodingPlatform();
 
         // Act & Assert
         expect(
@@ -84,7 +84,7 @@ void main() {
       'Default implementation of setLocale should throw unimplemented error',
       () {
         // Arrange
-        final geocodingPlatform = ExtendsGeocodingPlatform();
+        final ExtendsGeocodingPlatform geocodingPlatform = ExtendsGeocodingPlatform();
 
         // Act & Assert
         expect(

geocoding_platform_interface/test/legacy/src/models/location_test.dart

@@ -7,12 +7,12 @@ void main() {
       'hashCode hould be the same for two instances with the same values',
       () {
         // Arrange
-        final firstLocation = Location(
+        final Location firstLocation = Location(
           latitude: 0,
           longitude: 0,
           timestamp: DateTime.fromMillisecondsSinceEpoch((0)),
         );
-        final secondLocation = Location(
+        final Location secondLocation = Location(
           latitude: 0,
           longitude: 0,
           timestamp: DateTime.fromMillisecondsSinceEpoch((0)),
@@ -27,12 +27,12 @@ void main() {
       'hashCode should not match when the latitude property is different',
       () {
         // Arrange
-        final firstLocation = Location(
+        final Location firstLocation = Location(
           latitude: 0,
           longitude: 0,
           timestamp: DateTime.fromMillisecondsSinceEpoch(0),
         );
-        final secondLocation = Location(
+        final Location secondLocation = Location(
           latitude: 1,
           longitude: 0,
           timestamp: DateTime.fromMillisecondsSinceEpoch(0),
@@ -47,12 +47,12 @@ void main() {
       'hashCode should not match when the longitude property is different',
       () {
         // Arrange
-        final firstLocation = Location(
+        final Location firstLocation = Location(
           latitude: 0,
           longitude: 0,
           timestamp: DateTime.fromMillisecondsSinceEpoch(0),
         );
-        final secondLocation = Location(
+        final Location secondLocation = Location(
           latitude: 0,
           longitude: 1,
           timestamp: DateTime.fromMillisecondsSinceEpoch(0),
@@ -67,12 +67,12 @@ void main() {
       'hashCode should not match when the timestamp property is different',
       () {
         // Arrange
-        final firstLocation = Location(
+        final Location firstLocation = Location(
           latitude: 0,
           longitude: 0,
           timestamp: DateTime.fromMillisecondsSinceEpoch(0),
         );
-        final secondLocation = Location(
+        final Location secondLocation = Location(
           latitude: 0,
           longitude: 0,
           timestamp: DateTime.fromMillisecondsSinceEpoch(1),
@@ -92,7 +92,7 @@ void main() {
     test(
       'fromMap throws argument error when latitude or longitude are null',
       () {
-        final location = <dynamic, dynamic>{
+        final Map<dynamic, dynamic> location = <dynamic, dynamic>{
           'latitude': null,
           'longitude': null,
           'timestamp': 1615216821218,
@@ -104,13 +104,13 @@ void main() {
 
   group('toString tests:', () {
     test('toString should list the contents of all properties', () {
-      final mockLocation = Location(
+      final Location mockLocation = Location(
         latitude: 52.2165157,
         longitude: 6.9437819,
         timestamp: DateTime.fromMillisecondsSinceEpoch(0).toUtc(),
       );
 
-      final expected =
+      final String expected =
           '''
       Latitude: ${mockLocation.latitude},
       Longitude: ${mockLocation.longitude},