Merge pull request #5895 from woocommerce/issue/5846-variable-products

rachelmcr · web-flow · commit 645dbbf9c4b0 · 2022-01-24T12:56:26.000Z
Order Creation: Include variable products in product list on Add Product screen
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/AddProductToOrder.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/AddProductToOrder.swift
@@ -19,11 +19,7 @@ struct AddProductToOrder: View {
                     InfiniteScrollList(isLoading: viewModel.shouldShowScrollIndicator,
                                        loadAction: viewModel.syncNextPage) {
                         ForEach(viewModel.productRows) { rowViewModel in
-                            ProductRow(viewModel: rowViewModel)
-                                .onTapGesture {
-                                    viewModel.selectProduct(rowViewModel.productOrVariationID)
-                                    isPresented.toggle()
-                                }
+                            createProductRow(rowViewModel: rowViewModel)
                         }
                     }
                 case .empty:
@@ -57,6 +53,23 @@ struct AddProductToOrder: View {
         }
         .wooNavigationBarStyle()
     }
+
+    /// Creates the `ProductRow` for a product, depending on whether the product is variable.
+    ///
+    @ViewBuilder private func createProductRow(rowViewModel: ProductRowViewModel) -> some View {
+        if rowViewModel.numberOfVariations > 0,
+           let addVariationToOrderVM = viewModel.getVariationsViewModel(for: rowViewModel.productOrVariationID) {
+            LazyNavigationLink(destination: AddProductVariationToOrder(isPresented: $isPresented, viewModel: addVariationToOrderVM)) {
+                ProductRow(viewModel: rowViewModel)
+            }
+        } else {
+            ProductRow(viewModel: rowViewModel)
+                .onTapGesture {
+                    viewModel.selectProduct(rowViewModel.productOrVariationID)
+                    isPresented.toggle()
+                }
+        }
+    }
 }
 
 private extension AddProductToOrder {
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/AddProductToOrderViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/AddProductToOrderViewModel.swift
@@ -14,24 +14,10 @@ final class AddProductToOrderViewModel: ObservableObject {
     ///
     private let stores: StoresManager
 
-    /// Product types excluded from the product list.
-    /// For now, only non-variable product types are supported.
-    ///
-    private let excludedProductTypes: [ProductType] = [ProductType.variable]
-
-    /// Product statuses included in the product list.
-    /// Only published or private products can be added to an order.
-    ///
-    private let includedProductStatuses: [ProductStatus] = [ProductStatus.publish, ProductStatus.privateStatus]
-
     /// All products that can be added to an order.
     ///
     private var products: [Product] {
-        return productsResultsController.fetchedObjects.filter {
-            let hasValidProductType = !excludedProductTypes.contains( $0.productType )
-            let hasValidProductStatus = includedProductStatuses.contains( $0.productStatus )
-            return hasValidProductType && hasValidProductStatus
-        }
+        productsResultsController.fetchedObjects.filter { $0.purchasable }
     }
 
     /// View models for each product row
@@ -96,6 +82,15 @@ final class AddProductToOrderViewModel: ObservableObject {
         }
         onProductSelected?(selectedProduct)
     }
+
+    /// Get the view model for a list of product variations to add to the order
+    ///
+    func getVariationsViewModel(for productID: Int64) -> AddProductVariationToOrderViewModel? {
+        guard let variableProduct = products.first(where: { $0.productID == productID }) else {
+            return nil
+        }
+        return AddProductVariationToOrderViewModel(siteID: siteID, product: variableProduct)
+    }
 }
 
 // MARK: - SyncingCoordinatorDelegate & Sync Methods
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/AddProductVariationToOrder.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/AddProductVariationToOrder.swift
@@ -3,6 +3,8 @@ import SwiftUI
 /// View showing a list of product variations to add to an order.
 ///
 struct AddProductVariationToOrder: View {
+    @Environment(\.presentationMode) private var presentation
+
     /// Defines whether the view is presented.
     ///
     @Binding var isPresented: Bool
@@ -43,6 +45,17 @@ struct AddProductVariationToOrder: View {
         .ignoresSafeArea(.container, edges: .horizontal)
         .navigationTitle(viewModel.productName)
         .navigationBarTitleDisplayMode(.inline)
+        .navigationBarBackButtonHidden(true)
+        .toolbar {
+            // Minimal back button
+            ToolbarItem(placement: .navigationBarLeading) {
+                Button {
+                    presentation.wrappedValue.dismiss()
+                } label: {
+                    Image(uiImage: .chevronLeftImage.imageFlippedForRightToLeftLayoutDirection())
+                }
+            }
+        }
         .onAppear {
             viewModel.syncFirstPage()
         }
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/ProductRow.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/ProductRow.swift
@@ -30,7 +30,7 @@ struct ProductRow: View {
                     // Product details
                     VStack(alignment: .leading) {
                         Text(viewModel.name)
-                        Text(viewModel.stockAndPriceLabel)
+                        Text(viewModel.productDetailsLabel)
                             .subheadlineStyle()
                         Text(viewModel.skuLabel)
                             .subheadlineStyle()
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/ProductRowViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/ProductRowViewModel.swift
@@ -35,7 +35,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
 
     /// Product price
     ///
-    private let price: String
+    private let price: String?
 
     /// Product stock status
     ///
@@ -49,13 +49,14 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
     ///
     private let manageStock: Bool
 
-    /// Label showing product stock status and price.
+    /// Label showing product details: stock status, price, and variations (if any).
     ///
-    lazy var stockAndPriceLabel: String = {
+    lazy var productDetailsLabel: String = {
         let stockLabel = createStockText()
         let priceLabel = createPriceText()
+        let variationsLabel = createVariationsText()
 
-        return [stockLabel, priceLabel]
+        return [stockLabel, priceLabel, variationsLabel]
             .compactMap({ $0 })
             .joined(separator: " • ")
     }()
@@ -83,17 +84,22 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
         quantity <= minimumQuantity
     }
 
+    /// Number of variations in a variable product
+    ///
+    let numberOfVariations: Int
+
     init(id: String? = nil,
          productOrVariationID: Int64,
          name: String,
          sku: String?,
-         price: String,
+         price: String?,
          stockStatusKey: String,
          stockQuantity: Decimal?,
          manageStock: Bool,
          quantity: Decimal = 1,
          canChangeQuantity: Bool,
          imageURL: URL?,
+         numberOfVariations: Int = 0,
          currencyFormatter: CurrencyFormatter = CurrencyFormatter(currencySettings: ServiceLocator.currencySettings)) {
         self.id = id ?? productOrVariationID.description
         self.productOrVariationID = productOrVariationID
@@ -107,6 +113,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
         self.canChangeQuantity = canChangeQuantity
         self.imageURL = imageURL
         self.currencyFormatter = currencyFormatter
+        self.numberOfVariations = numberOfVariations
     }
 
     /// Initialize `ProductRowViewModel` with a `Product`
@@ -116,17 +123,26 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
                      quantity: Decimal = 1,
                      canChangeQuantity: Bool,
                      currencyFormatter: CurrencyFormatter = CurrencyFormatter(currencySettings: ServiceLocator.currencySettings)) {
+        // Don't show any price for variable products; price will be shown for each product variation.
+        let price: String?
+        if product.productType == .variable {
+            price = nil
+        } else {
+            price = product.price
+        }
+
         self.init(id: id,
                   productOrVariationID: product.productID,
                   name: product.name,
                   sku: product.sku,
-                  price: product.price,
+                  price: price,
                   stockStatusKey: product.stockStatusKey,
                   stockQuantity: product.stockQuantity,
                   manageStock: product.manageStock,
                   quantity: quantity,
                   canChangeQuantity: canChangeQuantity,
                   imageURL: product.imageURL,
+                  numberOfVariations: product.variations.count,
                   currencyFormatter: currencyFormatter)
     }
 
@@ -186,10 +202,23 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
     /// Create the price text based on a product's price.
     ///
     private func createPriceText() -> String? {
+        guard let price = price else {
+            return nil
+        }
         let unformattedPrice = price.isNotEmpty ? price : "0"
         return currencyFormatter.formatAmount(unformattedPrice)
     }
 
+    /// Create the variations text for a variable product.
+    ///
+    private func createVariationsText() -> String? {
+        guard numberOfVariations > 0 else {
+            return nil
+        }
+        let format = String.pluralize(numberOfVariations, singular: Localization.singleVariation, plural: Localization.pluralVariations)
+        return String.localizedStringWithFormat(format, numberOfVariations)
+    }
+
     /// Increment the product quantity.
     ///
     func incrementQuantity() {
@@ -210,5 +239,9 @@ private extension ProductRowViewModel {
     enum Localization {
         static let stockFormat = NSLocalizedString("%1$@ in stock", comment: "Label about product's inventory stock status shown during order creation")
         static let skuFormat = NSLocalizedString("SKU: %1$@", comment: "SKU label in order details > product row. The variable shows the SKU of the product.")
+        static let singleVariation = NSLocalizedString("%ld variation",
+                                                       comment: "Label for one product variation when showing details about a variable product")
+        static let pluralVariations = NSLocalizedString("%ld variations",
+                                                        comment: "Label for multiple product variations when showing details about a variable product")
     }
 }
diff --git a/WooCommerce/Classes/ViewRelated/ReusableViews/SwiftUI Components/LazyNavigationLink.swift b/WooCommerce/Classes/ViewRelated/ReusableViews/SwiftUI Components/LazyNavigationLink.swift
@@ -10,7 +10,7 @@ struct LazyNavigationLink<Destination: View, Label: View>: View {
 
     /// Set it to `true` to proceed with the desired navigation. Set it to `false` to remove the view from the navigation context.
     ///
-    @Binding var isActive: Bool
+    var isActive: Binding<Bool>?
 
     /// `NavigationLink` label
     ///
@@ -19,15 +19,19 @@ struct LazyNavigationLink<Destination: View, Label: View>: View {
     /// Creates a navigation link that creates and presents the destination view when active.
     /// - Parameters:
     ///   - destination: A view for the navigation link to present.
-    ///   - isActive: A binding to a Boolean value that indicates whether `destination` is currently presented.
+    ///   - isActive: An optional binding to a Boolean value that indicates whether `destination` is currently presented.
     ///   - label: A view builder to produce a label describing the `destination` to present.
-    init(destination: @autoclosure @escaping () -> Destination, isActive: Binding<Bool>, label: @escaping () -> Label) {
+    init(destination: @autoclosure @escaping () -> Destination, isActive: Binding<Bool>? = nil, label: @escaping () -> Label) {
         self.destination = destination
-        self._isActive = isActive
+        self.isActive = isActive
         self.label = label
     }
 
     var body: some View {
-        NavigationLink(destination: LazyView(destination), isActive: $isActive, label: label)
+        if let isActive = isActive {
+            NavigationLink(destination: LazyView(destination), isActive: isActive, label: label)
+        } else {
+            NavigationLink(destination: LazyView(destination), label: label)
+        }
     }
 }
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/AddProductToOrderViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/AddProductToOrderViewModelTests.swift
@@ -25,7 +25,7 @@ class AddProductToOrderViewModelTests: XCTestCase {
 
     func test_view_model_adds_product_rows_with_unchangeable_quantity() {
         // Given
-        let product = Product.fake().copy(siteID: sampleSiteID, statusKey: "publish")
+        let product = Product.fake().copy(siteID: sampleSiteID, purchasable: true)
         insert(product)
 
         // When
@@ -38,44 +38,6 @@ class AddProductToOrderViewModelTests: XCTestCase {
         XCTAssertFalse(productRow.canChangeQuantity, "Product row canChangeQuantity property should be false but is true instead")
     }
 
-    func test_products_include_all_product_types_except_variable() {
-        // Given
-        let simpleProduct = Product.fake().copy(siteID: sampleSiteID, productID: 1, productTypeKey: "simple", statusKey: "publish")
-        let groupedProduct = Product.fake().copy(siteID: sampleSiteID, productID: 2, productTypeKey: "grouped", statusKey: "publish")
-        let affiliateProduct = Product.fake().copy(siteID: sampleSiteID, productID: 3, productTypeKey: "external", statusKey: "publish")
-        let variableProduct = Product.fake().copy(siteID: sampleSiteID, productID: 4, productTypeKey: "variable", statusKey: "publish")
-        let subscriptionProduct = Product.fake().copy(siteID: sampleSiteID, productID: 5, productTypeKey: "subscription", statusKey: "publish")
-        insert([simpleProduct, groupedProduct, affiliateProduct, variableProduct, subscriptionProduct])
-
-        // When
-        let viewModel = AddProductToOrderViewModel(siteID: sampleSiteID, storageManager: storageManager)
-
-        // Then
-        XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == 1 }), "Products do not include simple product")
-        XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == 2 }), "Products do not include grouped product")
-        XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == 3 }), "Products do not include affiliate product")
-        XCTAssertFalse(viewModel.productRows.contains(where: { $0.productOrVariationID == 4 }), "Products include variable product")
-        XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == 5 }), "Products do not include subscription product")
-    }
-
-    func test_product_rows_only_contain_products_with_published_and_private_statuses() {
-        // Given
-        let publishedProduct = Product.fake().copy(siteID: sampleSiteID, productID: 1, statusKey: "publish")
-        let draftProduct = Product.fake().copy(siteID: sampleSiteID, productID: 2, statusKey: "draft")
-        let pendingProduct = Product.fake().copy(siteID: sampleSiteID, productID: 3, statusKey: "pending")
-        let privateProduct = Product.fake().copy(siteID: sampleSiteID, productID: 4, statusKey: "private")
-        insert([publishedProduct, draftProduct, pendingProduct, privateProduct])
-
-        // When
-        let viewModel = AddProductToOrderViewModel(siteID: sampleSiteID, storageManager: storageManager)
-
-        // Then
-        XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == 1 }), "Product rows do not include published product")
-        XCTAssertFalse(viewModel.productRows.contains(where: { $0.productOrVariationID == 2 }), "Product rows include draft product")
-        XCTAssertFalse(viewModel.productRows.contains(where: { $0.productOrVariationID == 3 }), "Product rows include pending product")
-        XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == 4 }), "Product rows do not include private product")
-    }
-
     func test_scrolling_indicator_appears_only_during_sync() {
         // Given
         let viewModel = AddProductToOrderViewModel(siteID: sampleSiteID, storageManager: storageManager, stores: stores)
@@ -124,7 +86,7 @@ class AddProductToOrderViewModelTests: XCTestCase {
             switch action {
             case let .synchronizeProducts(_, _, _, _, _, _, _, _, _, _, onCompletion):
                 XCTAssertEqual(viewModel.syncStatus, .firstPageSync)
-                let product = Product.fake().copy(siteID: self.sampleSiteID, statusKey: "publish")
+                let product = Product.fake().copy(siteID: self.sampleSiteID, purchasable: true)
                 self.insert(product)
                 onCompletion(.success(true))
             default:
@@ -141,7 +103,7 @@ class AddProductToOrderViewModelTests: XCTestCase {
 
     func test_sync_status_does_not_change_while_syncing_when_storage_contains_products() {
         // Given
-        let product = Product.fake().copy(siteID: self.sampleSiteID, statusKey: "publish")
+        let product = Product.fake().copy(siteID: self.sampleSiteID, purchasable: true)
         insert(product)
 
         let viewModel = AddProductToOrderViewModel(siteID: sampleSiteID, storageManager: storageManager, stores: stores)
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/NewOrderViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/NewOrderViewModelTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/ProductRowViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/ProductRowViewModelTests.swift
