move navigation controller routing to a category

Author: Wes Smith

DeepLinkKit.xcodeproj/project.pbxproj

@@ -51,6 +51,7 @@
 		DEAD328B19E079D3003C8D65 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = DEAD327B19E079D3003C8D65 /* InfoPlist.strings */; };
 		DEAD328C19E079D3003C8D65 /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = DEAD327D19E079D3003C8D65 /* Images.xcassets */; };
 		DEAD328D19E079D3003C8D65 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = DEAD327E19E079D3003C8D65 /* main.m */; };
+		DEB497F71CB441FA005FC580 /* UINavigationController_DPLRoutingSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = DEB497F61CB441FA005FC580 /* UINavigationController_DPLRoutingSpec.m */; };
 		DECB32531A881CA10071C76E /* NSObject_DPLJSONObjectSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = DECB32521A881CA10071C76E /* NSObject_DPLJSONObjectSpec.m */; };
 		DECB32551A882D1A0071C76E /* DPLMutableDeepLinkSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = DECB32541A882D1A0071C76E /* DPLMutableDeepLinkSpec.m */; };
 		DECB32571A8866700071C76E /* DPLMutableDeepLink_AppLinksSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = DECB32561A8866700071C76E /* DPLMutableDeepLink_AppLinksSpec.m */; };
@@ -125,6 +126,8 @@
 		DE16E9341A4289D500077E18 /* DPLRouteMatcher.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = DPLRouteMatcher.h; sourceTree = "<group>"; };
 		DE16E9351A4289D500077E18 /* DPLRouteMatcher.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = DPLRouteMatcher.m; sourceTree = "<group>"; };
 		DE16E9371A4289DF00077E18 /* DPLRouteMatcherSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = DPLRouteMatcherSpec.m; sourceTree = "<group>"; };
+		DE1B5F581CB301300086227F /* UINavigationController+DPLRouting.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "UINavigationController+DPLRouting.h"; sourceTree = "<group>"; };
+		DE1B5F591CB301300086227F /* UINavigationController+DPLRouting.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "UINavigationController+DPLRouting.m"; sourceTree = "<group>"; };
 		DE3E61081A3B4485008D6DFC /* NSString+DPLJSON.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSString+DPLJSON.h"; sourceTree = "<group>"; };
 		DE3E61091A3B4485008D6DFC /* NSString+DPLJSON.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSString+DPLJSON.m"; sourceTree = "<group>"; };
 		DE3E610D1A3B4492008D6DFC /* NSString_DPLJSONSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = NSString_DPLJSONSpec.m; sourceTree = "<group>"; };
@@ -156,6 +159,7 @@
 		DEAD328319E079D3003C8D65 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
 		DEAD328419E079D3003C8D65 /* Tests-Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = "Tests-Info.plist"; sourceTree = "<group>"; };
 		DEAD328519E079D3003C8D65 /* Tests-Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "Tests-Prefix.pch"; sourceTree = "<group>"; };
+		DEB497F61CB441FA005FC580 /* UINavigationController_DPLRoutingSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = UINavigationController_DPLRoutingSpec.m; sourceTree = "<group>"; };
 		DEB4EDBC1A4A036D00F31D14 /* DPLDeepLink_Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = DPLDeepLink_Private.h; sourceTree = "<group>"; };
 		DEB4EDBD1A4A726200F31D14 /* DeepLinkKit.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = DeepLinkKit.h; sourceTree = "<group>"; };
 		DEC308D71CAD6A05006828A5 /* module.modulemap */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = "sourcecode.module-map"; name = module.modulemap; path = DeepLinkKit/module.modulemap; sourceTree = "<group>"; };
@@ -471,6 +475,8 @@
 				DE3E61091A3B4485008D6DFC /* NSString+DPLJSON.m */,
 				DECB32501A87E94B0071C76E /* NSObject+DPLJSONObject.h */,
 				DECB32511A87E94B0071C76E /* NSObject+DPLJSONObject.m */,
+				DE1B5F581CB301300086227F /* UINavigationController+DPLRouting.h */,
+				DE1B5F591CB301300086227F /* UINavigationController+DPLRouting.m */,
 			);
 			path = Categories;
 			sourceTree = "<group>";
@@ -482,6 +488,7 @@
 				DE3E610D1A3B4492008D6DFC /* NSString_DPLJSONSpec.m */,
 				DE16E91D1A42733100077E18 /* NSString_DPLTrimSpec.m */,
 				DECB32521A881CA10071C76E /* NSObject_DPLJSONObjectSpec.m */,
+				DEB497F61CB441FA005FC580 /* UINavigationController_DPLRoutingSpec.m */,
 			);
 			path = Categories;
 			sourceTree = "<group>";
@@ -1055,6 +1062,7 @@
 				DE058E101A3B485500147C04 /* DPLDeepLinkSpec.m in Sources */,
 				DECB32551A882D1A0071C76E /* DPLMutableDeepLinkSpec.m in Sources */,
 				DE058E0A1A3B46FD00147C04 /* NSString_DPLQuerySpec.m in Sources */,
+				DEB497F71CB441FA005FC580 /* UINavigationController_DPLRoutingSpec.m in Sources */,
 				DECB32571A8866700071C76E /* DPLMutableDeepLink_AppLinksSpec.m in Sources */,
 				2F4988DE1AE71ABC0069EF2B /* DPLRouteHandlerIntegrationTest.m in Sources */,
 				DEA55ADF1A5F2BBC00C312F5 /* DPLDeepLink_AppLinksSpec.m in Sources */,

DeepLinkKit/Categories/UINavigationController+DPLRouting.h

@@ -0,0 +1,12 @@
+@import UIKit;
+
+@interface UINavigationController (DPLRouting)
+
+/**
+ Places a view controller in the receivers view controller stack.
+ @param targetViewController The view controller to be placed in/on to the stack.
+ @note The `targetViewController' is pushed or inserted into the stack replacing any pre-existing instances of the same class. If the `targetViewController' instance is already in the stack, it will become the `topViewController'.
+ */
+- (void)DPL_placeTargetViewController:(UIViewController *)targetViewController;
+
+@end

DeepLinkKit/Categories/UINavigationController+DPLRouting.m

@@ -0,0 +1,32 @@
+#import "UINavigationController+DPLRouting.h"
+
+@implementation UINavigationController (DPLRouting)
+
+- (void)DPL_placeTargetViewController:(UIViewController *)targetViewController {
+    
+    if ([self.viewControllers containsObject:targetViewController]) {
+        [self popToViewController:targetViewController animated:NO];
+    }
+    else {
+        
+        for (UIViewController *controller in self.viewControllers) {
+            if ([controller isMemberOfClass:[targetViewController class]]) {
+                
+                [self popToViewController:controller animated:NO];
+                [self popViewControllerAnimated:NO];
+                
+                if ([controller isEqual:self.topViewController]) {
+                    [self setViewControllers:@[targetViewController] animated:NO];
+                }
+                
+                break;
+            }
+        }
+        
+        if (![self.topViewController isEqual:targetViewController]) {
+            [self pushViewController:targetViewController animated:NO];
+        }
+    }
+}
+
+@end

DeepLinkKit/DeepLinkKit_Private.h

@@ -7,3 +7,4 @@
 #import "NSString+DPLQuery.h"
 #import "NSString+DPLJSON.h"
 #import "NSObject+DPLJSONObject.h"
+#import "UINavigationController+DPLRouting.h"

DeepLinkKit/RouteHandler/DPLRouteHandler.m

@@ -1,4 +1,5 @@
 #import "DPLRouteHandler.h"
+#import "UINavigationController+DPLRouting.h"
 
 @implementation DPLRouteHandler
 
@@ -32,39 +33,7 @@ - (void)presentTargetViewController:(UIViewController <DPLTargetViewController>
     }
     else if ([presentingViewController isKindOfClass:[UINavigationController class]]) {
 
-        [self placeTargetViewController:targetViewController
-                 inNavigationController:(UINavigationController *)presentingViewController];
-    }
-}
-
-
-#pragma mark - Private
-
-- (void)placeTargetViewController:(UIViewController *)targetViewController
-           inNavigationController:(UINavigationController *)navigationController {
-    
-    if ([navigationController.viewControllers containsObject:targetViewController]) {
-        [navigationController popToViewController:targetViewController animated:NO];
-    }
-    else {
-        
-        for (UIViewController *controller in navigationController.viewControllers) {
-            if ([controller isMemberOfClass:[targetViewController class]]) {
-                
-                [navigationController popToViewController:controller animated:NO];
-                [navigationController popViewControllerAnimated:NO];
-                
-                if ([controller isEqual:navigationController.topViewController]) {
-                    [navigationController setViewControllers:@[targetViewController] animated:NO];
-                }
-                
-                break;
-            }
-        }
-        
-        if (![navigationController.topViewController isEqual:targetViewController]) {
-            [navigationController pushViewController:targetViewController animated:NO];
-        }
+        [((UINavigationController *)presentingViewController) DPL_placeTargetViewController:targetViewController];
     }
 }
 

DeepLinkKit/module.modulemap

@@ -16,6 +16,7 @@ framework module DeepLinkKit {
     exclude header "NSString+DPLQuery.h"
     exclude header "NSString+DPLJSON.h"
     exclude header "NSObject+DPLJSONObject.h"
+    exclude header "UINavigationController+DPLRouting.h"
 }
 
 explicit module DeepLinkKit.Private {

Podfile.lock

@@ -19,7 +19,7 @@ EXTERNAL SOURCES:
     :path: .
 
 SPEC CHECKSUMS:
-  DeepLinkKit: 5349fa5cc37cadeb32e0fa239c28536bc0557cf2
+  DeepLinkKit: c5c1b216b8aa00fa7735ffeee6a354e39e7574ac
   Expecta: e1c022fcd33910b6be89c291d2775b3fe27a89fe
   KIF: 2275c6d59c77e5e56f660f006b99d73780130540
   OCMock: 18c9b7e67d4c2770e95bb77a9cc1ae0c91fe3835

Tests/Categories/UINavigationController_DPLRoutingSpec.m

@@ -0,0 +1,47 @@
+#import "Specta.h"
+#import "UINavigationController+DPLRouting.h"
+
+@interface VC1 : UIViewController @end
+@implementation VC1 @end
+
+@interface VC2 : UIViewController @end
+@implementation VC2 @end
+
+@interface VC3 : UIViewController @end
+@implementation VC3 @end
+
+
+SpecBegin(UINavigationController_DPLRouting)
+
+describe(@"DPL_placeTargetViewController:", ^{
+    
+    VC1 *vc1 = [VC1 new];
+    VC2 *vc2 = [VC2 new];
+    VC3 *vc3 = [VC3 new];
+    
+    __block UINavigationController *nc;
+    beforeEach(^{
+        nc = [[UINavigationController alloc] initWithRootViewController:[UIViewController new]];
+    });
+    
+    it(@"pushes a view controller on the stack if not already present", ^{
+        [nc DPL_placeTargetViewController:vc1];
+        expect(nc.topViewController).to.equal(vc1);
+    });
+    
+    it(@"pops to the view controller instance on the stack if already present", ^{
+        [nc setViewControllers:@[vc1, vc2, vc3] animated:NO];
+        [nc DPL_placeTargetViewController:vc2];
+        expect(nc.topViewController).to.equal(vc2);
+    });
+    
+    it(@"replaces existing instances of same view controller class already present on the stack", ^{
+       [nc setViewControllers:@[vc1, vc2, vc3] animated:NO];
+        VC2 *newvc2instance = [VC2 new];
+        [nc DPL_placeTargetViewController:newvc2instance];
+        expect(nc.topViewController).to.equal(newvc2instance);
+        expect(nc.viewControllers).toNot.contain(vc2);
+    });
+});
+
+SpecEnd