Remove LogEntry and divide Device

fpseverino · fpseverino · commit a0de55b16233 · 2024-12-28T18:59:05.000+01:00
diff --git a/Package.swift b/Package.swift
@@ -22,14 +22,6 @@ let package = Package(
             ],
             swiftSettings: swiftSettings
         ),
-        .testTarget(
-            name: "FluentWalletTests",
-            dependencies: [
-                .target(name: "FluentWallet"),
-                .product(name: "XCTFluent", package: "fluent-kit"),
-            ],
-            swiftSettings: swiftSettings
-        ),
         .target(
             name: "FluentWalletPasses",
             dependencies: [
diff --git a/Sources/FluentWallet/FluentWallet.docc/FluentWallet.md b/Sources/FluentWallet/FluentWallet.docc/FluentWallet.md
@@ -13,20 +13,3 @@ This package provides a collection of Fluent protocol and concrete models, usefu
     }
     @Column(size: 2) { }
 }
-
-## Topics
-
-### Models
-
-- ``DeviceModel``
-- ``LogEntryModel``
-
-### Concrete Models
-
-- ``Device``
-- ``LogEntry``
-
-### Migrations
-
-- ``CreateDevice``
-- ``CreateLogEntry``
diff --git a/Sources/FluentWallet/Models/Concrete Models/LogEntry.swift b/Sources/FluentWallet/Models/Concrete Models/LogEntry.swift
diff --git a/Sources/FluentWallet/Models/LogEntryModel.swift b/Sources/FluentWallet/Models/LogEntryModel.swift
diff --git a/Sources/FluentWalletOrders/FluentWalletOrders.docc/FluentWalletOrders.md b/Sources/FluentWalletOrders/FluentWalletOrders.docc/FluentWalletOrders.md
@@ -19,9 +19,11 @@ For information on Apple Wallet orders, see the [Apple Developer Documentation](
 ### Concrete Models
 
 - ``Order``
+- ``OrdersDevice``
 - ``OrdersRegistration``
 
 ### Migrations
 
 - ``CreateOrder``
+- ``CreateOrdersDevice``
 - ``CreateOrdersRegistration``
diff --git a/Sources/FluentWalletOrders/Models/Concrete Models/OrdersDevice.swift b/Sources/FluentWalletOrders/Models/Concrete Models/OrdersDevice.swift
@@ -1,19 +1,19 @@
 import FluentKit
 
-/// The `Model` that stores Apple Wallet devices.
-final public class Device: DeviceModel, @unchecked Sendable {
+/// The `Model` that stores Apple Wallet passes devices.
+final public class OrdersDevice: DeviceModel, @unchecked Sendable {
     /// The schema name of the device model.
-    public static let schema = Device.FieldKeys.schemaName
+    public static let schema = OrdersDevice.FieldKeys.schemaName
 
     @ID(custom: .id)
     public var id: Int?
 
     /// The push token used for sending updates to the device.
-    @Field(key: Device.FieldKeys.pushToken)
+    @Field(key: OrdersDevice.FieldKeys.pushToken)
     public var pushToken: String
 
     /// The identifier Apple Wallet provides for the device.
-    @Field(key: Device.FieldKeys.libraryIdentifier)
+    @Field(key: OrdersDevice.FieldKeys.libraryIdentifier)
     public var libraryIdentifier: String
 
     public init(libraryIdentifier: String, pushToken: String) {
@@ -24,25 +24,25 @@ final public class Device: DeviceModel, @unchecked Sendable {
     public init() {}
 }
 
-/// The migration that creates the ``Device`` table.
-public struct CreateDevice: AsyncMigration {
+/// The migration that creates the ``OrdersDevice`` table.
+public struct CreateOrdersDevice: AsyncMigration {
     public func prepare(on database: any Database) async throws {
-        try await database.schema(Device.FieldKeys.schemaName)
+        try await database.schema(OrdersDevice.FieldKeys.schemaName)
             .field(.id, .int, .identifier(auto: true))
-            .field(Device.FieldKeys.pushToken, .string, .required)
-            .field(Device.FieldKeys.libraryIdentifier, .string, .required)
-            .unique(on: Device.FieldKeys.pushToken, Device.FieldKeys.libraryIdentifier)
+            .field(OrdersDevice.FieldKeys.pushToken, .string, .required)
+            .field(OrdersDevice.FieldKeys.libraryIdentifier, .string, .required)
+            .unique(on: OrdersDevice.FieldKeys.pushToken, OrdersDevice.FieldKeys.libraryIdentifier)
             .create()
     }
 
     public func revert(on database: any Database) async throws {
-        try await database.schema(Device.FieldKeys.schemaName).delete()
+        try await database.schema(OrdersDevice.FieldKeys.schemaName).delete()
     }
 
     public init() {}
 }
 
-extension Device {
+extension OrdersDevice {
     package enum FieldKeys {
         package static let schemaName = "devices"
         static let pushToken = FieldKey(stringLiteral: "push_token")
diff --git a/Sources/FluentWalletOrders/Models/Concrete Models/OrdersRegistration.swift b/Sources/FluentWalletOrders/Models/Concrete Models/OrdersRegistration.swift
@@ -11,7 +11,7 @@ final public class OrdersRegistration: OrdersRegistrationModel, @unchecked Senda
 
     /// The device for this registration.
     @Parent(key: OrdersRegistration.FieldKeys.deviceID)
-    public var device: Device
+    public var device: OrdersDevice
 
     /// The order for this registration.
     @Parent(key: OrdersRegistration.FieldKeys.orderID)
@@ -27,7 +27,7 @@ public struct CreateOrdersRegistration: AsyncMigration {
             .field(.id, .int, .identifier(auto: true))
             .field(
                 OrdersRegistration.FieldKeys.deviceID, .int, .required,
-                .references(Device.FieldKeys.schemaName, .id, onDelete: .cascade)
+                .references(OrdersDevice.FieldKeys.schemaName, .id, onDelete: .cascade)
             )
             .field(
                 OrdersRegistration.FieldKeys.orderID, .uuid, .required,
diff --git a/Sources/FluentWalletPasses/FluentWalletPasses.docc/FluentWalletPasses.md b/Sources/FluentWalletPasses/FluentWalletPasses.docc/FluentWalletPasses.md
@@ -27,11 +27,13 @@ For information on Apple Wallet passes, see the [Apple Developer Documentation](
 ### Concrete Models
 
 - ``Pass``
+- ``PassesDevice``
 - ``PassesRegistration``
 
 ### Migrations
 
 - ``CreatePass``
+- ``CreatePassesDevice``
 - ``CreatePassesRegistration``
 
 ### Personalized Passes
diff --git a/Sources/FluentWalletPasses/Models/Concrete Models/PassesDevice.swift b/Sources/FluentWalletPasses/Models/Concrete Models/PassesDevice.swift
@@ -0,0 +1,51 @@
+import FluentKit
+
+/// The `Model` that stores Apple Wallet passes devices.
+final public class PassesDevice: DeviceModel, @unchecked Sendable {
+    /// The schema name of the device model.
+    public static let schema = PassesDevice.FieldKeys.schemaName
+
+    @ID(custom: .id)
+    public var id: Int?
+
+    /// The push token used for sending updates to the device.
+    @Field(key: PassesDevice.FieldKeys.pushToken)
+    public var pushToken: String
+
+    /// The identifier Apple Wallet provides for the device.
+    @Field(key: PassesDevice.FieldKeys.libraryIdentifier)
+    public var libraryIdentifier: String
+
+    public init(libraryIdentifier: String, pushToken: String) {
+        self.libraryIdentifier = libraryIdentifier
+        self.pushToken = pushToken
+    }
+
+    public init() {}
+}
+
+/// The migration that creates the ``PassesDevice`` table.
+public struct CreatePassesDevice: AsyncMigration {
+    public func prepare(on database: any Database) async throws {
+        try await database.schema(PassesDevice.FieldKeys.schemaName)
+            .field(.id, .int, .identifier(auto: true))
+            .field(PassesDevice.FieldKeys.pushToken, .string, .required)
+            .field(PassesDevice.FieldKeys.libraryIdentifier, .string, .required)
+            .unique(on: PassesDevice.FieldKeys.pushToken, PassesDevice.FieldKeys.libraryIdentifier)
+            .create()
+    }
+
+    public func revert(on database: any Database) async throws {
+        try await database.schema(PassesDevice.FieldKeys.schemaName).delete()
+    }
+
+    public init() {}
+}
+
+extension PassesDevice {
+    package enum FieldKeys {
+        package static let schemaName = "devices"
+        static let pushToken = FieldKey(stringLiteral: "push_token")
+        static let libraryIdentifier = FieldKey(stringLiteral: "library_identifier")
+    }
+}
diff --git a/Sources/FluentWalletPasses/Models/Concrete Models/PassesRegistration.swift b/Sources/FluentWalletPasses/Models/Concrete Models/PassesRegistration.swift
@@ -11,7 +11,7 @@ final public class PassesRegistration: PassesRegistrationModel, @unchecked Senda
 
     /// The device for this registration.
     @Parent(key: PassesRegistration.FieldKeys.deviceID)
-    public var device: Device
+    public var device: PassesDevice
 
     /// The pass for this registration.
     @Parent(key: PassesRegistration.FieldKeys.passID)
@@ -27,7 +27,7 @@ public struct CreatePassesRegistration: AsyncMigration {
             .field(.id, .int, .identifier(auto: true))
             .field(
                 PassesRegistration.FieldKeys.deviceID, .int, .required,
-                .references(Device.FieldKeys.schemaName, .id, onDelete: .cascade)
+                .references(PassesDevice.FieldKeys.schemaName, .id, onDelete: .cascade)
             )
             .field(
                 PassesRegistration.FieldKeys.passID, .uuid, .required,
diff --git a/Tests/FluentWalletOrdersTests/FluentWalletOrdersTests.swift b/Tests/FluentWalletOrdersTests/FluentWalletOrdersTests.swift
@@ -27,12 +27,31 @@ struct FluentWalletOrdersTests {
         try await migration.revert(on: test.db)
     }
 
+    @Test("OrdersDevice Concrete Model")
+    func ordersDevice() async throws {
+        let migration = CreateOrdersDevice()
+        try await migration.prepare(on: test.db)
+
+        let libraryIdentifier = "Test Library Identifier"
+        let pushToken = "Test Push Token"
+
+        test.append([
+            TestOutput(OrdersDevice(libraryIdentifier: libraryIdentifier, pushToken: pushToken))
+        ])
+
+        let fetchedDevice = try #require(await OrdersDevice.query(on: test.db).first())
+        #expect(fetchedDevice._$libraryIdentifier.value == libraryIdentifier)
+        #expect(fetchedDevice._$pushToken.value == pushToken)
+
+        try await migration.revert(on: test.db)
+    }
+
     @Test("OrdersRegistration Concrete Model")
     func ordersRegistration() async throws {
         let migration = CreateOrdersRegistration()
         try await migration.prepare(on: test.db)
 
-        let device = Device()
+        let device = OrdersDevice()
         device._$id.value = 1
 
         let order = Order()
@@ -59,7 +78,7 @@ struct FluentWalletOrdersTests {
 
         let libraryIdentifier = "Test Library Identifier"
         let pushToken = "Test Push Token"
-        let device = Device(libraryIdentifier: libraryIdentifier, pushToken: pushToken)
+        let device = OrdersDevice(libraryIdentifier: libraryIdentifier, pushToken: pushToken)
         device._$id.value = 1
 
         let typeIdentifier = "Test Type Identifier"
diff --git a/Tests/FluentWalletPassesTests/FluentWalletPassesTests.swift b/Tests/FluentWalletPassesTests/FluentWalletPassesTests.swift
@@ -28,12 +28,31 @@ struct FluentWalletPassesTests {
         try await migration.revert(on: test.db)
     }
 
+    @Test("PassesDevice Concrete Model")
+    func passesDevice() async throws {
+        let migration = CreatePassesDevice()
+        try await migration.prepare(on: test.db)
+
+        let libraryIdentifier = "Test Library Identifier"
+        let pushToken = "Test Push Token"
+
+        test.append([
+            TestOutput(PassesDevice(libraryIdentifier: libraryIdentifier, pushToken: pushToken))
+        ])
+
+        let fetchedDevice = try #require(await PassesDevice.query(on: test.db).first())
+        #expect(fetchedDevice._$libraryIdentifier.value == libraryIdentifier)
+        #expect(fetchedDevice._$pushToken.value == pushToken)
+
+        try await migration.revert(on: test.db)
+    }
+
     @Test("PassesRegistration Concrete Model")
     func passesRegistration() async throws {
         let migration = CreatePassesRegistration()
         try await migration.prepare(on: test.db)
 
-        let device = Device()
+        let device = PassesDevice()
         device._$id.value = 1
 
         let pass = Pass()
@@ -105,7 +124,7 @@ struct FluentWalletPassesTests {
 
         let libraryIdentifier = "Test Library Identifier"
         let pushToken = "Test Push Token"
-        let device = Device(libraryIdentifier: libraryIdentifier, pushToken: pushToken)
+        let device = PassesDevice(libraryIdentifier: libraryIdentifier, pushToken: pushToken)
         device._$id.value = 1
 
         let typeIdentifier = "Test Type Identifier"
diff --git a/Tests/FluentWalletTests/FluentWalletTests.swift b/Tests/FluentWalletTests/FluentWalletTests.swift
