Add convenience constructors from success document types that craete non-optional caches.

Author: mattpolzin

Sources/JSONAPIResourceCache/ResourceCache.swift

@@ -182,3 +182,76 @@ extension EncodableJSONAPIDocument where
         return cache
     }
 }
+
+// MARK: Success Documents
+// success documents can return non-optional caches
+
+extension Document.SuccessDocument where
+    BodyData.PrimaryResourceBody: SingleResourceBodyProtocol,
+    BodyData.PrimaryResourceBody.PrimaryResource: CacheableResource,
+    BodyData.IncludeType: CacheableResource,
+    BodyData.PrimaryResourceBody.PrimaryResource.Cache == BodyData.IncludeType.Cache {
+    public func resourceCache() -> BodyData.IncludeType.Cache {
+
+        var cache = BodyData.IncludeType.Cache()
+
+        data.primary.value.cache(in: &cache)
+
+        for include in data.includes.values {
+            include.cache(in: &cache)
+        }
+
+        return cache
+    }
+}
+
+extension Document.SuccessDocument where
+    BodyData.PrimaryResourceBody: ManyResourceBodyProtocol,
+    BodyData.PrimaryResourceBody.PrimaryResource: CacheableResource,
+    BodyData.IncludeType: CacheableResource,
+    BodyData.PrimaryResourceBody.PrimaryResource.Cache == BodyData.IncludeType.Cache {
+    public func resourceCache() -> BodyData.IncludeType.Cache {
+
+        var cache = BodyData.IncludeType.Cache()
+
+        for resource in data.primary.values {
+            resource.cache(in: &cache)
+        }
+
+        for include in data.includes.values {
+            include.cache(in: &cache)
+        }
+
+        return cache
+    }
+}
+
+extension Document.SuccessDocument where
+    BodyData.PrimaryResourceBody: SingleResourceBodyProtocol,
+    BodyData.PrimaryResourceBody.PrimaryResource: CacheableResource,
+    BodyData.IncludeType == NoIncludes {
+    public func resourceCache() -> BodyData.PrimaryResourceBody.PrimaryResource.Cache {
+
+        var cache = BodyData.PrimaryResourceBody.PrimaryResource.Cache()
+
+        data.primary.value.cache(in: &cache)
+
+        return cache
+    }
+}
+
+extension Document.SuccessDocument where
+    BodyData.PrimaryResourceBody: ManyResourceBodyProtocol,
+    BodyData.PrimaryResourceBody.PrimaryResource: CacheableResource,
+    BodyData.IncludeType == NoIncludes {
+    public func resourceCache() -> BodyData.PrimaryResourceBody.PrimaryResource.Cache {
+
+        var cache = BodyData.PrimaryResourceBody.PrimaryResource.Cache()
+
+        for resource in data.primary.values {
+            resource.cache(in: &cache)
+        }
+
+        return cache
+    }
+}

Tests/JSONAPIResourceCacheTests/ResourceCacheTests.swift

@@ -154,6 +154,82 @@ final class ResourceCacheTests: XCTestCase {
         XCTAssertEqual((firstPrimaryResource ~> \.type1).materialize(from: cache!), type1)
         XCTAssertEqual((firstPrimaryResource ~> \.type3).materialize(from: cache!), type3)
     }
+
+    func test_successDocumentCreation() {
+        let t1Id = "1234"
+        let t2Id = "5678"
+        let t2Id2 = "1323221"
+        let t3Id = "910112"
+
+        let date = Date()
+
+        let type3 = Type3(
+            id: .init(rawValue: t3Id),
+            attributes: .init(int: 1234),
+            relationships: .init(type2: .init(id: .init(rawValue: t2Id))),
+            meta: .none,
+            links: .none
+        )
+
+        let type2s = [
+            Type2(
+                id: .init(rawValue: t2Id),
+                attributes: .init(string: "hello world"),
+                relationships: .init(
+                    type1: .init(id: .init(rawValue: t1Id)),
+                    type3: .init(id: .init(rawValue: t3Id))
+                ),
+                meta: .none,
+                links: .none
+            ),
+            Type2(
+                id: .init(rawValue: t2Id2),
+                attributes: .init(string: "hi"),
+                relationships: .init(
+                    type1: .init(id: .init(rawValue: t1Id)),
+                    type3: .init(id: .init(rawValue: t3Id))
+                ),
+                meta: .none,
+                links: .none
+            )
+        ]
+
+        let type1 = Type1(
+            id: .init(rawValue: t1Id),
+            attributes: .init(createdAt: .init(value: date)),
+            relationships: .init(
+                type2: .init(id: .init(rawValue: t2Id)),
+                type4: .init(ids: [])
+            ),
+            meta: .none,
+            links: .none
+        )
+
+        let document = JSONAPI.Document<
+            ManyResourceBody<Type2>,
+            NoMetadata,
+            NoLinks,
+            Include2<Type1, Type3>,
+            NoAPIDescription,
+        UnknownJSONAPIError>.SuccessDocument(
+                apiDescription: .none,
+                body: .init(resourceObjects: type2s),
+                includes: .init(values: [.init(type1), .init(type3)]),
+                meta: .none,
+                links: .none
+        )
+
+        let cache = document.resourceCache()
+
+        XCTAssertEqual(cache[type1.id], type1)
+        XCTAssertEqual(cache[type2s[0].id], type2s[0])
+        XCTAssertEqual(cache[type2s[1].id], type2s[1])
+        XCTAssertEqual(cache[type3.id], type3)
+
+        let firstPrimaryResource = document.body.primaryResource!.values.first!
+        XCTAssertEqual((firstPrimaryResource ~> \.type1).materialize(from: cache), type1)
+        XCTAssertEqual((firstPrimaryResource ~> \.type3).materialize(from: cache), type3)
+    }
 }
 
 // MARK: - Test Types