folder structure

Sources/Convenience/NSFetchedResultsController+Convenience.swift

@@ -0,0 +1,75 @@
+//
+//  NSManagedObject+Convenience.swift
+//  CoreStore
+//
+//  Copyright © 2015 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: - NSFetchedResultsController
+
+public extension NSFetchedResultsController {
+    
+    /**
+     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 fetchRequest: the `NSFetchRequest` instance to use with the `NSFetchedResultsController`
+     - parameter from: an optional `From` clause indicating the entity type. If not specified, the `fetchRequest` argument's `entity` property should already be set.
+     - 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.
+     */
+    @nonobjc
+    public static func createForStack<T: NSManagedObject>(dataStack: DataStack, fetchRequest: NSFetchRequest, from: From<T>? = nil, sectionBy: SectionBy? = nil, fetchClauses: [FetchClause]) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController(
+            context: dataStack.mainContext,
+            fetchRequest: fetchRequest,
+            from: from,
+            sectionBy: sectionBy,
+            applyFetchClauses: { fetchRequest in
+            
+                fetchClauses.forEach { $0.applyToFetchRequest(fetchRequest) }
+            }
+        )
+    }
+    
+    
+    // MARK: Internal
+    
+    @nonobjc
+    internal static func createFromContext<T: NSManagedObject>(context: NSManagedObjectContext, fetchRequest: NSFetchRequest, from: From<T>? = nil, sectionBy: SectionBy? = nil, fetchClauses: [FetchClause]) -> NSFetchedResultsController {
+        
+        return CoreStoreFetchedResultsController(
+            context: context,
+            fetchRequest: fetchRequest,
+            from: from,
+            sectionBy: sectionBy,
+            applyFetchClauses: { fetchRequest in
+                
+                fetchClauses.forEach { $0.applyToFetchRequest(fetchRequest) }
+            }
+        )
+    }
+}

Sources/Convenience/NSManagedObject+Convenience.swift

@@ -0,0 +1,82 @@
+//
+//  NSManagedObject+Convenience.swift
+//  CoreStore
+//
+//  Copyright © 2015 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: - NSManagedObject
+
+public extension NSManagedObject {
+    
+    /**
+     Provides a convenience wrapper for accessing `primitiveValueForKey(...)` with proper calls to `willAccessValueForKey(...)` and `didAccessValueForKey(...)`. This is useful when implementing accessor methods for transient attributes.
+     
+     - parameter KVCKey: the KVC key
+     - returns: the primitive value for the KVC key
+     */
+    @nonobjc
+    @warn_unused_result
+    public func accessValueForKVCKey(KVCKey: KeyPath) -> AnyObject? {
+        
+        self.willAccessValueForKey(KVCKey)
+        let primitiveValue: AnyObject? = self.primitiveValueForKey(KVCKey)
+        self.didAccessValueForKey(KVCKey)
+        
+        return primitiveValue
+    }
+    
+    /**
+     Provides a convenience wrapper for setting `setPrimitiveValue(...)` with proper calls to `willChangeValueForKey(...)` and `didChangeValueForKey(...)`. This is useful when implementing mutator methods for transient attributes.
+     
+     - parameter value: the value to set the KVC key with
+     - parameter KVCKey: the KVC key
+     */
+    @nonobjc
+    public func setValue(value: AnyObject?, forKVCKey KVCKey: KeyPath) {
+        
+        self.willChangeValueForKey(KVCKey)
+        self.setPrimitiveValue(value, forKey: KVCKey)
+        self.didChangeValueForKey(KVCKey)
+    }
+    
+    /**
+     Re-faults the object to use the latest values from the persistent store
+     */
+    @nonobjc
+    public func refreshAsFault() {
+        
+        self.managedObjectContext?.refreshObject(self, mergeChanges: false)
+    }
+    
+    /**
+     Re-faults the object to use the latest values from the persistent store and merges previously pending changes back
+     */
+    @nonobjc
+    public func refreshAndMerge() {
+        
+        self.managedObjectContext?.refreshObject(self, mergeChanges: true)
+    }
+}

Sources/Convenience/NSProgress+Convenience.swift

@@ -0,0 +1,138 @@
+//
+//  NSProgress+Convenience.swift
+//  CoreStore
+//
+//  Copyright © 2015 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
+#if USE_FRAMEWORKS
+    import GCDKit
+#endif
+
+
+// MARK: - NSProgress
+
+public extension NSProgress {
+    
+    /**
+     Sets a closure that the `NSProgress` calls whenever its `fractionCompleted` changes. You can use this instead of setting up KVO.
+     
+     - parameter closure: the closure to execute on progress change
+     */
+    @nonobjc
+    public func setProgressHandler(closure: ((progress: NSProgress) -> Void)?) {
+        
+        self.progressObserver.progressHandler = closure
+    }
+    
+    
+    // MARK: Private
+    
+    private struct PropertyKeys {
+        
+        static var progressObserver: Void?
+    }
+    
+    @nonobjc
+    private var progressObserver: ProgressObserver {
+        
+        get {
+            
+            let object: ProgressObserver? = getAssociatedObjectForKey(&PropertyKeys.progressObserver, inObject: self)
+            if let observer = object {
+                
+                return observer
+            }
+            
+            let observer = ProgressObserver(self)
+            setAssociatedRetainedObject(
+                observer,
+                forKey: &PropertyKeys.progressObserver,
+                inObject: self
+            )
+            
+            return observer
+        }
+    }
+}
+
+
+// MARK: - ProgressObserver
+
+@objc
+private final class ProgressObserver: NSObject {
+    
+    private unowned let progress: NSProgress
+    private var progressHandler: ((progress: NSProgress) -> Void)? {
+        
+        didSet {
+            
+            let progressHandler = self.progressHandler
+            if (progressHandler == nil) == (oldValue == nil) {
+                
+                return
+            }
+            
+            if let _ = progressHandler {
+                
+                self.progress.addObserver(
+                    self,
+                    forKeyPath: "fractionCompleted",
+                    options: [.Initial, .New],
+                    context: nil
+                )
+            }
+            else {
+                
+                self.progress.removeObserver(self, forKeyPath: "fractionCompleted")
+            }
+        }
+    }
+    
+    private init(_ progress: NSProgress) {
+        
+        self.progress = progress
+        super.init()
+    }
+    
+    deinit {
+        
+        if let _ = self.progressHandler {
+            
+            self.progressHandler = nil
+            self.progress.removeObserver(self, forKeyPath: "fractionCompleted")
+        }
+    }
+    
+    override func observeValueForKeyPath(keyPath: String?, ofObject object: AnyObject?, change: [String : AnyObject]?, context: UnsafeMutablePointer<Void>) {
+        
+        guard let progress = object as? NSProgress where progress == self.progress && keyPath == "fractionCompleted" else {
+            
+            return
+        }
+        
+        GCDQueue.Main.async { [weak self] () -> Void in
+            
+            self?.progressHandler?(progress: progress)
+        }
+    }
+}