Merge branch 'trunk' into issue/5829-ReviewsViewController-tests

Author: Sharma Elanthiriayan

WooCommerce/Classes/ViewRelated/Coupons/CouponListViewController.swift

@@ -10,6 +10,14 @@ final class CouponListViewController: UIViewController {
     ///
     private var emptyStateViewController: UIViewController?
 
+    /// Pull To Refresh Support.
+    ///
+    private lazy var refreshControl: UIRefreshControl = {
+        let refreshControl = UIRefreshControl()
+        refreshControl.addTarget(self, action: #selector(refreshCouponList), for: .valueChanged)
+        return refreshControl
+    }()
+
     private var subscriptions: Set<AnyCancellable> = []
 
     init(siteID: Int64) {
@@ -33,15 +41,16 @@ final class CouponListViewController: UIViewController {
             .removeDuplicates()
             .sink { [weak self] state in
                 guard let self = self else { return }
-                self.removeNoResultsOverlay()
-                self.removePlaceholderCoupons()
+                self.resetViews()
                 switch state {
                 case .empty:
                     self.displayNoResultsOverlay()
                 case .loading:
                     self.displayPlaceholderCoupons()
                 case .coupons:
                     self.tableView.reloadData()
+                case .refreshing:
+                    self.refreshControl.beginRefreshing()
                 case .initialized:
                     break
                 }
@@ -53,6 +62,25 @@ final class CouponListViewController: UIViewController {
     }
 }
 
+// MARK: - Actions
+private extension CouponListViewController {
+    /// Triggers a refresh for the coupon list
+    ///
+    @objc func refreshCouponList() {
+        viewModel.refreshCoupons()
+    }
+
+    /// Removes overlays and loading indicators if present.
+    ///
+    func resetViews() {
+        removeNoResultsOverlay()
+        removePlaceholderCoupons()
+        if refreshControl.isRefreshing {
+            refreshControl.endRefreshing()
+        }
+    }
+}
+
 
 // MARK: - View Configuration
 //
@@ -66,6 +94,7 @@ private extension CouponListViewController {
         tableView.dataSource = self
         tableView.estimatedRowHeight = Constants.estimatedRowHeight
         tableView.rowHeight = UITableView.automaticDimension
+        tableView.addSubview(refreshControl)
     }
 
     func registerTableViewCells() {

WooCommerce/Classes/ViewRelated/Coupons/CouponManagementListViewModel.swift

@@ -15,6 +15,7 @@ enum CouponListState {
     case loading // View should show ghost cells
     case empty // View should display the empty state
     case coupons // View should display the contents of `couponViewModels`
+    case refreshing // View should display the refresh control
 }
 
 final class CouponListViewModel {
@@ -116,6 +117,12 @@ final class CouponListViewModel {
     func coupon(at indexPath: IndexPath) -> Coupon? {
         return resultsController.safeObject(at: indexPath)
     }
+
+    /// Triggers a refresh of loaded coupons
+    ///
+    func refreshCoupons() {
+        syncingCoordinator.resynchronize(reason: nil, onCompletion: nil)
+    }
 }
 
 
@@ -133,7 +140,7 @@ extension CouponListViewModel: SyncingCoordinatorDelegate {
               pageSize: Int,
               reason: String?,
               onCompletion: ((Bool) -> Void)?) {
-        transitionToSyncingState(pageNumber: pageNumber)
+        transitionToSyncingState(pageNumber: pageNumber, hasData: couponViewModels.isNotEmpty)
         let action = CouponAction
             .synchronizeCoupons(siteID: siteID,
                                 pageNumber: pageNumber,
@@ -162,9 +169,9 @@ extension CouponListViewModel: SyncingCoordinatorDelegate {
 // MARK: - Pagination
 //
 private extension CouponListViewModel {
-    func transitionToSyncingState(pageNumber: Int) {
+    func transitionToSyncingState(pageNumber: Int, hasData: Bool) {
         if pageNumber == 1 {
-            state = .loading
+            state = hasData ? .refreshing : .loading
         }
     }
 

WooCommerce/Classes/ViewRelated/Dashboard/Stats v4/StoreStatsAndTopPerformersPeriodViewController.swift

@@ -189,10 +189,15 @@ extension StoreStatsAndTopPerformersPeriodViewController {
         topPerformersPeriodViewController.displayGhostContent()
     }
 
-    /// Unlocks the and removes the Placeholder Content
+    /// Removes the placeholder content for store stats.
     ///
-    func removeGhostContent() {
+    func removeStoreStatsGhostContent() {
         storeStatsPeriodViewController.removeGhostContent()
+    }
+
+    /// Removes the placeholder content for top performers.
+    ///
+    func removeTopPerformersGhostContent() {
         topPerformersPeriodViewController.removeGhostContent()
     }
 

WooCommerce/Classes/ViewRelated/Dashboard/Stats v4/StoreStatsAndTopPerformersViewController.swift

@@ -110,7 +110,6 @@ private extension StoreStatsAndTopPerformersViewController {
         defer {
             group.notify(queue: .main) { [weak self] in
                 self?.isSyncing = false
-                self?.removeGhostContent()
                 self?.showSpinner(shouldShowSpinner: false)
                 if let error = syncError {
                     DDLogError("⛔️ Error loading dashboard: \(error)")
@@ -151,8 +150,12 @@ private extension StoreStatsAndTopPerformersViewController {
             // For tasks dispatched for each time period.
             let periodGroup = DispatchGroup()
 
+            // For tasks dispatched for store stats (order and visitor stats) for each time period.
+            let periodStoreStatsGroup = DispatchGroup()
+
             group.enter()
             periodGroup.enter()
+            periodStoreStatsGroup.enter()
             self.syncStats(for: siteID,
                            siteTimezone: timezoneForSync,
                            timeRange: vc.timeRange,
@@ -166,10 +169,12 @@ private extension StoreStatsAndTopPerformersViewController {
                 }
                 group.leave()
                 periodGroup.leave()
+                periodStoreStatsGroup.leave()
             }
 
             group.enter()
             periodGroup.enter()
+            periodStoreStatsGroup.enter()
             self.syncSiteVisitStats(for: siteID,
                                     siteTimezone: timezoneForSync,
                                     timeRange: vc.timeRange,
@@ -180,6 +185,7 @@ private extension StoreStatsAndTopPerformersViewController {
                 }
                 group.leave()
                 periodGroup.leave()
+                periodStoreStatsGroup.leave()
             }
 
             group.enter()
@@ -194,6 +200,8 @@ private extension StoreStatsAndTopPerformersViewController {
                 }
                 group.leave()
                 periodGroup.leave()
+
+                vc.removeTopPerformersGhostContent()
             }
 
             periodGroup.notify(queue: .main) {
@@ -204,6 +212,10 @@ private extension StoreStatsAndTopPerformersViewController {
                     syncError = periodSyncError
                 }
             }
+
+            periodStoreStatsGroup.notify(queue: .main) {
+                vc.removeStoreStatsGhostContent()
+            }
         }
     }
 
@@ -225,27 +237,12 @@ private extension StoreStatsAndTopPerformersViewController {
     /// Displays the Ghost Placeholder whenever there is no visible data.
     ///
     func ensureGhostContentIsDisplayed() {
-        guard visibleChildViewController.shouldDisplayStoreStatsGhostContent else {
-            return
+        periodVCs.forEach { periodVC in
+            guard periodVC.shouldDisplayStoreStatsGhostContent else {
+                return
+            }
+            periodVC.displayGhostContent()
         }
-
-        displayGhostContent()
-    }
-
-    /// Locks UI Interaction and displays Ghost Placeholder animations.
-    ///
-    func displayGhostContent() {
-        view.isUserInteractionEnabled = false
-        buttonBarView.startGhostAnimation(style: .wooDefaultGhostStyle)
-        visibleChildViewController.displayGhostContent()
-    }
-
-    /// Unlocks the and removes the Placeholder Content
-    ///
-    func removeGhostContent() {
-        view.isUserInteractionEnabled = true
-        buttonBarView.stopGhostAnimation()
-        visibleChildViewController.removeGhostContent()
     }
 
     /// If the Ghost Content was previously onscreen, this method will restart the animations.

WooCommerce/Classes/ViewRelated/Dashboard/Stats v4/StoreStatsV4PeriodViewController.swift

@@ -1,6 +1,7 @@
 import Charts
 import Combine
 import UIKit
+import struct WordPressUI.GhostStyle
 import Yosemite
 
 /// Different display modes of site visit stats
@@ -160,6 +161,13 @@ final class StoreStatsV4PeriodViewController: UIViewController {
         observeReloadChartAnimated()
     }
 
+    override func viewWillAppear(_ animated: Bool) {
+        super.viewWillAppear(animated)
+
+        // After returning to the My Store tab, `restartGhostAnimation` is required to resume ghost animation.
+        restartGhostAnimationIfNeeded()
+    }
+
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
         reloadAllFields()
@@ -243,7 +251,7 @@ extension StoreStatsV4PeriodViewController {
     ///
     func displayGhostContent() {
         ensurePlaceholderIsVisible()
-        placeholderChartsView.startGhostAnimation(style: .wooDefaultGhostStyle)
+        placeholderChartsView.startGhostAnimation(style: Constants.ghostStyle)
     }
 
     /// Removes the Placeholder Content.
@@ -267,6 +275,12 @@ extension StoreStatsV4PeriodViewController {
         view.pinSubviewToAllEdges(placeholderChartsView)
     }
 
+    private func restartGhostAnimationIfNeeded() {
+        guard placeholderChartsView.superview != nil else {
+            return
+        }
+        placeholderChartsView.restartGhostAnimation(style: Constants.ghostStyle)
+    }
 }
 
 // MARK: - Configuration
@@ -748,5 +762,7 @@ private extension StoreStatsV4PeriodViewController {
 
         static let containerBackgroundColor: UIColor = .systemBackground
         static let headerComponentBackgroundColor: UIColor = .clear
+
+        static let ghostStyle: GhostStyle = .wooDefaultGhostStyle
     }
 }

WooCommerce/Classes/ViewRelated/Orders/OrderListViewController.swift

@@ -158,6 +158,8 @@ final class OrderListViewController: UIViewController {
         //
         // We can remove this once we've replaced XLPagerTabStrip.
         tableView.reloadData()
+
+        restartPlaceholderAnimation()
     }
 
     /// Returns a function that creates cells for `dataSource`.
@@ -410,7 +412,7 @@ private extension OrderListViewController {
         // let's reset the state before using it again
         ghostableTableView.removeGhostContent()
         ghostableTableView.displayGhostContent(options: options,
-                                               style: .wooDefaultGhostStyle)
+                                               style: Constants.ghostStyle)
         ghostableTableView.startGhostAnimation()
         ghostableTableView.isHidden = false
     }
@@ -423,6 +425,14 @@ private extension OrderListViewController {
         ghostableTableView.removeGhostContent()
     }
 
+    /// After returning to the screen, `restartGhostAnimation` is required to resume ghost animation.
+    func restartPlaceholderAnimation() {
+        guard ghostableTableView.isHidden == false else {
+            return
+        }
+        ghostableTableView.restartGhostAnimation(style: Constants.ghostStyle)
+    }
+
     /// Shows the EmptyStateViewController
     ///
     func displayEmptyViewController() {
@@ -675,4 +685,8 @@ private extension OrderListViewController {
         case results
         case empty
     }
+
+    enum Constants {
+        static let ghostStyle: GhostStyle = .wooDefaultGhostStyle
+    }
 }

WooCommerce/WooCommerceTests/ViewRelated/Coupons/CouponListViewModelTests.swift

@@ -111,4 +111,38 @@ final class CouponListViewModelTests: XCTestCase {
         // Then
         XCTAssertEqual(sut.state, .empty)
     }
+
+    func test_refreshCoupon_updates_state_to_refreshing() {
+        // Given
+        setUpWithCouponFetched() // we need to have existing data to enter refreshing state
+
+        // When
+        sut.refreshCoupons()
+
+        // Then
+        XCTAssertEqual(sut.state, .refreshing)
+    }
+
+    func test_refreshCoupons_calls_resynchronize_on_syncCoordinator() {
+        // Given
+        sut = CouponListViewModel(siteID: 123, syncingCoordinator: mockSyncingCoordinator)
+
+        // When
+        sut.refreshCoupons()
+
+        // Then
+        XCTAssert(mockSyncingCoordinator.spyDidCallResynchronize)
+    }
+
+    func test_handleCouponSyncResult_removes_refreshing_when_refresh_completes() {
+        // Given
+        setUpWithCouponFetched()
+        sut.refreshCoupons()
+
+        // When
+        sut.handleCouponSyncResult(result: .success(false))
+
+        // Then
+        XCTAssertEqual(sut.state, .coupons)
+    }
 }