move dynamicMemberLookup from Values to ProgressManager, add setter methods for totalCount and completedCount, remove withProperties closure

Author: chloe-yeo

Sources/FoundationEssentials/ProgressManager/ProgressManager+Interop.swift

@@ -187,9 +187,7 @@ internal final class NSProgressBridge: Progress, @unchecked Sendable {
         self.progress = progress
         super.init(parent: nil, userInfo: nil)
 
-        managerBridge.withProperties { properties in
-            properties.completedCount = Int(progress.completedUnitCount)
-        }
+        managerBridge.completedCount(Int(progress.completedUnitCount))
 
         let position = manager.addChild(
             child: managerBridge,
@@ -202,11 +200,8 @@ internal final class NSProgressBridge: Progress, @unchecked Sendable {
     // Overrides the _updateChild func that Foundation.Progress calls to update parent
     // so that the parent that gets updated is the ProgressManager parent
     override func _updateChild(_ child: Foundation.Progress, fraction: _NSProgressFractionTuple, portion: Int64) {
-        managerBridge.withProperties { properties in
-            properties.totalCount = Int(fraction.next.total)
-            properties.completedCount = Int(fraction.next.completed)
-        }
-        
+        managerBridge.totalCount(Int(fraction.next.total))
+        managerBridge.completedCount(Int(fraction.next.completed))
         managerBridge.markSelfDirty()
     }
 }

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

@@ -223,6 +223,64 @@ extension ProgressManager {
         internal mutating func complete(by count: Int) {
             selfFraction.completed += count
 
+#if FOUNDATION_FRAMEWORK
+            switch interopType {
+            case .interopObservation(let observation):
+                observation.subprogressBridge?.manager.notifyObservers(
+                    with: .fractionUpdated(
+                        totalCount: selfFraction.total ?? 0,
+                        completedCount: selfFraction.completed
+                    )
+                )
+                
+                if let _ = observation.reporterBridge {
+                    notifyObservers(
+                        with: .fractionUpdated(
+                            totalCount: selfFraction.total ?? 0,
+                            completedCount: selfFraction.completed
+                        )
+                    )
+                }
+            case .interopMirror:
+                break
+            default:
+                break
+            }
+#endif
+        }
+        
+        internal mutating func completedCount(_ count: Int) {
+            selfFraction.completed = count
+
+#if FOUNDATION_FRAMEWORK
+            switch interopType {
+            case .interopObservation(let observation):
+                observation.subprogressBridge?.manager.notifyObservers(
+                    with: .fractionUpdated(
+                        totalCount: selfFraction.total ?? 0,
+                        completedCount: selfFraction.completed
+                    )
+                )
+                
+                if let _ = observation.reporterBridge {
+                    notifyObservers(
+                        with: .fractionUpdated(
+                            totalCount: selfFraction.total ?? 0,
+                            completedCount: selfFraction.completed
+                        )
+                    )
+                }
+            case .interopMirror:
+                break
+            default:
+                break
+            }
+#endif
+        }
+        
+        internal mutating func totalCount(_ count: Int?) {
+            selfFraction.total = count
+
 #if FOUNDATION_FRAMEWORK
             switch interopType {
             case .interopObservation(let observation):

Sources/FoundationEssentials/ProgressManager/ProgressManager+State.swift

@@ -23,6 +23,7 @@ internal import _FoundationCollections
 
 /// An object that conveys ongoing progress to the user for a specified task.
 @available(FoundationPreview 6.2, *)
+@dynamicMemberLookup
 @Observable public final class ProgressManager: Sendable {
 
     internal let state: Mutex<State>
@@ -191,6 +192,36 @@ internal import _FoundationCollections
         }
     }
 
+    public func completedCount(_ count: Int) {
+        let parents: [ParentState]? = state.withLock { state in
+            guard state.selfFraction.completed != count else {
+                return nil
+            }
+            
+            state.completedCount(count)
+            
+            return state.parents
+        }
+        if let parents = parents {
+            markSelfDirty(parents: parents)
+        }
+    }
+    
+    public func totalCount(_ count: Int?) {
+        let parents: [ParentState]? = state.withLock { state in
+            guard state.selfFraction.total != count else {
+                return nil
+            }
+            
+            state.totalCount(count)
+            
+            return state.parents
+        }
+        if let parents = parents {
+            markSelfDirty(parents: parents)
+        }
+    }
+    
     // MARK: Internal Observation Support for Extensions
 
     /// Provides access to the observation registrar for use in extensions.

Sources/FoundationEssentials/ProgressManager/ProgressManager.swift

@@ -16,9 +16,9 @@ import Observation
 ///
 /// It is read-only and can be added as a child of another ProgressManager.
 @available(FoundationPreview 6.2, *)
+@dynamicMemberLookup
 @Observable public final class ProgressReporter: Sendable, Hashable, Equatable, CustomStringConvertible, CustomDebugStringConvertible {
 
-    public typealias Values = ProgressManager.Values
     public typealias Property = ProgressManager.Property
 
     /// The total units of work.
@@ -82,13 +82,6 @@ import Observation
         return self.description
     }
 
-    /// Reads properties that convey additional information about progress.
-    public func withProperties<T, E: Error>(
-        _ closure: (sending Values) throws(E) -> sending T
-    ) throws(E) -> T {
-        return try manager.getProperties(closure)
-    }
-    
     /// Returns a summary for the specified integer property across the progress subtree.
     ///
     /// This method aggregates the values of a custom integer property from the underlying progress manager
@@ -173,6 +166,97 @@ import Observation
         return manager.summary(of: property)
     }
 
+    /// Gets or sets custom integer properties.
+    ///
+    /// This subscript provides read-write access to custom progress properties where both the value
+    /// and summary types are `Int`. If the property has not been set, the getter returns the
+    /// property's default value.
+    ///
+    /// - Parameter key: A key path to the custom integer property type.
+    public subscript<P: Property>(dynamicMember key: KeyPath<ProgressManager.Properties, P.Type>) -> Int where P.Value == Int, P.Summary == Int {
+        get {
+            manager[dynamicMember: key]
+        }
+    }
+    
+    /// Gets or sets custom unsigned integer properties.
+    ///
+    /// This subscript provides read-write access to custom progress properties where both the value
+    /// and summary types are `UInt64`. If the property has not been set, the getter returns the
+    /// property's default value.
+    ///
+    /// - Parameter key: A key path to the custom unsigned integer property type.
+    public subscript<P: Property>(dynamicMember key: KeyPath<ProgressManager.Properties, P.Type>) -> UInt64 where P.Value == UInt64, P.Summary == UInt64 {
+        get {
+            manager[dynamicMember: key]
+        }
+    }
+    
+    /// Gets or sets custom double properties.
+    ///
+    /// This subscript provides read-write access to custom progress properties where both the value
+    /// and summary types are `Double`. If the property has not been set, the getter returns the
+    /// property's default value.
+    ///
+    /// - Parameter key: A key path to the custom double property type.
+    public subscript<P: Property>(dynamicMember key: KeyPath<ProgressManager.Properties, P.Type>) -> P.Value where P.Value == Double, P.Summary == Double {
+        get {
+            manager[dynamicMember: key]
+        }
+    }
+    
+    /// Gets or sets custom string properties.
+    ///
+    /// This subscript provides read-write access to custom progress properties where the value
+    /// type is `String?` and the summary type is `[String?]`. If the property has not been set,
+    /// the getter returns the property's default value.
+    ///
+    /// - Parameter key: A key path to the custom string property type.
+    public subscript<P: Property>(dynamicMember key: KeyPath<ProgressManager.Properties, P.Type>) -> String? where P.Value == String?, P.Summary == [String?] {
+        get {
+            manager[dynamicMember: key]
+        }
+    }
+    
+    /// Gets or sets custom URL properties.
+    ///
+    /// This subscript provides read-write access to custom progress properties where the value
+    /// type is `URL?` and the summary type is `[URL?]`. If the property has not been set,
+    /// the getter returns the property's default value.
+    ///
+    /// - Parameter key: A key path to the custom URL property type.
+    public subscript<P: Property>(dynamicMember key: KeyPath<ProgressManager.Properties, P.Type>) -> URL? where P.Value == URL?, P.Summary == [URL?] {
+        get {
+            manager[dynamicMember: key]
+        }
+    }
+    
+    /// Gets or sets custom unsigned integer properties.
+    ///
+    /// This subscript provides read-write access to custom progress properties where the value
+    /// type is `UInt64` and the summary type is `[UInt64]`. If the property has not been set,
+    /// the getter returns the property's default value.
+    ///
+    /// - Parameter key: A key path to the custom unsigned integer property type.
+    public subscript<P: Property>(dynamicMember key: KeyPath<ProgressManager.Properties, P.Type>) -> UInt64 where P.Value == UInt64, P.Summary == [UInt64] {
+        get {
+            manager[dynamicMember: key]
+        }
+    }
+    
+    /// Gets or sets custom duration properties.
+    ///
+    /// This subscript provides read-write access to custom progress properties where the value
+    /// type is `Duration` and the summary type is `Duration`. If the property has not been set,
+    /// the getter returns the property's default value.
+    ///
+    /// - Parameter key: A key path to the custom duration property type.
+    public subscript<P: Property>(dynamicMember key: KeyPath<ProgressManager.Properties, P.Type>) -> Duration where P.Value == Duration, P.Summary == Duration {
+        get {
+            manager[dynamicMember: key]
+        }
+    }
+    
     internal let manager: ProgressManager
 
     internal init(manager: ProgressManager) {