Clarify default visit options

hotwired · May 14, 2024 · 7af0efa · 7af0efa
1 parent 76a35d0
commit 7af0efa
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/Source/Turbo Navigator/TurboNavigator.swift b/Source/Turbo Navigator/TurboNavigator.swift
@@ -45,14 +45,14 @@ public class TurboNavigator {
     /// Convenience function to routing a proposal directly.
     ///
     /// - Parameter url: the URL to visit
-    /// - Parameter options: passed options will override any from the path configuration
+    /// - Parameter options: passed options will override default `advance` visit options
     /// - Parameter parameters: provide context relevant to `url`
     public func route(_ url: URL,
-                      options: VisitOptions = VisitOptions(action: .advance),
+                      options: VisitOptions? = VisitOptions(action: .advance),
                       parameters: [String: Any]? = nil) {
         let properties = session.pathConfiguration?.properties(for: url) ?? PathProperties()
         route(VisitProposal(url: url,
-                            options: options,
+                            options: options ?? .init(action: .advance),
                             properties: properties,
                             parameters: parameters))
     }

diff --git a/Tests/Turbo Navigator/TurboNavigatorTests.swift b/Tests/Turbo Navigator/TurboNavigatorTests.swift
@@ -17,7 +17,7 @@ final class TurboNavigationHierarchyControllerTests: XCTestCase {
         loadNavigationControllerInWindow()
     }
 
-    func test_default_default_default_pushesOnMainStack() {
+    func test_default_default_default_defaultOptionsParamater_pushesOnMainStack() {
         navigator.route(oneURL)
         XCTAssertEqual(navigationController.viewControllers.count, 1)
         XCTAssert(navigator.rootViewController.viewControllers.last is VisitableViewController)
@@ -27,6 +27,17 @@ final class TurboNavigationHierarchyControllerTests: XCTestCase {
         XCTAssert(navigator.rootViewController.viewControllers.last is VisitableViewController)
         assertVisited(url: twoURL, on: .main)
     }
+
+    func test_default_default_default_nilOptionsParameter_pushesOnMainStack() {
+        navigator.route(oneURL)
+        XCTAssertEqual(navigationController.viewControllers.count, 1)
+        XCTAssert(navigator.rootViewController.viewControllers.last is VisitableViewController)
+
+        navigator.route(twoURL, options: nil)
+        XCTAssertEqual(navigationController.viewControllers.count, 2)
+        XCTAssert(navigator.rootViewController.viewControllers.last is VisitableViewController)
+        assertVisited(url: twoURL, on: .main)
+    }
 
     func test_default_default_default_visitingSamePage_replacesOnMainStack() {
         navigator.route(oneURL)