README.md

CoreDataModelActor

CoreDataModelActor is a Swift Package that extends and enhances the ideas presented by fatbobman in his article and the associated experimental project CoreDataEvolution. This package introduces support for older platforms (down to iOS 13) and provides two different executors to manage Core Data concurrency across various versions of Apple's operating systems.

Example Usage

Here’s an example of how to use CoreDataModelActor to manage Core Data operations with actors:

import Foundation
import CoreDataModelActor
import CoreDataModelActorMacros

@NSModelActor
actor DocumentsRepository {
    func toggleFavorite(objectID: NSManagedObjectID) async throws {
        guard let document = try modelContext.existingObject(with: objectID) as? Item else { return }
        document.timestamp = .now
        try modelContext.save()
    }
}

Or, if you don't want to use the macro:

import CoreData
import CoreDataModelActor

actor DocumentsRepository: NSModelActor {
    let modelContainer: NSPersistentContainer
    let modelExecutor: any CoreDataModelActor.NSModelObjectContextExecutor

    init(container: NSPersistentContainer) {
        self.modelExecutor = NSModelObjectContextExecutorFactory.makeExecutor(context: container.newBackgroundContext())
        self.modelContainer = container
    }
    
    func toggleFavorite(objectID: NSManagedObjectID) async throws {
        guard let document = try modelContext.existingObject(with: objectID) as? Item else { return }
        document.timestamp = .now
        try modelContext.save()
    }    
}

Minimum Supported Targets

• macOS 10.15
• iOS 13
• tvOS 13
• watchOS 6
• Mac Catalyst 13

Credits

This project is inspired by and based on the experimental work done by fatbobman. You can find the original article and project at the following links:

• Article: Core Data Reform: Achieving Elegant Concurrency Operations Like SwiftData
• Experimental Project: CoreDataEvolution