mirror of
https://github.com/JohnEstropia/CoreStore.git
synced 2026-02-22 18:48:03 +01:00
202 lines
8.2 KiB
Swift
202 lines
8.2 KiB
Swift
//
|
|
// BaseDataTransaction.swift
|
|
// CoreStore
|
|
//
|
|
// Copyright (c) 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
|
|
import GCDKit
|
|
|
|
|
|
// MARK: - BaseDataTransaction
|
|
|
|
/**
|
|
The `BaseDataTransaction` is an abstract interface for `NSManagedObject` creates, updates, and deletes. All `BaseDataTransaction` subclasses manage a private `NSManagedObjectContext` which are direct children of the `NSPersistentStoreCoordinator`'s root `NSManagedObjectContext`. This means that all updates are saved first to the persistent store, and then propagated up to the read-only `NSManagedObjectContext`.
|
|
*/
|
|
public /*abstract*/ class BaseDataTransaction {
|
|
|
|
// MARK: Object management
|
|
|
|
/**
|
|
Indicates if the transaction has pending changes
|
|
*/
|
|
public var hasChanges: Bool {
|
|
|
|
return self.context.hasChanges
|
|
}
|
|
|
|
/**
|
|
Creates a new `NSManagedObject` with the specified entity type.
|
|
|
|
:param: into the `Into` clause indicating the destination `NSManagedObject` entity type and the destination configuration
|
|
:returns: a new `NSManagedObject` instance of the specified entity type.
|
|
*/
|
|
public func create<T: NSManagedObject>(into: Into<T>) -> T {
|
|
|
|
CoreStore.assert(self.transactionQueue.isCurrentExecutionContext(), "Attempted to create an entity of type <\(T.self)> outside its designated queue.")
|
|
|
|
let context = self.context
|
|
let entityClass = (into.entityClass as! NSManagedObject.Type)
|
|
let object = entityClass.createInContext(context) as! T
|
|
|
|
if into.inferStoreIfPossible {
|
|
|
|
switch context.parentStack!.persistentStoreForEntityClass(entityClass, configuration: nil, inferStoreIfPossible: true) {
|
|
|
|
case (.Some(let persistentStore), _):
|
|
context.assignObject(object, toPersistentStore: persistentStore)
|
|
|
|
case (.None, true):
|
|
CoreStore.assert(false, "Attempted to create an entity of type <\(entityClass)> with ambiguous destination persistent store, but the configuration name was not specified.")
|
|
|
|
default:
|
|
CoreStore.assert(false, "Attempted to create an entity of type <\(entityClass)>, but a destination persistent store containing the entity type could not be found.")
|
|
}
|
|
}
|
|
else {
|
|
|
|
switch context.parentStack!.persistentStoreForEntityClass(entityClass, configuration: into.configuration, inferStoreIfPossible: false) {
|
|
|
|
case (.Some(let persistentStore), _):
|
|
context.assignObject(object, toPersistentStore: persistentStore)
|
|
|
|
default:
|
|
if let configuration = into.configuration {
|
|
|
|
CoreStore.assert(false, "Attempted to create an entity of type <\(entityClass)> into the configuration \"\(configuration)\", which it doesn't belong to.")
|
|
}
|
|
else {
|
|
|
|
CoreStore.assert(false, "Attempted to create an entity of type <\(entityClass)> into the default configuration, which it doesn't belong to.")
|
|
}
|
|
}
|
|
}
|
|
|
|
return object
|
|
}
|
|
|
|
/**
|
|
Returns an editable proxy of a specified `NSManagedObject`.
|
|
|
|
:param: object the `NSManagedObject` type to be edited
|
|
:returns: an editable proxy for the specified `NSManagedObject`.
|
|
*/
|
|
public func edit<T: NSManagedObject>(object: T?) -> T? {
|
|
|
|
CoreStore.assert(self.transactionQueue.isCurrentExecutionContext(), "Attempted to update an entity of type \(typeName(object)) outside its designated queue.")
|
|
|
|
return object?.inContext(self.context)
|
|
}
|
|
|
|
/**
|
|
Returns an editable proxy of the object with the specified `NSManagedObjectID`.
|
|
|
|
:param: into an `Into` clause specifying the entity type
|
|
:param: objectID the `NSManagedObjectID` for the object to be edited
|
|
:returns: an editable proxy for the specified `NSManagedObject`.
|
|
*/
|
|
public func edit<T: NSManagedObject>(into: Into<T>, _ objectID: NSManagedObjectID) -> T? {
|
|
|
|
CoreStore.assert(self.transactionQueue.isCurrentExecutionContext(), "Attempted to update an entity of type <\(T.self)> outside its designated queue.")
|
|
CoreStore.assert(into.inferStoreIfPossible || (into.configuration ?? Into.defaultConfigurationName) == objectID.persistentStore?.configurationName, "Attempted to update an entity of type <\(T.self)> but the specified persistent store do not match the `NSManagedObjectID`.")
|
|
|
|
return (into.entityClass as! NSManagedObject.Type).inContext(self.context, withObjectID: objectID) as? T
|
|
}
|
|
|
|
/**
|
|
Deletes a specified `NSManagedObject`.
|
|
|
|
:param: object the `NSManagedObject` to be deleted
|
|
*/
|
|
public func delete(object: NSManagedObject?) {
|
|
|
|
CoreStore.assert(self.transactionQueue.isCurrentExecutionContext(), "Attempted to delete an entity outside its designated queue.")
|
|
|
|
object?.inContext(self.context)?.deleteFromContext()
|
|
}
|
|
|
|
/**
|
|
Deletes the specified `NSManagedObject`s.
|
|
|
|
:param: object1 the `NSManagedObject` to be deleted
|
|
:param: object2 another `NSManagedObject` to be deleted
|
|
:param: objects other `NSManagedObject`s to be deleted
|
|
*/
|
|
public func delete(object1: NSManagedObject?, _ object2: NSManagedObject?, _ objects: NSManagedObject?...) {
|
|
|
|
self.delete([object1, object2] + objects)
|
|
}
|
|
|
|
/**
|
|
Deletes the specified `NSManagedObject`s.
|
|
|
|
:param: objects the `NSManagedObject`s to be deleted
|
|
*/
|
|
public func delete(objects: [NSManagedObject?]) {
|
|
|
|
CoreStore.assert(self.transactionQueue.isCurrentExecutionContext(), "Attempted to delete entities outside their designated queue.")
|
|
|
|
let context = self.context
|
|
for object in objects {
|
|
|
|
object?.inContext(context)?.deleteFromContext()
|
|
}
|
|
}
|
|
|
|
// MARK: Saving changes
|
|
|
|
/**
|
|
Rolls back the transaction by resetting the `NSManagedObjectContext`. After calling this method, all `NSManagedObjects` fetched within the transaction will become invalid.
|
|
*/
|
|
public func rollback() {
|
|
|
|
CoreStore.assert(self.transactionQueue.isCurrentExecutionContext(), "Attempted to rollback a \(typeName(self)) outside its designated queue.")
|
|
|
|
self.context.reset()
|
|
}
|
|
|
|
|
|
// MARK: Internal
|
|
|
|
internal let context: NSManagedObjectContext
|
|
internal let transactionQueue: GCDQueue
|
|
internal let childTransactionQueue: GCDQueue = .createSerial("com.corestore.datastack.childtransactionqueue")
|
|
|
|
internal var isCommitted = false
|
|
internal var result: SaveResult?
|
|
|
|
internal init(mainContext: NSManagedObjectContext, queue: GCDQueue) {
|
|
|
|
self.transactionQueue = queue
|
|
|
|
let context = mainContext.temporaryContextInTransactionWithConcurrencyType(
|
|
queue == .Main
|
|
? .MainQueueConcurrencyType
|
|
: .PrivateQueueConcurrencyType
|
|
)
|
|
self.context = context
|
|
|
|
context.parentTransaction = self
|
|
}
|
|
}
|