Merge branch 'trunk' into issue/6950-orders-split-view

Author: jaclync

RELEASE-NOTES.txt

@@ -6,8 +6,9 @@
 - [*] Orders: Now it's possible to select and copy text from the notes on an order. [https://github.com/woocommerce/woocommerce-ios/pull/6894]
 - [*] Support Arabic numerals on amount fields. [https://github.com/woocommerce/woocommerce-ios/pull/6891]
 - [*] Product Selector: Enabled selecting all variations on variable product rows. [https://github.com/woocommerce/woocommerce-ios/pull/6899]
+- [*] Coupons: Now it's possible to update discount types for coupons. [https://github.com/woocommerce/woocommerce-ios/pull/6935]
 - [*] Orders tab: the view width now adjusts to the app in tablet split view on iOS 15. [https://github.com/woocommerce/woocommerce-ios/pull/6951]
-
+ 
 9.2
 -----
 - [***] Experimental Features: Coupons editing and deletion features are now enabled as part of coupon management. [https://github.com/woocommerce/woocommerce-ios/pull/6853]

WooCommerce/Classes/Extensions/UIImage+Woo.swift

@@ -293,6 +293,24 @@ extension UIImage {
         return UIImage.gridicon(.filter)
     }
 
+    /// Fixed cart discount icon
+    ///
+    static var fixedCartDiscountIcon: UIImage {
+        return UIImage(named: "icon-fixed-cart-discount")!
+    }
+
+    /// Fixed product discount icon
+    ///
+    static var fixedProductDiscountIcon: UIImage {
+        return UIImage(named: "icon-fixed-product-discount")!
+    }
+
+    /// Percentage discount icon
+    ///
+    static var percentageDiscountIcon: UIImage {
+        return UIImage(named: "icon-percentage-discount")!
+    }
+
     /// Gift Icon (with a red dot at the top right corner)
     ///
     static var giftWithTopRightRedDotImage: UIImage {

WooCommerce/Classes/Model/Coupon+Woo.swift

@@ -18,33 +18,33 @@ extension Coupon.DiscountType {
         }
     }
 
-    /// Localized title to be displayed for the discount type in `AddEditCoupon` when in creation mode.
+    /// Description to be displayed on the discount type list selector.
     ///
-    var titleCreateCoupon: String {
+    var actionSheetDescription: String? {
         switch self {
         case .percent:
-            return Localization.titleCreatePercentageDiscount
+            return Localization.percentageDiscountDescription
         case .fixedCart:
-            return Localization.titleCreateFixedCartDiscount
+            return Localization.fixedCartDiscountDescription
         case .fixedProduct:
-            return Localization.titleCreateFixedProductDiscount
-        default:
-            return Localization.titleCreateGenericDiscount
+            return Localization.fixedProductDiscountDescription
+        case .other:
+            return nil
         }
     }
 
-    /// Localized title to be displayed for the discount type in `AddEditCoupon` when in editing mode.
+    /// Image to be displayed on the discount type list selector
     ///
-    var titleEditCoupon: String {
+    var actionSheetIcon: UIImage? {
         switch self {
         case .percent:
-            return Localization.titleEditPercentageDiscount
+            return UIImage.percentageDiscountIcon
         case .fixedCart:
-            return Localization.titleEditFixedCartDiscount
+            return UIImage.fixedCartDiscountIcon
         case .fixedProduct:
-            return Localization.titleEditFixedProductDiscount
-        default:
-            return Localization.titleEditGenericDiscount
+            return UIImage.fixedProductDiscountIcon
+        case .other:
+            return nil
         }
     }
 
@@ -53,30 +53,18 @@ extension Coupon.DiscountType {
         static let fixedCartDiscount = NSLocalizedString("Fixed Cart Discount", comment: "Name of fixed cart discount type")
         static let fixedProductDiscount = NSLocalizedString("Fixed Product Discount", comment: "Name of fixed product discount type")
         static let otherDiscount = NSLocalizedString("Other", comment: "Generic name of non-default discount types")
-        static let titleEditPercentageDiscount = NSLocalizedString(
-            "Edit percentage discount",
-            comment: "Title of the view for editing a coupon with percentage discount.")
-        static let titleEditFixedCartDiscount = NSLocalizedString(
-            "Edit fixed cart discount",
-            comment: "Title of the view for editing a coupon with fixed cart discount.")
-        static let titleEditFixedProductDiscount = NSLocalizedString(
-            "Edit fixed product discount",
-            comment: "Title of the view for editing a coupon with fixed product discount.")
-        static let titleEditGenericDiscount = NSLocalizedString(
-            "Edit discount",
-            comment: "Title of the view for editing a coupon with generic discount.")
-        static let titleCreatePercentageDiscount = NSLocalizedString(
-            "Create percentage discount",
-            comment: "Title of the view for creating a coupon with percentage discount.")
-        static let titleCreateFixedCartDiscount = NSLocalizedString(
-            "Create fixed cart discount",
-            comment: "Title of the view for creating a coupon with fixed cart discount.")
-        static let titleCreateFixedProductDiscount = NSLocalizedString(
-            "Create fixed product discount",
-            comment: "Title of the view for creating a coupon with fixed product discount.")
-        static let titleCreateGenericDiscount = NSLocalizedString(
-            "Create discount",
-            comment: "Title of the view for creating a coupon with generic discount.")
+        static let percentageDiscountDescription = NSLocalizedString(
+            "Create a percentage discount for selected products",
+            comment: "Description for percentage discount type on the action sheet presented from Add or Edit coupon screen"
+        )
+        static let fixedCartDiscountDescription = NSLocalizedString(
+            "Create a fixed total discount for the entire cart",
+            comment: "Description for fixed cart discount type on the action sheet presented from Add or Edit coupon screen"
+        )
+        static let fixedProductDiscountDescription = NSLocalizedString(
+            "Create a fixed total discount for selected products",
+            comment: "Description for fixed product discount type on the action sheet presented from Add or Edit coupon screen"
+        )
     }
 }
 

WooCommerce/Classes/ViewRelated/BottomSheet/BottomSheetListSelector.swift

@@ -0,0 +1,27 @@
+import SwiftUI
+
+/// SwiftUI wrapper of `BottomSheetListSelectorViewController`.
+///
+struct BottomSheetListSelector<Command: BottomSheetListSelectorCommand, Model, Cell>: UIViewControllerRepresentable
+    where Command.Model == Model, Command.Cell == Cell {
+
+    private let viewProperties: BottomSheetListSelectorViewProperties
+    private let command: Command
+    private let onDismiss: ((_ selected: Model?) -> Void)?
+
+    init(viewProperties: BottomSheetListSelectorViewProperties,
+         command: Command,
+         onDismiss: ((_ selected: Model?) -> Void)?) {
+        self.viewProperties = viewProperties
+        self.command = command
+        self.onDismiss = onDismiss
+    }
+
+    func makeUIViewController(context: Context) -> BottomSheetListSelectorViewController<Command, Model, Cell> {
+        return BottomSheetListSelectorViewController(viewProperties: viewProperties, command: command, onDismiss: onDismiss)
+    }
+
+    func updateUIViewController(_ uiViewController: BottomSheetListSelectorViewController<Command, Model, Cell>, context: Context) {
+        // no-op
+    }
+}

WooCommerce/Classes/ViewRelated/Coupons/Add and Edit Coupons/AddEditCoupon.swift

@@ -13,6 +13,17 @@ final class AddEditCouponHostingController: UIHostingController<AddEditCoupon> {
         rootView.dismissHandler = { [weak self] in
             self?.dismiss(animated: true)
         }
+
+        rootView.discountTypeHandler = { [weak self] viewProperties in
+            guard let self = self else { return }
+            let command = DiscountTypeBottomSheetListSelectorCommand(selected: self.viewModel.discountType) { [weak self] selectedType in
+                guard let self = self else { return }
+                viewModel.discountType = selectedType
+                self.presentedViewController?.dismiss(animated: true, completion: nil)
+            }
+            let presenter = BottomSheetListSelectorPresenter(viewProperties: viewProperties, command: command)
+            presenter.show(from: self, sourceView: self.view, sourceBarButtonItem: nil, arrowDirections: .any)
+        }
     }
 
     required dynamic init?(coder aDecoder: NSCoder) {
@@ -49,13 +60,18 @@ struct AddEditCoupon: View {
     ///
     var onDisappear: () -> Void = {}
 
+    /// Set this closure to display the bottom sheet for discount type selection the UIKit way.
+    ///
+    var discountTypeHandler: (BottomSheetListSelectorViewProperties) -> Void = { _ in }
+
     @ObservedObject private var viewModel: AddEditCouponViewModel
     @State private var showingEditDescription: Bool = false
     @State private var showingCouponExpiryActionSheet: Bool = false
     @State private var showingCouponExpiryDate: Bool = false
     @State private var showingCouponRestrictions: Bool = false
     @State private var showingSelectProducts: Bool = false
     @State private var showingSelectCategories: Bool = false
+    @State private var showingDiscountType: Bool = false
 
     private var expiryDateActionSheetButtons: [Alert.Button] {
         var buttons: [Alert.Button] = []
@@ -83,6 +99,9 @@ struct AddEditCoupon: View {
         return buttons
     }
 
+    private var idiom: UIUserInterfaceIdiom { UIDevice.current.userInterfaceIdiom }
+    private let viewProperties = BottomSheetListSelectorViewProperties(title: Localization.discountTypeSheetTitle)
+
     private let categorySelectorConfig = ProductCategorySelector.Configuration.categoriesForCoupons
     private let categoryListConfig = ProductCategoryListViewController.Configuration(searchEnabled: true, clearSelectionEnabled: true)
 
@@ -99,6 +118,26 @@ struct AddEditCoupon: View {
                             ListHeaderView(text: Localization.headerCouponDetails.uppercased(), alignment: .left)
 
                             Group {
+                                TitleAndValueRow(title: Localization.discountType,
+                                                 value: viewModel.discountTypeValue,
+                                                 selectionStyle: .disclosure, action: {
+                                    // TODO: remove this workaround with `adaptiveSheetPresentationController` when we drop support for iOS 14
+                                    if idiom == .pad {
+                                        showingDiscountType.toggle()
+                                    } else {
+                                        discountTypeHandler(viewProperties)
+                                    }
+                                }).popover(isPresented: $showingDiscountType) {
+                                    let command = DiscountTypeBottomSheetListSelectorCommand(selected: viewModel.discountType) { selectedType in
+                                        viewModel.discountType = selectedType
+                                        showingDiscountType.toggle()
+                                    }
+                                    BottomSheetListSelector(viewProperties: viewProperties, command: command, onDismiss: nil)
+                                }
+
+                                Divider()
+                                    .padding(.leading, Constants.margin)
+
                                 TitleAndTextFieldRow(title: viewModel.amountLabel,
                                                      placeholder: "0",
                                                      text: $viewModel.amountField,
@@ -336,7 +375,7 @@ private extension AddEditCoupon {
             comment: "Header of the coupon details in the view for adding or editing a coupon.")
         static let couponCode = NSLocalizedString(
             "Coupon Code",
-            comment: "Text field coupon code in the view for adding or editing a coupon.")
+            comment: "Text field coupon code in the view for adding or editing a coupon code.")
         static let couponCodePlaceholder = NSLocalizedString(
             "Enter a coupon",
             comment: "Text field coupon code placeholder in the view for adding or editing a coupon.")
@@ -345,16 +384,20 @@ private extension AddEditCoupon {
             comment: "The footer of the text field coupon code in the view for adding or editing a coupon.")
         static let regenerateCouponCodeButton = NSLocalizedString(
             "Regenerate Coupon Code",
-            comment: "Button in the view for adding or editing a coupon.")
+            comment: "Button in the view for adding or editing a coupon code.")
         static let couponExpiryDate = NSLocalizedString(
             "Coupon Expiry Date",
-            comment: "Field in the view for adding or editing a coupon.")
+            comment: "Field in the view for adding or editing a coupon's expiry date.")
+        static let discountType = NSLocalizedString(
+            "Discount Type",
+            comment: "Field in the view for adding or editing a coupon's discount type.")
         static let includeFreeShipping = NSLocalizedString(
             "Include Free Shipping?",
-            comment: "Toggle field in the view for adding or editing a coupon.")
+            comment: "Toggle field in the view for adding or editing a coupon's free shipping support.")
         static let headerApplyCouponTo = NSLocalizedString(
             "Apply this coupon to",
-            comment: "Header of the section for applying a coupon to specific products or categories in the view for adding or editing a coupon.")
+            comment: "Header of the section for applying a coupon to specific products or categories in the view " +
+            "for adding or editing a coupon's product and category restrictions.")
         static let allProductsButton = NSLocalizedString(
             "All Products",
             comment: "Button indicating that coupon can be applied to all products in the view for adding or editing a coupon.")
@@ -381,6 +424,10 @@ private extension AddEditCoupon {
                                                                      comment: "Button in the action sheet for adding the expiration date for a coupon.")
         static let titleEditDescriptionView = NSLocalizedString("Coupon Description",
                                                                 comment: "Title of the view for editing the coupon description.")
+        static let discountTypeSheetTitle = NSLocalizedString(
+            "Discount Type",
+            comment: "Title for the sheet to select discount type on the Add or Edit coupon screen."
+        )
     }
 }
 

WooCommerce/Classes/ViewRelated/Coupons/Add and Edit Coupons/AddEditCouponViewModel.swift

@@ -23,12 +23,18 @@ final class AddEditCouponViewModel: ObservableObject {
     var title: String {
         switch editingOption {
         case .creation:
-            return discountType.titleCreateCoupon
+            return Localization.createCouponTitle
         case .editing:
-            return discountType.titleEditCoupon
+            return Localization.editCouponTitle
         }
     }
 
+    /// The value for populating the coupon discount type field based on the `discountType`.
+    ///
+    var discountTypeValue: TitleAndValueRow.Value {
+        return .content(discountType.localizedName)
+    }
+
     /// Label representing the label of the amount field, localized based on discount type.
     ///
     var amountLabel: String {
@@ -123,7 +129,8 @@ final class AddEditCouponViewModel: ObservableObject {
 
     var hasChangesMade: Bool {
         let coupon = populatedCoupon
-        return checkAmountUpdated(for: coupon) ||
+        return checkDiscountTypeUpdated(for: coupon) ||
+        checkAmountUpdated(for: coupon) ||
         checkDescriptionUpdated(for: coupon) ||
         checkCouponCodeUpdated(for: coupon) ||
         checkAllowedProductsAndCategoriesUpdated(for: coupon) ||
@@ -315,6 +322,13 @@ final class AddEditCouponViewModel: ObservableObject {
 // MARK: - Helpers
 //
 private extension AddEditCouponViewModel {
+    func checkDiscountTypeUpdated(for coupon: Coupon) -> Bool {
+        guard let initialCoupon = self.coupon else {
+            return false
+        }
+        return coupon.discountType != initialCoupon.discountType
+    }
+
     func checkUsageRestrictionsUpdated(for coupon: Coupon) -> Bool {
         guard let initialCoupon = self.coupon else {
             return false
@@ -384,6 +398,7 @@ private extension AddEditCouponViewModel {
 
     func trackCouponUpdateInitiated(with coupon: Coupon) {
         ServiceLocator.analytics.track(.couponUpdateInitiated, withProperties: [
+            "discount_type_updated": checkDiscountTypeUpdated(for: coupon),
             "coupon_code_updated": checkCouponCodeUpdated(for: coupon),
             "amount_updated": checkAmountUpdated(for: coupon),
             "description_updated": checkDescriptionUpdated(for: coupon),
@@ -457,5 +472,7 @@ private extension AddEditCouponViewModel {
             "Edit Product Categories (%1$d)",
             comment: "Button for specify the product categories where a coupon can be applied in the view for adding or editing a coupon. " +
             "Reads like: Edit Categories")
+        static let createCouponTitle = NSLocalizedString("Create coupon", comment: "Title of the Create coupon screen")
+        static let editCouponTitle = NSLocalizedString("Edit coupon", comment: "Title of the Edit coupon screen")
     }
 }

WooCommerce/Classes/ViewRelated/Coupons/Add and Edit Coupons/DiscountTypeBottomSheetListSelectorCommand.swift

@@ -0,0 +1,43 @@
+import Foundation
+import Yosemite
+
+/// `BottomSheetListSelectorCommand` for selecting a discount type for a coupon.
+///
+final class DiscountTypeBottomSheetListSelectorCommand: BottomSheetListSelectorCommand {
+    typealias Model = Coupon.DiscountType
+    typealias Cell = ImageAndTitleAndTextTableViewCell
+
+    let data: [Coupon.DiscountType] = [
+        .percent,
+        .fixedCart,
+        .fixedProduct
+    ]
+
+    var selected: Coupon.DiscountType? = nil
+
+    private let onSelection: (Coupon.DiscountType) -> Void
+
+    init(selected: Coupon.DiscountType?, onSelection: @escaping (Coupon.DiscountType) -> Void) {
+        self.onSelection = onSelection
+        self.selected = selected
+    }
+
+    func configureCell(cell: ImageAndTitleAndTextTableViewCell, model: Coupon.DiscountType) {
+        let viewModel = ImageAndTitleAndTextTableViewCell.ViewModel(title: model.localizedName,
+                                                                    text: model.actionSheetDescription,
+                                                                    image: model.actionSheetIcon,
+                                                                    imageTintColor: .gray(.shade20),
+                                                                    numberOfLinesForText: 0,
+                                                                    isSelected: isSelected(model: model),
+                                                                    isActionable: false)
+        cell.updateUI(viewModel: viewModel)
+    }
+
+    func handleSelectedChange(selected: Coupon.DiscountType) {
+        onSelection(selected)
+    }
+
+    func isSelected(model: Coupon.DiscountType) -> Bool {
+        return model == selected
+    }
+}