Merge pull request #5394 from anas-p/feature/4846-variation-number-in-list-and-details

Author: Ecarrion

WooCommerce/Classes/ViewRelated/Products/Cells/ProductsTabProductTableViewCell.swift

@@ -64,8 +64,7 @@ extension ProductsTabProductTableViewCell: SearchResultCell {
 
 extension ProductsTabProductTableViewCell {
     func update(viewModel: ProductsTabProductViewModel, imageService: ImageService) {
-        nameLabel.text = viewModel.name
-
+        nameLabel.text = viewModel.createNameLabel()
         detailsLabel.attributedText = viewModel.detailsAttributedString
 
         productImageView.contentMode = .center
@@ -155,7 +154,7 @@ private extension ProductsTabProductTableViewCell {
 
     func configureNameLabel() {
         nameLabel.applyBodyStyle()
-        nameLabel.numberOfLines = 2
+        nameLabel.numberOfLines = 0
     }
 
     func configureDetailsLabel() {

WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewController+Helpers.swift

@@ -84,12 +84,15 @@ extension ProductFormViewController {
     // MARK: - Progress
 
     /// Progress view for save action.
+    ///
     func showSavingProgress(_ messageType: SaveMessageType) {
         switch messageType {
         case .publish:
             displayInProgressView(title: Localization.ProgressView.productPublishingTitle, message: Localization.ProgressView.productPublishingMessage)
         case .save:
             displayInProgressView(title: Localization.ProgressView.productSavingTitle, message: Localization.ProgressView.productSavingMessage)
+        case .saveVariation:
+            displayInProgressView(title: Localization.ProgressView.productVariationTitle, message: Localization.ProgressView.productVariationMessage)
         }
     }
 
@@ -176,5 +179,9 @@ private enum Localization {
                                                               comment: "Title of the in-progress UI while deleting the Variation remotely")
         static let variationDeletionMessage = NSLocalizedString("Please wait while we update your store details",
                                                                 comment: "Message of the in-progress UI while deleting the Variation remotely")
+        static let productVariationTitle = NSLocalizedString("Saving your variation...",
+                                                          comment: "Title of the in-progress UI while saving a Variation remotely")
+        static let productVariationMessage = NSLocalizedString("Please wait while we save your latest changes",
+                                                            comment: "Message of the in-progress UI while saving a Variation remotely")
     }
 }

WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewController.swift

@@ -96,9 +96,9 @@ final class ProductFormViewController<ViewModel: ProductFormViewModelProtocol>:
 
     override func viewDidLoad() {
         super.viewDidLoad()
-
         configurePresentationStyle()
         configureNavigationBar()
+
         configureMainView()
         configureTableView()
         configureMoreDetailsContainerView()
@@ -407,9 +407,12 @@ final class ProductFormViewController<ViewModel: ProductFormViewModelProtocol>:
 //
 private extension ProductFormViewController {
 
-    func configureNavigationBar() {
+    /// Configure navigation bar with the title
+    ///
+    func configureNavigationBar(title: String = "") {
         updateNavigationBar()
         updateBackButtonTitle()
+        updateNavigationBarTitle()
     }
 
     func configureMainView() {
@@ -801,6 +804,14 @@ private extension ProductFormViewController {
         navigationItem.backButtonTitle = viewModel.productModel.name.isNotEmpty ? viewModel.productModel.name : Localization.unnamedProduct
     }
 
+    func updateNavigationBarTitle() {
+        // Update navigation bar title with variation ID for variation page
+        guard let variationID = viewModel.productionVariationID else {
+            return
+        }
+        title = Localization.variationViewTitle(variationID: "\(variationID)")
+    }
+
     func updateNavigationBar() {
         // Create action buttons based on view model
         let rightBarButtonItems: [UIBarButtonItem] = viewModel.actionButtons.reversed().map { buttonType in
@@ -1435,6 +1446,11 @@ private enum Localization {
                                                             comment: "Navigation bar title for editing linked products for a grouped product")
     static let unnamedProduct = NSLocalizedString("Unnamed product",
                                                   comment: "Back button title when the product doesn't have a name")
+
+    static func variationViewTitle(variationID: String) -> String {
+        let titleFormat = NSLocalizedString("Variation #%1$@", comment: "Navigation bar title for variation. Parameters: %1$@ - Product variation ID")
+        return String.localizedStringWithFormat(titleFormat, variationID)
+    }
 }
 
 private enum ActionSheetStrings {

WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewModel.swift

@@ -7,6 +7,9 @@ import protocol Storage.StorageManagerType
 final class ProductFormViewModel: ProductFormViewModelProtocol {
     typealias ProductModel = EditableProductModel
 
+    /// Production variation ID only for Product Variation not for product
+    var productionVariationID: Int64? = nil
+
     /// Emits product on change, except when the product name is the only change (`productName` is emitted for this case).
     var observableProduct: Observable<EditableProductModel> {
         productSubject

WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewModelProtocol.swift

@@ -19,8 +19,10 @@ enum ActionButtonType {
 enum SaveMessageType {
     case publish
     case save
+    case saveVariation
 }
 
+
 /// A view model for `ProductFormViewController` to add/edit a generic product model (e.g. `Product` or `ProductVariation`).
 ///
 protocol ProductFormViewModelProtocol {
@@ -56,6 +58,9 @@ protocol ProductFormViewModelProtocol {
     /// The action buttons that should be rendered in the navigation bar.
     var actionButtons: [ActionButtonType] { get }
 
+    /// The product variation ID
+    var productionVariationID: Int64? { get }
+
     // Unsaved changes
 
     func hasUnsavedChanges() -> Bool
@@ -148,14 +153,20 @@ extension ProductFormViewModelProtocol {
 
     /// Returns `.publish` when the product does not exists remotely and it's gonna be published for the first time.
     /// Returns `.publish` when the product is going to be published from a different status (eg: from draft).
+    /// Returns `.saveVariation` when save variation
     /// Returns `.save` for any other case.
     ///
     func saveMessageType(for productStatus: ProductStatus) -> SaveMessageType {
         switch productStatus {
         case .publish where !productModel.existsRemotely || originalProductModel.status != .publish:
             return .publish
         default:
-            return .save
+            if self is ProductVariationFormViewModel {
+                return .saveVariation
+            }
+            else {
+                return .save
+            }
         }
     }
 }

WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductVariationFormViewModel.swift

@@ -26,6 +26,11 @@ final class ProductVariationFormViewModel: ProductFormViewModelProtocol {
         isUpdateEnabledSubject
     }
 
+    /// The product variation ID
+    var productionVariationID: Int64? {
+        productVariation.productVariation.productVariationID
+    }
+
     /// Emits a void value informing when there is a new variation price state available
     var newVariationsPrice: Observable<Void> = PublishSubject<Void>()
 

WooCommerce/Classes/ViewRelated/Products/Variations/ProductVariationsViewController.swift

@@ -410,6 +410,7 @@ extension ProductVariationsViewController: UITableViewDelegate {
         let currency = ServiceLocator.currencySettings.symbol(from: currencyCode)
         let productImageActionHandler = ProductImageActionHandler(siteID: productVariation.siteID,
                                                                   product: model)
+
         let viewModel = ProductVariationFormViewModel(productVariation: model,
                                                       allAttributes: allAttributes,
                                                       parentProductSKU: parentProductSKU,

WooCommerce/Classes/ViewRelated/Products/Variations/ProductsTabProductViewModel+ProductVariation.swift

@@ -7,7 +7,7 @@ extension ProductsTabProductViewModel {
         imageUrl = productVariationModel.productVariation.image?.src
         name = productVariationModel.name
         detailsAttributedString = productVariationModel.createDetailsAttributedString(currencySettings: currencySettings)
-
+        productVariation = productVariationModel.productVariation
         imageService = ServiceLocator.imageService
         isSelected = false
         isDraggable = false

WooCommerce/Classes/ViewRelated/Products/View Models/ProductsTabProductViewModel.swift

@@ -19,22 +19,41 @@ private extension ProductStatus {
 struct ProductsTabProductViewModel {
     let imageUrl: String?
     let name: String
+    let productVariation: ProductVariation?
     let detailsAttributedString: NSAttributedString
     let isSelected: Bool
     let isDraggable: Bool
 
     // Dependency for configuring the view.
     let imageService: ImageService
 
-    init(product: Product, isSelected: Bool = false, isDraggable: Bool = false, imageService: ImageService = ServiceLocator.imageService) {
+    init(product: Product,
+         productVariation: ProductVariation? = nil,
+         isSelected: Bool = false,
+         isDraggable: Bool = false,
+         imageService: ImageService = ServiceLocator.imageService) {
+
         imageUrl = product.images.first?.src
         name = product.name.isEmpty ? Localization.noTitle : product.name
+        self.productVariation = productVariation
         self.isSelected = isSelected
         self.isDraggable = isDraggable
         detailsAttributedString = EditableProductModel(product: product).createDetailsAttributedString()
 
         self.imageService = imageService
     }
+
+    /// Variation will show product variation ID within the title,
+    /// Product will only show product name
+    /// See more: https://github.com/woocommerce/woocommerce-ios/issues/4846
+    /// 
+    func createNameLabel() -> String {
+        if let variationID = productVariation?.productVariationID {
+            // Add product variation ID with name
+            return "\(Localization.variationID(variationID: "\(variationID)"))\n\(name)"
+        }
+        return name
+    }
 }
 
 private extension EditableProductModel {
@@ -83,5 +102,9 @@ private extension EditableProductModel {
 private extension ProductsTabProductViewModel {
     enum Localization {
         static let noTitle = NSLocalizedString("(No Title)", comment: "Product title in Products list when there is no title")
+        static func variationID(variationID: String) -> String {
+            let titleFormat = NSLocalizedString("#%1$@", comment: "Variation ID. Parameters: %1$@ - Product variation ID")
+            return String.localizedStringWithFormat(titleFormat, variationID)
+        }
     }
 }

WooCommerce/WooCommerce.xcodeproj/project.pbxproj

@@ -5402,12 +5402,12 @@
 		B56DB3F12049C0B800D4AA8E /* Classes */ = {
 			isa = PBXGroup;
 			children = (
+				B57B67882107545B00AF8905 /* Model */,
 				D8D15F81230A178100D48B3F /* ServiceLocator */,
 				747AA0872107CE270047A89B /* Analytics */,
 				B55D4C0420B6026700D7A50F /* Authentication */,
 				0211252225773EB40075AD2A /* Copiable */,
 				CE1CCB4C20572444000EE3AC /* Extensions */,
-				B57B67882107545B00AF8905 /* Model */,
 				B5BBD6DC21B1701F00E3207E /* Notifications */,
 				CE1CCB3E2056F204000EE3AC /* Styles */,
 				B5D1AFBE20BC67B500DB0E8C /* System */,