new routing library and refactor shortcuts (#2241)

Author: rnystrom

Classes/Search/SearchViewController.swift

@@ -104,6 +104,10 @@ SearchResultSectionControllerDelegate {
         }
     }
 
+    func searchBarBecomeFirstResponder() {
+        searchBar.becomeFirstResponder()
+    }
+
     // MARK: Data Loading/Paging
 
     private func update(animated: Bool) {

Classes/Systems/AppDelegate.swift

@@ -23,6 +23,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
 
         appController.appDidFinishLaunching(with: window)
+        appController.setupRoutes()
 
         // setup fabric
         Fabric.with([Crashlytics.self])
@@ -49,11 +50,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     }
 
     func application(_ application: UIApplication, performActionFor shortcutItem: UIApplicationShortcutItem, completionHandler: @escaping (Bool) -> Void) {
-        guard let route = Route(shortcutItem: shortcutItem) else {
-            completionHandler(false)
-            return
-        }
-        completionHandler(appController.handle(route: route))
+        appController.handle(path: shortcutItem.type, params: shortcutItem.params)
     }
 
     func applicationDidBecomeActive(_ application: UIApplication) {

Classes/Systems/AppRouter/AppController+SetupRoutes.swift

@@ -0,0 +1,19 @@
+//
+//  AppController+SetupRoutes.swift
+//  Freetime
+//
+//  Created by Ryan Nystrom on 10/7/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+
+import Foundation
+
+extension AppController {
+
+    func setupRoutes() {
+        register(route: BookmarkShortcutRoute.self)
+        register(route: SwitchAccountShortcutRoute.self)
+        register(route: SearchShortcutRoute.self)
+    }
+
+}

Classes/Systems/AppRouter/AppController.swift

@@ -18,6 +18,7 @@ final class AppController: LoginSplashViewControllerDelegate, GitHubSessionListe
     private var appClient: GithubClient?
     private var settingsNavigationController: UINavigationController?
     private var watchAppSync: WatchAppUserSessionSync?
+    private var routes = [String: (Routable & RoutePerformable).Type]()
 
     init() {
         sessionManager.addListener(listener: self)
@@ -51,18 +52,30 @@ final class AppController: LoginSplashViewControllerDelegate, GitHubSessionListe
         appClient?.badge.fetch(application: application, handler: completion)
     }
 
-    func handle(route: Route) -> Bool {
-        switch route {
-        case .tab(let tab):
-            splitViewController.select(tabAt: tab.rawValue)
-            return true
-        case .switchAccount(let sessionIndex):
-            if let index = sessionIndex {
-                let session = sessionManager.userSessions[index]
-                sessionManager.focus(session, dismiss: false)
-            }
-            return true
+    @discardableResult
+    func handle(url: URL) -> Bool {
+        guard let components = URLComponents(url: url, resolvingAgainstBaseURL: false)
+            else { return false }
+        var params = [String: String]()
+        for item in components.queryItems ?? [] {
+            params[item.name] = item.value
         }
+        return handle(path: url.path, params: params)
+    }
+
+    @discardableResult
+    func handle(path: String, params: [String: String]) -> Bool {
+        guard let routeType = routes[path],
+            let route = routeType.from(params: params)
+            else { return false }
+        return route.perform(
+            sessionManager: sessionManager,
+            splitViewController: splitViewController
+        )
+    }
+
+    func register<T: Routable & RoutePerformable>(route: T.Type) {
+        routes[T.path] = T.self
     }
 
     private func resetWatchSync(userSession: GitHubUserSession) {

Classes/Systems/AppRouter/AppSplitViewController.swift

@@ -20,18 +20,14 @@ final class AppSplitViewController: UISplitViewController {
         preferredDisplayMode = .allVisible
     }
 
-    private var detailNavigationController: UINavigationController? {
+    var detailNavigationController: UINavigationController? {
         return viewControllers.last as? UINavigationController
     }
 
-    private var masterTabBarController: UITabBarController? {
+    var masterTabBarController: UITabBarController? {
         return viewControllers.first as? UITabBarController
     }
 
-    func select(tabAt index: Int) {
-        masterTabBarController?.selectedIndex = index
-    }
-
     func resetEmpty() {
         let controller = UIViewController()
         controller.view.backgroundColor = Styles.Colors.background

Classes/Systems/AppRouter/BookmarkShortcutRoute.swift

@@ -0,0 +1,28 @@
+//
+//  BookmarkShortcutRoute.swift
+//  Freetime
+//
+//  Created by Ryan Nystrom on 10/7/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+
+import Foundation
+import GitHubSession
+
+struct BookmarkShortcutRoute: Routable {
+    static func from(params: [String : String]) -> BookmarkShortcutRoute? {
+        return BookmarkShortcutRoute()
+    }
+    static var path: String {
+        return "com.githawk.shortcut.bookmark"
+    }
+}
+
+extension BookmarkShortcutRoute: RoutePerformable {
+    func perform(
+        sessionManager: GitHubSessionManager,
+        splitViewController: AppSplitViewController
+        ) -> Bool {
+        return splitViewController.masterTabBarController?.selectTab(of: BookmarkViewController.self) != nil
+    }
+}

Classes/Systems/AppRouter/Routable.swift

@@ -0,0 +1,19 @@
+//
+//  Routable.swift
+//  Freetime
+//
+//  Created by Ryan Nystrom on 10/7/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+
+import Foundation
+
+protocol Routable {
+    static func from(params: [String: String]) -> Self?
+    var encoded: [String: String] { get }
+    static var path: String { get }
+}
+
+extension Routable {
+    var encoded: [String: String] { return [:] }
+}

Classes/Systems/AppRouter/RoutePerformable.swift

@@ -0,0 +1,18 @@
+//
+//  RoutePerformable.swift
+//  Freetime
+//
+//  Created by Ryan Nystrom on 10/7/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+
+import Foundation
+import GitHubSession
+
+protocol RoutePerformable {
+    @discardableResult
+    func perform(
+        sessionManager: GitHubSessionManager,
+        splitViewController: AppSplitViewController
+    ) -> Bool
+}

Classes/Systems/AppRouter/SearchShortcutRoute.swift

@@ -0,0 +1,31 @@
+//
+//  SearchShortcutRoute.swift
+//  Freetime
+//
+//  Created by Ryan Nystrom on 10/7/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+
+import UIKit
+import GitHubSession
+
+struct SearchShortcutRoute: Routable {
+    static func from(params: [String : String]) -> SearchShortcutRoute? {
+        return SearchShortcutRoute()
+    }
+    static var path: String {
+        return "com.githawk.shortcut.search"
+    }
+}
+
+extension SearchShortcutRoute: RoutePerformable {
+    func perform(
+        sessionManager: GitHubSessionManager,
+        splitViewController: AppSplitViewController
+        ) -> Bool {
+        guard let controller = splitViewController.masterTabBarController?.selectTab(of: SearchViewController.self)
+            else { return false }
+        controller.searchBarBecomeFirstResponder()
+        return true
+    }
+}

Classes/Systems/AppRouter/SwitchAccountShortcutRoute.swift

@@ -0,0 +1,38 @@
+//
+//  SwitchAccountShortcutRoute.swift
+//  Freetime
+//
+//  Created by Ryan Nystrom on 10/7/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+
+import Foundation
+import GitHubSession
+
+struct SwitchAccountShortcutRoute: Routable {
+    let username: String
+    static func from(params: [String : String]) -> SwitchAccountShortcutRoute? {
+        guard let username = params["username"] else { return nil }
+        return SwitchAccountShortcutRoute(username: username)
+    }
+    var encoded: [String : String] {
+        return ["username": username]
+    }
+    static var path: String {
+        return "com.githawk.shortcut.switch"
+    }
+}
+
+extension SwitchAccountShortcutRoute: RoutePerformable {
+    func perform(
+        sessionManager: GitHubSessionManager,
+        splitViewController: AppSplitViewController
+        ) -> Bool {
+        let userSessions = sessionManager.userSessions
+        guard let needle = userSessions.first(where: { username == $0.username })
+            else { return false }
+        sessionManager.focus(needle, dismiss: false)
+        splitViewController.masterTabBarController?.selectTab(of: NotificationsViewController.self)
+        return true
+    }
+}