ListMonitor and ObjectMonitor objective C bridge

2026-03-21 00:49:20 +01:00 · 2016-03-29 14:15:57 +09:00
parent 9d7960e674
commit e99d19d2ac
15 changed files with 718 additions and 103 deletions
--- a/Sources/ObjectiveC/CSDataStack+Observing.swift
+++ b/Sources/ObjectiveC/CSDataStack+Observing.swift
@@ -0,0 +1,183 @@
+//
+//  CSDataStack+Observing.swift
+//  CoreStore
+//
+//  Copyright © 2016 John Rommel Estropia
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+//
+
+import Foundation
+import CoreData
+
+
+// MARK: - CSDataStack
+
+@available(OSX, unavailable)
+public extension CSDataStack {
+    
+    /**
+     Creates a `CSObjectMonitor` for the specified `NSManagedObject`. Multiple `ObjectObserver`s may then register themselves to be notified when changes are made to the `NSManagedObject`.
+     
+     - parameter object: the `NSManagedObject` to observe changes from
+     - returns: a `ObjectMonitor` that monitors changes to `object`
+     */
+    @objc
+    @warn_unused_result
+    public func monitorObject(object: NSManagedObject) -> CSObjectMonitor {
+        
+        return bridge {
+            
+            self.bridgeToSwift.monitorObject(object)
+        }
+    }
+    
+    /**
+     Creates a `CSListMonitor` for a list of `NSManagedObject`s that satisfy the specified fetch clauses. Multiple `CSListObserver`s may then register themselves to be notified when changes are made to the list.
+     
+     - parameter from: a `CSFrom` clause indicating the entity type
+     - parameter fetchClauses: a series of `FetchClause` instances for fetching the object list. Accepts `CSWhere`, `CSOrderBy`, and `CSTweak` clauses.
+     - returns: a `CSListMonitor` instance that monitors changes to the list
+     */
+    @objc
+    @warn_unused_result
+    public func monitorListFrom(from: CSFrom, fetchClauses: [CSFetchClause]) -> CSListMonitor {
+        
+        CoreStore.assert(
+            NSThread.isMainThread(),
+            "Attempted to observe objects from \(typeName(self)) outside the main thread."
+        )
+        CoreStore.assert(
+            fetchClauses.contains { $0 is CSOrderBy },
+            "A CSListMonitor requires a CSOrderBy clause."
+        )
+        return bridge {
+            
+            ListMonitor(
+                dataStack: self.bridgeToSwift,
+                from: from.bridgeToSwift,
+                sectionBy: nil,
+                applyFetchClauses: { fetchRequest in
+                    
+                    fetchClauses.forEach { $0.applyToFetchRequest(fetchRequest) }
+                }
+            )
+        }
+    }
+    
+    /**
+     Asynchronously creates a `CSListMonitor` for a list of `NSManagedObject`s that satisfy the specified fetch clauses. Multiple `CSListObserver`s may then register themselves to be notified when changes are made to the list. Since `NSFetchedResultsController` greedily locks the persistent store on initial fetch, you may prefer this method instead of the synchronous counterpart to avoid deadlocks while background updates/saves are being executed.
+     
+     - parameter createAsynchronously: the closure that receives the created `CSListMonitor` instance
+     - parameter from: a `CSFrom` clause indicating the entity type
+     - parameter fetchClauses: a series of `CSFetchClause` instances for fetching the object list. Accepts `CSWhere`, `CSOrderBy`, and `CSTweak` clauses.
+     */
+    @objc
+    public func monitorListByCreatingAsynchronously(createAsynchronously: (CSListMonitor) -> Void, from: CSFrom, fetchClauses: [CSFetchClause]) {
+        
+        CoreStore.assert(
+            NSThread.isMainThread(),
+            "Attempted to observe objects from \(typeName(self)) outside the main thread."
+        )
+        CoreStore.assert(
+            fetchClauses.contains { $0 is CSOrderBy },
+            "A CSListMonitor requires an CSOrderBy clause."
+        )
+        _ = ListMonitor(
+            dataStack: self.bridgeToSwift,
+            from: from.bridgeToSwift,
+            sectionBy: nil,
+            applyFetchClauses: { fetchRequest in
+                
+                fetchClauses.forEach { $0.applyToFetchRequest(fetchRequest) }
+            },
+            createAsynchronously: {
+                
+                createAsynchronously($0.bridgeToObjectiveC)
+            }
+        )
+    }
+    
+    /**
+     Creates a `CSListMonitor` for a sectioned list of `NSManagedObject`s that satisfy the specified fetch clauses. Multiple `ListObserver`s may then register themselves to be notified when changes are made to the list.
+     
+     - parameter from: a `CSFrom` clause indicating the entity type
+     - parameter sectionBy: a `CSSectionBy` clause indicating the keyPath for the attribute to use when sorting the list into sections.
+     - parameter fetchClauses: a series of `FetchClause` instances for fetching the object list. Accepts `CSWhere`, `CSOrderBy`, and `CSTweak` clauses.
+     - returns: a `CSListMonitor` instance that monitors changes to the list
+     */
+    @objc
+    @warn_unused_result
+    public func monitorSectionedListFrom(from: CSFrom, sectionBy: CSSectionBy, fetchClauses: [CSFetchClause]) -> CSListMonitor {
+        
+        CoreStore.assert(
+            NSThread.isMainThread(),
+            "Attempted to observe objects from \(typeName(self)) outside the main thread."
+        )
+        CoreStore.assert(
+            fetchClauses.contains { $0 is CSOrderBy },
+            "A CSListMonitor requires an CSOrderBy clause."
+        )
+        return bridge {
+            
+            ListMonitor(
+                dataStack: self.bridgeToSwift,
+                from: from.bridgeToSwift,
+                sectionBy: sectionBy.bridgeToSwift,
+                applyFetchClauses: { fetchRequest in
+                    
+                    fetchClauses.forEach { $0.applyToFetchRequest(fetchRequest) }
+                }
+            )
+        }
+    }
+    
+    /**
+     Asynchronously creates a `CSListMonitor` for a sectioned list of `NSManagedObject`s that satisfy the specified fetch clauses. Multiple `CSListObserver`s may then register themselves to be notified when changes are made to the list. Since `NSFetchedResultsController` greedily locks the persistent store on initial fetch, you may prefer this method instead of the synchronous counterpart to avoid deadlocks while background updates/saves are being executed.
+     
+     - parameter createAsynchronously: the closure that receives the created `CSListMonitor` instance
+     - parameter from: a `CSFrom` clause indicating the entity type
+     - parameter sectionBy: a `CSSectionBy` clause indicating the keyPath for the attribute to use when sorting the list into sections.
+     - parameter fetchClauses: a series of `CSFetchClause` instances for fetching the object list. Accepts `CSWhere`, `CSOrderBy`, and `CSTweak` clauses.
+     */
+    public func monitorSectionedListByCreatingAsynchronously(createAsynchronously: (CSListMonitor) -> Void, from: CSFrom, sectionBy: CSSectionBy, fetchClauses: [CSFetchClause]) {
+        
+        CoreStore.assert(
+            NSThread.isMainThread(),
+            "Attempted to observe objects from \(typeName(self)) outside the main thread."
+        )
+        CoreStore.assert(
+            fetchClauses.contains { $0 is CSOrderBy },
+            "A CSListMonitor requires an CSOrderBy clause."
+        )
+        _ = ListMonitor(
+            dataStack: self.bridgeToSwift,
+            from: from.bridgeToSwift,
+            sectionBy: sectionBy.bridgeToSwift,
+            applyFetchClauses: { fetchRequest in
+                
+                fetchClauses.forEach { $0.applyToFetchRequest(fetchRequest) }
+            },
+            createAsynchronously: {
+                
+                createAsynchronously($0.bridgeToObjectiveC)
+            }
+        )
+    }
+}