refactor: rename matchingKey as matchPath

jaeho-flitto · jaeho-flitto · commit 363a4553c740 · 2023-01-16T15:15:34.000+09:00
diff --git a/Examples/MVI-Example/MVI-Example/Feature/Home/HomeRouteBuilder.swift b/Examples/MVI-Example/MVI-Example/Feature/Home/HomeRouteBuilder.swift
@@ -6,7 +6,7 @@ struct HomeRouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         HomeView.build(
           intent: HomeIntent(initialState: .init(), navigator: navigator))
       }
diff --git a/Examples/MVI-Example/MVI-Example/Feature/Page1/Page1RouteBuilder.swift b/Examples/MVI-Example/MVI-Example/Feature/Page1/Page1RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page1RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page1View.build(
           intent: Page1Intent(initialState: .init(), navigator: navigator))
       }
diff --git a/Examples/MVI-Example/MVI-Example/Feature/Page2/Page2RouteBuilder.swift b/Examples/MVI-Example/MVI-Example/Feature/Page2/Page2RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page2RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page2View.build(
           intent: Page2Intent(initialState: .init(), navigator: navigator))
       }
diff --git a/Examples/MVI-Example/MVI-Example/Feature/Page3/Page3RouteBuilder.swift b/Examples/MVI-Example/MVI-Example/Feature/Page3/Page3RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page3RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page3View.build(
           intent: Page3Intent(
             initialState: .init(message: items.getValue(key: "page3-message") ?? ""),
diff --git a/Examples/MVI-Example/MVI-Example/Feature/Page4/Page4RouteBuilder.swift b/Examples/MVI-Example/MVI-Example/Feature/Page4/Page4RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page4RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page4View.build(
           intent: Page4Intent(
             initialState: .init(message: items.getValue(key: "page4-message") ?? ""),
diff --git a/Examples/TCA-Example/TCA-Example/Feature/Home/HomeRouteBuilder.swift b/Examples/TCA-Example/TCA-Example/Feature/Home/HomeRouteBuilder.swift
@@ -6,7 +6,7 @@ struct HomeRouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String : String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         HomeView(
           store: .init(
             initialState: Home.State(),
diff --git a/Examples/TCA-Example/TCA-Example/Feature/Page1/Page1RouteBuilder.swift b/Examples/TCA-Example/TCA-Example/Feature/Page1/Page1RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page1RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page1View(
           store: .init(
             initialState: Page1.State(),
diff --git a/Examples/TCA-Example/TCA-Example/Feature/Page2/Page2RouteBuilder.swift b/Examples/TCA-Example/TCA-Example/Feature/Page2/Page2RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page2RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page2View(
           store: .init(
             initialState: Page2.State(),
diff --git a/Examples/TCA-Example/TCA-Example/Feature/Page3/Page3RouteBuilder.swift b/Examples/TCA-Example/TCA-Example/Feature/Page3/Page3RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page3RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page3View(
           store: .init(
             initialState: Page3.State(message: items.getValue(key: "page3-message") ?? ""),
diff --git a/Examples/TCA-Example/TCA-Example/Feature/Page4/Page4RouteBuilder.swift b/Examples/TCA-Example/TCA-Example/Feature/Page4/Page4RouteBuilder.swift
@@ -6,7 +6,7 @@ struct Page4RouteBuilder: RouteBuilder {
 
   var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
     { navigator, items, dep in
-      WrappingController(matchingKey: matchPath) {
+      WrappingController(matchPath: matchPath) {
         Page4View(
           store: .init(
             initialState: Page4.State(message: items.getValue(key: "page4-message") ?? ""),
diff --git a/README.md b/README.md
@@ -252,7 +252,7 @@ For example, you can put it in `ViewModel` or `Environment`.
 
     var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {
       { navigator, items, dependency in
-        return WrappingController(matchingKey: matchPath) {
+        return WrappingController(matchPath: matchPath) {
           HomePage(navigator: navigator)
         }
       }
diff --git a/Sources/LinkNavigator/Builder/RouteBuilderType.swift b/Sources/LinkNavigator/Builder/RouteBuilderType.swift
@@ -1,6 +1,6 @@
 import UIKit
 
-public typealias MatchingViewController = MatchingKeyUsable & UIViewController
+public typealias MatchingViewController = MatchPathUsable & UIViewController
 
 public protocol RouteBuilder {
 	var matchPath: String { get }
diff --git a/Sources/LinkNavigator/Components/WrappingController.swift b/Sources/LinkNavigator/Components/WrappingController.swift
@@ -1,18 +1,18 @@
 import SwiftUI
 
-public protocol MatchingKeyUsable {
-  var matchingKey: String { get }
+public protocol MatchPathUsable {
+  var matchPath: String { get }
 }
 
-public final class WrappingController<Content: View>: UIHostingController<Content>, MatchingKeyUsable {
+public final class WrappingController<Content: View>: UIHostingController<Content>, MatchPathUsable {
 
-  public let matchingKey: String
+  public let matchPath: String
 
   public init(
-    matchingKey: String,
+    matchPath: String,
     @ViewBuilder content: () -> Content)
   {
-    self.matchingKey = matchingKey
+    self.matchPath = matchPath
     super.init(rootView: content())
   }
 
diff --git a/Sources/LinkNavigator/Core/LinkNavigator.swift b/Sources/LinkNavigator/Core/LinkNavigator.swift
@@ -52,7 +52,7 @@ public protocol LinkNavigatorType {
   ///
   ///   var build: (LinkNavigatorType, [String: String], DependencyType) -> UIViewController? {
   ///     { navigator, items, dep in
-  ///       WrappingController(matchingKey: matchPath) {
+  ///       WrappingController(matchPath: matchPath) {
   ///         Page4View(
   ///           store: .init(
   ///             initialState: Page4.State(message: items["page4-message"] ?? ""), // catches here.
@@ -254,7 +254,6 @@ public protocol LinkNavigatorType {
   ///   - paths: An array of ``RouteBuilder/matchPath`` for the specific page.
   func rootRemove(paths: [String])
 
-
   /// Remove last page in pages.
   ///
   /// ```swift
@@ -398,15 +397,15 @@ extension LinkNavigator: LinkNavigatorType {
   public var currentPaths: [String] {
     currentActivityNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable }
-      .map(\.matchingKey)
+      .compactMap { $0 as? MatchPathUsable }
+      .map(\.matchPath)
   }
 
   public var rootCurrentPaths: [String] {
     rootNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable }
-      .map(\.matchingKey)
+      .compactMap { $0 as? MatchPathUsable }
+      .map(\.matchPath)
   }
 
   public func next(paths: [String], items: [String: String], isAnimated: Bool) {
@@ -508,8 +507,8 @@ extension LinkNavigator: LinkNavigatorType {
   public func remove(paths: [String]) {
     let new = currentActivityNavigationController
       .viewControllers
-      .compactMap{ $0 as? MatchingKeyUsable & UIViewController }
-      .filter{ !paths.contains($0.matchingKey) }
+      .compactMap{ $0 as? MatchPathUsable & UIViewController }
+      .filter{ !paths.contains($0.matchPath) }
 
     guard new.count != currentActivityNavigationController.viewControllers.count else { return }
     currentActivityNavigationController.setViewControllers(new, animated: false)
@@ -518,8 +517,8 @@ extension LinkNavigator: LinkNavigatorType {
   public func rootRemove(paths: [String]) {
     let new = rootNavigationController
       .viewControllers
-      .compactMap{ $0 as? MatchingKeyUsable & UIViewController }
-      .filter{ !paths.contains($0.matchingKey) }
+      .compactMap{ $0 as? MatchPathUsable & UIViewController }
+      .filter{ !paths.contains($0.matchPath) }
 
     guard new.count != rootNavigationController.viewControllers.count else { return }
     rootNavigationController.setViewControllers(new, animated: false)
@@ -577,42 +576,42 @@ fileprivate extension LinkNavigator {
   func isCurrentContain(path: String) -> Bool {
     currentActivityNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable }
-      .first(where: { $0.matchingKey == path }) != nil
+      .compactMap { $0 as? MatchPathUsable }
+      .first(where: { $0.matchPath == path }) != nil
   }
 
   func isCurrentContainRootViewController(path: String) -> Bool {
     rootNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable }
-      .first(where: { $0.matchingKey == path }) != nil
+      .compactMap { $0 as? MatchPathUsable }
+      .first(where: { $0.matchPath == path }) != nil
   }
 
   func findFirstViewController(path: String) -> UIViewController? {
     currentActivityNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable & UIViewController }
-      .first(where: { $0.matchingKey == path })
+      .compactMap { $0 as? MatchPathUsable & UIViewController }
+      .first(where: { $0.matchPath == path })
   }
 
   func findLastViewController(path: String) -> UIViewController? {
     currentActivityNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable & UIViewController }
-      .last(where: { $0.matchingKey == path })
+      .compactMap { $0 as? MatchPathUsable & UIViewController }
+      .last(where: { $0.matchPath == path })
   }
 
   func findFirstViewControllerRootView(path: String) -> UIViewController? {
     rootNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable & UIViewController }
-      .first(where: { $0.matchingKey == path })
+      .compactMap { $0 as? MatchPathUsable & UIViewController }
+      .first(where: { $0.matchPath == path })
   }
 
   func findLastViewControllerRootView(path: String) -> UIViewController? {
     rootNavigationController
       .viewControllers
-      .compactMap { $0 as? MatchingKeyUsable & UIViewController }
-      .last(where: { $0.matchingKey == path })
+      .compactMap { $0 as? MatchPathUsable & UIViewController }
+      .last(where: { $0.matchPath == path })
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ struct HomeRouteBuilder: RouteBuilder {`
`6`	`6`
`7`	`7`	`var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {`
`8`	`8`	`{ navigator, items, dep in`
`9`		`- WrappingController(matchingKey: matchPath) {`
	`9`	`+ WrappingController(matchPath: matchPath) {`
`10`	`10`	`HomeView.build(`
`11`	`11`	`intent: HomeIntent(initialState: .init(), navigator: navigator))`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ struct Page1RouteBuilder: RouteBuilder {`
`6`	`6`
`7`	`7`	`var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {`
`8`	`8`	`{ navigator, items, dep in`
`9`		`- WrappingController(matchingKey: matchPath) {`
	`9`	`+ WrappingController(matchPath: matchPath) {`
`10`	`10`	`Page1View.build(`
`11`	`11`	`intent: Page1Intent(initialState: .init(), navigator: navigator))`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ struct Page2RouteBuilder: RouteBuilder {`
`6`	`6`
`7`	`7`	`var build: (LinkNavigatorType, [String: String], DependencyType) -> MatchingViewController? {`
`8`	`8`	`{ navigator, items, dep in`
`9`		`- WrappingController(matchingKey: matchPath) {`
	`9`	`+ WrappingController(matchPath: matchPath) {`
`10`	`10`	`Page2View.build(`
`11`	`11`	`intent: Page2Intent(initialState: .init(), navigator: navigator))`
`12`	`12`	`}`