CypherPoetCoreDataKit

A collection of utilities for building Core Data applications in SwiftUI.

🚧 Disclaimer

This library is still very much a WIP as I study some of the new best practices, patterns, and affordances for Core Data after the release of SwiftUI 2.0. Please treat it as a guideline/reference for the time being 🙂.

Features

• ✅ A CoreDataManager that handles setting up your "Core Data Stack".
• ✅ A rich set of utilities for performing Core Data migrations.
• ✅ A FetchedResultsControlling protocol that helps architect NSFetchedResultsController instances and extract data from their NSFetchRequest results.
• ✅ Predicate Utilities
• ✅ Strongly-typed errors.
• ✅ NSPersistentStore helpers for using NSSQLiteStoreType in production apps and NSInMemoryStoreType in tests or previews:

Installation

Xcode Projects

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/CypherPoetCoreDataKit.

Swift Package Manager Projects

You can add CypherPoetCoreDataKit as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(url: "https://github.com/CypherPoet/CypherPoetCoreDataKit", .exact("0.0.17")),
    ],
    //...
)

From there, refer to CypherPoetCoreDataKit as a "target dependency" in any of your package's targets that need it.

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
          "CypherPoetCoreDataKit",
        ],
        ...
    ),
    ...
]

Then simply import CypherPoetCoreDataKit wherever you’d like to use it.

Usage

Currently, usage of these utilities is best demonstrated by the various example applications here. But a few pointers...

Dynamically initializing a Core Data Stack for your app depending on whether it's running for production or for Xcode Previews.

• 🔗 Example

Setting up the Core Data stack on launch

• 🔗 iOS Example
• 🔗 macOS Example

Core Data Migrations

• 🔗 Example application built specifically around this.

Contributing

Contributions to CypherPoetCoreDataKit are most welcome. Check out some of the issue templates for more info.

💻 Developing

Requirements

• Xcode 12.5+ (Recommended)

📜 Generating Documentation

Documentation is generated by Jazzy. Installation instructions can be found here, and as soon as you have it set up, docs can be generated simply by running jazzy from the command line.

📝 Note that this will only generate the docs folder for you to view locally. This folder is being ignored by git, as an action exists to automatically generate docs and serve them on the project's gh-pages branch.

🏷 License

CypherPoetCoreDataKit is available under the MIT license. See the LICENSE file for more info.