Expose exit information on RouteSteps (#391)

stadiamaps · Dec 9, 2024 · 990e688 · 990e688
1 parent 1a59786
commit 990e688
Show file tree

Hide file tree

Showing 29 changed files with 8,365 additions and 13 deletions.
diff --git a/.github/workflows/ios.yml b/.github/workflows/ios.yml
@@ -59,7 +59,7 @@ jobs:
     - name: Ensure that Package.swift is NOT configured for local development at this stage (easy to forget)
       run: sed -i '' 's/let useLocalFramework = true/let useLocalFramework = false/' Package.swift
 
-    - name: Commit changed files (it is easy to forget about ferrostar.swift)
+    - name: Detect changed files (it is easy to forget about ferrostar.swift)
       run: |
         if [[ -n "$(git status --porcelain apple/Sources/UniFFI/*)" ]]; then
           echo "Dirty files detected"

diff --git a/Package.swift b/Package.swift
@@ -16,7 +16,7 @@ if useLocalFramework {
         path: "./common/target/ios/libferrostar-rs.xcframework"
     )
 } else {
-    let releaseTag = "0.23.0"
+    let releaseTag = "0.24.0"
     let releaseChecksum = "fa308b519db5424d73d00d60ca03fc18c1dcf2f88704aadce29259d12f2de2b2"
     binaryTarget = .binaryTarget(
         name: "FerrostarCoreRS",

diff --git a/_typos.toml b/_typos.toml
@@ -7,4 +7,4 @@ extend-ignore-re = [
 rememberable = "rememberable"
 
 [files]
-extend-exclude = ["**/build/*", "*.pbxproj", "**/dist/*", "guide/**/*.js"]
+extend-exclude = ["**/build/*", "*.pbxproj", "**/dist/*", "guide/**/*.js", "**/fixtures/*"]
diff --git a/android/build.gradle b/android/build.gradle
@@ -17,5 +17,5 @@ ext {
 
 allprojects {
     group = "com.stadiamaps.ferrostar"
-    version = "0.23.0"
+    version = "0.24.0"
 }
diff --git a/android/core/src/androidTest/java/com/stadiamaps/ferrostar/core/FerrostarCoreTest.kt b/android/core/src/androidTest/java/com/stadiamaps/ferrostar/core/FerrostarCoreTest.kt
@@ -112,6 +112,7 @@ class FerrostarCoreTest {
                       geometry = mockGeom,
                       distance = 1.0,
                       roadName = "foo road",
+                      exits = listOf(),
                       instruction = "Sail straight",
                       visualInstructions =
                           listOf(

diff --git a/apple/Sources/FerrostarCore/Mock/MockNavigationState.swift b/apple/Sources/FerrostarCore/Mock/MockNavigationState.swift
@@ -52,6 +52,7 @@ public extension NavigationState {
                         distance: 100,
                         duration: 99,
                         roadName: "Jefferson St.",
+                        exits: [],
                         instruction: "Walk west on Jefferson St.",
                         visualInstructions: [
                             VisualInstruction(

diff --git a/apple/Sources/FerrostarSwiftUI/TestFixtureFactory.swift b/apple/Sources/FerrostarSwiftUI/TestFixtureFactory.swift
@@ -71,6 +71,7 @@ struct RouteStepFactory: TestFixtureFactory {
             distance: 100,
             duration: 99,
             roadName: roadNameBuilder(n),
+            exits: [],
             instruction: "Walk west on \(roadNameBuilder(n))",
             visualInstructions: [visualInstructionBuilder(n)],
             spokenInstructions: [],

diff --git a/apple/Sources/UniFFI/ferrostar.swift b/apple/Sources/UniFFI/ferrostar.swift
diff --git a/apple/Tests/FerrostarCoreTests/FerrostarCoreTests.swift b/apple/Tests/FerrostarCoreTests/FerrostarCoreTests.swift
@@ -35,6 +35,7 @@ let mockRoute = Route(
         distance: 1,
         duration: 0,
         roadName: "foo road",
+        exits: [],
         instruction: "Sail straight", // 🏴‍☠️⛵️
         visualInstructions: [VisualInstruction(
             primaryContent: instructionContent,

diff --git a/...sts/FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/test200MockGETRouteResponse.1.txt b/...sts/FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/test200MockGETRouteResponse.1.txt
@@ -20,6 +20,7 @@
         - annotations: Optional<Array<String>>.none
         - distance: 1.0
         - duration: 0.0
+        - exits: 0 elements
         ▿ geometry: 2 elements
           ▿ GeographicCoordinate
             - lat: 0.0

diff --git a/...ts/FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/test200MockPOSTRouteResponse.1.txt b/...ts/FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/test200MockPOSTRouteResponse.1.txt
@@ -20,6 +20,7 @@
         - annotations: Optional<Array<String>>.none
         - distance: 1.0
         - duration: 0.0
+        - exits: 0 elements
         ▿ geometry: 2 elements
           ▿ GeographicCoordinate
             - lat: 0.0

diff --git a/...e/Tests/FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/testCustomRouteProvider.1.txt b/...e/Tests/FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/testCustomRouteProvider.1.txt
@@ -20,6 +20,7 @@
         - annotations: Optional<Array<String>>.none
         - distance: 1.0
         - duration: 0.0
+        - exits: 0 elements
         ▿ geometry: 2 elements
           ▿ GeographicCoordinate
             - lat: 0.0

diff --git a/.../FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/testValhallaCostingOptionsJSON.1.txt b/.../FerrostarCoreTests/__Snapshots__/FerrostarCoreTests/testValhallaCostingOptionsJSON.1.txt
@@ -44,6 +44,7 @@
         - annotations: Optional<Array<String>>.none
         - distance: 284.0
         - duration: 11.488
+        - exits: 0 elements
         ▿ geometry: 10 elements
           ▿ GeographicCoordinate
             - lat: 60.534716
@@ -85,6 +86,7 @@
         - annotations: Optional<Array<String>>.none
         - distance: 0.0
         - duration: 0.0
+        - exits: 0 elements
         ▿ geometry: 2 elements
           ▿ GeographicCoordinate
             - lat: 60.534991

diff --git a/...e/Tests/FerrostarCoreTests/__Snapshots__/ValhallaCoreTests/testValhallaRouteParsing.1.txt b/...e/Tests/FerrostarCoreTests/__Snapshots__/ValhallaCoreTests/testValhallaRouteParsing.1.txt
@@ -44,6 +44,7 @@
         - annotations: Optional<Array<String>>.none
         - distance: 284.0
         - duration: 11.488
+        - exits: 0 elements
         ▿ geometry: 10 elements
           ▿ GeographicCoordinate
             - lat: 60.534716
@@ -85,6 +86,7 @@
         - annotations: Optional<Array<String>>.none
         - distance: 0.0
         - duration: 0.0
+        - exits: 0 elements
         ▿ geometry: 2 elements
           ▿ GeographicCoordinate
             - lat: 60.534991

diff --git a/common/Cargo.lock b/common/Cargo.lock
diff --git a/common/ferrostar/Cargo.toml b/common/ferrostar/Cargo.toml
@@ -2,7 +2,7 @@ lints.workspace = true
 
 [package]
 name = "ferrostar"
-version = "0.23.0"
+version = "0.24.0"
 readme = "README.md"
 description = "The core of modern turn-by-turn navigation."
 keywords = ["navigation", "routing", "valhalla", "osrm"]

diff --git a/common/ferrostar/src/models.rs b/common/ferrostar/src/models.rs
@@ -311,6 +311,8 @@ pub struct RouteStep {
     pub duration: f64,
     /// The name of the road being traveled on (useful for certain UI styles).
     pub road_name: Option<String>,
+    /// A list of exits (name or number).
+    pub exits: Vec<String>,
     /// A description of the maneuver (ex: "Turn wright onto main street").
     ///
     /// Note for UI implementers: the context this appears in (or doesn't)