mirror of
https://github.com/JohnEstropia/CoreStore.git
synced 2026-01-14 13:13:33 +01:00
276 lines
11 KiB
Swift
276 lines
11 KiB
Swift
//
|
|
// CSUnsafeDataTransaction.swift
|
|
// CoreStore
|
|
//
|
|
// Copyright © 2018 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: - CSUnsafeDataTransaction
|
|
|
|
/**
|
|
The `CSUnsafeDataTransaction` serves as the Objective-C bridging type for `UnsafeDataTransaction`.
|
|
|
|
- SeeAlso: `UnsafeDataTransaction`
|
|
*/
|
|
@available(*, deprecated, message: "CoreStore Objective-C API will be removed soon.")
|
|
@objc
|
|
public final class CSUnsafeDataTransaction: CSBaseDataTransaction, CoreStoreObjectiveCType {
|
|
/**
|
|
Saves the transaction changes asynchronously. For a `CSUnsafeDataTransaction`, multiple commits are allowed, although it is the developer's responsibility to ensure a reasonable leeway to prevent blocking the main thread.
|
|
|
|
- parameter success: the block executed if the save succeeds.
|
|
- parameter failure: the block executed if the save fails. A `CSError` is reported as the argument of the block.
|
|
*/
|
|
@objc
|
|
public func commitWithSuccess(_ success: (() -> Void)?, _ failure: ((CSError) -> Void)?) {
|
|
|
|
let transaction = self.bridgeToSwift
|
|
transaction.context.saveAsynchronously(
|
|
sourceIdentifier: transaction.sourceIdentifier,
|
|
completion: { (_, error) in
|
|
|
|
defer {
|
|
|
|
withExtendedLifetime(self, {})
|
|
}
|
|
if let error = error {
|
|
|
|
failure?(error.bridgeToObjectiveC)
|
|
}
|
|
else {
|
|
|
|
success?()
|
|
}
|
|
}
|
|
)
|
|
}
|
|
|
|
/**
|
|
Saves the transaction changes and waits for completion synchronously. For a `CSUnsafeDataTransaction`, multiple commits are allowed, although it is the developer's responsibility to ensure a reasonable leeway to prevent blocking the main thread.
|
|
|
|
- parameter error: the `CSError` pointer that indicates the reason in case of an failure
|
|
- returns: `YES` if the commit succeeded, `NO` if the commit failed. If `NO`, the `error` argument will hold error information.
|
|
*/
|
|
@objc
|
|
public func commitAndWait(error: NSErrorPointer) -> Bool {
|
|
|
|
return bridge(error) {
|
|
|
|
let transaction = self.bridgeToSwift
|
|
if case (_, let error?) = transaction.context.saveSynchronously(
|
|
waitForMerge: true,
|
|
sourceIdentifier: transaction.sourceIdentifier
|
|
) {
|
|
|
|
throw error
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
Rolls back the transaction.
|
|
*/
|
|
@objc
|
|
public func rollback() {
|
|
|
|
self.bridgeToSwift.rollback()
|
|
}
|
|
|
|
/**
|
|
Undo's the last change made to the transaction.
|
|
*/
|
|
@objc
|
|
public func undo() {
|
|
|
|
self.bridgeToSwift.undo()
|
|
}
|
|
|
|
/**
|
|
Redo's the last undone change to the transaction.
|
|
*/
|
|
@objc
|
|
public func redo() {
|
|
|
|
self.bridgeToSwift.redo()
|
|
}
|
|
|
|
/**
|
|
Immediately flushes all pending changes to the transaction's observers. This is useful in conjunction with `ListMonitor`s and `ObjectMonitor`s created from `UnsafeDataTransaction`s used to manage temporary "scratch" data.
|
|
|
|
- Important: Note that unlike `commit()`, `flush()` does not propagate/save updates to the `DataStack` and the persistent store. However, the flushed changes will be seen by children transactions created further from the current transaction (i.e. through `transaction.beginUnsafe()`)
|
|
*/
|
|
@objc
|
|
public func flush() {
|
|
|
|
self.bridgeToSwift.flush()
|
|
}
|
|
|
|
/**
|
|
Flushes all pending changes to the transaction's observers at the end of the `closure`'s execution. This is useful in conjunction with `ListMonitor`s and `ObjectMonitor`s created from `UnsafeDataTransaction`s used to manage temporary "scratch" data.
|
|
|
|
- Important: Note that unlike `commit()`, `flush()` does not propagate/save updates to the `DataStack` and the persistent store. However, the flushed changes will be seen by children transactions created further from the current transaction (i.e. through `transaction.beginUnsafe()`)
|
|
- parameter block: the block where changes can be made prior to the flush
|
|
*/
|
|
@objc
|
|
public func flush(_ block: () -> Void) {
|
|
|
|
self.bridgeToSwift.flush {
|
|
|
|
block()
|
|
}
|
|
}
|
|
|
|
/**
|
|
Begins a child transaction where `NSManagedObject` creates, updates, and deletes can be made. This is useful for making temporary changes, such as partially filled forms.
|
|
|
|
To support "undo" methods such as `-undo`, `-redo`, and `-rollback`, use the `-beginSafeWithSupportsUndo:` method passing `YES` to the argument. Without "undo" support, calling those methods will raise an exception.
|
|
- returns: a `CSUnsafeDataTransaction` instance where creates, updates, and deletes can be made.
|
|
*/
|
|
@objc
|
|
public func beginUnsafe() -> CSUnsafeDataTransaction {
|
|
|
|
return bridge {
|
|
|
|
self.bridgeToSwift.beginUnsafe()
|
|
}
|
|
}
|
|
|
|
/**
|
|
Begins a child transaction where `NSManagedObject` creates, updates, and deletes can be made. This is useful for making temporary changes, such as partially filled forms.
|
|
|
|
To support "undo" methods such as `-undo`, `-redo`, and `-rollback`, use the `-beginSafeWithSupportsUndo:` method passing `YES` to the argument. Without "undo" support, calling those methods will raise an exception.
|
|
- parameter sourceIdentifier: an optional value that identifies the source of this transaction. This identifier will be passed to the change notifications and callers can use it for custom handling that depends on the source.
|
|
- returns: a `CSUnsafeDataTransaction` instance where creates, updates, and deletes can be made.
|
|
*/
|
|
@objc
|
|
public func beginUnsafeWithSourceIdentifier(
|
|
_ sourceIdentifier: Any?
|
|
) -> CSUnsafeDataTransaction {
|
|
|
|
return bridge {
|
|
|
|
self.bridgeToSwift.beginUnsafe(
|
|
sourceIdentifier: sourceIdentifier
|
|
)
|
|
}
|
|
}
|
|
|
|
/**
|
|
Begins a child transaction where `NSManagedObject` creates, updates, and deletes can be made. This is useful for making temporary changes, such as partially filled forms.
|
|
|
|
- parameter supportsUndo: `-undo`, `-redo`, and `-rollback` methods are only available when this parameter is `YES`, otherwise those method will raise an exception. Note that turning on Undo support may heavily impact performance especially on iOS or watchOS where memory is limited.
|
|
- returns: a `CSUnsafeDataTransaction` instance where creates, updates, and deletes can be made.
|
|
*/
|
|
@objc
|
|
public func beginUnsafeWithSupportsUndo(
|
|
_ supportsUndo: Bool
|
|
) -> CSUnsafeDataTransaction {
|
|
|
|
return bridge {
|
|
|
|
self.bridgeToSwift.beginUnsafe(
|
|
supportsUndo: supportsUndo
|
|
)
|
|
}
|
|
}
|
|
|
|
/**
|
|
Begins a child transaction where `NSManagedObject` creates, updates, and deletes can be made. This is useful for making temporary changes, such as partially filled forms.
|
|
|
|
- parameter supportsUndo: `-undo`, `-redo`, and `-rollback` methods are only available when this parameter is `YES`, otherwise those method will raise an exception. Note that turning on Undo support may heavily impact performance especially on iOS or watchOS where memory is limited.
|
|
- parameter sourceIdentifier: an optional value that identifies the source of this transaction. This identifier will be passed to the change notifications and callers can use it for custom handling that depends on the source.
|
|
- returns: a `CSUnsafeDataTransaction` instance where creates, updates, and deletes can be made.
|
|
*/
|
|
@objc
|
|
public func beginUnsafeWithSupportsUndo(
|
|
_ supportsUndo: Bool,
|
|
sourceIdentifier: Any?
|
|
) -> CSUnsafeDataTransaction {
|
|
|
|
return bridge {
|
|
|
|
self.bridgeToSwift.beginUnsafe(
|
|
supportsUndo: supportsUndo,
|
|
sourceIdentifier: sourceIdentifier
|
|
)
|
|
}
|
|
}
|
|
|
|
/**
|
|
Returns the `NSManagedObjectContext` for this unsafe transaction. Use only for cases where external frameworks need an `NSManagedObjectContext` instance to work with.
|
|
|
|
Note that it is the developer's responsibility to ensure the following:
|
|
- that the `CSUnsafeDataTransaction` that owns this context should be strongly referenced and prevented from being deallocated during the context's lifetime
|
|
- that all saves will be done either through the `CSUnsafeDataTransaction`'s `-commit:` or `-commitAndWait` method, or by calling `-save:` manually on the context, its parent, and all other ancestor contexts if there are any.
|
|
*/
|
|
@objc
|
|
public func unsafeContext() -> NSManagedObjectContext {
|
|
|
|
return self.bridgeToSwift.context
|
|
}
|
|
|
|
|
|
// MARK: NSObject
|
|
|
|
public override var description: String {
|
|
|
|
return "(\(String(reflecting: Self.self))) \(self.bridgeToSwift.coreStoreDumpString)"
|
|
}
|
|
|
|
|
|
// MARK: CoreStoreObjectiveCType
|
|
|
|
public typealias SwiftType = UnsafeDataTransaction
|
|
|
|
public var bridgeToSwift: UnsafeDataTransaction {
|
|
|
|
return super.swiftTransaction as! UnsafeDataTransaction
|
|
}
|
|
|
|
public required init(_ swiftValue: UnsafeDataTransaction) {
|
|
|
|
super.init(swiftValue as BaseDataTransaction)
|
|
}
|
|
|
|
public required override init(_ swiftValue: BaseDataTransaction) {
|
|
|
|
super.init(swiftValue)
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - UnsafeDataTransaction
|
|
|
|
@available(*, deprecated, message: "CoreStore Objective-C API will be removed soon.")
|
|
extension UnsafeDataTransaction: CoreStoreSwiftType {
|
|
|
|
// MARK: CoreStoreSwiftType
|
|
|
|
public var bridgeToObjectiveC: CSUnsafeDataTransaction {
|
|
|
|
return CSUnsafeDataTransaction(self)
|
|
}
|
|
}
|