[Woo POS][Local Catalog] Basic mapping from POS models to Persisted models

Modules/Sources/Storage/GRDB/Model/PersistedProduct.swift

@@ -1,6 +1,7 @@
 import Foundation
 import GRDB
 
+// periphery:ignore - TODO: remove ignore when populating database
 public struct PersistedProduct: Codable {
     public let id: Int64
     public let siteID: Int64
@@ -48,6 +49,7 @@ public struct PersistedProduct: Codable {
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 extension PersistedProduct: FetchableRecord, PersistableRecord {
     public static var databaseTableName: String { "product" }
 
@@ -67,8 +69,12 @@ extension PersistedProduct: FetchableRecord, PersistableRecord {
         static let stockQuantity = Column(CodingKeys.stockQuantity)
         static let stockStatusKey = Column(CodingKeys.stockStatusKey)
     }
+
+    public static let images = hasMany(PersistedProductImage.self)
+    public static let attributes = hasMany(PersistedProductAttribute.self)
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedProduct {
     enum CodingKeys: String, CodingKey {
         case id

Modules/Sources/Storage/GRDB/Model/PersistedProductAttribute.swift

@@ -1,6 +1,7 @@
 import Foundation
 import GRDB
 
+// periphery:ignore - TODO: remove ignore when populating database
 public struct PersistedProductAttribute: Codable {
     public private(set) var id: Int64?
     public let productID: Int64
@@ -27,6 +28,7 @@ public struct PersistedProductAttribute: Codable {
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 extension PersistedProductAttribute: FetchableRecord, MutablePersistableRecord {
     public static var databaseTableName: String { "productAttribute" }
 
@@ -46,6 +48,7 @@ extension PersistedProductAttribute: FetchableRecord, MutablePersistableRecord {
 }
 
 
+// periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedProductAttribute {
     enum CodingKeys: String, CodingKey {
         case id

Modules/Sources/Storage/GRDB/Model/PersistedProductImage.swift

@@ -1,6 +1,7 @@
 import Foundation
 import GRDB
 
+// periphery:ignore - TODO: remove ignore when populating database
 public struct PersistedProductImage: Codable {
     public let id: Int64
     public let productID: Int64
@@ -27,6 +28,7 @@ public struct PersistedProductImage: Codable {
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 extension PersistedProductImage: FetchableRecord, PersistableRecord {
     public static var databaseTableName: String { "productImage" }
 
@@ -42,6 +44,7 @@ extension PersistedProductImage: FetchableRecord, PersistableRecord {
 }
 
 
+// periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedProductImage {
     enum CodingKeys: String, CodingKey {
         case id

Modules/Sources/Storage/GRDB/Model/PersistedProductVariation.swift

@@ -1,6 +1,7 @@
 import Foundation
 import GRDB
 
+// periphery:ignore - TODO: remove ignore when populating database
 public struct PersistedProductVariation: Codable {
     public let id: Int64
     public let siteID: Int64
@@ -39,6 +40,7 @@ public struct PersistedProductVariation: Codable {
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 extension PersistedProductVariation: FetchableRecord, PersistableRecord {
     public static var databaseTableName: String { "productVariation" }
 
@@ -55,9 +57,13 @@ extension PersistedProductVariation: FetchableRecord, PersistableRecord {
         static let stockQuantity = Column(CodingKeys.stockQuantity)
         static let stockStatusKey = Column(CodingKeys.stockStatusKey)
     }
+
+    public static let attributes = hasMany(PersistedProductVariationAttribute.self).forKey("attributes")
+    public static let image = hasOne(PersistedProductVariationImage.self).forKey("image")
 }
 
 
+// periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedProductVariation {
     enum CodingKeys: String, CodingKey {
         case id

Modules/Sources/Storage/GRDB/Model/PersistedProductVariationAttribute.swift

@@ -1,6 +1,7 @@
 import Foundation
 import GRDB
 
+// periphery:ignore - TODO: remove ignore when populating database
 public struct PersistedProductVariationAttribute: Codable {
     public private(set) var id: Int64?
     public let productVariationID: Int64
@@ -18,6 +19,8 @@ public struct PersistedProductVariationAttribute: Codable {
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
+// periphery:ignore - TODO: remove ignore when populating database
 extension PersistedProductVariationAttribute: FetchableRecord, MutablePersistableRecord {
     public static var databaseTableName: String { "productVariationAttribute" }
 
@@ -34,6 +37,7 @@ extension PersistedProductVariationAttribute: FetchableRecord, MutablePersistabl
 }
 
 
+// periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedProductVariationAttribute {
     enum CodingKeys: String, CodingKey {
         case id

Modules/Sources/Storage/GRDB/Model/PersistedProductVariationImage.swift

@@ -1,6 +1,7 @@
 import Foundation
 import GRDB
 
+// periphery:ignore - TODO: remove ignore when populating database
 public struct PersistedProductVariationImage: Codable {
     public let id: Int64
     public let productVariationID: Int64
@@ -27,6 +28,7 @@ public struct PersistedProductVariationImage: Codable {
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 extension PersistedProductVariationImage: FetchableRecord, PersistableRecord {
     public static var databaseTableName: String { "productVariationImage" }
 
@@ -42,6 +44,7 @@ extension PersistedProductVariationImage: FetchableRecord, PersistableRecord {
 }
 
 
+// periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedProductVariationImage {
     enum CodingKeys: String, CodingKey {
         case id

Modules/Sources/Storage/GRDB/Model/PersistedSite.swift

@@ -1,22 +1,28 @@
 import Foundation
 import GRDB
 
+// periphery:ignore - TODO: remove ignore when populating database
 public struct PersistedSite: Codable {
+    // periphery:ignore - TODO: remove ignore when populating database
     public let id: Int64
 
+    // periphery:ignore - TODO: remove ignore when populating database
     public init(id: Int64) {
         self.id = id
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 extension PersistedSite: FetchableRecord, PersistableRecord {
     public static var databaseTableName: String { "site" }
 
     public enum Columns {
+        // periphery:ignore - TODO: remove ignore when populating database
         static let id = Column(CodingKeys.id)
     }
 }
 
+// periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedSite {
     enum CodingKeys: String, CodingKey {
         case id

Modules/Sources/Storage/Protocols/Object.swift

@@ -11,6 +11,7 @@ public protocol Object: AnyObject {
 
     /// Returns an instance of ObjectID: expected to identify the current instance, unequivocally.
     ///
+    // periphery:ignore - Used in tests, no changes but mysteriously stopped being ignored.
     var objectID: ObjectID { get }
 
     /// Returns the receiver's Entity Name.

Modules/Sources/Yosemite/Model/Model.swift

@@ -350,12 +350,19 @@ public typealias StorageWooShippingShipment = Storage.WooShippingShipment
 public typealias StorageWooShippingOriginAddress = Storage.WooShippingOriginAddress
 
 // MARK: - GRDB Persisted Models
+// periphery:ignore - TODO: remove ignore when populating database
 public typealias PersistedSite = Storage.PersistedSite
+// periphery:ignore - TODO: remove ignore when populating database
 public typealias PersistedProduct = Storage.PersistedProduct
+// periphery:ignore - TODO: remove ignore when populating database
 public typealias PersistedProductAttribute = Storage.PersistedProductAttribute
+// periphery:ignore - TODO: remove ignore when populating database
 public typealias PersistedProductImage = Storage.PersistedProductImage
+// periphery:ignore - TODO: remove ignore when populating database
 public typealias PersistedProductVariation = Storage.PersistedProductVariation
+// periphery:ignore - TODO: remove ignore when populating database
 public typealias PersistedProductVariationAttribute = Storage.PersistedProductVariationAttribute
+// periphery:ignore - TODO: remove ignore when populating database
 public typealias PersistedProductVariationImage = Storage.PersistedProductVariationImage
 
 // MARK: - Internal ReadOnly Models

Modules/Sources/Yosemite/Model/Storage/PersistedProduct+Conversions.swift

@@ -0,0 +1,137 @@
+import Foundation
+import Storage
+
+// MARK: - PersistedProduct Conversions
+// periphery:ignore - TODO: remove ignore when populating database
+extension PersistedProduct {
+    init(from posProduct: POSProduct) {
+        self.init(
+            id: posProduct.productID,
+            siteID: posProduct.siteID,
+            name: posProduct.name,
+            productTypeKey: posProduct.productTypeKey,
+            fullDescription: posProduct.fullDescription,
+            shortDescription: posProduct.shortDescription,
+            sku: posProduct.sku,
+            globalUniqueID: posProduct.globalUniqueID,
+            price: posProduct.price,
+            downloadable: posProduct.downloadable,
+            parentID: posProduct.parentID,
+            manageStock: posProduct.manageStock,
+            stockQuantity: posProduct.stockQuantity,
+            stockStatusKey: posProduct.stockStatusKey
+        )
+    }
+
+    func toPOSProduct(images: [ProductImage] = [], attributes: [ProductAttribute] = []) -> POSProduct {
+        return POSProduct(
+            siteID: siteID,
+            productID: id,
+            name: name,
+            productTypeKey: productTypeKey,
+            fullDescription: fullDescription,
+            shortDescription: shortDescription,
+            sku: sku,
+            globalUniqueID: globalUniqueID,
+            price: price,
+            downloadable: downloadable,
+            parentID: parentID,
+            images: images,
+            attributes: attributes,
+            manageStock: manageStock,
+            stockQuantity: stockQuantity,
+            stockStatusKey: stockStatusKey
+        )
+    }
+
+    func toPOSProduct(db: GRDBDatabaseConnection) throws -> POSProduct {
+        let (images, attributes) = try db.read { db in
+            let images = try request(for: PersistedProduct.images).fetchAll(db)
+            let attributes = try request(for: PersistedProduct.attributes).fetchAll(db)
+            return (images, attributes)
+        }
+
+        return toPOSProduct(
+            images: images.map { $0.toProductImage() },
+            attributes: attributes.map { $0.toProductAttribute(siteID: siteID) }
+        )
+    }
+
+}
+
+// MARK: - POSProduct Storage Extensions
+// periphery:ignore - TODO: remove ignore when populating database
+extension POSProduct {
+    public func save(to db: GRDBDatabaseConnection) throws {
+        try db.write { db in
+            let product = PersistedProduct(from: self)
+            try product.insert(db)
+
+            // Save related images
+            for image in self.images {
+                let persistedImage = PersistedProductImage(from: image, productID: self.productID)
+                try persistedImage.insert(db)
+            }
+
+            // Save related attributes
+            for attribute in self.attributes {
+                var persistedAttribute = PersistedProductAttribute(from: attribute, productID: self.productID)
+                try persistedAttribute.insert(db)
+            }
+        }
+    }
+}
+
+// MARK: - PersistedProductAttribute Conversions
+// periphery:ignore - TODO: remove ignore when populating database
+extension PersistedProductAttribute {
+    init(from productAttribute: ProductAttribute, productID: Int64) {
+        self.init(
+            productID: productID,
+            name: productAttribute.name,
+            position: Int64(productAttribute.position),
+            visible: productAttribute.visible,
+            variation: productAttribute.variation,
+            options: productAttribute.options
+        )
+    }
+
+    func toProductAttribute(siteID: Int64) -> ProductAttribute {
+        return ProductAttribute(
+            siteID: siteID,
+            attributeID: id ?? 0,
+            name: name,
+            position: Int(position),
+            visible: visible,
+            variation: variation,
+            options: options
+        )
+    }
+}
+
+// MARK: - PersistedProductImage Conversions
+// periphery:ignore - TODO: remove ignore when populating database
+extension PersistedProductImage {
+    init(from productImage: ProductImage, productID: Int64) {
+        self.init(
+            id: productImage.imageID,
+            productID: productID,
+            dateCreated: productImage.dateCreated,
+            dateModified: productImage.dateModified,
+            src: productImage.src,
+            name: productImage.name,
+            alt: productImage.alt
+        )
+    }
+
+    func toProductImage() -> ProductImage {
+        return ProductImage(
+            imageID: id,
+            dateCreated: dateCreated,
+            dateModified: dateModified,
+            src: src,
+            name: name,
+            alt: alt
+        )
+    }
+}