mirror of
https://github.com/JohnEstropia/CoreStore.git
synced 2026-01-14 13:13:33 +01:00
317 lines
9.5 KiB
Swift
317 lines
9.5 KiB
Swift
//
|
|
// CoreStoreError.swift
|
|
// CoreStore
|
|
//
|
|
// Copyright © 2014 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: - CoreStoreError
|
|
|
|
public enum CoreStoreError: ErrorType, CustomStringConvertible, CustomDebugStringConvertible, Equatable {
|
|
|
|
/**
|
|
A failure occured because of an unknown error.
|
|
*/
|
|
case Unknown
|
|
|
|
/**
|
|
The `NSPersistentStore` could note be initialized because another store existed at the specified `NSURL`.
|
|
*/
|
|
case DifferentStorageExistsAtURL(existingPersistentStoreURL: NSURL)
|
|
|
|
/**
|
|
An `NSMappingModel` could not be found for a specific source and destination model versions.
|
|
*/
|
|
case MappingModelNotFound(localStoreURL: NSURL, targetModel: NSManagedObjectModel, targetModelVersion: String)
|
|
|
|
/**
|
|
Progressive migrations are disabled for a store, but an `NSMappingModel` could not be found for a specific source and destination model versions.
|
|
*/
|
|
case ProgressiveMigrationRequired(localStoreURL: NSURL)
|
|
|
|
/**
|
|
An internal SDK call failed with the specified `NSError`.
|
|
*/
|
|
case InternalError(NSError: NSError)
|
|
|
|
|
|
// MARK: ErrorType
|
|
|
|
public var _domain: String {
|
|
|
|
return CoreStoreErrorDomain
|
|
}
|
|
|
|
public var _code: Int {
|
|
|
|
switch self {
|
|
|
|
case .Unknown: return CoreStoreErrorCode.UnknownError.rawValue
|
|
case .DifferentStorageExistsAtURL: return CoreStoreErrorCode.DifferentPersistentStoreExistsAtURL.rawValue
|
|
case .MappingModelNotFound: return CoreStoreErrorCode.MappingModelNotFound.rawValue
|
|
case .ProgressiveMigrationRequired: return CoreStoreErrorCode.ProgressiveMigrationRequired.rawValue
|
|
case .InternalError: return CoreStoreErrorCode.InternalError.rawValue
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: CustomStringConvertible
|
|
|
|
public var description: String {
|
|
|
|
// TODO:
|
|
return self.objc.description
|
|
}
|
|
|
|
|
|
// MARK: CustomDebugStringConvertible
|
|
|
|
public var debugDescription: String {
|
|
|
|
return self.description
|
|
}
|
|
|
|
|
|
// MARK: Internal
|
|
|
|
internal init(_ error: ErrorType?) {
|
|
|
|
self = error.flatMap { $0.swift } ?? .Unknown
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - CoreStoreError: Equatable
|
|
|
|
@warn_unused_result
|
|
public func == (lhs: CoreStoreError, rhs: CoreStoreError) -> Bool {
|
|
|
|
switch (lhs, rhs) {
|
|
|
|
case (.Unknown, .Unknown):
|
|
return true
|
|
|
|
case (.DifferentStorageExistsAtURL(let url1), .DifferentStorageExistsAtURL(let url2)):
|
|
return url1 == url2
|
|
|
|
case (.MappingModelNotFound(let url1, let model1, let version1), .MappingModelNotFound(let url2, let model2, let version2)):
|
|
return url1 == url2 && model1 == model2 && version1 == version2
|
|
|
|
case (.ProgressiveMigrationRequired(let url1), .ProgressiveMigrationRequired(let url2)):
|
|
return url1 == url2
|
|
|
|
case (.InternalError(let NSError1), .InternalError(let NSError2)):
|
|
return NSError1 == NSError2
|
|
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - CoreStoreErrorDomain
|
|
|
|
/**
|
|
The `NSError` error domain for `CoreStore`.
|
|
*/
|
|
@nonobjc
|
|
public let CoreStoreErrorDomain = "com.corestore.error"
|
|
|
|
|
|
// MARK: - CoreStoreErrorCode
|
|
|
|
/**
|
|
The `NSError` error codes for `CoreStoreErrorDomain`.
|
|
*/
|
|
public enum CoreStoreErrorCode: Int {
|
|
|
|
/**
|
|
A failure occured because of an unknown error.
|
|
*/
|
|
case UnknownError
|
|
|
|
/**
|
|
The `NSPersistentStore` could note be initialized because another store existed at the specified `NSURL`.
|
|
*/
|
|
case DifferentPersistentStoreExistsAtURL
|
|
|
|
/**
|
|
An `NSMappingModel` could not be found for a specific source and destination model versions.
|
|
*/
|
|
case MappingModelNotFound
|
|
|
|
/**
|
|
Progressive migrations are disabled for a store, but an `NSMappingModel` could not be found for a specific source and destination model versions.
|
|
*/
|
|
case ProgressiveMigrationRequired
|
|
|
|
/**
|
|
An internal SDK call failed with the specified "NSError" userInfo key.
|
|
*/
|
|
case InternalError
|
|
}
|
|
|
|
|
|
// MARK: - NSError
|
|
|
|
public extension NSError {
|
|
|
|
// MARK: Internal
|
|
|
|
internal var isCoreDataMigrationError: Bool {
|
|
|
|
let code = self.code
|
|
return (code == NSPersistentStoreIncompatibleVersionHashError
|
|
|| code == NSMigrationMissingSourceModelError
|
|
|| code == NSMigrationError)
|
|
&& self.domain == NSCocoaErrorDomain
|
|
}
|
|
|
|
|
|
// MARK: Deprecated
|
|
|
|
/**
|
|
If the error's domain is equal to `CoreStoreErrorDomain`, returns the associated `CoreStoreErrorCode`. For other domains, returns `nil`.
|
|
*/
|
|
@available(*, deprecated=2.0.0, message="Use CoreStoreError enum values instead.")
|
|
public var coreStoreErrorCode: CoreStoreErrorCode? {
|
|
|
|
return (self.domain == CoreStoreErrorDomain
|
|
? CoreStoreErrorCode(rawValue: self.code)
|
|
: nil)
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: Internal
|
|
|
|
internal extension ErrorType {
|
|
|
|
internal var swift: CoreStoreError {
|
|
|
|
if case let error as CoreStoreError = self {
|
|
|
|
return error
|
|
}
|
|
|
|
guard let error = (self as Any) as? NSError else {
|
|
|
|
return .Unknown
|
|
}
|
|
|
|
guard error.domain == CoreStoreErrorDomain else {
|
|
|
|
return .InternalError(NSError: error)
|
|
}
|
|
|
|
guard let code = CoreStoreErrorCode(rawValue: error.code) else {
|
|
|
|
return .Unknown
|
|
}
|
|
|
|
let info = error.userInfo
|
|
switch code {
|
|
|
|
case .UnknownError:
|
|
return .Unknown
|
|
|
|
case .DifferentPersistentStoreExistsAtURL:
|
|
guard case let existingPersistentStoreURL as NSURL = info["existingPersistentStoreURL"] else {
|
|
|
|
return .Unknown
|
|
}
|
|
return .DifferentStorageExistsAtURL(existingPersistentStoreURL: existingPersistentStoreURL)
|
|
|
|
case .MappingModelNotFound:
|
|
guard let localStoreURL = info["localStoreURL"] as? NSURL,
|
|
let targetModel = info["targetModel"] as? NSManagedObjectModel,
|
|
let targetModelVersion = info["targetModelVersion"] as? String else {
|
|
|
|
return .Unknown
|
|
}
|
|
return .MappingModelNotFound(localStoreURL: localStoreURL, targetModel: targetModel, targetModelVersion: targetModelVersion)
|
|
|
|
case .ProgressiveMigrationRequired:
|
|
guard let localStoreURL = info["localStoreURL"] as? NSURL else {
|
|
|
|
return .Unknown
|
|
}
|
|
return .ProgressiveMigrationRequired(localStoreURL: localStoreURL)
|
|
|
|
case .InternalError:
|
|
guard case let NSError as NSError = info["NSError"] else {
|
|
|
|
return .Unknown
|
|
}
|
|
return .InternalError(NSError: NSError)
|
|
}
|
|
}
|
|
|
|
internal var objc: NSError {
|
|
|
|
guard let error = self as? CoreStoreError else {
|
|
|
|
return ((self as Any) as? NSError) ?? self as NSError
|
|
}
|
|
|
|
let code: CoreStoreErrorCode
|
|
let info: [NSObject: AnyObject]
|
|
switch error {
|
|
|
|
case .Unknown:
|
|
code = .UnknownError
|
|
info = [:]
|
|
|
|
case .DifferentStorageExistsAtURL(let existingPersistentStoreURL):
|
|
code = .DifferentPersistentStoreExistsAtURL
|
|
info = [
|
|
"existingPersistentStoreURL": existingPersistentStoreURL
|
|
]
|
|
|
|
case .MappingModelNotFound(let localStoreURL, let targetModel, let targetModelVersion):
|
|
code = .MappingModelNotFound
|
|
info = [
|
|
"localStoreURL": localStoreURL,
|
|
"targetModel": targetModel,
|
|
"targetModelVersion": targetModelVersion
|
|
]
|
|
|
|
case .ProgressiveMigrationRequired(let localStoreURL):
|
|
code = .ProgressiveMigrationRequired
|
|
info = [
|
|
"localStoreURL": localStoreURL
|
|
]
|
|
|
|
case .InternalError(let NSError):
|
|
code = .InternalError
|
|
info = [
|
|
"NSError": NSError
|
|
]
|
|
}
|
|
|
|
return NSError(domain: CoreStoreErrorDomain, code: code.rawValue, userInfo: info)
|
|
}
|
|
}
|