Merge pull request #3 from Ryu0118/feature/allkeypath-recursively

Add feature to recursively get KeyPath of all properties
Ryu0118 · Jun 8, 2023 · f8756f5 · f8756f5
2 parents 197d9c3 + 4740397
commit f8756f5
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 0 deletions.
diff --git a/Sources/KeyPathIterable/KeyPathIterable.swift b/Sources/KeyPathIterable/KeyPathIterable.swift
@@ -1,3 +1,43 @@
 public protocol KeyPathIterable {
     static var allKeyPaths: [PartialKeyPath<Self>] { get }
+    static var allAnyKeyPaths: [AnyKeyPath] { get }
+
+    var allKeyPaths: [PartialKeyPath<Self>] { get }
+    var allAnyKeyPaths: [AnyKeyPath] { get }
+
+    var recursivelyAllKeyPaths: [PartialKeyPath<Self>] { get }
+    var recursivelyAllAnyKeyPaths: [AnyKeyPath] { get }
+}
+
+public extension KeyPathIterable {
+    static var allAnyKeyPaths: [AnyKeyPath] {
+        allKeyPaths.map { $0 as AnyKeyPath }
+    }
+
+    var allKeyPaths: [PartialKeyPath<Self>] {
+        Self.allKeyPaths
+    }
+
+    var allAnyKeyPaths: [AnyKeyPath] {
+        allKeyPaths.map { $0 as AnyKeyPath }
+    }
+
+    var recursivelyAllKeyPaths: [PartialKeyPath<Self>] {
+        var recursivelyKeyPaths = [PartialKeyPath<Self>]()
+        for keyPath in allKeyPaths {
+            recursivelyKeyPaths.append(keyPath)
+            if let anyKeyPathIterable = self[keyPath: keyPath] as? any KeyPathIterable {
+                for childKeyPath in anyKeyPathIterable.recursivelyAllAnyKeyPaths {
+                    if let appendedKeyPath = keyPath.appending(path: childKeyPath) {
+                        recursivelyKeyPaths.append(appendedKeyPath)
+                    }
+                }
+            }
+        }
+        return recursivelyKeyPaths
+    }
+
+    var recursivelyAllAnyKeyPaths: [AnyKeyPath] {
+        recursivelyAllKeyPaths.map { $0 as AnyKeyPath }
+    }
 }
diff --git a/Tests/KeyPathIterableTests/KeyPathIterableTests.swift b/Tests/KeyPathIterableTests/KeyPathIterableTests.swift
@@ -30,6 +30,22 @@ final class KeyPathIterableTests: XCTestCase {
         XCTAssertEqual(count, 0)
     }
 
+    func testRecursivelyAllKeyPaths() throws {
+        let recursivelyAllKeyPaths = Set(NestedStruct(hoge: .init(), fuga: .init()).recursivelyAllKeyPaths)
+
+        XCTAssertEqual(
+            recursivelyAllKeyPaths,
+            [
+                 \.hoge,
+                 \.hoge.hoge,
+                 \.hoge.fuga,
+                 \.hoge.foo,
+                 \.fuga,
+                 \.fuga.fuga,
+                 \.fuga.hoge
+            ]
+        )
+    }
 
     @KeyPathIterable
     struct StructHoge {
@@ -40,8 +56,14 @@ final class KeyPathIterableTests: XCTestCase {
 
     @KeyPathIterable
     enum EnumHoge {
+        case c1
+
         var hoge: Int { 1 }
         var fuga: Int { 2 }
+
+        init() {
+            self = .c1
+        }
     }
 
     @KeyPathIterable
@@ -58,4 +80,10 @@ final class KeyPathIterableTests: XCTestCase {
         nonisolated var hoge: Int { 1 }
         var fuga = 2
     }
+
+    @KeyPathIterable
+    struct NestedStruct {
+        let hoge: StructHoge
+        let fuga: EnumHoge
+    }
 }