Adds support for track type

mmllr · mmllr · commit 3b750cb7f1e4 · 2025-03-25T14:27:14.000+01:00
diff --git a/README.md b/README.md
@@ -19,13 +19,14 @@ A library for parsing and exporting GPX files with no dependencies besides Found
 - [x] Grade segmentation
 - [x] Support for Garmin trackpoint extensions
 - [x] Support for multiple track segements
+- [x] Support for track types
 
 ## Installation
 
 To use the `GPXKit` library in a SwiftPM project, add the following line to the dependencies in your `Package.swift` file:
 
 ```swift
-.package(url: "https://github.com/mmllr/GPXKit", from: "2.3.1")
+.package(url: "https://github.com/mmllr/GPXKit", from: "2.4.0")
 ```
 
 ## Usage examples
diff --git a/Sources/GPXKit/GPXExporter.swift b/Sources/GPXKit/GPXExporter.swift
@@ -1,5 +1,5 @@
 //
-// GPXKit - MIT License - Copyright © 2024 Markus Müller. All rights reserved.
+// GPXKit - MIT License - Copyright © 2025 Markus Müller. All rights reserved.
 //
 
 import Foundation
@@ -42,6 +42,7 @@ public struct GPXExporter: Sendable {
                 GPXTags.track.embed([
                     GPXTags.name.embed(track.title),
                     track.description.flatMap { GPXTags.description.embed($0) } ?? "",
+                    track.type.flatMap { GPXTags.type.embed($0) } ?? "",
                     trackXML
                 ].joined(separator: "\n"))
             ].joined(separator: "\n")
diff --git a/Sources/GPXKit/GPXFileParser.swift b/Sources/GPXKit/GPXFileParser.swift
@@ -1,5 +1,5 @@
 //
-// GPXKit - MIT License - Copyright © 2024 Markus Müller. All rights reserved.
+// GPXKit - MIT License - Copyright © 2025 Markus Müller. All rights reserved.
 //
 
 import Algorithms
@@ -43,6 +43,7 @@ enum GPXTags: String {
     case heartrate = "hr"
     case cadence = "cad"
     case speed
+    case type
 }
 
 enum GPXAttributes: String {
@@ -94,7 +95,8 @@ public struct GPXFileParser: Sendable {
                 description: nil,
                 trackPoints: [],
                 keywords: parseKeywords(node: node),
-                elevationSmoothing: elevationSmoothing
+                elevationSmoothing: elevationSmoothing,
+                type: nil
             )
         }
         let title = trackNode.childFor(.name)?.content ?? ""
@@ -108,7 +110,8 @@ public struct GPXFileParser: Sendable {
             trackPoints: trackPoints,
             keywords: parseKeywords(node: node),
             elevationSmoothing: elevationSmoothing,
-            segments: segments
+            segments: segments,
+            type: trackNode.childFor(.type)?.content
         )
     }
 
diff --git a/Sources/GPXKit/GPXTrack.swift b/Sources/GPXKit/GPXTrack.swift
@@ -1,5 +1,5 @@
 //
-// GPXKit - MIT License - Copyright © 2024 Markus Müller. All rights reserved.
+// GPXKit - MIT License - Copyright © 2025 Markus Müller. All rights reserved.
 //
 
 import Foundation
@@ -44,9 +44,10 @@ public struct GPXTrack: Hashable, Sendable {
     public var bounds: GeoBounds
     /// Keywords describing a gpx track
     public var keywords: [String]
-
     /// The ``Segment`` of the track. Contains at least one segment
     public var segments: [Segment]
+    /// The type of the gpx track. Defaults to nil.
+    public var type: String?
 
     /// Initializes a GPXTrack.
     /// - Parameters:
@@ -55,14 +56,17 @@ public struct GPXTrack: Hashable, Sendable {
     ///   - title: String describing the track.
     ///   - trackPoints: Array of ``TrackPoint``s describing the route.
     ///   - keywords: Array of `String`s with keywords. Default is an empty array (no keywords).
+    ///   - segments: Array of ``Segment`` values. Defaults to nil.
+    ///   - type: The type of the gpx track. Defaults to nil.
     public init(
         date: Date? = nil,
         waypoints: [Waypoint]? = nil,
         title: String,
         description: String? = nil,
         trackPoints: [TrackPoint],
         keywords: [String] = [],
-        segments: [Segment]? = nil
+        segments: [Segment]? = nil,
+        type: String? = nil
     ) {
         self.date = date
         self.waypoints = waypoints
@@ -73,6 +77,7 @@ public struct GPXTrack: Hashable, Sendable {
         bounds = trackPoints.bounds()
         self.keywords = keywords
         self.segments = segments ?? [.init(range: trackPoints.indices, distance: graph.distance)]
+        self.type = type
     }
 
     /// Initializes a GPXTrack. You don't need to construct this value by yourself, as it is done by GXPKits track parsing logic.
@@ -82,8 +87,9 @@ public struct GPXTrack: Hashable, Sendable {
     ///   - title: String describing the track.
     ///   - trackPoints: Array of ``TrackPoint``s describing the route.
     ///   - keywords: Array of `String`s with keywords. Default is an empty array (no keywords).
-    ///   - elevationSmoothing: The ``ElevationSmoothing`` in meters for the grade segments. Defaults to
-    /// ``ElevationSmoothing/segmentation(_:)`` with 50 meters.
+    ///   - elevationSmoothing: The ``ElevationSmoothing`` in meters for the grade segments. Defaults to ``ElevationSmoothing/segmentation(_:)`` with 50 meters.
+    ///   - segments: Array of ``Segment`` values. Defaults to nil.
+    ///   - type: The type of the gpx track. Defaults to nil.
     public init(
         date: Date? = nil,
         waypoints: [Waypoint]? = nil,
@@ -92,7 +98,8 @@ public struct GPXTrack: Hashable, Sendable {
         trackPoints: [TrackPoint],
         keywords: [String] = [],
         elevationSmoothing: ElevationSmoothing = .segmentation(50),
-        segments: [Segment]? = nil
+        segments: [Segment]? = nil,
+        type: String? = nil
     ) throws {
         self.date = date
         self.waypoints = waypoints
@@ -103,5 +110,6 @@ public struct GPXTrack: Hashable, Sendable {
         bounds = trackPoints.bounds()
         self.keywords = keywords
         self.segments = segments ?? [Segment(range: trackPoints.indices, distance: graph.distance)]
+        self.type = type
     }
 }
diff --git a/Sources/GPXKit/TrackGraph+Private.swift b/Sources/GPXKit/TrackGraph+Private.swift
@@ -1,5 +1,5 @@
 //
-// GPXKit - MIT License - Copyright © 2024 Markus Müller. All rights reserved.
+// GPXKit - MIT License - Copyright © 2025 Markus Müller. All rights reserved.
 //
 
 import Foundation
@@ -134,10 +134,10 @@ extension Array where Element: Simplifiable {
         }
 
         let last = (points.count - 1)
-        var simplied = [points.first!]
-        simplifyDPStep(points, first: 0, last: last, sqTolerance: sqTolerance, simplified: &simplied)
-        simplied.append(points.last!)
+        var simplified = [points.first!]
+        simplifyDPStep(points, first: 0, last: last, sqTolerance: sqTolerance, simplified: &simplified)
+        simplified.append(points.last!)
 
-        return simplied
+        return simplified
     }
 }
diff --git a/Tests/GPXKitTests/GPXExporterTests.swift b/Tests/GPXKitTests/GPXExporterTests.swift
@@ -1,5 +1,5 @@
 //
-// GPXKit - MIT License - Copyright © 2024 Markus Müller. All rights reserved.
+// GPXKit - MIT License - Copyright © 2025 Markus Müller. All rights reserved.
 //
 
 import Foundation
@@ -42,7 +42,7 @@ struct GPXExporterTests {
     @Test
     func testExportingAnEmptyTrackWithDateAndTitleResultsInAnEmptyGPXFile() throws {
         let date = Date()
-        let track = GPXTrack(date: date, title: "Track title", description: "Track description", trackPoints: [])
+        let track = GPXTrack(date: date, title: "Track title", description: "Track description", trackPoints: [], type: "cycling")
         let sut = GPXExporter(track: track)
 
         let expectedContent: GPXKit.XMLNode = XMLNode(
@@ -54,7 +54,8 @@ struct GPXExporterTests {
                 ]),
                 XMLNode(name: GPXTags.track.rawValue, children: [
                     XMLNode(name: GPXTags.name.rawValue, content: track.title),
-                    XMLNode(name: GPXTags.description.rawValue, content: "Track description")
+                    XMLNode(name: GPXTags.description.rawValue, content: "Track description"),
+                    XMLNode(name: GPXTags.type.rawValue, content: "cycling")
                 ])
             ]
         )
@@ -67,7 +68,7 @@ struct GPXExporterTests {
     @Test
     func testItWillNotExportANilDescription() throws {
         let date = Date()
-        let track = GPXTrack(date: date, title: "Track title", description: nil, trackPoints: [])
+        let track = GPXTrack(date: date, title: "Track title", description: nil, trackPoints: [], type: nil)
         let sut = GPXExporter(track: track)
 
         let expectedContent: GPXKit.XMLNode = XMLNode(
@@ -95,7 +96,8 @@ struct GPXExporterTests {
             title: "Track title",
             description: "Description",
             trackPoints: [],
-            keywords: ["one", "two"]
+            keywords: ["one", "two"],
+            type: "custom"
         )
         let sut = GPXExporter(track: track, creatorName: "Custom creator name")
 
@@ -108,7 +110,8 @@ struct GPXExporterTests {
                 ]),
                 XMLNode(name: GPXTags.track.rawValue, children: [
                     XMLNode(name: GPXTags.name.rawValue, content: track.title),
-                    XMLNode(name: GPXTags.description.rawValue, content: "Description")
+                    XMLNode(name: GPXTags.description.rawValue, content: "Description"),
+                    XMLNode(name: GPXTags.type.rawValue, content: "custom")
                 ])
             ]
         )
@@ -119,14 +122,15 @@ struct GPXExporterTests {
     }
 
     @Test
-    func testExportingANonEmptyTrackWithDates() throws {
+    func testExportingANonEmptyTrackWithDatesAndType() throws {
         let date = Date()
         let track = GPXTrack(
             date: date,
             title: "Track title",
             description: "Non empty track",
             trackPoints: givenTrackPoints(10),
-            keywords: ["keyword1", "keyword2", "keyword3"]
+            keywords: ["keyword1", "keyword2", "keyword3"],
+            type: "cycling"
         )
         let sut = GPXExporter(track: track)
 
@@ -143,6 +147,7 @@ struct GPXExporterTests {
                 XMLNode(name: GPXTags.track.rawValue, children: [
                     XMLNode(name: GPXTags.name.rawValue, content: track.title),
                     XMLNode(name: GPXTags.description.rawValue, content: "Non empty track"),
+                    XMLNode(name: GPXTags.type.rawValue, content: "cycling"),
                     XMLNode(
                         name: GPXTags.trackSegment.rawValue,
                         children: track.trackPoints.map {
@@ -175,7 +180,8 @@ struct GPXExporterTests {
                 TrackPoint(coordinate: .random, date: Date()),
                 TrackPoint(coordinate: .random, date: Date()),
                 TrackPoint(coordinate: .random, date: Date())
-            ]
+            ],
+            type: "running"
         )
         let sut = GPXExporter(track: track, shouldExportDate: false)
         let expectedContent: GPXKit.XMLNode = XMLNode(
@@ -185,6 +191,7 @@ struct GPXExporterTests {
                 XMLNode(name: GPXTags.metadata.rawValue),
                 XMLNode(name: GPXTags.track.rawValue, children: [
                     XMLNode(name: GPXTags.name.rawValue, content: track.title),
+                    XMLNode(name: GPXTags.type.rawValue, content: "running"),
                     XMLNode(
                         name: GPXTags.trackSegment.rawValue,
                         children: track.trackPoints.map {
@@ -202,7 +209,7 @@ struct GPXExporterTests {
 
     @Test
     func testItWillNotExportNilWaypoints() throws {
-        let track = GPXTrack(date: Date(), waypoints: nil, title: "Track title", trackPoints: [])
+        let track = GPXTrack(date: Date(), waypoints: nil, title: "Track title", trackPoints: [], type: nil)
         let sut = GPXExporter(track: track, shouldExportDate: false)
         let expectedContent: GPXKit.XMLNode = XMLNode(
             name: GPXTags.gpx.rawValue,
@@ -231,7 +238,7 @@ struct GPXExporterTests {
                 description: "Kreisel description"
             )
         ]
-        let track = GPXTrack(date: Date(), waypoints: waypoints, title: "Track title", trackPoints: [])
+        let track = GPXTrack(date: Date(), waypoints: waypoints, title: "Track title", trackPoints: [], type: "track type")
         let sut = GPXExporter(track: track, shouldExportDate: false)
         let expectedContent: GPXKit.XMLNode = XMLNode(
             name: GPXTags.gpx.rawValue,
@@ -255,7 +262,8 @@ struct GPXExporterTests {
                     XMLNode(name: GPXTags.description.rawValue, content: "Kreisel description")
                 ]),
                 XMLNode(name: GPXTags.track.rawValue, children: [
-                    XMLNode(name: GPXTags.name.rawValue, content: track.title)
+                    XMLNode(name: GPXTags.name.rawValue, content: track.title),
+                    XMLNode(name: GPXTags.type.rawValue, content: "track type")
                 ])
             ]
         )
@@ -321,7 +329,8 @@ struct GPXExporterTests {
             segments: [
                 .init(range: 0 ..< 5, distance: points[0 ..< 5].expectedDistance()),
                 .init(range: 5 ..< 10, distance: points[5 ..< 10].expectedDistance())
-            ]
+            ],
+            type: "rowing"
         )
         let sut = GPXExporter(track: track)
 
@@ -338,6 +347,7 @@ struct GPXExporterTests {
                 XMLNode(name: GPXTags.track.rawValue, children: [
                     XMLNode(name: GPXTags.name.rawValue, content: track.title),
                     XMLNode(name: GPXTags.description.rawValue, content: "Non empty track"),
+                    XMLNode(name: GPXTags.type.rawValue, content: "rowing"),
                     XMLNode(
                         name: GPXTags.trackSegment.rawValue,
                         children: points[0 ..< 5].map {
@@ -356,4 +366,29 @@ struct GPXExporterTests {
 
         assertNodesAreEqual(expectedContent, result)
     }
+
+    @Test
+    func testItWillNotExportAnNonexistingTrackType() throws {
+        let date = Date()
+        let track = GPXTrack(date: date, title: "Track title", description: "Track description", trackPoints: [], type: nil)
+        let sut = GPXExporter(track: track)
+
+        let expectedContent: GPXKit.XMLNode = XMLNode(
+            name: GPXTags.gpx.rawValue,
+            attributes: expectedHeaderAttributes(),
+            children: [
+                XMLNode(name: GPXTags.metadata.rawValue, children: [
+                    XMLNode(name: GPXTags.time.rawValue, content: expectedString(for: date))
+                ]),
+                XMLNode(name: GPXTags.track.rawValue, children: [
+                    XMLNode(name: GPXTags.name.rawValue, content: track.title),
+                    XMLNode(name: GPXTags.description.rawValue, content: "Track description")
+                ])
+            ]
+        )
+
+        let result = try parseResult(sut.xmlString)
+
+        assertNodesAreEqual(expectedContent, result)
+    }
 }
diff --git a/Tests/GPXKitTests/GPXParserTests.swift b/Tests/GPXKitTests/GPXParserTests.swift
diff --git a/Tests/GPXKitTests/GPXTrackTests.swift b/Tests/GPXKitTests/GPXTrackTests.swift
diff --git a/Tests/GPXKitTests/TestFixtures.swift b/Tests/GPXKitTests/TestFixtures.swift

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`//`
`2`		`-// GPXKit - MIT License - Copyright © 2024 Markus Müller. All rights reserved.`
	`2`	`+// GPXKit - MIT License - Copyright © 2025 Markus Müller. All rights reserved.`
`3`	`3`	`//`
`4`	`4`
`5`	`5`	`import Algorithms`
`@@ -43,6 +43,7 @@ enum GPXTags: String {`
`43`	`43`	`case heartrate = "hr"`
`44`	`44`	`case cadence = "cad"`
`45`	`45`	`case speed`
	`46`	`+ case type`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`enum GPXAttributes: String {`
`@@ -94,7 +95,8 @@ public struct GPXFileParser: Sendable {`
`94`	`95`	`description: nil,`
`95`	`96`	`trackPoints: [],`
`96`	`97`	`keywords: parseKeywords(node: node),`
`97`		`- elevationSmoothing: elevationSmoothing`
	`98`	`+ elevationSmoothing: elevationSmoothing,`
	`99`	`+ type: nil`
`98`	`100`	`)`
`99`	`101`	`}`
`100`	`102`	`let title = trackNode.childFor(.name)?.content ?? ""`
`@@ -108,7 +110,8 @@ public struct GPXFileParser: Sendable {`
`108`	`110`	`trackPoints: trackPoints,`
`109`	`111`	`keywords: parseKeywords(node: node),`
`110`	`112`	`elevationSmoothing: elevationSmoothing,`
`111`		`- segments: segments`
	`113`	`+ segments: segments,`
	`114`	`+ type: trackNode.childFor(.type)?.content`
`112`	`115`	`)`
`113`	`116`	`}`
`114`	`117`