instructions attribute on Storage.PaymentGateway

Author: joshheald

Storage/Storage.xcodeproj/project.pbxproj

@@ -272,6 +272,7 @@
 		0345DB4527A8122700B02D0C /* Model 63.xcdatamodel */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcdatamodel; path = "Model 63.xcdatamodel"; sourceTree = "<group>"; };
 		0371C37D28781D1F00277E2C /* FeatureAnnouncementCampaign.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FeatureAnnouncementCampaign.swift; sourceTree = "<group>"; };
 		0371C37E28781D1F00277E2C /* FeatureAnnouncementCampaignSettings.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FeatureAnnouncementCampaignSettings.swift; sourceTree = "<group>"; };
+		0372D8B828AFD9530041028A /* Model 72.xcdatamodel */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcdatamodel; path = "Model 72.xcdatamodel"; sourceTree = "<group>"; };
 		077F39C3269F1F4600ABEADC /* SystemPlugin+CoreDataClass.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SystemPlugin+CoreDataClass.swift"; sourceTree = "<group>"; };
 		077F39C5269F1F7C00ABEADC /* SystemPlugin+CoreDataProperties.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SystemPlugin+CoreDataProperties.swift"; sourceTree = "<group>"; };
 		2618707125409C65006522A1 /* ShippingLineTax+CoreDataClass.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "ShippingLineTax+CoreDataClass.swift"; sourceTree = "<group>"; };
@@ -1788,6 +1789,7 @@
 		DEC51AA4275B41BE009F3DF4 /* WooCommerce.xcdatamodeld */ = {
 			isa = XCVersionGroup;
 			children = (
+				0372D8B828AFD9530041028A /* Model 72.xcdatamodel */,
 				CC6A05402877012B002C144E /* Model 71.xcdatamodel */,
 				B963A5CA2853859400EFADA0 /* Model 70.xcdatamodel */,
 				268FEC8528513A470005E4C2 /* Model 69.xcdatamodel */,
@@ -1860,7 +1862,7 @@
 				DEC51ADE275B41BE009F3DF4 /* Model 47.xcdatamodel */,
 				DEC51ADF275B41BE009F3DF4 /* Model 19.xcdatamodel */,
 			);
-			currentVersion = CC6A05402877012B002C144E /* Model 71.xcdatamodel */;
+			currentVersion = 0372D8B828AFD9530041028A /* Model 72.xcdatamodel */;
 			path = WooCommerce.xcdatamodeld;
 			sourceTree = "<group>";
 			versionGroupType = wrapper.xcdatamodel;

Storage/Storage/Model/MIGRATIONS.md

@@ -2,6 +2,10 @@
 
 This file documents changes in the WCiOS Storage data model. Please explain any changes to the data model as well as any custom migrations.
 
+## Model 71 (Release 9.6.0.0)
+- @joshheald 2022-08-19
+    - Added `instructions` attribute to `PaymentGateway` entity.
+
 ## Model 71 (Release 9.6.0.0)
 - @rachelmcr 2022-07-07
     - Added `OrderMetaData` entity.

Storage/Storage/Model/PaymentGateway+CoreDataProperties.swift

@@ -13,5 +13,10 @@ extension PaymentGateway {
     @NSManaged public var gatewayDescription: String
     @NSManaged public var features: [String]
     @NSManaged public var enabled: Bool
+    @NSManaged public var instructions: String?
+
+}
+
+extension PaymentGateway: Identifiable {
 
 }

Storage/Storage/Model/WooCommerce.xcdatamodeld/.xccurrentversion

@@ -3,6 +3,6 @@
 <plist version="1.0">
 <dict>
 	<key>_XCCurrentVersionName</key>
-	<string>Model 71.xcdatamodel</string>
+	<string>Model 72.xcdatamodel</string>
 </dict>
 </plist>

Storage/Storage/Model/WooCommerce.xcdatamodeld/Model 72.xcdatamodel/contents

@@ -1242,6 +1242,36 @@ final class MigrationTests: XCTestCase {
         // The OrderMetaData.order inverse relationship should be updated.
         XCTAssertEqual(customField.value(forKey: "order") as? NSManagedObject, migratedOrder)
     }
+
+    func test_migrating_from_71_to_72_adds_instructions_attribute_to_PaymentGateway() throws {
+        // Given
+        let sourceContainer = try startPersistentContainer("Model 71")
+        let sourceContext = sourceContainer.viewContext
+
+        let paymentGateway = insertPaymentGateway(to: sourceContext)
+        try sourceContext.save()
+
+        // `instructions` should not be present before migration
+        XCTAssertNil(paymentGateway.entity.relationshipsByName["instructions"])
+
+        // When
+        let targetContainer = try migrate(sourceContainer, to: "Model 72")
+        let targetContext = targetContainer.viewContext
+
+        // Confidence check
+        XCTAssertEqual(try targetContext.count(entityName: "PaymentGateway"), 1)
+
+        let migratedPaymentGateway = try XCTUnwrap(targetContext.first(entityName: "PaymentGateway"))
+
+        // The instructions should be nil after migration: it's an optional field.
+        XCTAssertNil(migratedPaymentGateway.value(forKey: "instructions"))
+
+        // Set a test instructions
+        migratedPaymentGateway.setValue("payment gateway instructions", forKey: "instructions")
+
+        // Check instructions are correctly set.
+        assertEqual("payment gateway instructions", migratedPaymentGateway.value(forKey: "instructions") as? String)
+    }
 }
 
 // MARK: - Persistent Store Setup and Migrations
@@ -1635,6 +1665,18 @@ private extension MigrationTests {
         ])
     }
 
+    @discardableResult
+    func insertPaymentGateway(to context: NSManagedObjectContext) -> NSManagedObject {
+        context.insert(entityName: "PaymentGateway", properties: [
+            "siteID": 1372,
+            "gatewayID": "woocommerce-payments",
+            "title": "WooCommerce Payments",
+            "gatewayDescription": "WooCommerce Payments - easy payments by Woo",
+            "enabled": true,
+            "features": []
+        ])
+    }
+
     @discardableResult
     func insertPaymentGatewayAccount(to context: NSManagedObjectContext) -> NSManagedObject {
         context.insert(entityName: "PaymentGatewayAccount", properties: [

Storage/StorageTests/CoreData/MigrationTests.swift

@@ -14,6 +14,7 @@ extension Storage.PaymentGateway: ReadOnlyConvertible {
         gatewayDescription = paymentGateway.description
         enabled = paymentGateway.enabled
         features = paymentGateway.features.map { $0.rawValue }
+        instructions = paymentGateway.instructions
     }
 
     /// Returns a ReadOnly version of the receiver.
@@ -25,6 +26,6 @@ extension Storage.PaymentGateway: ReadOnlyConvertible {
                        description: gatewayDescription,
                        enabled: enabled,
                        features: features.compactMap { PaymentGateway.Feature(rawValue: $0) },
-        instructions: "")
+                       instructions: instructions)
     }
 }