make 'extensions' as nested maps

kb0 · Dec 5, 2024 · d563967 · d563967
1 parent 426a6e9
commit d563967
Show file tree

Hide file tree

Showing 13 changed files with 94 additions and 56 deletions.
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -5,7 +5,7 @@ linter:
     - always_declare_return_types
     - always_put_control_body_on_new_line
     - always_put_required_named_parameters_first
-    - always_require_non_null_named_parameters
+    # - always_require_non_null_named_parameters
     # - always_specify_types
     - annotate_overrides
     - avoid_annotating_with_dynamic
@@ -26,8 +26,8 @@ linter:
     - avoid_relative_lib_imports
     - avoid_renaming_method_parameters
     - avoid_return_types_on_setters
-    - avoid_returning_null
-    - avoid_returning_null_for_future
+    # - avoid_returning_null
+    # - avoid_returning_null_for_future
     - avoid_returning_null_for_void
     - avoid_returning_this
     - avoid_setters_without_getters

diff --git a/lib/src/gpx_reader.dart b/lib/src/gpx_reader.dart
@@ -379,6 +379,39 @@ class GpxReader {
     return string;
   }
 
+  Object? _readMap(Iterator<XmlEvent> iterator, String tagName) {
+    final elm = iterator.current;
+    if (!(elm is XmlStartElementEvent &&
+        elm.name == tagName &&
+        !elm.isSelfClosing)) {
+      return null;
+    }
+
+    final valueMap = <String, Object>{};
+    String? valueText;
+    while (iterator.moveNext()) {
+      final val = iterator.current;
+
+      if (val is XmlStartElementEvent) {
+        valueMap[val.name] = _readMap(iterator, val.name) ?? {};
+      }
+
+      if (val is XmlTextEvent) {
+        valueText = val.value;
+      }
+
+      if (val is XmlCDATAEvent) {
+        valueText = val.value;
+      }
+
+      if (val is XmlEndElementEvent && val.name == tagName) {
+        break;
+      }
+    }
+
+    return valueMap.isNotEmpty ? valueMap : valueText;
+  }
+
   Trkseg _readSegment(Iterator<XmlEvent> iterator) {
     final trkseg = Trkseg();
     final elm = iterator.current;
@@ -407,31 +440,9 @@ class GpxReader {
     return trkseg;
   }
 
-  Map<String, String> _readExtensions(Iterator<XmlEvent> iterator) {
-    final exts = <String, String>{};
-    final elm = iterator.current;
-
-    /*if (elm is XmlStartElementEvent) {
-      link.href = elm.attributes
-          .firstWhere((attr) => attr.name == GpxTagV11.href)
-          .value;
-    }*/
-
-    if ((elm is XmlStartElementEvent) && !elm.isSelfClosing) {
-      while (iterator.moveNext()) {
-        final val = iterator.current;
-
-        if (val is XmlStartElementEvent) {
-          exts[val.name] = _readString(iterator, val.name) ?? '';
-        }
-
-        if (val is XmlEndElementEvent && val.name == GpxTagV11.extensions) {
-          break;
-        }
-      }
-    }
-
-    return exts;
+  Map<String, Object> _readExtensions(Iterator<XmlEvent> iterator) {
+    final exts = _readMap(iterator, GpxTagV11.extensions) ?? {};
+    return (exts is Map<String, Object>) ? exts : {};
   }
 
   Link _readLink(Iterator<XmlEvent> iterator) {

diff --git a/lib/src/gpx_writer.dart b/lib/src/gpx_writer.dart
@@ -191,7 +191,7 @@ class GpxWriter {
     }
   }
 
-  void _writeExtensions(XmlBuilder builder, Map<String, String>? value) {
+  void _writeExtensions(XmlBuilder builder, Map<String, Object>? value) {
     if (value != null && value.isNotEmpty) {
       builder.element(GpxTagV11.extensions, nest: () {
         value.forEach((k, v) {
@@ -216,7 +216,15 @@ class GpxWriter {
 
   void _writeElement(XmlBuilder builder, String tagName, Object? value) {
     if (value != null) {
-      builder.element(tagName, nest: value);
+      if (value is Map) {
+        builder.element(tagName, nest: () {
+          value.forEach((k, v) {
+            _writeElement(builder, k, v);
+          });
+        });
+      } else {
+        builder.element(tagName, nest: value);
+      }
     }
   }
 

diff --git a/lib/src/model/gpx.dart b/lib/src/model/gpx.dart
@@ -32,7 +32,7 @@ class Gpx {
 
   /// You can add extend GPX by adding your own elements from another schema
   /// here.
-  Map<String, String> extensions = {};
+  Map<String, Object> extensions = {};
 
   @override
   // ignore: type_annotate_public_apis
@@ -44,7 +44,7 @@ class Gpx {
           const ListEquality().equals(other.wpts, wpts) &&
           const ListEquality().equals(other.rtes, rtes) &&
           const ListEquality().equals(other.trks, trks) &&
-          const MapEquality().equals(other.extensions, extensions);
+          const DeepCollectionEquality().equals(other.extensions, extensions);
     }
 
     return false;

diff --git a/lib/src/model/metadata.dart b/lib/src/model/metadata.dart
@@ -38,7 +38,7 @@ class Metadata {
 
   /// You can add extend GPX by adding your own elements from another schema
   /// here.
-  Map<String, String> extensions = {};
+  Map<String, Object> extensions = {};
 
   /// Construct a new [Metadata] object.
   Metadata(
@@ -50,9 +50,9 @@ class Metadata {
       this.time,
       this.keywords,
       this.bounds,
-      Map<String, String>? extensions})
+      Map<String, Object>? extensions})
       : links = links ?? [],
-        extensions = extensions ?? <String, String>{};
+        extensions = extensions ?? <String, Object>{};
 
   @override
   // ignore: type_annotate_public_apis
@@ -66,7 +66,7 @@ class Metadata {
           other.time == time &&
           other.keywords == keywords &&
           other.bounds == bounds &&
-          const MapEquality().equals(other.extensions, extensions);
+          const DeepCollectionEquality().equals(other.extensions, extensions);
     }
 
     return false;

diff --git a/lib/src/model/rte.dart b/lib/src/model/rte.dart
@@ -31,7 +31,7 @@ class Rte {
 
   /// You can add extend GPX by adding your own elements from another schema
   /// here.
-  Map<String, String> extensions;
+  Map<String, Object> extensions;
 
   /// A list of route points.
   List<Wpt> rtepts;
@@ -45,10 +45,10 @@ class Rte {
       List<Link>? links,
       this.number,
       this.type,
-      Map<String, String>? extensions,
+      Map<String, Object>? extensions,
       List<Wpt>? rtepts})
       : links = links ?? [],
-        extensions = extensions ?? <String, String>{},
+        extensions = extensions ?? <String, Object>{},
         rtepts = rtepts ?? [];
 
   @override
@@ -62,7 +62,7 @@ class Rte {
           const ListEquality().equals(other.links, links) &&
           other.number == number &&
           other.type == type &&
-          const MapEquality().equals(other.extensions, extensions) &&
+          const DeepCollectionEquality().equals(other.extensions, extensions) &&
           const ListEquality().equals(other.rtepts, rtepts);
     }
 

diff --git a/lib/src/model/trk.dart b/lib/src/model/trk.dart
@@ -30,7 +30,7 @@ class Trk {
 
   /// You can add extend GPX by adding your own elements from another schema
   /// here.
-  Map<String, String> extensions;
+  Map<String, Object> extensions;
 
   /// A Track Segment holds a list of Track Points which are logically connected
   /// in order. To represent a single GPS track where GPS reception was lost, or
@@ -47,10 +47,10 @@ class Trk {
       List<Link>? links,
       this.number,
       this.type,
-      Map<String, String>? extensions,
+      Map<String, Object>? extensions,
       List<Trkseg>? trksegs})
       : links = links ?? [],
-        extensions = extensions ?? <String, String>{},
+        extensions = extensions ?? <String, Object>{},
         trksegs = trksegs ?? [];
 
   @override
@@ -64,7 +64,7 @@ class Trk {
           const ListEquality().equals(other.links, links) &&
           other.number == number &&
           other.type == type &&
-          const MapEquality().equals(other.extensions, extensions) &&
+          const DeepCollectionEquality().equals(other.extensions, extensions) &&
           const ListEquality().equals(other.trksegs, trksegs);
     }
 

diff --git a/lib/src/model/trkseg.dart b/lib/src/model/trkseg.dart
@@ -14,19 +14,19 @@ class Trkseg {
 
   /// You can add extend GPX by adding your own elements from another schema
   /// here.
-  Map<String, String> extensions;
+  Map<String, Object> extensions;
 
   /// Construct a new [Trkseg] object.
-  Trkseg({List<Wpt>? trkpts, Map<String, String>? extensions})
+  Trkseg({List<Wpt>? trkpts, Map<String, Object>? extensions})
       : trkpts = trkpts ?? [],
-        extensions = extensions ?? <String, String>{};
+        extensions = extensions ?? <String, Object>{};
 
   @override
   // ignore: type_annotate_public_apis
   bool operator ==(other) {
     if (other is Trkseg) {
       return const ListEquality().equals(other.trkpts, trkpts) &&
-          const MapEquality().equals(other.extensions, extensions);
+          const DeepCollectionEquality().equals(other.extensions, extensions);
     }
 
     return false;

diff --git a/lib/src/model/wpt.dart b/lib/src/model/wpt.dart
@@ -79,7 +79,7 @@ class Wpt {
 
   /// You can add extend GPX by adding your own elements from another schema
   /// here.
-  Map<String, String> extensions;
+  Map<String, Object> extensions;
 
   /// Construct a new [Wpt] object.
   Wpt(
@@ -103,9 +103,9 @@ class Wpt {
       this.pdop,
       this.ageofdgpsdata,
       this.dgpsid,
-      Map<String, String>? extensions})
+      Map<String, Object>? extensions})
       : links = links ?? [],
-        extensions = extensions ?? <String, String>{};
+        extensions = extensions ?? <String, Object>{};
 
   @override
   // ignore: type_annotate_public_apis
@@ -131,7 +131,7 @@ class Wpt {
           other.pdop == pdop &&
           other.ageofdgpsdata == ageofdgpsdata &&
           other.dgpsid == dgpsid &&
-          const MapEquality().equals(other.extensions, extensions);
+          const DeepCollectionEquality().equals(other.extensions, extensions);
     }
 
     return false;

diff --git a/test/assets/complex.gpx b/test/assets/complex.gpx
@@ -10,6 +10,10 @@
     <extensions>
       <m1>v1</m1>
       <m2>v2</m2>
+      <mext:ext>
+        <mext:val>val</mext:val>
+        <mext:num>10</mext:num>
+      </mext:ext>
     </extensions>
   </metadata>
   <extensions>
@@ -23,6 +27,10 @@
     <extensions>
       <k1>v1</k1>
       <k2>v2</k2>
+      <wext:ext>
+        <wext:val>val</wext:val>
+        <wext:num>10</wext:num>
+      </wext:ext>
     </extensions>
   </wpt>
   <wpt lat="36.62" lon="101.77">

diff --git a/test/gpx_reader_test.dart b/test/gpx_reader_test.dart
@@ -45,6 +45,7 @@ void main() {
         .fromString(await File('test/assets/complex.gpx').readAsString());
     final src = createComplexGPX();
 
+    expect(gpx.metadata?.extensions, src.metadata?.extensions);
     expect(gpx.metadata, src.metadata);
     expect(gpx.extensions, src.extensions);
     expect(gpx.trks, src.trks);

diff --git a/test/gpx_writer_test.dart b/test/gpx_writer_test.dart
@@ -87,8 +87,10 @@ void main() {
     final xml = await File('test/assets/namespace.gpx').readAsString();
 
     final gpxXml = GpxWriter().asXml(gpx);
-    gpxXml.children[1].setAttribute("xmlns:trp", "http://www.garmin.com/xmlschemas/TripExtensions/v1");
-    gpxXml.children[1].setAttribute("xsi:schemaLocation", "http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd");
+    gpxXml.children[1].setAttribute(
+        'xmlns:trp', 'http://www.garmin.com/xmlschemas/TripExtensions/v1');
+    gpxXml.children[1].setAttribute('xsi:schemaLocation',
+        'http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd');
     expectXml(gpxXml.toXmlString(), xml);
   });
 }
diff --git a/test/utils.dart b/test/utils.dart
@@ -117,15 +117,23 @@ Gpx createComplexGPX() {
   gpx.metadata!.time = DateTime.utc(2010, 1, 2, 3, 4, 5);
   gpx.metadata!.copyright =
       Copyright(author: 'lib', year: 2019, license: 'UNKNOWN');
-  gpx.metadata!.extensions = {'m1': 'v1', 'm2': 'v2'};
+  gpx.metadata!.extensions = {
+    'm1': 'v1',
+    'm2': 'v2',
+    'mext:ext': {'mext:val': 'val', 'mext:num': '10'}
+  };
   gpx.wpts = [
     Wpt(
         lat: -25.7996,
         lon: -62.8666,
         ele: 10.2,
         name: 'Monte Quemado',
         desc: 'Argentina',
-        extensions: {'k1': 'v1', 'k2': 'v2'}),
+        extensions: {
+          'k1': 'v1',
+          'k2': 'v2',
+          'wext:ext': {'wext:val': 'val', 'wext:num': '10'}
+        }),
     Wpt(lat: 36.62, lon: 101.77, ele: 10.2, name: 'Xining', desc: 'China'),
   ];
   gpx.rtes = [