diff --git a/CoreStore.xcodeproj/project.pbxproj b/CoreStore.xcodeproj/project.pbxproj index f231963..55e0184 100644 --- a/CoreStore.xcodeproj/project.pbxproj +++ b/CoreStore.xcodeproj/project.pbxproj @@ -693,6 +693,10 @@ B5B866E125E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5B866DF25E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift */; }; B5B866E225E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5B866DF25E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift */; }; B5B866E325E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5B866DF25E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift */; }; + B5B866ED25F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5B866EC25F4800800335476 /* DataStack.AddStoragePublisher.swift */; }; + B5B866EE25F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5B866EC25F4800800335476 /* DataStack.AddStoragePublisher.swift */; }; + B5B866EF25F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5B866EC25F4800800335476 /* DataStack.AddStoragePublisher.swift */; }; + B5B866F025F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5B866EC25F4800800335476 /* DataStack.AddStoragePublisher.swift */; }; B5BF7FAD234C41E90070E741 /* Internals.DiffableDataSourceSnapshot.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5BF7FAC234C41E90070E741 /* Internals.DiffableDataSourceSnapshot.swift */; }; B5BF7FAE234C41E90070E741 /* Internals.DiffableDataSourceSnapshot.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5BF7FAC234C41E90070E741 /* Internals.DiffableDataSourceSnapshot.swift */; }; B5BF7FAF234C41E90070E741 /* Internals.DiffableDataSourceSnapshot.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5BF7FAC234C41E90070E741 /* Internals.DiffableDataSourceSnapshot.swift */; }; @@ -1157,6 +1161,7 @@ B5AEFAB41C9962AE00AD137F /* CoreStoreBridge.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CoreStoreBridge.swift; sourceTree = ""; }; B5B866DA25E9012F00335476 /* ListPublisher+Reactive.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "ListPublisher+Reactive.swift"; sourceTree = ""; }; B5B866DF25E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ObjectPublisher.SnapshotPublisher.swift; sourceTree = ""; }; + B5B866EC25F4800800335476 /* DataStack.AddStoragePublisher.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DataStack.AddStoragePublisher.swift; sourceTree = ""; }; B5BF7FAC234C41E90070E741 /* Internals.DiffableDataSourceSnapshot.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Internals.DiffableDataSourceSnapshot.swift; sourceTree = ""; }; B5BF7FB1234C97910070E741 /* DiffableDataSource.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DiffableDataSource.swift; sourceTree = ""; }; B5BF7FB6234C97CE0070E741 /* DiffableDataSource.TableViewAdapter-UIKit.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "DiffableDataSource.TableViewAdapter-UIKit.swift"; sourceTree = ""; }; @@ -1769,6 +1774,7 @@ B5C795C225DD651F00BDACC1 /* DataStack+Reactive.swift */, B5B866DA25E9012F00335476 /* ListPublisher+Reactive.swift */, B5944EF525E269F9001D1D81 /* ObjectPublisher+Reactive.swift */, + B5B866EC25F4800800335476 /* DataStack.AddStoragePublisher.swift */, B5944EFA25E8E8DA001D1D81 /* ListPublisher.SnapshotPublisher.swift */, B5B866DF25E9048000335476 /* ObjectPublisher.SnapshotPublisher.swift */, ); @@ -2356,6 +2362,7 @@ B5AA37F1235C28EE00FFD4B9 /* DiffableDataSource.CollectionViewAdapter-AppKit.swift in Sources */, B5D7A5B61CA3BF8F005C752B /* CSInto.swift in Sources */, B56007141B3F6C2800A9A8F9 /* SectionBy.swift in Sources */, + B5B866ED25F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */, B5DE522B230BD7CC00A22534 /* Internals.swift in Sources */, B5E84F371AFF85470064E85B /* NSManagedObjectContext+Transaction.swift in Sources */, B509D7BC23C847BC00F42824 /* Value.Optional.swift in Sources */, @@ -2608,6 +2615,7 @@ 82BA18C21C4BBD5300A0916E /* ObjectMonitor.swift in Sources */, B5D7A5B81CA3BF8F005C752B /* CSInto.swift in Sources */, 82BA18BD1C4BBD4A00A0916E /* GroupBy.swift in Sources */, + B5B866EE25F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */, B5ECDC1F1CA81A2100C7F112 /* CSDataStack+Querying.swift in Sources */, B5BF7FCC234D80910070E741 /* Internals.LazyNonmutating.swift in Sources */, B5C976E41C6C9F9A00B1AF90 /* UnsafeDataTransaction+Observing.swift in Sources */, @@ -2860,6 +2868,7 @@ B50E175523517C6B004F033C /* Internals.DiffableDataUIDispatcher.Changeset.swift in Sources */, B5A5F26A1CAEC50F004AB9AF /* CSSelect.swift in Sources */, B5FEC1911C9166E700532541 /* NSPersistentStore+Setup.swift in Sources */, + B5B866F025F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */, B52DD1AB1BE1F93900949AFE /* From.swift in Sources */, B52DD1A11BE1F92C00949AFE /* DataStack+Transaction.swift in Sources */, B5220E1C1D130801009BC71E /* Internals.FetchedResultsControllerDelegate.swift in Sources */, @@ -3112,6 +3121,7 @@ B56321891BD65216006C9394 /* AsynchronousDataTransaction.swift in Sources */, B5ECDC201CA81A2100C7F112 /* CSDataStack+Querying.swift in Sources */, B5C976E51C6C9F9B00B1AF90 /* UnsafeDataTransaction+Observing.swift in Sources */, + B5B866EF25F4800800335476 /* DataStack.AddStoragePublisher.swift in Sources */, B5BF7FCD234D80910070E741 /* Internals.LazyNonmutating.swift in Sources */, B53FBA151CAB63CB00F0D40A /* Progress+ObjectiveC.swift in Sources */, B50564D52350CC3100482308 /* PropertyProtocol.swift in Sources */, diff --git a/Sources/DataStack+Reactive.swift b/Sources/DataStack+Reactive.swift index f1f2c7b..d069265 100644 --- a/Sources/DataStack+Reactive.swift +++ b/Sources/DataStack+Reactive.swift @@ -75,6 +75,78 @@ extension DataStack.ReactiveNamespace { // MARK: Public + /** + Reactive extension for `CoreStore.DataStack`'s `addStorage(...)` API. Asynchronously adds a `StorageInterface` to the stack. + ``` + dataStack.reactive + .addStorage( + InMemoryStore(configuration: "Config1") + ) + .sink( + receiveCompletion: { result in + // ... + }, + receiveValue: { storage in + // ... + } + ) + .store(in: &cancellables) + ``` + - parameter storage: the storage + - returns: A `Future` that emits a `StorageInterface` instance added to the `DataStack`. Note that the `StorageInterface` event value may not always be the same instance as the parameter argument if a previous `StorageInterface` was already added at the same URL and with the same configuration. + */ + public func addStorage(_ storage: T) -> Future { + + return .init { (promise) in + + self.base.addStorage( + storage, + completion: { (result) in + + switch result { + + case .success(let storage): + promise(.success(storage)) + + case .failure(let error): + promise(.failure(error)) + } + } + ) + } + } + + /** + Reactive extension for `CoreStore.DataStack`'s `addStorage(...)` API. Asynchronously adds a `LocalStorage` to the stack. Migrations are also initiated by default. The event emits `DataStack.AddStoragePublisher.Progress` `enum` values. + ``` + dataStack.reactive + .addStorage( + SQLiteStore( + fileName: "core_data.sqlite", + configuration: "Config1" + ) + ) + .sink( + receiveCompletion: { result in + // ... + }, + receiveValue: { (progress) in + print("\(round(progress.fractionCompleted * 100)) %") // 0.0 ~ 1.0 + } + ) + .store(in: &cancellables) + ``` + - parameter storage: the local storage + - returns: A `DataStack.AddStoragePublisher` that emits a `DataStack.AddStoragePublisher.Progress` value with metadata for migration progress. Note that the `LocalStorage` event value may not always be the same instance as the parameter argument if a previous `LocalStorage` was already added at the same URL and with the same configuration. + */ + public func addStorage(_ storage: T) -> DataStack.AddStoragePublisher { + + return .init( + dataStack: self.base, + storage: storage + ) + } + /** Reactive extension for `CoreStore.DataStack`'s `importObject(...)` API. Creates an `ImportableObject` by importing from the specified import source. The event value will be the object instance correctly associated for the `DataStack`. ``` diff --git a/Sources/DataStack.AddStoragePublisher.swift b/Sources/DataStack.AddStoragePublisher.swift new file mode 100644 index 0000000..bc2c443 --- /dev/null +++ b/Sources/DataStack.AddStoragePublisher.swift @@ -0,0 +1,238 @@ +// +// DataStack.AddStoragePublisher.swift +// CoreStore +// +// Copyright © 2021 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. +// + +#if canImport(Combine) +import Combine +import CoreData + + +// MARK: - DataStack + +@available(iOS 13.0, tvOS 13.0, watchOS 6.0, macOS 10.15, *) +extension DataStack { + + // MARK: - AddStoragePublisher + + /** + A `Publisher` that emits a `ListSnapshot` whenever changes occur in the `ListPublisher`. + + - SeeAlso: DataStack.reactive.addStorage(_:) + */ + public struct AddStoragePublisher: Publisher { + + // MARK: Internal + + internal let dataStack: DataStack + internal let storage: Storage + + + // MARK: Publisher + + public typealias Output = Progress + public typealias Failure = CoreStoreError + + public func receive(subscriber: S) where S.Input == Output, S.Failure == Failure { + + subscriber.receive( + subscription: AddStorageSubscription( + dataStack: self.dataStack, + storage: self.storage, + subscriber: subscriber + ) + ) + } + + // MARK: - Progress + + /** + A `Progress` contains info on a `LocalStorage`'s setup progress. + + - SeeAlso: DataStack.reactive.addStorage(_:) + */ + public enum Progress { + + /** + The `LocalStorage` is currently being migrated + */ + case migrating(storage: Storage, progressObject: Foundation.Progress) + + /** + The `LocalStorage` has been added to the `DataStack` and is ready for reading and writing + */ + case finished(storage: Storage, migrationRequired: Bool) + + /** + The fraction of the overall work completed by the migration. Returns a value between 0.0 and 1.0, inclusive. + */ + public var fractionCompleted: Double { + + switch self { + + case .migrating(_, let progressObject): + return progressObject.fractionCompleted + + case .finished: + return 1 + } + } + + /** + Returns `true` if the storage was successfully added to the stack, `false` otherwise. + */ + public var isCompleted: Bool { + + switch self { + + case .migrating: + return false + + case .finished: + return true + } + } + } + + + // MARK: - AddStorageSubscriber + + fileprivate final class AddStorageSubscriber: Subscriber { + + // MARK: Subscriber + + typealias Failure = CoreStoreError + + func receive(subscription: Subscription) { + + subscription.request(.unlimited) + } + + func receive(_ input: Output) -> Subscribers.Demand { + + return .unlimited + } + + func receive(completion: Subscribers.Completion) {} + } + + + // MARK: - AddStorageSubscription + + fileprivate final class AddStorageSubscription: Subscription where S.Input == Output, S.Failure == CoreStoreError { + + // MARK: FilePrivate + + init( + dataStack: DataStack, + storage: Storage, + subscriber: S + ) { + + self.dataStack = dataStack + self.storage = storage + self.subscriber = subscriber + } + + + // MARK: Subscription + + func request(_ demand: Subscribers.Demand) { + + guard demand > 0 else { + + return + } + var progress: Foundation.Progress? + progress = self.dataStack.addStorage( + self.storage, + completion: { [weak self] result in + + guard + let self = self, + let subscriber = self.subscriber + else { + + return + } + switch result { + + case .success(let storage): + _ = subscriber.receive( + .finished( + storage: storage, + migrationRequired: progress != nil + ) + ) + subscriber.receive( + completion: .finished + ) + + case .failure(let error): + subscriber.receive( + completion: .failure(error) + ) + } + } + ) + guard let progress = progress else { + + return + } + progress.cs_setProgressHandler { [weak self] progress in + + guard + let self = self, + let subscriber = self.subscriber + else { + + return + } + _ = subscriber.receive( + .migrating( + storage: self.storage, + progressObject: progress + ) + ) + } + } + + + // MARK: Cancellable + + func cancel() { + + self.subscriber = nil + } + + + // MARK: Private + + private let dataStack: DataStack + private let storage: Storage + private var subscriber: S? + } + } +} + +#endif diff --git a/Sources/ListPublisher.SnapshotPublisher.swift b/Sources/ListPublisher.SnapshotPublisher.swift index 8a8e04a..0b04190 100644 --- a/Sources/ListPublisher.SnapshotPublisher.swift +++ b/Sources/ListPublisher.SnapshotPublisher.swift @@ -37,6 +37,8 @@ extension ListPublisher { /** A `Publisher` that emits a `ListSnapshot` whenever changes occur in the `ListPublisher`. + + - SeeAlso: ListPublisher.reactive.snapshot(emitInitialValue:) */ public struct SnapshotPublisher: Publisher { diff --git a/Sources/ObjectPublisher.SnapshotPublisher.swift b/Sources/ObjectPublisher.SnapshotPublisher.swift index 93d4e73..00a9a44 100644 --- a/Sources/ObjectPublisher.SnapshotPublisher.swift +++ b/Sources/ObjectPublisher.SnapshotPublisher.swift @@ -37,6 +37,8 @@ extension ObjectPublisher { /** A `Publisher` that emits an `ObjectSnapshot?` whenever changes occur in the `ObjectPublisher`. The event emits `nil` if the object has been deletd. + + - SeeAlso: ObjectPublisher.reactive.snapshot(emitInitialValue:) */ public struct SnapshotPublisher: Publisher {