Major refactor

feature/add-unmanaged-protocol-for-types-that-prefer-a-unique-id-other-than-ObjectID

Author: roanutil

.benchmarkBaselines/coredata-repository-benchmarks/main/results.json

@@ -1,16 +1,17 @@
-// swift-tools-version:5.8
+// swift-tools-version:5.10
 
 import PackageDescription
 
 let package = Package(
     name: "CoreDataRepository",
     defaultLocalization: "en",
     platforms: [
-        .iOS(.v15),
-        .macOS(.v12),
-        .tvOS(.v15),
-        .watchOS(.v8),
-        .macCatalyst(.v15),
+        .iOS(.v16),
+        .macOS(.v13),
+        .tvOS(.v16),
+        .watchOS(.v9),
+        .macCatalyst(.v16),
+        .visionOS(.v1),
     ],
     products: [
         .library(
@@ -19,6 +20,10 @@ let package = Package(
         ),
     ],
     dependencies: [
+        .package(
+            url: "https://github.com/ordo-one/package-benchmark.git",
+            from: "1.23.5"
+        ),
         .package(
             url: "https://github.com/pointfreeco/swift-custom-dump.git",
             from: "1.0.0"
@@ -35,6 +40,14 @@ let package = Package(
             dependencies: [
                 "CoreDataRepository",
                 .product(name: "CustomDump", package: "swift-custom-dump"),
+                "Internal",
+            ],
+            swiftSettings: .swiftSix
+        ),
+        .target(
+            name: "Internal",
+            dependencies: [
+                "CoreDataRepository",
             ],
             swiftSettings: .swiftSix
         ),
@@ -52,3 +65,19 @@ extension [SwiftSetting] {
         .enableExperimentalFeature("StrictConcurrency"),
     ]
 }
+
+// Benchmark of coredata-repository-benchmarks
+package.targets += [
+    .executableTarget(
+        name: "coredata-repository-benchmarks",
+        dependencies: [
+            .product(name: "Benchmark", package: "package-benchmark"),
+            "CoreDataRepository",
+            "Internal",
+        ],
+        path: "Benchmarks/coredata-repository-benchmarks",
+        plugins: [
+            .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
+        ]
+    ),
+]

.benchmarkBaselines/coredata-repository-benchmarks/v3/results.json

@@ -13,7 +13,7 @@ import Foundation
 /// Batch operations that do not use `NSBatch*Request` are not atomic. Some operations may succeed while others fail. If
 /// multiple errors are returned, it would
 /// be helpful if each error is associated with the input data for the operation.
-public struct CoreDataBatchError<T>: Error {
+public struct CoreDataBatchError<T>: Error where T: Sendable {
     /// The input data used for the batched operation. Usually an ``UnmanagedModel`` instance or URL encoded
     /// NSManagedObjectID.
     public let item: T

.benchmarkBaselines/coredata-repository-benchmarks/v4/results.json

@@ -11,16 +11,18 @@ import Foundation
 
 /// An error that models all the possible error conditions of CoreDataRepository.
 ///
-/// CoreDataError also conforms to CustomNSError so that it cleanly casts to NSError
+/// ``CoreDataError`` also conforms to `CustomNSError` so that it cleanly casts to `NSError`
 public enum CoreDataError: Error, Hashable, Sendable {
     /// UnmanagedModels store the ``CoreData.NSManagedObjectID`` of their respective RepositoryManagedModels as a URL.
     /// This URL
     /// must be mapped back into a ``NSManagedObjectID`` for most transactions. If it fails, this error is returned.
     case failedToGetObjectIdFromUrl(URL)
 
-    /// For some aggregate functions, a NSAttributeDescription is required so that a NSFetchRequest can be constructed
+    /// For some aggregate functions, a `NSAttributeDescription` is required so that a `NSFetchRequest` can be
+    /// constructed
     /// against the correct property.
-    /// If the NSAttributeDescription is not for the correct or expected NSEntityDescription, this error is returned.
+    /// If the `NSAttributeDescription` is not for the correct or expected `NSEntityDescription`, this error is
+    /// returned.
     case propertyDoesNotMatchEntity
 
     /// CoreData may return a value of a related type to what is actually needed. If casting the value CoreData returns
@@ -31,23 +33,31 @@ public enum CoreDataError: Error, Hashable, Sendable {
     /// is returned.
     case fetchedObjectIsFlaggedAsDeleted
 
-    /// If CoreData throws a CocoaError, it is embedded here.
+    /// If CoreData throws a `CocoaError`, it is embedded here.
     case cocoa(CocoaError)
 
-    /// If the type of an error is unknown, it is cast to NSError and embedded here.
+    /// If the type of an error is unknown, it is cast to `NSError` and embedded here.
     case unknown(NSError)
 
-    /// If a NSEntityDescription is malformed by not having a name, this error is returned.
+    /// If a `NSEntityDescription` is malformed by not having a name, this error is returned.
     case noEntityNameFound
 
-    /// The count aggregate function requires at least one NSAttributeDescription on the NSEntityDescription. If there
+    /// The count aggregate function requires at least one `NSAttributeDescription` on the `NSEntityDescription`. If
+    /// there
     /// is none, this error is returned.
     case atLeastOneAttributeDescRequired
 
-    /// If an UnmanagedModel is used in a transaction where it is expected to already be persisted but has no URL
+    /// If a ``ManagedIdUrlReferencable`` value is used in a transaction where it is expected to already be persisted
+    /// but has no `URL`
     /// representing the ``NSManagedObjectID``, this error is returned.
     case noUrlOnItemToMapToObjectId
 
+    /// If a ``ManagedIdReferencable`` value is used in a transaction where it is expected to already be persisted but
+    /// has no `NSManagedObjectID`, this error is returned.
+    case noObjectIdOnItem
+
+    case noMatchFoundWhenReadingItem
+
     public var localizedDescription: String {
         switch self {
         case .failedToGetObjectIdFromUrl:
@@ -96,10 +106,23 @@ public enum CoreDataError: Error, Hashable, Sendable {
             )
         case .noUrlOnItemToMapToObjectId:
             return NSLocalizedString(
-                "No object ID URL found on the unmanaged model for an operation against an existing managed object.",
+                "No object ID URL found on the model for an operation against an existing managed object.",
+                bundle: .module,
+                comment: "Error for performing an operation against an existing NSManagedObject but the "
+                    + "ManagedIdUrlReferencable instance has no managedIdUrl for looking up the NSManagedOjbectID."
+            )
+        case .noObjectIdOnItem:
+            return NSLocalizedString(
+                "No object ID found on the model for an operation against an existing managed object.",
                 bundle: .module,
-                comment: "Error for performing an operation against an existing NSManagedObject but the UnmanagedModel "
-                    + "instance has no ManagedRepoUrl for looking up the NSManagedOjbectID."
+                comment: "Error for performing an operation against an existing NSManagedObject but the "
+                    + "ManagedIdReferencable instance has no managedId."
+            )
+        case .noMatchFoundWhenReadingItem:
+            return NSLocalizedString(
+                "No match found when attempting to read an instance from CoreData.",
+                bundle: .module,
+                comment: "Error for reading an instance from CoreData but no instance was found."
             )
         }
     }
@@ -129,6 +152,10 @@ extension CoreDataError: CustomNSError {
             return 8
         case .noUrlOnItemToMapToObjectId:
             return 9
+        case .noObjectIdOnItem:
+            return 10
+        case .noMatchFoundWhenReadingItem:
+            return 11
         }
     }
 
@@ -155,6 +182,10 @@ extension CoreDataError: CustomNSError {
             return [:]
         case .noUrlOnItemToMapToObjectId:
             return [:]
+        case .noObjectIdOnItem:
+            return [:]
+        case .noMatchFoundWhenReadingItem:
+            return [:]
         }
     }
 }