Merge pull request #428 from woocommerce/issue/nuking-orderstatus-viewmodel

Deprecating OrderStatusViewModel

Author: jleandroperez

WooCommerce/Classes/Extensions/UILabel+Helpers.swift

@@ -33,38 +33,6 @@ extension UILabel {
         textColor = StyleManager.defaultTextColor
     }
 
-    func applyStatusStyle(for status: OrderStatus) {
-        adjustsFontForContentSizeCategory = true
-        layer.borderWidth = 1.0
-        layer.cornerRadius = 4.0
-        font = .footnote
-
-        switch status {
-            case .processing:
-                fallthrough
-            case .pending:
-                backgroundColor = StyleManager.statusSuccessColor
-                layer.borderColor = StyleManager.statusSuccessBoldColor.cgColor
-            case .failed:
-                fallthrough
-            case .refunded:
-                backgroundColor = StyleManager.statusDangerColor
-                layer.borderColor = StyleManager.statusDangerBoldColor.cgColor
-            case .completed:
-                backgroundColor = StyleManager.statusPrimaryColor
-                layer.borderColor = StyleManager.statusPrimaryBoldColor.cgColor
-            case .onHold:
-                fallthrough
-            case .cancelled:
-                fallthrough
-            case .custom:
-                fallthrough
-            default:
-                backgroundColor = StyleManager.statusNotIdentifiedColor
-                layer.borderColor = StyleManager.statusNotIdentifiedBoldColor.cgColor
-        }
-    }
-
     func applyPaddedLabelDefaultStyles() {
         adjustsFontForContentSizeCategory = true
         layer.borderWidth = 1.0

WooCommerce/Classes/Extensions/UILabel+OrderStatus.swift

@@ -0,0 +1,64 @@
+import Foundation
+import UIKit
+import Yosemite
+
+
+// MARK: - UILabel + OrderStatus Methods
+//
+extension UILabel {
+
+    /// Applies the appropriate Style for a given OrderStatus
+    ///
+    func applyStyle(for status: OrderStatus) {
+        applyFootnoteStyle()
+        applyLayerSettings()
+        applyBackground(for: status)
+    }
+
+    /// Setup: Layer
+    ///
+    private func applyLayerSettings() {
+        layer.borderWidth = OrderStatusSettings.borderWidth
+        layer.cornerRadius = OrderStatusSettings.cornerRadius
+    }
+
+    /// Setup: Background Color
+    ///
+    private func applyBackground(for status: OrderStatus) {
+        switch status {
+        case .processing:
+            fallthrough
+        case .pending:
+            backgroundColor = StyleManager.statusSuccessColor
+            layer.borderColor = StyleManager.statusSuccessBoldColor.cgColor
+        case .failed:
+            fallthrough
+        case .refunded:
+            backgroundColor = StyleManager.statusDangerColor
+            layer.borderColor = StyleManager.statusDangerBoldColor.cgColor
+        case .completed:
+            backgroundColor = StyleManager.statusPrimaryColor
+            layer.borderColor = StyleManager.statusPrimaryBoldColor.cgColor
+        case .onHold:
+            fallthrough
+        case .cancelled:
+            fallthrough
+        case .custom:
+            fallthrough
+        default:
+            backgroundColor = StyleManager.statusNotIdentifiedColor
+            layer.borderColor = StyleManager.statusNotIdentifiedBoldColor.cgColor
+        }
+    }
+}
+
+
+// MARK: - Private
+//
+private extension UILabel {
+
+    enum OrderStatusSettings {
+        static let borderWidth = CGFloat(1.0)
+        static let cornerRadius = CGFloat(4.0)
+    }
+}

WooCommerce/Classes/ViewModels/OrderDetailsViewModel.swift

@@ -8,13 +8,10 @@ class OrderDetailsViewModel {
     let moneyFormatter: MoneyFormatter
     let couponLines: [OrderCouponLine]?
 
-    let orderStatusViewModel: OrderStatusViewModel
-
     init(order: Order) {
         self.order = order
         self.moneyFormatter = MoneyFormatter()
         self.couponLines = order.coupons
-        self.orderStatusViewModel = OrderStatusViewModel(orderStatus: order.status)
     }
 
     var summaryTitle: String? {
@@ -39,18 +36,6 @@ class OrderDetailsViewModel {
 
     let fulfillTitle = NSLocalizedString("Fulfill order", comment: "Fulfill order button title")
 
-    var paymentStatus: String {
-        return order.status.description
-    }
-
-    var paymentBackgroundColor: UIColor {
-        return orderStatusViewModel.backgroundColor
-    }
-
-    var paymentBorderColor: CGColor {
-        return orderStatusViewModel.borderColor
-    }
-
     var isProcessingPayment: Bool {
         return order.status == .processing
     }

WooCommerce/Classes/ViewModels/OrderStatusViewModel.swift

@@ -432,9 +432,8 @@ private extension OrderDetailsViewController {
     func configureSummary(cell: SummaryTableViewCell) {
         cell.title = viewModel.summaryTitle
         cell.dateCreated = viewModel.summaryDateCreated
-        cell.paymentStatus = viewModel.paymentStatus
-        cell.paymentBackgroundColor = viewModel.paymentBackgroundColor
-        cell.paymentBorderColor = viewModel.paymentBorderColor
+
+        cell.display(orderStatus: viewModel.order.status)
     }
 
     // MARK: - Get order note

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

@@ -1,51 +1,58 @@
 import UIKit
+import Yosemite
 
+
+// MARK: - SummaryTableViewCell
+//
 class SummaryTableViewCell: UITableViewCell {
+
+    /// Label: Title
+    ///
     @IBOutlet private weak var titleLabel: UILabel!
-    @IBOutlet private weak var createdLabel: UILabel!
-    @IBOutlet private weak var paymentStatusLabel: PaddedLabel!
 
-    public var paymentBackgroundColor: UIColor = .clear
+    /// Label: Creation / Update Date
+    ///
+    @IBOutlet private weak var createdLabel: UILabel!
 
+    /// Label: Payment Status
+    ///
+    @IBOutlet private weak var paymentStatusLabel: PaddedLabel!
 
-    public var title: String? {
+    /// Title
+    ///
+    var title: String? {
         get {
             return titleLabel.text
         }
         set {
             titleLabel.text = newValue
-            titleLabel.applyHeadlineStyle()
         }
     }
 
-    public var dateCreated: String? {
+    /// Date
+    ///
+    var dateCreated: String? {
         get {
             return createdLabel.text
         }
         set {
             createdLabel.text = newValue
-            createdLabel.applyFootnoteStyle()
         }
     }
 
-    public var paymentStatus: String? {
-        get {
-            return paymentStatusLabel.text
-        }
-        set {
-            paymentStatusLabel.text = newValue
-            paymentStatusLabel.applyPaddedLabelDefaultStyles()
-            paymentStatusLabel.backgroundColor = paymentBackgroundColor
-        }
+    /// Displays the specified OrderStatus, and applies the right Label Style
+    ///
+    func display(orderStatus: OrderStatus) {
+        paymentStatusLabel.text = orderStatus.description
+        paymentStatusLabel.applyStyle(for: orderStatus)
     }
 
-    public var paymentBorderColor: CGColor? {
-        get {
-            return paymentStatusLabel.layer.borderColor
-        }
-        set {
-            paymentStatusLabel.layer.borderColor = newValue
-        }
+
+    // MARK: - Overridden Methods
+
+    override func awakeFromNib() {
+        super.awakeFromNib()
+        configureLabels()
     }
 
     override func setSelected(_ selected: Bool, animated: Bool) {
@@ -59,9 +66,28 @@ class SummaryTableViewCell: UITableViewCell {
             super.setHighlighted(highlighted, animated: animated)
         }
     }
+}
+
 
+// MARK: - Private
+//
+private extension SummaryTableViewCell {
+
+    /// Preserves the current Payment BG Color
+    ///
     func preserveLabelColors(action: () -> Void) {
+        let paymentColor = paymentStatusLabel.backgroundColor
+
         action()
-        paymentStatusLabel.backgroundColor = paymentBackgroundColor
+
+        paymentStatusLabel.backgroundColor = paymentColor
+    }
+
+    /// Setup: Labels
+    ///
+    func configureLabels() {
+        titleLabel.applyHeadlineStyle()
+        createdLabel.applyFootnoteStyle()
+        paymentStatusLabel.applyPaddedLabelDefaultStyles()
     }
 }

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

@@ -1,21 +1,40 @@
 import UIKit
 
 
+// MARK: - OrderListCell
+//
 class OrderListCell: UITableViewCell {
-    @IBOutlet var titleLabel: UILabel!
-    @IBOutlet var totalLabel: UILabel!
-    @IBOutlet var paymentStatusLabel: PaddedLabel!
 
+    /// Order's Title
+    ///
+    @IBOutlet private var titleLabel: UILabel!
 
+    /// Order's Total
+    ///
+    @IBOutlet private var totalLabel: UILabel!
+
+    /// Payment
+    ///
+    @IBOutlet private var paymentStatusLabel: PaddedLabel!
+
+
+    /// Renders the specified Order ViewModel
+    ///
     func configureCell(viewModel: OrderDetailsViewModel) {
         titleLabel.text = viewModel.summaryTitle
-        titleLabel.applyHeadlineStyle()
 
         totalLabel.text = viewModel.totalFriendlyString
-        totalLabel.applyBodyStyle()
 
-        paymentStatusLabel.text = viewModel.paymentStatus
-        paymentStatusLabel.applyStatusStyle(for: viewModel.orderStatusViewModel.orderStatus)
+        paymentStatusLabel.text = viewModel.order.status.description
+        paymentStatusLabel.applyStyle(for: viewModel.order.status)
+    }
+
+
+    // MARK: - Overridden Methods
+
+    override func awakeFromNib() {
+        super.awakeFromNib()
+        configureLabels()
     }
 
     override func setSelected(_ selected: Bool, animated: Bool) {
@@ -34,12 +53,28 @@ class OrderListCell: UITableViewCell {
         super.prepareForReuse()
         paymentStatusLabel.layer.borderColor = UIColor.clear.cgColor
     }
+}
+
+
+// MARK: - Private
+//
+private extension OrderListCell {
 
+    /// Preserves the current Payment BG Color
+    ///
     func preserveLabelColors(action: () -> Void) {
         let paymentColor = paymentStatusLabel.backgroundColor
 
         action()
 
         paymentStatusLabel.backgroundColor = paymentColor
     }
+
+    /// Setup: Labels
+    ///
+    func configureLabels() {
+        titleLabel.applyHeadlineStyle()
+        totalLabel.applyBodyStyle()
+        paymentStatusLabel.applyFootnoteStyle()
+    }
 }