Flatten file directories (fixes #159)

Sources/CSSaveResult.swift

@@ -0,0 +1,184 @@
+//
+//  CSSaveResult.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: - CSSaveResult
+
+/**
+ The `CSSaveResult` serves as the Objective-C bridging type for `SaveResult`.
+ 
+ - SeeAlso: `SaveResult`
+ */
+@objc
+public final class CSSaveResult: NSObject, CoreStoreObjectiveCType {
+    
+    /**
+     `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
+    }
+    
+    /**
+     `YES` if the `commit` operation for the transaction succeeded and if there was an actual change made. Returns `NO` otherwise.
+     */
+    @objc
+    public var hasChanges: Bool {
+        
+        guard case .success(let hasChanges) = self.bridgeToSwift else {
+            
+            return false
+        }
+        return hasChanges
+    }
+    
+    /**
+     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 actual error.
+     */
+    @objc
+    public func handleSuccess(_ success: (_ hasChanges: Bool) -> Void, failure: (_ error: NSError) -> Void) {
+        
+        switch self.bridgeToSwift {
+            
+        case .success(let hasChanges):
+            success(hasChanges)
+            
+        case .failure(let error):
+            failure(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(_ success: (_ hasChanges: Bool) -> Void) {
+        
+        guard case .success(let hasChanges) = self.bridgeToSwift else {
+            
+            return
+        }
+        success(hasChanges)
+    }
+    
+    /**
+     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 actual error.
+     */
+    @objc
+    public func handleFailure(_ failure: (_ error: NSError) -> Void) {
+        
+        guard case .failure(let error) = self.bridgeToSwift else {
+                
+            return
+        }
+        failure(error.bridgeToObjectiveC)
+    }
+    
+    
+    // MARK: NSObject
+    
+    public override var hash: Int {
+        
+        return self.bridgeToSwift.hashValue
+    }
+    
+    public override func isEqual(_ object: Any?) -> Bool {
+        
+        guard let object = object as? CSSaveResult else {
+            
+            return false
+        }
+        return self.bridgeToSwift == object.bridgeToSwift
+    }
+    
+    public override var description: String {
+        
+        return "(\(String(reflecting: type(of: self)))) \(self.bridgeToSwift.coreStoreDumpString)"
+    }
+    
+    
+    // MARK: CoreStoreObjectiveCType
+    
+    public let bridgeToSwift: SaveResult
+    
+    public required init(_ swiftValue: SaveResult) {
+        
+        self.bridgeToSwift = swiftValue
+        super.init()
+    }
+}
+
+
+// MARK: - SaveResult
+
+extension SaveResult: CoreStoreSwiftType {
+    
+    // MARK: CoreStoreSwiftType
+    
+    public var bridgeToObjectiveC: CSSaveResult {
+        
+        return CSSaveResult(self)
+    }
+}