Add comments

Author: toupper

WooCommerce/Classes/Universal Links/RouteMatcher.swift

@@ -1,14 +1,20 @@
 import Foundation
 
+/// This struct enriches a route with the parameters that came along with the URL,
+/// making it possible to perform the route action
+/// 
 struct MatchedRoute {
     let route: Route
     let parameters: [String: String]
 
     func performAction() {
-        route.action.perform(with: parameters)
+        route.perform(with: parameters)
     }
 }
 
+/// RouterMatcher finds URL routes with paths that match the path of a specified URL,
+/// and extracts parameters from the URL.
+///
 class RouteMatcher {
     let routes: [Route]
 

WooCommerce/Classes/Universal Links/Routes/OrderDetailsRoute.swift

@@ -0,0 +1,11 @@
+import Foundation
+
+/// Shows order details from a given universal link that matches the right path
+///
+struct OrderDetailsRoute: Route {
+    let path = "/orders/details"
+
+    func perform(with parameters: [String: String]) {
+        DDLogInfo("We received an order details universal link with parameters: \(parameters)")
+    }
+}

WooCommerce/Classes/Universal Links/Routes/Route.swift

@@ -0,0 +1,10 @@
+import UIKit
+import Foundation
+
+/// A universal link route, used to encapsulate a URL path and action
+/// 
+protocol Route {
+    var path: String { get }
+
+    func perform(with parameters: [String: String])
+}

WooCommerce/Classes/Universal Links/UniversalLinkRouter.swift

@@ -1,14 +1,15 @@
 import Foundation
 import UIKit
 
-protocol LinkRouter {
-    init(routes: [Route])
-    func handle(url: URL)
-}
-
-struct UniversalLinkRouter: LinkRouter {
+/// Keeps a list of possible URL routes that are exposed
+/// via universal links, and handles incoming links to trigger the appropriate route.
+///
+struct UniversalLinkRouter {
     private let matcher: RouteMatcher
 
+    /// The order of the passed Route array matters, as given two routes that handle a path only the first
+    /// will be called to perform its action
+    ///
     init(routes: [Route]) {
         matcher = RouteMatcher(routes: routes)
     }

WooCommerce/WooCommerce.xcodeproj/project.pbxproj

@@ -6886,14 +6886,22 @@
 		B958A7C528B3D42000823EEF /* Universal Links */ = {
 			isa = PBXGroup;
 			children = (
+				B958A7CE28B50FAE00823EEF /* Routes */,
 				B958A7C628B3D44A00823EEF /* UniversalLinkRouter.swift */,
-				B958A7C828B3D47B00823EEF /* Route.swift */,
 				B958A7CA28B3D4A100823EEF /* RouteMatcher.swift */,
-				B958A7CC28B3DD9100823EEF /* OrderDetailsRoute.swift */,
 			);
 			path = "Universal Links";
 			sourceTree = "<group>";
 		};
+		B958A7CE28B50FAE00823EEF /* Routes */ = {
+			isa = PBXGroup;
+			children = (
+				B958A7CC28B3DD9100823EEF /* OrderDetailsRoute.swift */,
+				B958A7C828B3D47B00823EEF /* Route.swift */,
+			);
+			path = Routes;
+			sourceTree = "<group>";
+		};
 		B9B0391B28A690DA00DC1C83 /* PermanentNotice */ = {
 			isa = PBXGroup;
 			children = (