Merge pull request #427 from woocommerce/issue/nuking-note-viewmodel

Deprecating OrderNoteViewModel

Author: jleandroperez

WooCommerce/Classes/Extensions/Date+Woo.swift

@@ -0,0 +1,17 @@
+import Foundation
+
+
+// MARK: - Date Extensions
+//
+extension Date {
+
+    /// Returns the String Representation of the receiver, with the specified Date + Time Styles applied.
+    ///
+    func toString(dateStyle: DateFormatter.Style, timeStyle: DateFormatter.Style) -> String {
+        let formatter = DateFormatter()
+        formatter.dateStyle = dateStyle
+        formatter.timeStyle = timeStyle
+
+        return formatter.string(from: self)
+    }
+}

WooCommerce/Classes/Extensions/Date+Helpers.swift renamed to WooCommerce/Classes/Extensions/DateFormatter+Helpers.swift

@@ -48,5 +48,4 @@ extension DateFormatter {
             return formatter
         }()
     }
-
 }

WooCommerce/Classes/ViewModels/OrderNoteViewModel.swift

@@ -8,42 +8,53 @@ import CocoaLumberjack
 
 class OrderDetailsViewController: UIViewController {
 
-    // MARK: - Properties
-
+    /// Main TableView.
+    ///
     @IBOutlet weak var tableView: UITableView!
-    var viewModel: OrderDetailsViewModel! {
-        didSet {
-            reloadSections()
-            reloadTableViewIfPossible()
-        }
-    }
 
+    /// Pull To Refresh Support.
+    ///
     private lazy var refreshControl: UIRefreshControl = {
         let refreshControl = UIRefreshControl()
         refreshControl.addTarget(self, action: #selector(pullToRefresh), for: .valueChanged)
         return refreshControl
     }()
 
-    private var orderNotes: [OrderNoteViewModel] = [] {
-        didSet {
-            reloadSections()
-            reloadTableViewIfPossible()
-        }
-    }
-
+    /// Indicates if the Billing details should be rendered.
+    ///
     private var displaysBillingDetails = false {
         didSet {
             reloadSections()
         }
     }
-    private var sections = [Section]()
 
     /// EntityListener: Update / Deletion Notifications.
     ///
     private lazy var entityListener: EntityListener<Order> = {
         return EntityListener(storageManager: AppDelegate.shared.storageManager, readOnlyEntity: viewModel.order)
     }()
 
+    /// Sections to be rendered
+    ///
+    private var sections = [Section]()
+
+    /// Order to be rendered!
+    ///
+    var viewModel: OrderDetailsViewModel! {
+        didSet {
+            reloadSections()
+            reloadTableViewIfPossible()
+        }
+    }
+
+    /// Order Notes
+    ///
+    private var orderNotes: [OrderNote] = [] {
+        didSet {
+            reloadSections()
+            reloadTableViewIfPossible()
+        }
+    }
 
 
     // MARK: - View Lifecycle
@@ -61,11 +72,6 @@ class OrderDetailsViewController: UIViewController {
         super.viewWillAppear(animated)
         syncNotes()
     }
-
-    override func viewWillDisappear(_ animated: Bool) {
-        super.viewWillDisappear(animated)
-        self.navigationController?.isNavigationBarHidden = false
-    }
 }
 
 
@@ -101,6 +107,7 @@ private extension OrderDetailsViewController {
             guard let `self` = self else {
                 return
             }
+
             self.viewModel = OrderDetailsViewModel(order: order)
         }
 
@@ -360,11 +367,9 @@ private extension OrderDetailsViewController {
             return
         }
 
-        cell.iconButton.setImage(note.iconImage, for: .normal)
-        cell.iconButton.backgroundColor = note.iconColor
-        cell.dateCreated = note.formattedDateCreated
-        cell.statusText = note.statusText
-        cell.contents = note.contents
+        cell.isCustomerNote = note.isCustomerNote
+        cell.dateCreated = note.dateCreated.toString(dateStyle: .medium, timeStyle: .short)
+        cell.contents = note.note
     }
 
     func configurePayment(cell: PaymentTableViewCell) {
@@ -434,7 +439,7 @@ private extension OrderDetailsViewController {
 
     // MARK: - Get order note
     //
-    func note(at indexPath: IndexPath) -> OrderNoteViewModel? {
+    func note(at indexPath: IndexPath) -> OrderNote? {
         // We need to subtract 1 here because the first order note row is the "Add Order" cell
         let noteIndex = indexPath.row - 1
         guard orderNotes.indices.contains(noteIndex) else {
@@ -474,7 +479,7 @@ private extension OrderDetailsViewController {
                 return
             }
 
-            self?.orderNotes = orderNotes.map { OrderNoteViewModel(with: $0) }
+            self?.orderNotes = orderNotes
             WooAnalytics.shared.track(.orderNotesLoaded, withProperties: ["id": self?.viewModel.order.orderID ?? 0])
             onCompletion?(nil)
         }
@@ -526,7 +531,7 @@ extension OrderDetailsViewController: UITableViewDataSource {
     func tableView(_ tableView: UITableView, heightForHeaderInSection section: Int) -> CGFloat {
         if sections[section].title == nil {
             // iOS 11 table bug. Must return a tiny value to collapse `nil` or `empty` section headers.
-            return CGFloat.leastNonzeroMagnitude
+            return .leastNonzeroMagnitude
         }
 
         return UITableView.automaticDimension
@@ -548,18 +553,13 @@ extension OrderDetailsViewController: UITableViewDataSource {
     }
 
     func tableView(_ tableView: UITableView, heightForFooterInSection section: Int) -> CGFloat {
-        // Give the table some breathing room
-        let lastSection = sections.count - 1
-        if section == lastSection {
-            return UITableView.automaticDimension
-        }
+        let lastSectionIndex = sections.count - 1
 
-        guard let _ = sections[section].footer else {
-            // iOS 11 table bug. Must return a tiny value to collapse `nil` or `empty` section footers.
-            return CGFloat.leastNonzeroMagnitude
+        if sections[section].footer != nil || section == lastSectionIndex {
+            return UITableView.automaticDimension
         }
 
-        return UITableView.automaticDimension
+        return .leastNonzeroMagnitude
     }
 
     func tableView(_ tableView: UITableView, viewForFooterInSection section: Int) -> UIView? {

WooCommerce/Classes/ViewRelated/Orders/OrderDetails/OrderDetailsViewController.swift

@@ -1,25 +1,41 @@
 import UIKit
+import Gridicons
 
-class OrderNoteTableViewCell: UITableViewCell {
-    override func awakeFromNib() {
-        super.awakeFromNib()
 
-        dateLabel.applyBodyStyle()
-        statusLabel.applyBodyStyle()
-        noteLabel.applyBodyStyle()
-
-        statusLabel.textColor = StyleManager.wooGreyMid
-        iconButton.layer.cornerRadius = iconButton.frame.width / 2
-        iconButton.tintColor = .white
-    }
+// MARK: - OrderNoteTableViewCell
+//
+class OrderNoteTableViewCell: UITableViewCell {
 
-    @IBOutlet public var iconButton: UIButton!
+    /// Top Left Icon
+    ///
+    @IBOutlet private var iconButton: UIButton!
 
+    /// Top Right Label
+    ///
     @IBOutlet private var dateLabel: UILabel!
+
+    /// Secondary Top Label
+    ///
     @IBOutlet private var statusLabel: UILabel!
+
+    /// Bottom Label
+    ///
     @IBOutlet private var noteLabel: UILabel!
 
-    public var dateCreated: String? {
+
+    // MARK: - View Lifecycle
+
+    override func awakeFromNib() {
+        super.awakeFromNib()
+
+        configureLabels()
+        configureIconButton()
+    }
+
+
+    /// Date of Creation: To be displayed at the top of the cell
+    ///
+    var dateCreated: String? {
         get {
             return dateLabel.text
         }
@@ -28,21 +44,57 @@ class OrderNoteTableViewCell: UITableViewCell {
         }
     }
 
-    public var statusText: String? {
+    /// Note's Payload
+    ///
+    var contents: String? {
         get {
-            return statusLabel.text
+            return noteLabel.text
         }
         set {
-            statusLabel.text = newValue
+            noteLabel.text = newValue
         }
     }
 
-    public var contents: String? {
-        get {
-            return noteLabel.text
+    /// Indicates if the note is visible to the Customer (or it's set to private!)
+    ///
+    var isCustomerNote: Bool = false {
+        didSet {
+            privacyWasUpdated()
         }
-        set {
-            noteLabel.text = newValue
+    }
+}
+
+
+// MARK: - Private Methods
+//
+private extension OrderNoteTableViewCell {
+
+    /// Updates the Status Label + Icon's Color
+    ///
+    func privacyWasUpdated() {
+        if isCustomerNote {
+            iconButton.backgroundColor = StyleManager.statusPrimaryBoldColor
+            statusLabel.text = NSLocalizedString("Note to customer", comment: "Labels an order note to let user know it's visible to the customer")
+        } else {
+            iconButton.backgroundColor = StyleManager.wooGreyMid
+            statusLabel.text = NSLocalizedString("Private note", comment: "Labels an order note to let the user know it's private and not seen by the customer")
         }
     }
+
+    /// Setup: Labels
+    ///
+    func configureLabels() {
+        dateLabel.applyBodyStyle()
+        statusLabel.applyBodyStyle()
+        noteLabel.applyBodyStyle()
+    }
+
+    /// Setup: Icon Button
+    ///
+    func configureIconButton() {
+        let image = Gridicon.iconOfType(.aside)
+        iconButton.setImage(image, for: .normal)
+        iconButton.layer.cornerRadius = iconButton.frame.width / 2
+        iconButton.tintColor = .white
+    }
 }