Skip to content

Commit 8420346

Browse files
Readme update
1 parent 422a327 commit 8420346

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# ProgrammaticCoreData
22

3-
ProgrammaticCoreData is a declarative library for iOS and macOS for creating CoreData's `NSManagedObjectModel`s programmatically.
3+
ProgrammaticCoreData is a declarative library for iOS and macOS applications for creating CoreData's `NSManagedObjectModel`s programmatically.
44

55
### Why might I want to create my Core Data models programmatically (and with ProgrammaticCoreData):
66
- CoreData models that were created with Xcode's editor are a pain to ship in packages.
77
- When [linking multiple core data stores](https://developer.apple.com/documentation/coredata/linking_data_between_two_core_data_stores) certain CoreData features are limited or unavailable. Relationships across data stores for example are not supported (fetched properties can be used instead but have to be updated manually). Programmatic data models can be combined, resulting in one store and the ability to use relationships.
8-
- When [removing optionals from your CoreData code](https://www.jessesquires.com/blog/2022/01/26/core-data-optionals/) property types and their optionality in the Xcode data model and the manually created `Entities` have to match. When changing a property in either place the other has to be updated manually, which introduces a place to make mistakes. Since ProgrammaticCoreData uses KeyPaths for entity descriptions the compiler spots many of the aforementioned issues. Since creating entity descriptions programmatically allows for the Entity and the Entity Description to live in the same file, spotting issues the compiler did not catch might become a bit easier.
9-
- Xcode's CoreData models are stored as XML files. Reviewing changes can be difficult. A programmatic CoreData model makes reviews simpler
8+
- Working with CoreData from swift can be annoying. Optionality of properties is one such pain point. There are [good practices](https://www.jessesquires.com/blog/2022/01/26/core-data-optionals/) one can follow for "swiftifying" CoreData but maintaining Entities manually while keeping the data model generated in Xcode up to date introduces the possibility of making mistakes. When changing a property in either place the other has to be updated manually. Creating entity descriptions programmatically allows for the Entity and the Entity Description to live in the same file which makes spotting issues a bit easier. In addition, ProgrammaticCoreData makes use of `KeyPath`s which allows us to utilize the compiler for spotting many type mismatches.
9+
- Xcode's CoreData models are stored as XML files. Reviewing changes can be difficult. A programmatic CoreData model makes reviews simpler.
1010
- Data models created with ProgrammaticCoreData are declarative.
11-
- Apple's APIs for creating CoreData models programmatically relies heavily on strings. ProgrammaticCoreData replaces stringy API's with ones utilizing `KeyPath`s.
11+
- Apple's APIs for creating CoreData models programmatically relies heavily on `String`s. ProgrammaticCoreData replaces stringy API's with ones utilizing `KeyPath`s.
1212

1313
### Reasons for not creating your data models programmatically:
1414
- Migrations. A [humorous writeup](https://medium.com/@JohnCoatesDev/dont-create-core-data-models-programmatically-3a563e66ce2a) chronicles the pains of how to get migrations to work with programmatically created data models. There is very little public documentation for migrating CoreData models that were not created with Xcode's CoreData model editor. [It is possible though](https://github.com/JohnCoates/Slate/tree/master/Source/Database).

0 commit comments

Comments
 (0)