Keypaths for managed object set manipulation

Author: anconaesselmann

Sources/ProgrammaticCoreData/EntityDescriptionAttribute/EntityDescriptionAttribute+Initialization.swift

@@ -23,7 +23,7 @@ public extension EntityDescriptionAttribute {
 
     // TODO: allow to pass in min/max.
     static func relationship<InverseCoreDataType, InverseT>(
-        _ keyPath: KeyPath<CoreDataEntity, NSSet?>,
+        _ keyPath: KeyPath<CoreDataEntity, T>,
         inverse: KeyPath<InverseCoreDataType, InverseT>,
         deleteRule: NSDeleteRule = .noActionDeleteRule
     ) -> Self
@@ -41,15 +41,15 @@ public extension EntityDescriptionAttribute {
 
     // TODO: allow to pass in min/max.
     static func relationship<InverseCoreDataType, InverseT>(
-        _ keyPath: KeyPath<CoreDataEntity, NSSet>,
+        _ keyPath: KeyPath<CoreDataEntity, T>,
         inverse: KeyPath<InverseCoreDataType, InverseT>,
         is type: RelationshipProperties.RelationshipType = .toOne,
         deleteRule: NSDeleteRule = .noActionDeleteRule
     ) -> Self
         where
             CoreDataEntity: SelfDescribingCoreDataEntity,
             InverseCoreDataType: SelfDescribingCoreDataEntity,
-            T == NSSet
+            T: NSSet
     {
         .relationship(keyPath, RelationshipProperties(
             inverse: inverse,
@@ -61,14 +61,14 @@ public extension EntityDescriptionAttribute {
     static func undefined(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Any? = nil) -> Self {
         .undefined(keyPath, AttributeProperties(defaultValue: defaultValue))
     }
-    static func integer16(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Int16? = nil) -> Self {
-        .integer16(keyPath, AttributeProperties(defaultValue: defaultValue))
+    static func int16(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Int16? = nil) -> Self {
+        .int16(keyPath, AttributeProperties(defaultValue: defaultValue))
     }
-    static func integer32(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Int32? = nil) -> Self {
-        .integer32(keyPath, AttributeProperties(defaultValue: defaultValue))
+    static func int32(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Int32? = nil) -> Self {
+        .int32(keyPath, AttributeProperties(defaultValue: defaultValue))
     }
-    static func integer64(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Int64? = nil) -> Self {
-        .integer64(keyPath, AttributeProperties(defaultValue: defaultValue))
+    static func int64(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Int64? = nil) -> Self {
+        .int64(keyPath, AttributeProperties(defaultValue: defaultValue))
     }
     static func decimal(_ keyPath: KeyPath<CoreDataEntity, T>, defaultValue: Decimal? = nil) -> Self {
         .decimal(keyPath, AttributeProperties(defaultValue: defaultValue))

Sources/ProgrammaticCoreData/EntityDescriptionAttribute/EntityDescriptionAttribute.swift

@@ -11,9 +11,9 @@ public enum EntityDescriptionAttribute<CoreDataEntity, T> {
     }
 
     case undefined(KeyPath<CoreDataEntity, T>, AttributeProperties)
-    case integer16(KeyPath<CoreDataEntity, T>, AttributeProperties)
-    case integer32(KeyPath<CoreDataEntity, T>, AttributeProperties)
-    case integer64(KeyPath<CoreDataEntity, T>, AttributeProperties)
+    case int16(KeyPath<CoreDataEntity, T>, AttributeProperties)
+    case int32(KeyPath<CoreDataEntity, T>, AttributeProperties)
+    case int64(KeyPath<CoreDataEntity, T>, AttributeProperties)
     case decimal(KeyPath<CoreDataEntity, T>, AttributeProperties)
     case double(KeyPath<CoreDataEntity, T>, AttributeProperties)
     case float(KeyPath<CoreDataEntity, T>, AttributeProperties)
@@ -36,9 +36,9 @@ public enum EntityDescriptionAttribute<CoreDataEntity, T> {
         switch self {
         case
             .undefined(let keyPath, _),
-            .integer16(let keyPath, _),
-            .integer32(let keyPath, _),
-            .integer64(let keyPath, _),
+            .int16(let keyPath, _),
+            .int32(let keyPath, _),
+            .int64(let keyPath, _),
             .decimal(let keyPath, _),
             .double(let keyPath, _),
             .float(let keyPath, _),
@@ -62,9 +62,9 @@ public enum EntityDescriptionAttribute<CoreDataEntity, T> {
             return .relationship(properties)
         case
             .undefined(_, let properties),
-            .integer16(_, let properties),
-            .integer32(_, let properties),
-            .integer64(_, let properties),
+            .int16(_, let properties),
+            .int32(_, let properties),
+            .int64(_, let properties),
             .decimal(_, let properties),
             .double(_, let properties),
             .float(_, let properties),

Sources/ProgrammaticCoreData/EntityDescriptionAttribute/NSAttributeType+EntityDescriptionAttribute.swift

@@ -8,11 +8,11 @@ extension NSAttributeType {
         switch entityDescriptionAttribute {
         case .undefined:
             self = .undefinedAttributeType
-        case .integer16:
+        case .int16:
             self = .integer16AttributeType
-        case .integer32:
+        case .int32:
             self = .integer32AttributeType
-        case .integer64:
+        case .int64:
             self = .integer64AttributeType
         case .decimal:
             self = .decimalAttributeType

Sources/ProgrammaticCoreData/NSManagedObject+Extensions.swift

@@ -0,0 +1,40 @@
+//  Created by Axel Ancona Esselmann on 3/23/24.
+//
+
+import Foundation
+import CoreData
+
+public extension NSManagedObject {
+    enum SetInsertionError: Swift.Error {
+        case itemAlreadyInSet
+        case itemNotInSet
+    }
+
+    func add<ManagedObject, SelfType>(
+        _ value: ManagedObject,
+        keyPath: KeyPath<SelfType, NSSet>
+    ) throws
+        where 
+            ManagedObject: NSManagedObject,
+SelfType: NSManagedObject
+
+    {
+        let items = try self.mutableSetValue(keyPath)
+        guard !items.contains(value) else {
+            throw SetInsertionError.itemAlreadyInSet
+        }
+        items.add(value)
+    }
+
+    func remove<ManagedObject, SelfType>(_ value: ManagedObject, keyPath: KeyPath<SelfType, NSSet>) throws
+        where
+            ManagedObject: NSManagedObject,
+            SelfType: NSManagedObject
+    {
+        let items = try self.mutableSetValue(keyPath)
+        guard items.contains(value) else {
+            throw SetInsertionError.itemNotInSet
+        }
+        items.remove(value)
+    }
+}

Sources/ProgrammaticCoreData/NSObject+Extensions.swift

@@ -0,0 +1,20 @@
+//  Created by Axel Ancona Esselmann on 3/23/24.
+//
+
+import Foundation
+
+public extension NSObject {
+
+    enum NSObjectExtensionError: Error {
+        case nilKeypathString
+    }
+
+    func mutableSetValue<SelfType>(_ keyPath: KeyPath<SelfType, NSSet>) throws -> NSMutableSet
+        where SelfType: NSObject
+    {
+        guard let key = keyPath._kvcKeyPathString else {
+            throw NSObjectExtensionError.nilKeypathString
+        }
+        return self.mutableSetValue(forKey: key)
+    }
+}

Sources/ProgrammaticCoreData/SelfDescribingCoreDataEntity.swift

@@ -9,7 +9,7 @@ public protocol SelfDescribingCoreDataEntity: NSManagedObject {
 
 public extension SelfDescribingCoreDataEntity {
 
-    static func fetchRequest() throws -> NSFetchRequest<Self> {
+    static func fetchRequest() -> NSFetchRequest<Self> {
         NSFetchRequest<Self>(entityName: "\(Self.self)")
     }