Simpler API for creating CoreStore-managed NSFetchedResultsControllers, useful for external SDK's that require them

2026-01-15 21:53:39 +01:00 · 2016-05-28 01:47:48 +09:00
parent f396b01043
commit d07b648e07
4 changed files with 171 additions and 4 deletions
--- a/CoreStore.podspec
+++ b/CoreStore.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
    s.name = "CoreStore"
-    s.version = "1.6.7"
+    s.version = "1.6.8"
    s.license = "MIT"
    s.summary = "Unleashing the real power of Core Data with the elegance and safety of Swift"
    s.homepage = "https://github.com/JohnEstropia/CoreStore"
--- a/Helpers/NSFetchedResultsController+Convenience.swift
+++ b/Helpers/NSFetchedResultsController+Convenience.swift
@@ -32,8 +32,170 @@ import CoreData
 public extension NSFetchedResultsController {
    
    /**
-     Utility for creating an `NSFetchedResultsController` from a `DataStack`. This is useful to partially support Objective-C classes by passing an `NSFetchedResultsController` instance instead of a `ListMonitor`.
+     Utility for creating an `NSFetchedResultsController` from a `DataStack`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter dataStack: the `DataStack` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter sectionBy: a `SectionBy` 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 `Where`, `OrderBy`, and `Tweak` clauses.
+     - returns: an `NSFetchedResultsController` that observes a `DataStack`
     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(dataStack: DataStack, _ from: From<T>, _ sectionBy: SectionBy, _ fetchClauses: FetchClause...) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: dataStack.mainContext,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: sectionBy,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    /**
+     Utility for creating an `NSFetchedResultsController` from a `DataStack`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter dataStack: the `DataStack` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter sectionBy: a `SectionBy` 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 `Where`, `OrderBy`, and `Tweak` clauses.
+     - returns: an `NSFetchedResultsController` that observes a `DataStack`
+     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(dataStack: DataStack, _ from: From<T>, _ sectionBy: SectionBy, _ fetchClauses: [FetchClause]) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: dataStack.mainContext,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: sectionBy,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    /**
+     Utility for creating an `NSFetchedResultsController` from a `DataStack`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter dataStack: the `DataStack` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter fetchClauses: a series of `FetchClause` instances for fetching the object list. Accepts `Where`, `OrderBy`, and `Tweak` clauses.
+     - returns: an `NSFetchedResultsController` that observes a `DataStack`
+     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(dataStack: DataStack, _ from: From<T>, _ fetchClauses: FetchClause...) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: dataStack.mainContext,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: nil,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    /**
+     Utility for creating an `NSFetchedResultsController` from a `DataStack`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter dataStack: the `DataStack` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter fetchClauses: a series of `FetchClause` instances for fetching the object list. Accepts `Where`, `OrderBy`, and `Tweak` clauses.
+     - returns: an `NSFetchedResultsController` that observes a `DataStack`
+     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(dataStack: DataStack, _ from: From<T>, _ fetchClauses: [FetchClause]) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: dataStack.mainContext,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: nil,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    /**
+     Utility for creating an `NSFetchedResultsController` from an `UnsafeDataTransaction`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter transaction: the `UnsafeDataTransaction` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter sectionBy: a `SectionBy` 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 `Where`, `OrderBy`, and `Tweak` clauses.
+     - returns: an `NSFetchedResultsController` that observes an `UnsafeDataTransaction`
+     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(transaction: UnsafeDataTransaction, _ from: From<T>, _ sectionBy: SectionBy, _ fetchClauses: FetchClause...) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: transaction.context,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: sectionBy,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    /**
+     Utility for creating an `NSFetchedResultsController` from an `UnsafeDataTransaction`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter transaction: the `UnsafeDataTransaction` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter sectionBy: a `SectionBy` 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 `Where`, `OrderBy`, and `Tweak` clauses.
+     - returns: an `NSFetchedResultsController` that observes an `UnsafeDataTransaction`
+     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(transaction: UnsafeDataTransaction, _ from: From<T>, _ sectionBy: SectionBy, _ fetchClauses: [FetchClause]) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: transaction.context,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: sectionBy,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    /**
+     Utility for creating an `NSFetchedResultsController` from an `UnsafeDataTransaction`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter transaction: the `UnsafeDataTransaction` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter fetchClauses: a series of `FetchClause` instances for fetching the object list. Accepts `Where`, `OrderBy`, and `Tweak` clauses.
+     - returns: an `NSFetchedResultsController` that observes an `UnsafeDataTransaction`
+     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(transaction: UnsafeDataTransaction, _ from: From<T>, _ fetchClauses: FetchClause...) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: transaction.context,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: nil,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    /**
+     Utility for creating an `NSFetchedResultsController` from an `UnsafeDataTransaction`. This is useful when an `NSFetchedResultsController` is preferred over the overhead of `ListMonitor`s abstraction.
+     
+     - parameter transaction: the `UnsafeDataTransaction` to observe objects from
+     - parameter from: a `From` clause indicating the entity type
+     - parameter fetchClauses: a series of `FetchClause` instances for fetching the object list. Accepts `Where`, `OrderBy`, and `Tweak` clauses.
+     */
+    @nonobjc
+    public static func createFor<T: NSManagedObject>(transaction: UnsafeDataTransaction, _ from: From<T>, _ fetchClauses: [FetchClause]) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController<T>(
+            context: transaction.context,
+            fetchRequest: CoreStoreFetchRequest(),
+            from: from,
+            sectionBy: nil,
+            fetchClauses: fetchClauses
+        )
+    }
+    
+    @available(*, deprecated=1.6.8, message="Use NSFetchedResultsController.createFor(_:_:_:_:)  instead.")
+    @nonobjc
    public static func createForStack<T: NSManagedObject>(dataStack: DataStack, fetchRequest: NSFetchRequest, from: From<T>? = nil, sectionBy: SectionBy? = nil, fetchClauses: [FetchClause]) -> NSFetchedResultsController {
        
        return CoreStoreFetchedResultsController<T>(
@@ -45,7 +207,8 @@ public extension NSFetchedResultsController {
        )
    }
    
-    @available(*, deprecated=1.5.2, message="Use NSFetchedResultsController.createForStack(_:fetchRequest:from:sectionBy:fetchClauses:) to create NSFetchedResultsControllers directly")
+    @available(*, deprecated=1.5.2, message="Use NSFetchedResultsController.createFor(_:_:_:_:) to create NSFetchedResultsControllers directly")
+    @nonobjc
    public convenience init<T: NSManagedObject>(dataStack: DataStack, fetchRequest: NSFetchRequest, from: From<T>? = nil, sectionBy: SectionBy? = nil, fetchClauses: [FetchClause]) {
        
        let context = dataStack.mainContext
--- a/CoreStore/Info.plist
+++ b/CoreStore/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.6.7</string>
+	<string>1.6.8</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
--- a/CoreStore/Internal/CoreStoreFetchedResultsController.swift
+++ b/CoreStore/Internal/CoreStoreFetchedResultsController.swift
@@ -48,6 +48,10 @@ internal final class CoreStoreFetchedResultsController<T: NSManagedObject>: NSFe
    
    internal init<T>(context: NSManagedObjectContext, fetchRequest: NSFetchRequest, from: From<T>? = nil, sectionBy: SectionBy? = nil, fetchClauses: [FetchClause]) {
        
+        CoreStore.assert(
+            fetchClauses.filter { $0 is OrderBy }.count > 0,
+            "An \(typeName(NSFetchedResultsController)) requires an OrderBy clause."
+        )
        from?.applyToFetchRequest(fetchRequest, context: context, applyAffectedStores: false)
        for clause in fetchClauses {