Merge pull request #7052 from woocommerce/issue/6492-create-coupon

Coupons: Create coupon

Author: ThomazFB

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -578,6 +578,7 @@ public enum WooAnalyticsStat: String {
     case couponsLoaded = "coupons_loaded"
     case couponsLoadedFailed = "coupons_loaded_failed"
     case couponsListSearchTapped = "coupons_list_search_tapped"
+    case couponsListCreateTapped = "coupons_list_create_tapped"
     case couponDetails = "coupon_details"
     case couponSettingDisabled = "coupon_settings_disabled"
     case couponSettingEnabled = "coupon_settings_enabled"
@@ -586,6 +587,9 @@ public enum WooAnalyticsStat: String {
     case couponUpdateInitiated = "coupon_update_initiated"
     case couponUpdateSuccess = "coupon_update_success"
     case couponUpdateFailed = "coupon_update_failed"
+    case couponCreationInitiated = "coupon_creation_initiated"
+    case couponCreationSuccess = "coupon_creation_success"
+    case couponCreationFailed = "coupon_creation_failed"
 
     // MARK: Inbox Notes
     case inboxNotesLoaded = "inbox_notes_loaded"

WooCommerce/Classes/Model/Coupon+Woo.swift

@@ -127,6 +127,20 @@ extension Coupon {
         return amountString
     }
 
+    /// The message to be shared about the coupon
+    ///
+    func generateShareMessage(currencySettings: CurrencySettings) -> String {
+        let formattedAmount = formattedAmount(currencySettings: currencySettings)
+        let couponAmount = formattedAmount.isEmpty ? amount : formattedAmount
+        if productIds.isNotEmpty ||
+                   productCategories.isNotEmpty ||
+                   excludedProductIds.isNotEmpty ||
+                   excludedProductCategories.isNotEmpty {
+            return String.localizedStringWithFormat(Localization.shareMessageSomeProducts, couponAmount, code)
+        }
+        return String.localizedStringWithFormat(Localization.shareMessageAllProducts, couponAmount, code)
+    }
+
     /// Localize content for the "Apply to" field. This takes into consideration different cases of apply rules:
     ///    - When only specific products or categories are defined: Display "x Products" or "x Categories"
     ///    - When specific products/categories and exceptions are defined: Display "x Products excl. y Categories" etc.
@@ -246,6 +260,14 @@ extension Coupon {
             "%1$@, %2$@",
             comment: "Combined rule for a coupon. Reads like: 2 Products, 1 Category"
         )
+        static let shareMessageAllProducts = NSLocalizedString(
+                "Apply %1$@ off to all products with the promo code “%2$@”.",
+                comment: "Message to share the coupon code if it is applicable to all products. " +
+                        "Reads like: Apply 10% off to all products with the promo code “20OFF”.")
+        static let shareMessageSomeProducts = NSLocalizedString(
+                "Apply %1$@ off to some products with the promo code “%2$@”.",
+                comment: "Message to share the coupon code if it is applicable to some products. " +
+                        "Reads like: Apply 10% off to some products with the promo code “20OFF”.")
     }
 }
 

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

@@ -256,11 +256,11 @@ struct AddEditCoupon: View {
                         Button {
                             // This should be replaced with `@FocusState` when we drop support for iOS 14
                             UIApplication.shared.sendAction(#selector(UIResponder.resignFirstResponder), to: nil, from: nil, for: nil)
-                            viewModel.updateCoupon(coupon: viewModel.populatedCoupon, onUpdateFinished: {
+                            viewModel.completeCouponAddEdit(coupon: viewModel.populatedCoupon, onUpdateFinished: {
                                 dismissHandler()
                             })
                         } label: {
-                            Text(Localization.saveButton)
+                            Text(viewModel.addEditCouponButtonText)
                         }
                         .buttonStyle(PrimaryLoadingButtonStyle(isLoading: viewModel.isLoading))
                         .padding(.horizontal, Constants.margin)
@@ -304,6 +304,15 @@ struct AddEditCoupon: View {
                                         categoryListConfig: categoryListConfig,
                                         viewModel: viewModel.categorySelectorViewModel)
             }
+            .sheet(isPresented: $viewModel.showingCouponCreationSuccess) {
+                let couponCode = viewModel.coupon?.code ?? ""
+                if couponCode.isEmpty {
+                    let _ = DDLogError("⛔️ Error acquiring the coupon code after creation")
+                }
+                CouponCreationSuccess(couponCode: couponCode, shareMessage: viewModel.shareCouponMessage) {
+                    onDisappear()
+                }
+            }
             .toolbar {
                 ToolbarItem(placement: .cancellationAction) {
                     Button(Localization.cancelButton, action: {
@@ -377,7 +386,6 @@ private extension AddEditCoupon {
         static let usageRestrictions = NSLocalizedString(
             "Usage Restrictions",
             comment: "Field in the view for adding or editing a coupon.")
-        static let saveButton = NSLocalizedString("Save", comment: "Action for saving a Coupon remotely")
         static let addDescriptionPlaceholder = NSLocalizedString("Add the description of the coupon.",
                                                                  comment: "Placeholder text that will be shown in the view" +
                                                                  " for adding the description of a coupon.")
@@ -396,7 +404,7 @@ struct AddEditCoupon_Previews: PreviewProvider {
 
         /// Edit Coupon
         ///
-        let editingViewModel = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon, onCompletion: { _ in })
+        let editingViewModel = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon, onSuccess: { _ in })
         AddEditCoupon(editingViewModel)
     }
 }

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

@@ -1,6 +1,7 @@
 import Foundation
 import Yosemite
 import UIKit
+import WooFoundation
 import protocol Storage.StorageManagerType
 
 /// View model for `AddEditCoupon` view
@@ -13,7 +14,7 @@ final class AddEditCouponViewModel: ObservableObject {
     ///
     private let editingOption: EditingOption
 
-    private let onCompletion: ((Result<Coupon, Error>) -> Void)
+    private let onSuccess: (Coupon) -> Void
 
     /// Defines the current notice that should be shown.
     /// Defaults to `nil`.
@@ -29,6 +30,18 @@ final class AddEditCouponViewModel: ObservableObject {
         }
     }
 
+    /// Defines the main action button text that should be shown.
+    /// Switching between `Create` or `Save` action.
+    ///
+    var addEditCouponButtonText: String {
+        switch editingOption {
+        case .creation:
+            return Localization.createButton
+        case .editing:
+            return Localization.saveButton
+        }
+    }
+
     /// The value for populating the coupon discount type field based on the `discountType`.
     ///
     var discountTypeValue: TitleAndValueRow.Value {
@@ -127,7 +140,12 @@ final class AddEditCouponViewModel: ObservableObject {
         categoryIDs.isNotEmpty
     }
 
+    var shareCouponMessage: String {
+        coupon?.generateShareMessage(currencySettings: currencySettings) ?? ""
+    }
+
     var hasChangesMade: Bool {
+        guard editingOption == .editing else { return true }
         let coupon = populatedCoupon
         return checkDiscountTypeUpdated(for: coupon) ||
         checkAmountUpdated(for: coupon) ||
@@ -142,6 +160,7 @@ final class AddEditCouponViewModel: ObservableObject {
     private(set) var coupon: Coupon?
     private let stores: StoresManager
     private let storageManager: StorageManagerType
+    private let currencySettings: CurrencySettings
     let timezone: TimeZone
 
     /// When the view is updating or creating a new Coupon remotely.
@@ -162,22 +181,25 @@ final class AddEditCouponViewModel: ObservableObject {
     @Published var couponRestrictionsViewModel: CouponRestrictionsViewModel
     @Published var productOrVariationIDs: [Int64]
     @Published var categoryIDs: [Int64]
+    @Published var showingCouponCreationSuccess: Bool = false
 
     /// Init method for coupon creation
     ///
     init(siteID: Int64,
          discountType: Coupon.DiscountType,
          stores: StoresManager = ServiceLocator.stores,
          storageManager: StorageManagerType = ServiceLocator.storageManager,
+         currencySettings: CurrencySettings = ServiceLocator.currencySettings,
          timezone: TimeZone = .siteTimezone,
-         onCompletion: @escaping ((Result<Coupon, Error>) -> Void)) {
+         onSuccess: @escaping (Coupon) -> Void) {
         self.siteID = siteID
         editingOption = .creation
         self.discountType = discountType
         self.stores = stores
         self.storageManager = storageManager
+        self.currencySettings = currencySettings
         self.timezone = timezone
-        self.onCompletion = onCompletion
+        self.onSuccess = onSuccess
 
         amountField = String()
         codeField = String()
@@ -187,23 +209,26 @@ final class AddEditCouponViewModel: ObservableObject {
         couponRestrictionsViewModel = CouponRestrictionsViewModel(siteID: siteID)
         productOrVariationIDs = []
         categoryIDs = []
+        generateRandomCouponCode()
     }
 
     /// Init method for coupon editing
     ///
     init(existingCoupon: Coupon,
          stores: StoresManager = ServiceLocator.stores,
          storageManager: StorageManagerType = ServiceLocator.storageManager,
+         currencySettings: CurrencySettings = ServiceLocator.currencySettings,
          timezone: TimeZone = .siteTimezone,
-         onCompletion: @escaping ((Result<Coupon, Error>) -> Void)) {
+         onSuccess: @escaping (Coupon) -> Void) {
         siteID = existingCoupon.siteID
         coupon = existingCoupon
         editingOption = .editing
         discountType = existingCoupon.discountType
         self.stores = stores
         self.storageManager = storageManager
+        self.currencySettings = currencySettings
         self.timezone = timezone
-        self.onCompletion = onCompletion
+        self.onSuccess = onSuccess
 
         // Populate fields
         amountField = existingCoupon.amount
@@ -233,13 +258,50 @@ final class AddEditCouponViewModel: ObservableObject {
         codeField = code
     }
 
-    func updateCoupon(coupon: Coupon, onUpdateFinished: @escaping () -> Void) {
+    func completeCouponAddEdit(coupon: Coupon, onUpdateFinished: @escaping () -> Void) {
+        switch editingOption {
+        case .creation:
+            createCoupon(coupon: coupon)
+        case .editing:
+            updateCoupon(coupon: coupon, onUpdateFinished: onUpdateFinished)
+        }
+    }
+
+    private func createCoupon(coupon: Coupon) {
+        trackCouponCreateInitiated(with: coupon)
+
+        if let validationError = validateCouponLocally(coupon) {
+            notice = NoticeFactory.createCouponErrorNotice(validationError,
+                    editingOption: editingOption)
+            return
+        }
+
+        isLoading = true
+        let action = CouponAction.createCoupon(coupon, siteTimezone: timezone) { [weak self] result in
+            guard let self = self else { return }
+            self.isLoading = false
+            switch result {
+            case .success(let coupon):
+                ServiceLocator.analytics.track(.couponCreationSuccess)
+                self.coupon = coupon
+                self.onSuccess(coupon)
+                self.showingCouponCreationSuccess = true
+            case .failure(let error):
+                DDLogError("⛔️ Error creating the coupon: \(error)")
+                ServiceLocator.analytics.track(.couponCreationFailed, withError: error)
+                self.notice = NoticeFactory.createCouponErrorNotice(.other(error: error),
+                        editingOption: self.editingOption)
+            }
+        }
+        stores.dispatch(action)
+    }
+
+    private func updateCoupon(coupon: Coupon, onUpdateFinished: @escaping () -> Void) {
         trackCouponUpdateInitiated(with: coupon)
 
         if let validationError = validateCouponLocally(coupon) {
             notice = NoticeFactory.createCouponErrorNotice(validationError,
                                                            editingOption: editingOption)
-            onCompletion(.failure(validationError))
             return
         }
 
@@ -248,9 +310,9 @@ final class AddEditCouponViewModel: ObservableObject {
             guard let self = self else { return }
             self.isLoading = false
             switch result {
-            case .success(_):
+            case .success(let updatedCoupon):
                 ServiceLocator.analytics.track(.couponUpdateSuccess)
-                self.onCompletion(result)
+                self.onSuccess(updatedCoupon)
                 onUpdateFinished()
             case .failure(let error):
                 DDLogError("⛔️ Error updating the coupon: \(error)")
@@ -329,6 +391,19 @@ private extension AddEditCouponViewModel {
         return coupon.discountType != initialCoupon.discountType
     }
 
+    func checkUsageRestrictionsOnCreation(of coupon: Coupon) -> Bool {
+        coupon.maximumAmount.isNotEmpty ||
+        coupon.minimumAmount.isNotEmpty ||
+        (coupon.usageLimit ?? 0) > 0 ||
+        (coupon.usageLimitPerUser ?? 0) > 0 ||
+        (coupon.limitUsageToXItems ?? 0) > 0 ||
+        coupon.emailRestrictions.isNotEmpty ||
+        coupon.individualUse ||
+        coupon.excludeSaleItems ||
+        coupon.excludedProductIds.isNotEmpty ||
+        coupon.excludedProductCategories.isNotEmpty
+    }
+
     func checkUsageRestrictionsUpdated(for coupon: Coupon) -> Bool {
         guard let initialCoupon = self.coupon else {
             return false
@@ -396,6 +471,17 @@ private extension AddEditCouponViewModel {
         return coupon.freeShipping != initialCoupon.freeShipping
     }
 
+    func trackCouponCreateInitiated(with coupon: Coupon) {
+        ServiceLocator.analytics.track(.couponCreationInitiated, withProperties: [
+            "discount_type": coupon.discountType.rawValue,
+            "has_expiry_date": coupon.dateExpires != nil,
+            "includes_free_shipping": coupon.freeShipping,
+            "has_description": coupon.description.isNotEmpty,
+            "has_product_or_category_restrictions": coupon.excludedProductCategories.isNotEmpty || coupon.excludedProductIds.isNotEmpty,
+            "has_usage_restrictions": checkUsageRestrictionsOnCreation(of: coupon)
+        ])
+    }
+
     func trackCouponUpdateInitiated(with coupon: Coupon) {
         ServiceLocator.analytics.track(.couponUpdateInitiated, withProperties: [
             "discount_type_updated": checkDiscountTypeUpdated(for: coupon),
@@ -474,5 +560,7 @@ private extension AddEditCouponViewModel {
             "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")
+        static let saveButton = NSLocalizedString("Save", comment: "Action for saving a Coupon remotely")
+        static let createButton = NSLocalizedString("Create", comment: "Action for creating a Coupon remotely")
     }
 }

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

@@ -54,6 +54,9 @@ struct CouponCreationSuccess: View {
         .onAppear {
             animateEntry()
         }
+        .onDisappear {
+            onDismiss()
+        }
     }
 
     private func animateEntry() {

WooCommerce/Classes/ViewRelated/Coupons/CouponDetails/CouponDetailsViewModel.swift

@@ -97,13 +97,7 @@ final class CouponDetailsViewModel: ObservableObject {
     /// The message to be shared about the coupon
     ///
     var shareMessage: String {
-        if coupon.productIds.isNotEmpty ||
-            coupon.productCategories.isNotEmpty ||
-            coupon.excludedProductIds.isNotEmpty ||
-            coupon.excludedProductCategories.isNotEmpty {
-            return String.localizedStringWithFormat(Localization.shareMessageSomeProducts, amount, couponCode)
-        }
-        return String.localizedStringWithFormat(Localization.shareMessageAllProducts, amount, couponCode)
+        coupon.generateShareMessage(currencySettings: currencySettings)
     }
 
     /// Total number of orders that applied the coupon
@@ -286,15 +280,10 @@ private extension CouponDetailsViewModel {
     }
 
     func createAddEditCouponViewModel(with coupon: Coupon) -> AddEditCouponViewModel {
-        .init(existingCoupon: coupon, onCompletion: { [weak self] result in
+        .init(existingCoupon: coupon, onSuccess: { [weak self] updatedCoupon in
             guard let self = self else { return }
-            switch result {
-            case .success(let updatedCoupon):
-                self.updateCoupon(updatedCoupon)
-                self.onUpdate()
-            default:
-                break
-            }
+            self.updateCoupon(updatedCoupon)
+            self.onUpdate()
         })
     }
 }
@@ -305,14 +294,4 @@ private extension CouponDetailsViewModel {
     enum Constants {
         static let noLimit: Int64 = -1
     }
-    enum Localization {
-        static let shareMessageAllProducts = NSLocalizedString(
-            "Apply %1$@ off to all products with the promo code “%2$@”.",
-            comment: "Message to share the coupon code if it is applicable to all products. " +
-            "Reads like: Apply 10% off to all products with the promo code “20OFF”.")
-        static let shareMessageSomeProducts = NSLocalizedString(
-            "Apply %1$@ off to some products with the promo code “%2$@”.",
-            comment: "Message to share the coupon code if it is applicable to some products. " +
-            "Reads like: Apply 10% off to some products with the promo code “20OFF”.")
-    }
 }