|
|
@@ -0,0 +1,163 @@
|
|
|
+#if os(iOS) || os(tvOS)
|
|
|
+import UIKit
|
|
|
+
|
|
|
+#if !COCOAPODS
|
|
|
+import URLMatcher
|
|
|
+#endif
|
|
|
+
|
|
|
+public typealias URLPattern = String
|
|
|
+public typealias ViewControllerFactory = (_ url: URLConvertible, _ values: [String: Any], _ context: Any?) -> UIViewController?
|
|
|
+public typealias URLOpenHandlerFactory = (_ url: URLConvertible, _ values: [String: Any], _ context: Any?) -> Bool
|
|
|
+public typealias URLOpenHandler = () -> Bool
|
|
|
+
|
|
|
+public protocol NavigatorType {
|
|
|
+ var matcher: URLMatcher { get }
|
|
|
+ var delegate: NavigatorDelegate? { get set }
|
|
|
+
|
|
|
+ /// Registers a view controller factory to the URL pattern.
|
|
|
+ func register(_ pattern: URLPattern, _ factory: @escaping ViewControllerFactory)
|
|
|
+
|
|
|
+ /// Registers an URL open handler to the URL pattern.
|
|
|
+ func handle(_ pattern: URLPattern, _ factory: @escaping URLOpenHandlerFactory)
|
|
|
+
|
|
|
+ /// Returns a matching view controller from the specified URL.
|
|
|
+ ///
|
|
|
+ /// - parameter url: An URL to find view controllers.
|
|
|
+ ///
|
|
|
+ /// - returns: A match view controller or `nil` if not matched.
|
|
|
+ func viewController(for url: URLConvertible, context: Any?) -> UIViewController?
|
|
|
+
|
|
|
+ /// Returns a matching URL handler from the specified URL.
|
|
|
+ ///
|
|
|
+ /// - parameter url: An URL to find url handlers.
|
|
|
+ ///
|
|
|
+ /// - returns: A matching handler factory or `nil` if not matched.
|
|
|
+ func handler(for url: URLConvertible, context: Any?) -> URLOpenHandler?
|
|
|
+
|
|
|
+ /// Pushes a matching view controller to the navigation controller stack.
|
|
|
+ ///
|
|
|
+ /// - note: It is not a good idea to use this method directly because this method requires all
|
|
|
+ /// parameters. This method eventually gets called when pushing a view controller with
|
|
|
+ /// an URL, so it's recommended to implement this method only for mocking.
|
|
|
+ @discardableResult
|
|
|
+ func pushURL(_ url: URLConvertible, context: Any?, from: UINavigationControllerType?, animated: Bool) -> UIViewController?
|
|
|
+
|
|
|
+ /// Pushes the view controller to the navigation controller stack.
|
|
|
+ ///
|
|
|
+ /// - note: It is not a good idea to use this method directly because this method requires all
|
|
|
+ /// parameters. This method eventually gets called when pushing a view controller, so
|
|
|
+ /// it's recommended to implement this method only for mocking.
|
|
|
+ @discardableResult
|
|
|
+ func pushViewController(_ viewController: UIViewController, from: UINavigationControllerType?, animated: Bool) -> UIViewController?
|
|
|
+
|
|
|
+ /// Presents a matching view controller.
|
|
|
+ ///
|
|
|
+ /// - note: It is not a good idea to use this method directly because this method requires all
|
|
|
+ /// parameters. This method eventually gets called when presenting a view controller with
|
|
|
+ /// an URL, so it's recommended to implement this method only for mocking.
|
|
|
+ @discardableResult
|
|
|
+ func presentURL(_ url: URLConvertible, context: Any?, wrap: UINavigationController.Type?, from: UIViewControllerType?, animated: Bool, completion: (() -> Void)?) -> UIViewController?
|
|
|
+
|
|
|
+ /// Presents the view controller.
|
|
|
+ ///
|
|
|
+ /// - note: It is not a good idea to use this method directly because this method requires all
|
|
|
+ /// parameters. This method eventually gets called when presenting a view controller, so
|
|
|
+ /// it's recommended to implement this method only for mocking.
|
|
|
+ @discardableResult
|
|
|
+ func presentViewController(_ viewController: UIViewController, wrap: UINavigationController.Type?, from: UIViewControllerType?, animated: Bool, completion: (() -> Void)?) -> UIViewController?
|
|
|
+
|
|
|
+ /// Executes an URL open handler.
|
|
|
+ ///
|
|
|
+ /// - note: It is not a good idea to use this method directly because this method requires all
|
|
|
+ /// parameters. This method eventually gets called when opening an url, so it's
|
|
|
+ /// recommended to implement this method only for mocking.
|
|
|
+ @discardableResult
|
|
|
+ func openURL(_ url: URLConvertible, context: Any?) -> Bool
|
|
|
+}
|
|
|
+
|
|
|
+
|
|
|
+// MARK: - Protocol Requirements
|
|
|
+
|
|
|
+extension NavigatorType {
|
|
|
+ public func viewController(for url: URLConvertible) -> UIViewController? {
|
|
|
+ return self.viewController(for: url, context: nil)
|
|
|
+ }
|
|
|
+
|
|
|
+ public func handler(for url: URLConvertible) -> URLOpenHandler? {
|
|
|
+ return self.handler(for: url, context: nil)
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func pushURL(_ url: URLConvertible, context: Any? = nil, from: UINavigationControllerType? = nil, animated: Bool = true) -> UIViewController? {
|
|
|
+ guard let viewController = self.viewController(for: url, context: context) else { return nil }
|
|
|
+ return self.pushViewController(viewController, from: from, animated: animated)
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func pushViewController(_ viewController: UIViewController, from: UINavigationControllerType?, animated: Bool) -> UIViewController? {
|
|
|
+ guard (viewController is UINavigationController) == false else { return nil }
|
|
|
+ guard let navigationController = from ?? UIViewController.topMost?.navigationController else { return nil }
|
|
|
+ guard self.delegate?.shouldPush(viewController: viewController, from: navigationController) != false else { return nil }
|
|
|
+ navigationController.pushViewController(viewController, animated: animated)
|
|
|
+ return viewController
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func presentURL(_ url: URLConvertible, context: Any? = nil, wrap: UINavigationController.Type? = nil, from: UIViewControllerType? = nil, animated: Bool = true, completion: (() -> Void)? = nil) -> UIViewController? {
|
|
|
+ guard let viewController = self.viewController(for: url, context: context) else { return nil }
|
|
|
+ return self.presentViewController(viewController, wrap: wrap, from: from, animated: animated, completion: completion)
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func presentViewController(_ viewController: UIViewController, wrap: UINavigationController.Type?, from: UIViewControllerType?, animated: Bool, completion: (() -> Void)?) -> UIViewController? {
|
|
|
+ guard let fromViewController = from ?? UIViewController.topMost else { return nil }
|
|
|
+
|
|
|
+ let viewControllerToPresent: UIViewController
|
|
|
+ if let navigationControllerClass = wrap, (viewController is UINavigationController) == false {
|
|
|
+ viewControllerToPresent = navigationControllerClass.init(rootViewController: viewController)
|
|
|
+ } else {
|
|
|
+ viewControllerToPresent = viewController
|
|
|
+ }
|
|
|
+
|
|
|
+ guard self.delegate?.shouldPresent(viewController: viewController, from: fromViewController) != false else { return nil }
|
|
|
+ fromViewController.present(viewControllerToPresent, animated: animated, completion: completion)
|
|
|
+ return viewController
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func openURL(_ url: URLConvertible, context: Any?) -> Bool {
|
|
|
+ guard let handler = self.handler(for: url, context: context) else { return false }
|
|
|
+ return handler()
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+
|
|
|
+// MARK: - Syntactic Sugars for Optional Parameters
|
|
|
+
|
|
|
+extension NavigatorType {
|
|
|
+ @discardableResult
|
|
|
+ public func push(_ url: URLConvertible, context: Any? = nil, from: UINavigationControllerType? = nil, animated: Bool = true) -> UIViewController? {
|
|
|
+ return self.pushURL(url, context: context, from: from, animated: animated)
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func push(_ viewController: UIViewController, from: UINavigationControllerType? = nil, animated: Bool = true) -> UIViewController? {
|
|
|
+ return self.pushViewController(viewController, from: from, animated: animated)
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func present(_ url: URLConvertible, context: Any? = nil, wrap: UINavigationController.Type? = nil, from: UIViewControllerType? = nil, animated: Bool = true, completion: (() -> Void)? = nil) -> UIViewController? {
|
|
|
+ return self.presentURL(url, context: context, wrap: wrap, from: from, animated: animated, completion: completion)
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func present(_ viewController: UIViewController, wrap: UINavigationController.Type? = nil, from: UIViewControllerType? = nil, animated: Bool = true, completion: (() -> Void)? = nil) -> UIViewController? {
|
|
|
+ return self.presentViewController(viewController, wrap: wrap, from: from, animated: animated, completion: completion)
|
|
|
+ }
|
|
|
+
|
|
|
+ @discardableResult
|
|
|
+ public func open(_ url: URLConvertible, context: Any? = nil) -> Bool {
|
|
|
+ return self.openURL(url, context: context)
|
|
|
+ }
|
|
|
+}
|
|
|
+#endif
|
openlockPPP