Merge pull request #98 from hotwired/switching-context-behavior

Improved `default` context visit behavior when dismissing the `modal` context

Author: olivaresf

Source/Turbo/Navigator/NavigationHierarchyController.swift

@@ -94,22 +94,31 @@ class NavigationHierarchyController {
             navigationController.present(alert, animated: proposal.animated)
         }
     }
+    
+    private var isInModalContext: Bool {
+        navigationController.presentedViewController != nil
+        && !modalNavigationController.isBeingDismissed
+    }
 
     private func navigate(with controller: UIViewController, via proposal: VisitProposal) {
         switch proposal.context {
         case .default:
             if let visitable = controller as? Visitable {
                 delegate.visit(visitable, on: .main, with: proposal.options)
             }
+            let willReplaceModalContext = isInModalContext
             navigationController.dismiss(animated: proposal.animated)
-            pushOrReplace(on: navigationController, with: controller, via: proposal)
+            pushOrReplace(on: navigationController,
+                          with: controller,
+                          via: proposal,
+                          didReplaceModalContext: willReplaceModalContext)
         case .modal:
             if let visitable = controller as? Visitable {
                 delegate.visit(visitable, on: .modal, with: proposal.options)
             }
             controller.configureModalBehaviour(with: proposal)
 
-            if navigationController.presentedViewController != nil, !modalNavigationController.isBeingDismissed {
+            if isInModalContext {
                 pushOrReplace(on: modalNavigationController, with: controller, via: proposal)
             } else {
                 modalNavigationController.setViewControllers([controller], animated: proposal.animated)
@@ -119,12 +128,16 @@ class NavigationHierarchyController {
         }
     }
 
-    private func pushOrReplace(on navigationController: UINavigationController, with controller: UIViewController, via proposal: VisitProposal) {
+    private func pushOrReplace(on navigationController: UINavigationController,
+                               with controller: UIViewController,
+                               via proposal: VisitProposal,
+                               didReplaceModalContext: Bool = false) {
+        
         if visitingSamePage(on: navigationController, with: controller, via: proposal.url) {
             navigationController.replaceLastViewController(with: controller)
         } else if visitingPreviousPage(on: navigationController, with: controller, via: proposal.url) {
             navigationController.popViewController(animated: proposal.animated)
-        } else if proposal.options.action == .advance {
+        } else if proposal.options.action == .advance || didReplaceModalContext {
             navigationController.pushViewController(controller, animated: proposal.animated)
         } else {
             navigationController.replaceLastViewController(with: controller)

Tests/Turbo/Navigator/NavigationHierarchyControllerTests.swift

@@ -214,6 +214,36 @@ final class NavigationHierarchyControllerTests: XCTestCase {
         XCTAssert(modalNavigationController.viewControllers.last is VisitableViewController)
         assertVisited(url: proposal.url, on: .modal)
     }
+    
+    func test_modal_default_default_replaceAction_pushesOnMainStack_ifDifferentDestination() {
+        navigator.route(VisitProposal(path: "/one", context: .default))
+        XCTAssertEqual(navigationController.viewControllers.count, 1)
+        
+        navigator.route(VisitProposal(path: "/two", context: .modal))
+        XCTAssertEqual(modalNavigationController.viewControllers.count, 1)
+
+        let proposal = VisitProposal(path: "/three", action: .replace, context: .default)
+        navigator.route(proposal)
+        
+        XCTAssertNil(navigationController.presentedViewController)
+        XCTAssertEqual(navigationController.viewControllers.count, 2)
+        assertVisited(url: proposal.url, on: .main)
+    }
+    
+    func test_modal_default_default_replaceAction_replacesOnMainStack_ifSameDestination() {
+        navigator.route(VisitProposal(path: "/one", context: .default))
+        XCTAssertEqual(navigationController.viewControllers.count, 1)
+        
+        navigator.route(VisitProposal(path: "/two", context: .modal))
+        XCTAssertEqual(modalNavigationController.viewControllers.count, 1)
+
+        let proposal = VisitProposal(path: "/one", action: .replace, context: .default)
+        navigator.route(proposal)
+        
+        XCTAssertNil(navigationController.presentedViewController)
+        XCTAssertEqual(navigationController.viewControllers.count, 1)
+        assertVisited(url: proposal.url, on: .main)
+    }
 
     func test_modal_modal_replace_pushesOnModalStack() {
         navigator.route(VisitProposal(path: "/one", context: .modal))