WIP: CSSetupResult

Sources/ObjectiveC/CSDataStack+Migrating.swift

@@ -48,7 +48,7 @@ public extension CSDataStack {
 //     - parameter completion: the closure to be executed on the main queue when the process completes, either due to success or failure. The closure's `SetupResult` argument indicates the result. This closure is NOT executed if an error is thrown, but will be executed with a `.Failure` result if an error occurs asynchronously.
 //     - returns: an `NSProgress` instance if a migration has started, or `nil` is no migrations are required
 //     */
-//    public func addStorage(storage: StorageInterface, completion: (SetupResult<T>) -> Void) throws -> NSProgress? {
+//    public func addInMemoryStorage(storage: CSInMemoryStore, completion: (CSSetupResult) -> Void, error: NSErrorPointer) -> NSProgress? {
 //        
 //        self.coordinator.performAsynchronously {
 //            
@@ -91,7 +91,7 @@ public extension CSDataStack {
 //        
 //        return nil
 //    }
-//    
+//
 //    /**
 //     Asynchronously adds a `LocalStorage` with default settings to the stack. Migrations are also initiated by default.
 //     ```

Sources/ObjectiveC/CSDataStack.swift

@@ -229,7 +229,7 @@ public final class CSDataStack: NSObject, CoreStoreObjectiveCType {
             try self.bridgeToSwift.addStorageAndWait(storage.bridgeToSwift)
         }
     }
-    
+
     
     // MARK: NSObject
     

Sources/ObjectiveC/CSObjectObserver.swift

@@ -57,7 +57,7 @@ public protocol CSObjectObserver: class, AnyObject {
      - parameter changedPersistentKeys: an `NSSet` of key paths for the attributes that were changed. Note that `changedPersistentKeys` only contains keys for attributes/relationships present in the persistent store, thus transient properties will not be reported.
      */
     @objc
-    optional func objectMonitor(monitor: CSObjectMonitor, didUpdateObject object: NSManagedObject, changedPersistentKeys: Set<KeyPath>)
+    optional func objectMonitor(monitor: CSObjectMonitor, didUpdateObject object: NSManagedObject, changedPersistentKeys: Set<String>)
     
     /**
      Handles processing right after `object` is deleted

Sources/ObjectiveC/CSSQliteStore.swift

@@ -41,7 +41,7 @@ public final class CSSQLiteStore: NSObject, CSLocalStorage, CoreStoreObjectiveCT
      - parameter fileURL: the local file URL for the target SQLite persistent store. Note that if you have multiple configurations, you will need to specify a different `fileURL` explicitly for each of them.
      - parameter configuration: an optional configuration name from the model file. If not specified, defaults to `nil`, the "Default" configuration. Note that if you have multiple configurations, you will need to specify a different `fileURL` explicitly for each of them.
      - parameter mappingModelBundles: a list of `NSBundle`s from which to search mapping models for migration.
-     - parameter localStorageOptions: When the `CSSQLiteStore` is passed to the `CSDataStack`'s `addStorage()` methods, tells the `CSDataStack` how to setup the persistent store. Defaults to `[CSLocalStorageOptions none]`.
+     - parameter localStorageOptions: When the `CSSQLiteStore` is passed to the `CSDataStack`'s `addStorage()` methods, tells the `CSDataStack` how to setup the persistent store. Defaults to `CSLocalStorageOptionsNone`.
      */
     @objc
     public convenience init(fileURL: NSURL, configuration: String?, mappingModelBundles: [NSBundle]?, localStorageOptions: Int) {

Sources/ObjectiveC/CSSetupResult.swift

@@ -0,0 +1,190 @@
+//
+//  CSSetupResult.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: - CSSetupResult
+
+/**
+ The `CSSetupResult` serves as the Objective-C bridging type for `SetupResult`.
+ */
+@objc
+public final class CSSetupResult: NSObject {
+    
+    /**
+     `YES` if the `commit` operation for the transaction succeeded, either because the save succeeded or because there were no changes to save. Returns `NO` to indicate failure.
+     */
+    @objc
+    public var isSuccess: Bool {
+        
+        return self.bridgeToSwift.boolValue
+    }
+    
+    /**
+     `YES` if the `commit` operation for the transaction failed, or `NO` otherwise. When `YES`, the `error` property returns the actual `NSError` for the failure.
+     */
+    @objc
+    public var isFailure: Bool {
+        
+        return !self.bridgeToSwift.boolValue
+    }
+    
+    /**
+     A `CSStorageInterface` instance if the `commit` operation for the transaction succeeded. Returns `NO` otherwise.
+     */
+    @objc
+    public var storage: CSStorageInterface? {
+        
+        guard case .Success(let storage as CoreStoreSwiftType) = self.bridgeToSwift else {
+            
+            return nil
+        }
+        return storage.bridgeToObjectiveC
+    }
+    
+    /**
+     The `NSError` for a failed `commit` operation, or `nil` if the `commit` succeeded
+     */
+    @objc
+    public var error: NSError? {
+        
+        guard case .Failure(let error) = self.bridgeToSwift else {
+            
+            return nil
+        }
+        return error.bridgeToObjectiveC
+    }
+    
+    /**
+     If the result was a success, the `success` block is executed with a `BOOL` argument that indicates if there were any changes made. If the result was a failure, the `failure` block is executed with an `NSError` argument pertaining to the actual error.
+     
+     The blocks are executed immediately as `@noescape` and will not be retained.
+     
+     - parameter success: the block to execute on success. The block passes a `BOOL` argument that indicates if there were any changes made.
+     - parameter failure: the block to execute on failure. The block passes an `NSError` argument that pertains to the actuall error.
+     */
+    @objc
+    public func handleSuccess(@noescape success: (storage: CSStorageInterface) -> Void, @noescape failure: (error: NSError) -> Void) {
+        
+        switch self.bridgeToSwift {
+            
+        case .Success(let storage):
+            success(storage: storage.bridgeToObjectiveC)
+            
+        case .Failure(let error):
+            failure(error: error.bridgeToObjectiveC)
+        }
+    }
+    
+    /**
+     If the result was a success, the `success` block is executed with a `BOOL` argument that indicates if there were any changes made. If the result was a failure, this method does nothing.
+     
+     The block is executed immediately as `@noescape` and will not be retained.
+     
+     - parameter success: the block to execute on success. The block passes a `BOOL` argument that indicates if there were any changes made.
+     */
+    @objc
+    public func handleSuccess(@noescape success: (storage: CSStorageInterface) -> Void) {
+        
+        guard let storageInterface = self.storageInterface else {
+            
+            return
+        }
+        success(storage: storage)
+    }
+    
+    /**
+     If the result was a failure, the `failure` block is executed with an `NSError` argument pertaining to the actual error. If the result was a success, this method does nothing.
+     
+     The block is executed immediately as `@noescape` and will not be retained.
+     
+     - parameter failure: the block to execute on failure. The block passes an `NSError` argument that pertains to the actuall error.
+     */
+    @objc
+    public func handleFailure(@noescape failure: (error: NSError) -> Void) {
+        
+        guard let coreStoreError = self.coreStoreError else {
+            
+            return
+        }
+        failure(error: coreStoreError.bridgeToObjectiveC)
+    }
+    
+    
+    // MARK: NSObject
+    
+    public override var hash: Int {
+        
+        if let storageInterface = self.storageInterface {
+            
+            return self.isSuccess.hashValue ^ ObjectIdentifier(storageInterface).hashValue
+        }
+        return self.isSuccess.hashValue ^ self.coreStoreError!.hashValue
+    }
+    
+    public override func isEqual(object: AnyObject?) -> Bool {
+        
+        guard let object = object as? CSSetupResult else {
+            
+            return false
+        }
+        return self.storageInterface === object.storageInterface
+            && self.coreStoreError == object.coreStoreError
+    }
+    
+    
+    // MARK: CoreStoreObjectiveCType
+    
+    public required init<T: StorageInterface>(_ swiftValue: SetupResult<T>) {
+        
+        switch swiftValue {
+            
+        case .Success(let storage):
+            self.storageInterface = storage
+            
+        case .Failure(let error):
+            self.coreStoreError = error
+        }
+        super.init()
+    }
+    
+    private var storageInterface: StorageInterface?
+    private var coreStoreError: CoreStoreError?
+}
+
+
+// MARK: - SetupResult
+
+extension SetupResult {
+    
+    // MARK: CoreStoreSwiftType
+    
+    public var bridgeToObjectiveC: CSSetupResult {
+        
+        return CSSetupResult(self)
+    }
+}

Sources/ObjectiveC/CSStorageInterface.swift

@@ -2,11 +2,32 @@
 //  CSStorageInterface.swift
 //  CoreStore
 //
-//  Created by John Rommel Estropia on 2016/03/18.
-//  Copyright © 2016 John Rommel Estropia. All rights reserved.
+//  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 UIKit
+import Foundation
+import CoreData
+
+
+// MARK: - CSStorageInterface
 
 /**
  The `CSStorageInterface` serves as the Objective-C bridging type for `StorageInterface`.
@@ -40,39 +61,27 @@ public protocol CSStorageInterface {
  The `CSLocalStorageOptions` provides settings that tells the `CSDataStack` how to setup the persistent store for `CSLocalStorage` implementers.
  */
 @objc
-public final class CSLocalStorageOptions: NSObject {
+public enum CSLocalStorageOptions: Int {
     
     /**
      Tells the `DataStack` that the store should not be migrated or recreated, and should simply fail on model mismatch
      */
-    @objc
-    public static let none = 0
+    case None = 0
     
     /**
      Tells the `DataStack` to delete and recreate the store on model mismatch, otherwise exceptions will be thrown on failure instead
      */
-    @objc
-    public static let recreateStoreOnModelMismatch = 1
+    case RecreateStoreOnModelMismatch = 1
     
     /**
      Tells the `DataStack` to prevent progressive migrations for the store
      */
-    @objc
-    public static let preventProgressiveMigration = 2
+    case PreventProgressiveMigration = 2
     
     /**
      Tells the `DataStack` to allow lightweight migration for the store when added synchronously
      */
-    @objc
-    public static let allowSynchronousLightweightMigration = 4
-    
-    
-    // MARK: Private
-    
-    private override init() {
-        
-        fatalError()
-    }
+    case AllowSynchronousLightweightMigration = 4
 }