Merge pull request #6553 from woocommerce/issue/6523-remove-code-duplication-product-reviews-data-source

Remove code duplication in reviews data source

Author: toupper

RELEASE-NOTES.txt

@@ -1,5 +1,9 @@
 *** PLEASE FOLLOW THIS FORMAT: [<priority indicator, more stars = higher priority>] <description> [<PR URL>]
 
+9.0
+-----
+- [internal] Reviews lists on Products and Menu tabs are refactored to avoid duplicated code. Please quickly smoke test them to make sure that everything still works as before. [https://github.com/woocommerce/woocommerce-ios/pull/6553]
+
 8.9
 -----
 - [*] Coupons: Fixed issue loading the coupon list from the local storage on initial load. [https://github.com/woocommerce/woocommerce-ios/pull/6463]

WooCommerce/Classes/ViewRelated/Products/Edit Product/Reviews/ProductReviewsDataSource.swift

@@ -9,7 +9,7 @@ final class ProductReviewsViewController: UIViewController, GhostableViewControl
     private let viewModel: ProductReviewsViewModel
 
     lazy var ghostTableViewController = GhostTableViewController(options: GhostTableViewOptions(cellClass: ProductReviewTableViewCell.self,
-                                                                                                estimatedRowHeight: ProductReviewsDataSource
+                                                                                                estimatedRowHeight: DefaultReviewsDataSource
                                                                                                                     .Settings
                                                                                                                     .estimatedRowHeight))
 
@@ -60,7 +60,9 @@ final class ProductReviewsViewController: UIViewController, GhostableViewControl
     // MARK: - View Lifecycle
     init(product: Product) {
         self.product = product
-        viewModel = ProductReviewsViewModel(siteID: product.siteID, data: ProductReviewsDataSource(product: product))
+        viewModel = ProductReviewsViewModel(siteID: product.siteID,
+                                            data: DefaultReviewsDataSource(siteID: product.siteID,
+                                                                           customizer: ProductReviewsDataSourceCustomizer(product: product)))
         super.init(nibName: type(of: self).nibName, bundle: nil)
     }
 

WooCommerce/Classes/ViewRelated/Products/Edit Product/Reviews/ProductReviewsViewController.swift

@@ -100,3 +100,21 @@ private extension ProductReviewsViewModel {
         static let pageSize = 25
     }
 }
+
+/// Customizes the `ReviewsDataSource` for a product related reviews screen (only the reviews of the passed product)
+final class ProductReviewsDataSourceCustomizer: ReviewsDataSourceCustomizing {
+    let shouldShowProductTitleOnCells = false
+    private let product: Product
+
+    init(product: Product) {
+        self.product = product
+    }
+
+    func reviewsFilterPredicate(with sitePredicate: NSPredicate) -> NSPredicate {
+        let statusPredicate = NSPredicate(format: "statusKey ==[c] %@ AND productID == %lld",
+                                          ProductReviewStatus.approved.rawValue,
+                                          product.productID)
+
+        return  NSCompoundPredicate(andPredicateWithSubpredicates: [sitePredicate, statusPredicate])
+    }
+}

WooCommerce/Classes/ViewRelated/Products/Edit Product/Reviews/ProductReviewsViewModel.swift

@@ -12,6 +12,9 @@ final class DefaultReviewsDataSource: NSObject, ReviewsDataSource {
 
     private let siteID: Int64
 
+    /// Adds an extra layer of logic customization depending on the case (e.g only reviews of a specific product, global site reviews...)
+    private let customizer: ReviewsDataSourceCustomizing
+
     /// Product Reviews
     ///
     private lazy var reviewsResultsController: ResultsController<StorageProductReview> = {
@@ -20,7 +23,7 @@ final class DefaultReviewsDataSource: NSObject, ReviewsDataSource {
 
         return ResultsController<StorageProductReview>(storageManager: storageManager,
                                                        sectionNameKeyPath: "normalizedAgeAsString",
-                                                       matching: filterPredicate(),
+                                                       matching: customizer.reviewsFilterPredicate(with: sitePredicate()),
                                                        sortedBy: [descriptor])
     }()
 
@@ -78,9 +81,9 @@ final class DefaultReviewsDataSource: NSObject, ReviewsDataSource {
         return reviewsResultsController.numberOfObjects
     }
 
-
-    init(siteID: Int64) {
+    init(siteID: Int64, customizer: ReviewsDataSourceCustomizing) {
         self.siteID = siteID
+        self.customizer = customizer
         super.init()
         observeResults()
     }
@@ -131,8 +134,9 @@ final class DefaultReviewsDataSource: NSObject, ReviewsDataSource {
     }
 
     func refreshDataObservers() {
-        reviewsResultsController.predicate = filterPredicate()
-        productsResultsController.predicate = sitePredicate()
+        let sitePredicate = sitePredicate()
+        reviewsResultsController.predicate = customizer.reviewsFilterPredicate(with: sitePredicate)
+        productsResultsController.predicate = sitePredicate
     }
 }
 
@@ -179,7 +183,7 @@ private extension DefaultReviewsDataSource {
         let reviewProduct = product(id: review.productID)
         let note = notification(id: review.reviewID)
 
-        return ReviewViewModel(review: review, product: reviewProduct, notification: note)
+        return ReviewViewModel(showProductTitle: customizer.shouldShowProductTitleOnCells, review: review, product: reviewProduct, notification: note)
     }
 
     private func product(id productID: Int64) -> Product? {
@@ -237,7 +241,7 @@ extension DefaultReviewsDataSource: ReviewsInteractionDelegate {
 }
 
 
-private extension DefaultReviewsDataSource {
+extension DefaultReviewsDataSource {
     enum Settings {
         static let estimatedRowHeight = CGFloat(88)
     }

WooCommerce/Classes/ViewRelated/Reviews/DefaultReviewsDataSource.swift

@@ -15,10 +15,22 @@ protocol ReviewsInteractionDelegate: UITableViewDelegate {
     func tableView(_ tableView: UITableView, willDisplay cell: UITableViewCell, forRowAt indexPath: IndexPath, with syncingCoordinator: SyncingCoordinator)
 }
 
+/// Implement this protocol to add an extra layer of customization to the the
+/// ReviewsDataSource
+protocol ReviewsDataSourceCustomizing: AnyObject {
+    /// Whether it should show the product title on cell or not
+    ///
+    var shouldShowProductTitleOnCells: Bool { get }
+
+    /// Implement this method to return the predicate that will provide reviews.
+    ///
+    /// - parameter sitePredicate: This predicate adds a site constraint. By composing your predicate with it you will retrieve only reviews of that site.
+    ///
+    func reviewsFilterPredicate(with sitePredicate: NSPredicate) -> NSPredicate
+}
 
 /// Abstracts the dataSource used to render the Product Review list
 protocol ReviewsDataSource: UITableViewDataSource, ReviewsInteractionDelegate {
-
     /// Boolean indicating if there are reviews
     ///
     var isEmpty: Bool { get }

WooCommerce/Classes/ViewRelated/Reviews/ReviewsDataSource.swift

@@ -117,7 +117,8 @@ final class ReviewsViewController: UIViewController, GhostableViewController {
     //
     convenience init(siteID: Int64) {
         self.init(viewModel: ReviewsViewModel(siteID: siteID,
-                                              data: DefaultReviewsDataSource(siteID: siteID)))
+                                              data: DefaultReviewsDataSource(siteID: siteID,
+                                                                             customizer: GlobalReviewsDataSourceCustomizer())))
     }
 
     init(viewModel: ViewModel) {

WooCommerce/Classes/ViewRelated/Reviews/ReviewsViewController.swift

@@ -244,3 +244,17 @@ private extension ReviewsViewModel {
         static let section = "notifications"
     }
 }
+
+/// Customizes the `ReviewsDataSource` for a global reviews query (all of a site)
+final class GlobalReviewsDataSourceCustomizer: ReviewsDataSourceCustomizing {
+    let shouldShowProductTitleOnCells = true
+
+    func reviewsFilterPredicate(with sitePredicate: NSPredicate) -> NSPredicate {
+        let statusPredicate = NSPredicate(format: "statusKey ==[c] %@ OR statusKey ==[c] %@",
+                                          ProductReviewStatus.approved.rawValue,
+                                          ProductReviewStatus.hold.rawValue)
+
+        return  NSCompoundPredicate(andPredicateWithSubpredicates: [sitePredicate, statusPredicate])
+
+    }
+}