Set product details label for variations explicitly

Author: rachelmcr

WooCommerce/Classes/ViewRelated/Orders/Order Creation/NewOrderViewModel.swift

@@ -183,12 +183,13 @@ final class NewOrderViewModel: ObservableObject {
         }
 
         if item.variationID != 0, let variation = allProductVariations.first(where: { $0.productVariationID == item.variationID }) {
+            let attributes = ProductVariationFormatter().generateAttributes(for: variation, from: product.attributes)
             return ProductRowViewModel(id: item.id,
                                        productVariation: variation,
                                        name: product.name,
                                        quantity: item.quantity,
                                        canChangeQuantity: canChangeQuantity,
-                                       attributes: ProductVariationFormatter().generateAttributes(for: variation, from: product.attributes))
+                                       displayMode: .attributes(attributes))
         } else {
             return ProductRowViewModel(id: item.id, product: product, quantity: item.quantity, canChangeQuantity: canChangeQuantity)
         }

WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/AddProductVariationToOrderViewModel.swift

@@ -45,7 +45,10 @@ final class AddProductVariationToOrderViewModel: ObservableObject {
     ///
     var productVariationRows: [ProductRowViewModel] {
         return productVariations.map {
-            .init(productVariation: $0, name: ProductVariationFormatter().generateName(for: $0, from: productAttributes), canChangeQuantity: false)
+            .init(productVariation: $0,
+                  name: ProductVariationFormatter().generateName(for: $0, from: productAttributes),
+                  canChangeQuantity: false,
+                  displayMode: .stock)
         }
     }
 

WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/ProductRowViewModel.swift

@@ -49,15 +49,15 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
     ///
     private let manageStock: Bool
 
-    /// Product variation attributes
+    /// Display mode for a product variation.
+    /// Determines which details to display in the product details label.
     ///
-    private let variationAttributes: [VariationAttributeViewModel]?
+    private let variationDisplayMode: VariationDisplayMode?
 
     /// Label showing product details. Can include stock status or attributes, price, and variations (if any).
     ///
     var productDetailsLabel: String {
-        // When provided, the variation attributes should replace the stock status
-        let stockOrAttributesLabel = variationAttributes != nil ? createAttributesText() : createStockText()
+        let stockOrAttributesLabel = createStockOrAttributesText()
         let priceLabel = createPriceText()
         let variationsLabel = createVariationsText()
 
@@ -105,7 +105,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
          canChangeQuantity: Bool,
          imageURL: URL?,
          numberOfVariations: Int = 0,
-         variationAttributes: [VariationAttributeViewModel]? = nil,
+         variationDisplayMode: VariationDisplayMode? = nil,
          currencyFormatter: CurrencyFormatter = CurrencyFormatter(currencySettings: ServiceLocator.currencySettings)) {
         self.id = id ?? productOrVariationID.description
         self.productOrVariationID = productOrVariationID
@@ -120,7 +120,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
         self.imageURL = imageURL
         self.currencyFormatter = currencyFormatter
         self.numberOfVariations = numberOfVariations
-        self.variationAttributes = variationAttributes
+        self.variationDisplayMode = variationDisplayMode
     }
 
     /// Initialize `ProductRowViewModel` with a `Product`
@@ -160,7 +160,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
                      name: String,
                      quantity: Decimal = 1,
                      canChangeQuantity: Bool,
-                     attributes: [VariationAttributeViewModel]? = nil,
+                     displayMode: VariationDisplayMode,
                      currencyFormatter: CurrencyFormatter = CurrencyFormatter(currencySettings: ServiceLocator.currencySettings)) {
         let imageURL: URL?
         if let encodedImageURLString = productVariation.image?.src.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed) {
@@ -180,10 +180,32 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
                   quantity: quantity,
                   canChangeQuantity: canChangeQuantity,
                   imageURL: imageURL,
-                  variationAttributes: attributes,
+                  variationDisplayMode: displayMode,
                   currencyFormatter: currencyFormatter)
     }
 
+    /// Determines which product variation details to display.
+    ///
+    enum VariationDisplayMode {
+        /// Displays the variation's stock status
+        case stock
+
+        /// Displays the provided list of variation attributes
+        case attributes([VariationAttributeViewModel])
+    }
+
+    /// Creates the stock or variation attributes text.
+    /// Returns stock text for non-variations; uses variation display mode to determine the text for variations.
+    ///
+    private func createStockOrAttributesText() -> String {
+        switch variationDisplayMode {
+        case .attributes(let attributes):
+            return createAttributesText(from: attributes)
+        default:
+            return createStockText()
+        }
+    }
+
     /// Create the stock text based on a product's stock status/quantity.
     ///
     private func createStockText() -> String {
@@ -202,10 +224,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
 
     /// Create the attributes text based on the provided product variation attributes.
     ///
-    private func createAttributesText() -> String? {
-        guard let attributes = variationAttributes else {
-            return nil
-        }
+    private func createAttributesText(from attributes: [VariationAttributeViewModel]) -> String {
         return attributes.map { $0.nameOrValue }.joined(separator: ", ")
     }
 

WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/NewOrderViewModelTests.swift

@@ -258,7 +258,11 @@ class NewOrderViewModelTests: XCTestCase {
         let productRow = viewModel.createProductRowViewModel(for: newOrderItem, canChangeQuantity: false)
 
         // Then
-        let expectedProductRow = ProductRowViewModel(productVariation: productVariation, name: product.name, quantity: 2, canChangeQuantity: false)
+        let expectedProductRow = ProductRowViewModel(productVariation: productVariation,
+                                                     name: product.name,
+                                                     quantity: 2,
+                                                     canChangeQuantity: false,
+                                                     displayMode: .stock)
         XCTAssertEqual(productRow?.name, expectedProductRow.name)
         XCTAssertEqual(productRow?.skuLabel, expectedProductRow.skuLabel)
         XCTAssertEqual(productRow?.quantity, expectedProductRow.quantity)

WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/ProductRowViewModelTests.swift

@@ -46,7 +46,7 @@ class ProductRowViewModelTests: XCTestCase {
                                                             image: ProductImage.fake().copy(src: imageURLString))
 
         // When
-        let viewModel = ProductRowViewModel(id: rowID, productVariation: productVariation, name: name, canChangeQuantity: false)
+        let viewModel = ProductRowViewModel(id: rowID, productVariation: productVariation, name: name, canChangeQuantity: false, displayMode: .stock)
 
         // Then
         XCTAssertEqual(viewModel.id, rowID)
@@ -156,13 +156,13 @@ class ProductRowViewModelTests: XCTestCase {
         XCTAssertEqual(viewModel.productDetailsLabel, expectedProductDetailsLabel)
     }
 
-    func test_view_model_creates_expected_label_for_variation_with_provided_attributes() {
+    func test_view_model_creates_expected_label_for_variation_with_attributes_display_mode() {
         // Given
         let variation = ProductVariation.fake().copy(attributes: [ProductVariationAttribute(id: 1, name: "Color", option: "Blue")], stockStatus: .inStock)
         let attributes = [VariationAttributeViewModel(name: "Color", value: "Blue"), VariationAttributeViewModel(name: "Size")]
 
         // When
-        let viewModel = ProductRowViewModel(productVariation: variation, name: "", canChangeQuantity: false, attributes: attributes)
+        let viewModel = ProductRowViewModel(productVariation: variation, name: "", canChangeQuantity: false, displayMode: .attributes(attributes))
 
         // Then
         let expectedAttributesText = "Blue, Any Size"
@@ -172,12 +172,12 @@ class ProductRowViewModelTests: XCTestCase {
         XCTAssertFalse(viewModel.productDetailsLabel.contains(unexpectedStockText))
     }
 
-    func test_view_model_creates_expected_label_for_variation_without_provided_attributes() {
+    func test_view_model_creates_expected_label_for_variation_with_stock_display_mode() {
         // Given
         let variation = ProductVariation.fake().copy(attributes: [ProductVariationAttribute(id: 1, name: "Color", option: "Blue")], stockStatus: .inStock)
 
         // When
-        let viewModel = ProductRowViewModel(productVariation: variation, name: "", canChangeQuantity: false)
+        let viewModel = ProductRowViewModel(productVariation: variation, name: "", canChangeQuantity: false, displayMode: .stock)
 
         // Then
         let expectedStockText = "In stock"