adopt suggestion for using keypath instead of Property.Type as argument in summary methods

Author: chloe-yeo

Sources/FoundationEssentials/ProgressManager/ProgressManager+Properties+Accessors.swift

@@ -388,13 +388,13 @@ extension ProgressManager {
     /// - Parameter property: The type of the integer property to summarize. Must be a property
     ///   where both the value and summary types are `Int`.
     /// - Returns: An `Int` summary value for the specified property.
-    public func summary<P: Property>(of property: P.Type) -> P.Summary where P.Value == Int, P.Summary == Int {
-        if property.self == ProgressManager.Properties.TotalFileCount.self {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> P.Summary where P.Value == Int, P.Summary == Int {
+        if P.self == ProgressManager.Properties.TotalFileCount.self {
             self.access(keyPath: \.totalFileCount)
             self.access(keyPath: \.totalFileCountSummary)
             self.didSet(keyPath: \.totalFileCountSummary)
             return updatedFileCount(type: .total)
-        } else if property.self == ProgressManager.Properties.CompletedFileCount.self {
+        } else if P.self == ProgressManager.Properties.CompletedFileCount.self {
             self.access(keyPath: \.completedFileCount)
             self.access(keyPath: \.completedFileCountSummary)
             self.didSet(keyPath: \.completedFileCountSummary)
@@ -403,7 +403,7 @@ extension ProgressManager {
             self.access(keyPath: \.customPropertiesInt)
             self.access(keyPath: \.customPropertiesIntSummary)
             self.didSet(keyPath: \.customPropertiesIntSummary)
-            return updatedIntSummary(property: MetatypeWrapper(property))
+            return updatedIntSummary(property: MetatypeWrapper(P.self))
         }
     }
 
@@ -415,13 +415,13 @@ extension ProgressManager {
     /// - Parameter property: The type of the unsigned integer property to summarize. Must be a property
     ///   where both the value and summary types are `UInt64`.
     /// - Returns: An `UInt64` summary value for the specified property.
-    public func summary<P: Property>(of property: P.Type) -> P.Summary where P.Value == UInt64, P.Summary == UInt64 {
-        if property.self == ProgressManager.Properties.TotalByteCount.self {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> P.Summary where P.Value == UInt64, P.Summary == UInt64 {
+        if P.self == ProgressManager.Properties.TotalByteCount.self {
             self.access(keyPath: \.totalByteCount)
             self.access(keyPath: \.totalByteCountSummary)
             self.didSet(keyPath: \.totalByteCountSummary)
             return updatedByteCount(type: .total)
-        } else if property.self == ProgressManager.Properties.CompletedByteCount.self {
+        } else if P.self == ProgressManager.Properties.CompletedByteCount.self {
             self.access(keyPath: \.completedByteCount)
             self.access(keyPath: \.completedByteCountSummary)
             self.didSet(keyPath: \.completedByteCountSummary)
@@ -430,7 +430,7 @@ extension ProgressManager {
             self.access(keyPath: \.customPropertiesUInt64)
             self.access(keyPath: \.customPropertiesUInt64Summary)
             self.didSet(keyPath: \.customPropertiesUInt64Summary)
-            return updatedUInt64Summary(property: MetatypeWrapper(property))
+            return updatedUInt64Summary(property: MetatypeWrapper(P.self))
         }
     }
 
@@ -442,11 +442,11 @@ extension ProgressManager {
     /// - Parameter property: The type of the double property to summarize. Must be a property
     ///   where both the value and summary types are `Double`.
     /// - Returns: A `Double` summary value for the specified property.
-    public func summary<P: Property>(of property: P.Type) -> P.Summary where P.Value == Double, P.Summary == Double {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> P.Summary where P.Value == Double, P.Summary == Double {
         self.access(keyPath: \.customPropertiesDouble)
         self.access(keyPath: \.customPropertiesDoubleSummary)
         self.didSet(keyPath: \.customPropertiesDoubleSummary)
-        return updatedDoubleSummary(property: MetatypeWrapper(property))
+        return updatedDoubleSummary(property: MetatypeWrapper(P.self))
     }
 
     /// Returns a summary for a custom string property across the progress subtree.
@@ -457,11 +457,11 @@ extension ProgressManager {
     /// - Parameter property: The type of the string property to summarize. Must be a property
     ///   where both the value type is `String?` and the summary type is  `[String?]`.
     /// - Returns: A `[String?]` summary value for the specified property.
-    public func summary<P: Property>(of property: P.Type) -> P.Summary where P.Value == String?, P.Summary == [String?] {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> P.Summary where P.Value == String?, P.Summary == [String?] {
         self.access(keyPath: \.customPropertiesString)
         self.access(keyPath: \.customPropertiesStringSummary)
         self.didSet(keyPath: \.customPropertiesStringSummary)
-        return updatedStringSummary(property: MetatypeWrapper(property))
+        return updatedStringSummary(property: MetatypeWrapper(P.self))
     }
 
     /// Returns a summary for a custom URL property across the progress subtree.
@@ -472,11 +472,11 @@ extension ProgressManager {
     /// - Parameter property: The type of the URL property to summarize. Must be a property
     ///   where the value type is `URL?` and the summary type is `[URL?]`.
     /// - Returns: A `[URL?]` summary value for the specified property.
-    public func summary<P: Property>(of property: P.Type) -> P.Summary where P.Value == URL?, P.Summary == [URL?] {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> P.Summary where P.Value == URL?, P.Summary == [URL?] {
         self.access(keyPath: \.customPropertiesURL)
         self.access(keyPath: \.customPropertiesURLSummary)
         self.didSet(keyPath: \.customPropertiesURLSummary)
-        return updatedURLSummary(property: MetatypeWrapper(property))
+        return updatedURLSummary(property: MetatypeWrapper(P.self))
     }
 
     /// Returns a summary for a custom unsigned integer property across the progress subtree.
@@ -487,8 +487,8 @@ extension ProgressManager {
     /// - Parameter property: The type of the unsigned integer property to summarize. Must be a property
     ///   where the value type is `UInt64` and the summary type is `[UInt64]`.
     /// - Returns: A `[UInt64]` summary value for the specified property.
-    public func summary<P: Property>(of property: P.Type) -> P.Summary where P.Value == UInt64, P.Summary == [UInt64] {
-        if property.self == ProgressManager.Properties.Throughput.self {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> P.Summary where P.Value == UInt64, P.Summary == [UInt64] {
+        if P.self == ProgressManager.Properties.Throughput.self {
             self.access(keyPath: \.throughput)
             self.access(keyPath: \.throughputSummary)
             self.didSet(keyPath: \.throughputSummary)
@@ -497,7 +497,7 @@ extension ProgressManager {
             self.access(keyPath: \.customPropertiesUInt64Array)
             self.access(keyPath: \.customPropertiesUInt64ArraySummary)
             self.didSet(keyPath: \.customPropertiesUInt64ArraySummary)
-            return updatedUInt64ArraySummary(property: MetatypeWrapper(property))
+            return updatedUInt64ArraySummary(property: MetatypeWrapper(P.self))
         }
     }
 
@@ -509,8 +509,8 @@ extension ProgressManager {
     /// - Parameter property: The type of the duration property to summarize. Must be a property
     ///   where the value type is `Duration` and the summary type is `Duration`.
     /// - Returns: A `Duration` summary value for the specified property.
-    public func summary<P: Property>(of property: P.Type) -> P.Summary where P.Value == Duration, P.Summary == Duration {
-        if property.self == ProgressManager.Properties.EstimatedTimeRemaining.self {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> P.Summary where P.Value == Duration, P.Summary == Duration {
+        if P.self == ProgressManager.Properties.EstimatedTimeRemaining.self {
             self.access(keyPath: \.estimatedTimeRemaining)
             self.access(keyPath: \.estimatedTimeRemainingSummary)
             self.didSet(keyPath: \.estimatedTimeRemainingSummary)
@@ -519,7 +519,7 @@ extension ProgressManager {
             self.access(keyPath: \.customPropertiesDuration)
             self.access(keyPath: \.customPropertiesDurationSummary)
             self.didSet(keyPath: \.customPropertiesDurationSummary)
-            return updatedDurationSummary(property: MetatypeWrapper(property))
+            return updatedDurationSummary(property: MetatypeWrapper(P.self))
         }
     }
 }

Sources/FoundationEssentials/ProgressManager/ProgressManager.swift

@@ -551,12 +551,12 @@ extension ProgressManager: CustomStringConvertible, CustomDebugStringConvertible
         fractionCompleted: \(fractionCompleted)
         isIndeterminate: \(isIndeterminate)
         isFinished: \(isFinished)
-        totalFileCount: \(summary(of: ProgressManager.Properties.TotalFileCount.self))
-        completedFileCount: \(summary(of: ProgressManager.Properties.CompletedFileCount.self))
-        totalByteCount: \(summary(of: ProgressManager.Properties.TotalByteCount.self))
-        completedByteCount: \(summary(of: ProgressManager.Properties.CompletedByteCount.self))
-        throughput: \(summary(of: ProgressManager.Properties.Throughput.self))
-        estimatedTimeRemaining: \(summary(of: ProgressManager.Properties.EstimatedTimeRemaining.self))
+        totalFileCount: \(summary(of: \.totalFileCount))
+        completedFileCount: \(summary(of: \.completedFileCount))
+        totalByteCount: \(summary(of: \.totalByteCount))
+        completedByteCount: \(summary(of: \.completedByteCount))
+        throughput: \(summary(of: \.throughput))
+        estimatedTimeRemaining: \(summary(of: \.estimatedTimeRemaining))
         """
     }
 

Sources/FoundationEssentials/ProgressManager/ProgressReporter.swift

@@ -65,12 +65,12 @@ import Observation
         fractionCompleted: \(fractionCompleted)
         isIndeterminate: \(isIndeterminate)
         isFinished: \(isFinished)
-        totalFileCount: \(summary(of: ProgressManager.Properties.TotalFileCount.self))
-        completedFileCount: \(summary(of: ProgressManager.Properties.CompletedFileCount.self))
-        totalByteCount: \(summary(of: ProgressManager.Properties.TotalByteCount.self))
-        completedByteCount: \(summary(of: ProgressManager.Properties.CompletedByteCount.self))
-        throughput: \(summary(of: ProgressManager.Properties.Throughput.self))
-        estimatedTimeRemaining: \(summary(of: ProgressManager.Properties.EstimatedTimeRemaining.self))
+        totalFileCount: \(summary(of: \.totalFileCount))
+        completedFileCount: \(summary(of: \.completedFileCount))
+        totalByteCount: \(summary(of: \.totalByteCount))
+        completedByteCount: \(summary(of: \.completedByteCount))
+        throughput: \(summary(of: \.throughput))
+        estimatedTimeRemaining: \(summary(of: \.estimatedTimeRemaining))
         """
     }
 
@@ -90,7 +90,7 @@ import Observation
     /// - Parameter property: The type of the integer property to summarize. Must be a property
     ///   where both the value and summary types are `Int`.
     /// - Returns: The aggregated summary value for the specified property across the entire subtree.
-    public func summary<P: Property>(of property: P.Type) -> Int where P.Value == Int, P.Summary == Int {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> Int where P.Value == Int, P.Summary == Int {
         manager.summary(of: property)
     }
 
@@ -102,7 +102,7 @@ import Observation
     /// - Parameter property: The type of the unsigned property to summarize. Must be a property
     ///   where both the value and summary types are `UInt64`.
     /// - Returns: The aggregated summary value for the specified property across the entire subtree.
-    public func summary<P: Property>(of property: P.Type) -> UInt64 where P.Value == UInt64, P.Summary == UInt64 {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> UInt64 where P.Value == UInt64, P.Summary == UInt64 {
         manager.summary(of: property)
     }
 
@@ -114,7 +114,7 @@ import Observation
     /// - Parameter property: The type of the double property to summarize. Must be a property
     ///   where both the value and summary types are `Double`.
     /// - Returns: The aggregated summary value for the specified property across the entire subtree.
-    public func summary<P: Property>(of property: P.Type) -> Double where P.Value == Double, P.Summary == Double {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> Double where P.Value == Double, P.Summary == Double {
         manager.summary(of: property)
     }
 
@@ -126,7 +126,7 @@ import Observation
     /// - Parameter property: The type of the string property to summarize. Must be a property
     ///   where both the value and summary types are `String`.
     /// - Returns: The aggregated summary value for the specified property across the entire subtree.
-    public func summary<P: Property>(of property: P.Type) -> [String?] where P.Value == String?, P.Summary == [String?] {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> [String?] where P.Value == String?, P.Summary == [String?] {
         return manager.summary(of: property)
     }
 
@@ -138,7 +138,7 @@ import Observation
     /// - Parameter property: The type of the URL property to summarize. Must be a property
     ///   where both the value and summary types are `URL?` and `[URL?]` respectively.
     /// - Returns: The aggregated summary value for the specified property across the entire subtree.
-    public func summary<P: Property>(of property: P.Type) -> [URL?] where P.Value == URL?, P.Summary == [URL?] {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> [URL?] where P.Value == URL?, P.Summary == [URL?] {
         return manager.summary(of: property)
     }
 
@@ -150,7 +150,7 @@ import Observation
     /// - Parameter property: The type of the unsigned integer property to summarize. Must be a property
     ///   where the value type is `UInt64` and the summary type is `[UInt64]`.
     /// - Returns: The aggregated summary value for the specified property across the entire subtree.
-    public func summary<P: Property>(of property: P.Type) -> [UInt64] where P.Value == UInt64, P.Summary == [UInt64] {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> [UInt64] where P.Value == UInt64, P.Summary == [UInt64] {
         return manager.summary(of: property)
     }
 
@@ -162,7 +162,7 @@ import Observation
     /// - Parameter property: The type of the duration property to summarize. Must be a property
     ///   where both the value and summary types are `Duration`.
     /// - Returns: The aggregated summary value for the specified property across the entire subtree.
-    public func summary<P: Property>(of property: P.Type) -> Duration where P.Value == Duration, P.Summary == Duration {
+    public func summary<P: Property>(of property: KeyPath<ProgressManager.Properties, P.Type>) -> Duration where P.Value == Duration, P.Summary == Duration {
         return manager.summary(of: property)
     }