Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions Sources/CustomDump/Conformances/KeyPath.swift
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
#if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
extension AnyKeyPath: CustomDumpStringConvertible {
public var customDumpDescription: String {
extension AnyKeyPath: CustomDumpStringConvertible {
public var customDumpDescription: String {
#if swift(>=5.8)
if #available(macOS 13.3, iOS 16.4, watchOS 9.4, tvOS 16.4, *) {
return self.debugDescription
}
#endif
#if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
guard let name = keyPathToName[self] else {
func reflectName() -> String {
var namedKeyPaths = Reflection.allNamedKeyPaths(forUnderlyingTypeOf: Self.rootType)
Expand All @@ -24,9 +29,13 @@
return name
}
return name
}
#else
return typeName(Self.self, genericsAbbreviated: false)
#endif
}
}

#if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
private var keyPathToName: [AnyKeyPath: String] = [:]

// The source code below was extracted from the "KeyPath Reflection" branch of Apple's
Expand Down
28 changes: 20 additions & 8 deletions Sources/CustomDump/Internal/AnyType.swift
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
func typeName(_ type: Any.Type) -> String {
var name = _typeName(type)
if let index = name.firstIndex(of: ".") {
name.removeSubrange(...index)
}
return
name
func typeName(
_ type: Any.Type,
qualified: Bool = true,
genericsAbbreviated: Bool = true
) -> String {
var name = _typeName(type, qualified: qualified)
.replacingOccurrences(
of: #"\w+\.(\w+)"#,
with: "$1",
options: .regularExpression
)
.replacingOccurrences(
of: #"<.+>|\(unknown context at \$[[:xdigit:]]+\)\."#,
of: #"\(unknown context at \$[[:xdigit:]]+\)\."#,
with: "",
options: .regularExpression
)
if genericsAbbreviated {
name = name.replacingOccurrences(
of: #"<.+>"#,
with: "",
options: .regularExpression
)
}
return name
}
2 changes: 1 addition & 1 deletion Tests/CustomDumpTests/DiffTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -957,7 +957,7 @@ final class DiffTests: XCTestCase {
diff(
[
"value": 29.99 as Float
],
] as [String: Any],
[
"value": 29.99 as Double
]
Expand Down
113 changes: 108 additions & 5 deletions Tests/CustomDumpTests/DumpTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -573,10 +573,59 @@ final class DumpTests: XCTestCase {
)
}

#if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
func testKeyPath() {
var dump = ""
func testKeyPath() {
var dump = ""

#if swift(>=5.8)
if #available(macOS 13.3, iOS 16.4, watchOS 9.4, tvOS 16.4, *) {
dump = ""
customDump(\UserClass.name, to: &dump)
XCTAssertNoDifference(
dump,
#"""
\UserClass.name
"""#
)

dump = ""
customDump(\Pair.driver.name, to: &dump)
XCTAssertNoDifference(
dump,
#"""
\Pair.driver.name
"""#
)

dump = ""
customDump(\User.name.count, to: &dump)
XCTAssertNoDifference(
dump,
#"""
\User.name.count
"""#
)

dump = ""
customDump(\(x: Double, y: Double).x, to: &dump)
XCTAssertNoDifference(
dump,
#"""
\(x: Double, y: Double).x
"""#
)

dump = ""
customDump(\Item.$isInStock, to: &dump)
XCTAssertNoDifference(
dump,
#"""
\Item.$isInStock
"""#
)
return
}
#endif
#if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
// Run twice to exercise cached lookup
for _ in 1...2 {
dump = ""
Expand Down Expand Up @@ -614,9 +663,63 @@ final class DumpTests: XCTestCase {
WritableKeyPath<(x: Double, y: Double), Double>
"""#
)

dump = ""
customDump(\Item.$isInStock, to: &dump)
XCTAssertNoDifference(
dump,
#"""
KeyPath<Item, Wrapped<Bool>>
"""#
)
}
}
#endif
#else
dump = ""
customDump(\UserClass.name, to: &dump)
XCTAssertNoDifference(
dump,
#"""
KeyPath<UserClass, String>
"""#
)

dump = ""
customDump(\Pair.driver.name, to: &dump)
XCTAssertNoDifference(
dump,
#"""
KeyPath<Pair, String>
"""#
)

dump = ""
customDump(\User.name.count, to: &dump)
XCTAssertNoDifference(
dump,
#"""
KeyPath<User, Int>
"""#
)

dump = ""
customDump(\(x: Double, y: Double).x, to: &dump)
XCTAssertNoDifference(
dump,
#"""
WritableKeyPath<(x: Double, y: Double), Double>
"""#
)

dump = ""
customDump(\Item.$isInStock, to: &dump)
XCTAssertNoDifference(
dump,
#"""
KeyPath<Item, Wrapped<Bool>>
"""#
)
#endif
}

func testNamespacedTypes() {
var dump = ""
Expand Down
10 changes: 10 additions & 0 deletions Tests/CustomDumpTests/Mocks.swift
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,13 @@ struct Redacted<RawValue>: CustomDumpStringConvertible {

struct User: Equatable, Identifiable { var id: Int, name: String }
struct HashableUser: Equatable, Identifiable, Hashable { var id: Int, name: String }

@propertyWrapper
struct Wrapped<Value> {
var wrappedValue: Value
var projectedValue: Self { self }
}

struct Item {
@Wrapped var isInStock = true
}