Readme update and refactor of examples

Author: anconaesselmann

Examples/Example_01/Example_01/Persistence/CoreDataModels/NoteEntity.swift

@@ -6,16 +6,16 @@ import CoreData
 import ProgrammaticCoreData
 
 @objc(NoteEntity)
-public class NoteEntity: NSManagedObject, Identifiable {
-    @nonobjc public class func fetchRequest() -> NSFetchRequest<NoteEntity> {
-        return NSFetchRequest<NoteEntity>(entityName: "NoteEntity")
-    }
+final class NoteEntity: NSManagedObject, Identifiable {
 
-    @NSManaged public var id: UUID
-    @NSManaged public var text: String
-    @NSManaged public var created: Date
+    @NSManaged var id: UUID
+    @NSManaged var text: String
+    @NSManaged var created: Date
 
-    public init(
+    // The only available initializer initializes all none-optional properties. 
+    // Below we mark all other initializers as unavailable. The compiler can now
+    // enforce that we never instantiate an instance without setting all propperties.
+    init(
         context: NSManagedObjectContext,
         id: UUID,
         text: String,
@@ -27,24 +27,25 @@ public class NoteEntity: NSManagedObject, Identifiable {
         self.created = created
     }
 
+    // MARK: - Unavailable initializers
     @available(*, unavailable)
-    public override init(entity: NSEntityDescription, insertInto context: NSManagedObjectContext?) {
+    override init(entity: NSEntityDescription, insertInto context: NSManagedObjectContext?) {
         super.init(entity: entity, insertInto: context)
     }
 
     @available(*, unavailable)
-    public init(context: NSManagedObjectContext) {
+    init(context: NSManagedObjectContext) {
         fatalError()
     }
 
     @available(*, unavailable)
-    public init() {
+    init() {
         fatalError()
     }
 }
 
 extension NoteEntity: SelfDescribingCoreDataEntity {
-    public static var entityDescription = NoteEntity.description(
+    static var entityDescription = NoteEntity.description(
         .uuid(\.id),
         .string(\.text),
         .date(\.created)

Examples/Example_02/Example_02.xcodeproj/project.pbxproj

@@ -140,8 +140,8 @@
 		97AB88B72BE97DE100AB314B /* Persistence */ = {
 			isa = PBXGroup;
 			children = (
-				97AB88B82BE97EEA00AB314B /* Models */,
 				97AB88C52BE984A100AB314B /* ContainerBuilder.swift */,
+				97AB88B82BE97EEA00AB314B /* Models */,
 			);
 			path = Persistence;
 			sourceTree = "<group>";

Examples/Example_02/Example_02/Persistence/Models/AuthorEntity.swift

@@ -7,9 +7,6 @@ import ProgrammaticCoreData
 
 @objc(AuthorEntity)
 final class AuthorEntity: NSManagedObject, Identifiable {
-    @nonobjc class func fetchRequest() -> NSFetchRequest<AuthorEntity> {
-        return NSFetchRequest<AuthorEntity>(entityName: "AuthorEntity")
-    }
 
     @NSManaged var id: UUID
     @NSManaged var name: String
@@ -31,6 +28,9 @@ final class AuthorEntity: NSManagedObject, Identifiable {
     @objc(remove_books:)
     @NSManaged func removeFromBooks(_ values: Set<BookEntity>)
 
+    // The only available initializer initializes all none-optional properties.
+    // Below we mark all other initializers as unavailable. The compiler can now
+    // enforce that we never instantiate an instance without setting all propperties.
     init(
         context: NSManagedObjectContext,
         id: UUID,
@@ -41,6 +41,7 @@ final class AuthorEntity: NSManagedObject, Identifiable {
         self.name = name
     }
 
+    // MARK: - Unavailable initializers
     @available(*, unavailable)
     override init(entity: NSEntityDescription, insertInto context: NSManagedObjectContext?) {
         super.init(entity: entity, insertInto: context)

Examples/Example_02/Example_02/Persistence/Models/BookEntity.swift

@@ -7,14 +7,14 @@ import ProgrammaticCoreData
 
 @objc(BookEntity)
 final class BookEntity: NSManagedObject, Identifiable {
-    @nonobjc class func fetchRequest() -> NSFetchRequest<BookEntity> {
-        return NSFetchRequest<BookEntity>(entityName: "BookEntity")
-    }
 
     @NSManaged var id: UUID
     @NSManaged var title: String
     @NSManaged var author: AuthorEntity
 
+    // The only available initializer initializes all none-optional properties.
+    // Below we mark all other initializers as unavailable. The compiler can now
+    // enforce that we never instantiate an instance without setting all propperties.
     init(
         context: NSManagedObjectContext,
         id: UUID,
@@ -28,6 +28,7 @@ final class BookEntity: NSManagedObject, Identifiable {
         author.addToBooks(self)
     }
 
+    // MARK: - Unavailable initializers
     @available(*, unavailable)
     override init(entity: NSEntityDescription, insertInto context: NSManagedObjectContext?) {
         super.init(entity: entity, insertInto: context)

README.md

@@ -46,9 +46,6 @@ We create our `Note` entity programmatically:
 ```swift
 @objc(Note)
 final class Note: NSManagedObject, Identifiable {
-    @nonobjc class func fetchRequest() -> NSFetchRequest<Note> {
-        return NSFetchRequest<Note>(entityName: "Note")
-    }
 
     @NSManaged var id: UUID
     @NSManaged var text: String
@@ -69,10 +66,8 @@ extension Note: SelfDescribingCoreDataEntity {
 
 We can now build our data model and create a container:
 ```swift
-let container = try await NSManagedObjectModel(
-    Note.self
-)
-.createContainer(name: "Notes", location: .local)
+let container = try await NSManagedObjectModel(Note.self)
+    .createContainer(name: "Notes", location: .local)
 ```
 
 - [Example_02](https://github.com/anconaesselmann/ProgrammaticCoreData/tree/main/Examples/Example_02) is a Book Archive app with a to-many relationship from an `Author` to their `Book`s and an inverse to-one relationship from a `Book` and it's `Author`:
@@ -81,9 +76,6 @@ We create an `Author` entity programmatically. Note the `addToBooks` and `remove
 ```swift
 @objc(Author)
 final class Author: NSManagedObject, Identifiable {
-    @nonobjc class func fetchRequest() -> NSFetchRequest<Author> {
-        return NSFetchRequest<Author>(entityName: "Author")
-    }
 
     @NSManaged var id: UUID
     @NSManaged var name: String
@@ -111,9 +103,6 @@ We create a `Book` entity programmatically. Note that it should be impossible to
 ```swift
 @objc(Book)
 final class Book: NSManagedObject, Identifiable {
-    @nonobjc class func fetchRequest() -> NSFetchRequest<Book> {
-        return NSFetchRequest<Book>(entityName: "Book")
-    }
 
     @NSManaged var id: UUID
     @NSManaged var title: String
@@ -184,8 +173,7 @@ We can now build our data model and create a container:
 let container = try await NSManagedObjectModel(
     Author.self,
     Book.self
-)
-.createContainer(name: "Books", location: .local)
+).createContainer(name: "Books", location: .local)
 ```
 
 If we didn't care about the order of books on our `Author` entity we would declare a `books` `Set` instead of an `Array`: