Merge pull request #10 from canopas/add-debug-flags

Add debug log

Author: cp-amisha-i

Sources/UIPilot/DebugLog.swift

@@ -0,0 +1,14 @@
+//
+//  DebugLog.swift
+//  
+//
+//  Created by Amisha I on 28/03/22.
+//
+
+import Foundation
+
+class DebugLog: Logger {
+    func log(_ value: String) {
+        print(value)
+    }
+}

Sources/UIPilot/EmptyLog.swift

@@ -0,0 +1,14 @@
+//
+//  EmptyLog.swift
+//  
+//
+//  Created by Amisha I on 28/03/22.
+//
+
+import Foundation
+
+class EmptyLog: Logger {
+    func log(_ value: String) {
+        
+    }
+}

Sources/UIPilot/UIPilot.swift

@@ -2,39 +2,50 @@ import SwiftUI
 import Combine
 
 public class UIPilot<T: Equatable>: ObservableObject {
+
     var paths: [Path<T>] = [] {
         didSet { updateViewState() }
     }
 
     var routeMap: RouteMap<T>? {
         didSet { updateViewState() }
     }
-    
+
+    let logger: Logger
     var state: UIPilotViewState<T>!
 
-    public init(initial: T) {
+    public init(initial: T, debug: Bool = false) {
+        logger = debug ? DebugLog() : EmptyLog()
+        logger.log("UIPilot - Pilot Initialized.")
+
         state = UIPilotViewState(onPop: { [weak self] in
             self?.pop()
         })
         push(initial)
     }
 
     public func push(_ route: T) {
+        logger.log("UIPilot - Pushing \(route) route.")
         self.paths.append(Path(route: route))
     }
 
     public func pop() {
         if !self.paths.isEmpty {
+            logger.log("UIPilot - Route popped.")
             self.paths.removeLast()
         }
     }
 
     public func popTo(_ route: T, inclusive: Bool = false) {
+        logger.log("UIPilot: Popping route \(route).")
+
         if paths.isEmpty {
+            logger.log("UIPilot - Path is empty.")
             return
         }
 
         guard var found = paths.firstIndex(where: { $0.route == route }) else {
+            logger.log("UIPilot - Route not found.")
             return
         }
 
@@ -43,12 +54,14 @@ public class UIPilot<T: Equatable>: ObservableObject {
         }
 
         for _ in found..<paths.count {
+            logger.log("UIPilot - Route \(route) Popped.")
             pop()
         }
     }
 
     private func updateViewState() {
         if let routeMap = routeMap {
+            logger.log("UIPilot - Updating route state.")
             state.onPathsChanged(paths: paths, routeMap: routeMap)
         }
     }
@@ -68,9 +81,7 @@ struct Path<T: Equatable>: Equatable, Hashable {
 }
 
 struct PathView: View {
-    
     private let content: AnyView
-
     @ObservedObject var state: PathViewState
 
     public init(_ content: AnyView, state: PathViewState) {
@@ -119,11 +130,10 @@ class PathViewState: ObservableObject {
 class UIPilotViewState<T: Equatable>: ObservableObject {
 
     private let onPop: () -> Void
-    
     private var pathViews = [Path<T>: PathView]()
 
     @Published var content: PathView? = nil
-    
+
     init(onPop: @escaping () -> Void) {
         self.onPop = onPop
     }
@@ -138,7 +148,7 @@ class UIPilotViewState<T: Equatable>: ObservableObject {
         var current: PathView? = nil
         for path in paths.reversed() {
             var content = pathViews[path]
-            
+
             if content == nil {
                 pathViews[path] = PathView(routeMap(path.route), state: PathViewState())
                 content = pathViews[path]
@@ -151,10 +161,8 @@ class UIPilotViewState<T: Equatable>: ObservableObject {
                     self.onPop()
                 }
             }
-
             current = content
         }
-        
         return current
     }
 
@@ -192,3 +200,7 @@ public struct UIPilotHost<T: Equatable>: View {
         .environmentObject(pilot)
     }
 }
+
+protocol Logger {
+    func log(_ value: String)
+}