Merge remote-tracking branch 'origin/develop' into issue/nuking-orderstatus-viewmodel

Author: jleandroperez

Networking/Networking/Model/Note.swift

@@ -38,10 +38,18 @@ public struct Note {
     ///
     public let kind: Kind
 
+    /// Notification.Subtype expressed as a Swift Native enum.
+    ///
+    public let subkind: Subkind?
+
     /// Notification Type.
     ///
     public let type: String?
 
+    /// Notification Subtype.
+    ///
+    public let subtype: String?
+
     /// Associated Resource's URL.
     ///
     public let url: String?
@@ -96,6 +104,7 @@ public struct Note {
                 noticon: String?,
                 timestamp: String,
                 type: String,
+                subtype: String?,
                 url: String?,
                 title: String?,
                 subject: Data,
@@ -111,7 +120,9 @@ public struct Note {
         self.timestamp = timestamp
         self.timestampAsDate = DateFormatter.Defaults.iso8601.date(from: timestamp) ?? Date()
         self.type = type
+        self.subtype = subtype
         self.kind = Kind(rawValue: type) ?? .unknown
+        self.subkind = subtype.flatMap { Subkind(rawValue: $0) }
         self.url = url
         self.title = title
 
@@ -148,6 +159,7 @@ extension Note: Decodable {
         let noticon = container.failsafeDecodeIfPresent(String.self, forKey: .noticon)
         let timestamp = container.failsafeDecodeIfPresent(stringForKey: .timestamp) ?? String()
         let type = container.failsafeDecodeIfPresent(String.self, forKey: .type) ?? String()
+        let subtype = container.failsafeDecodeIfPresent(String.self, forKey: .subtype)
         let url = container.failsafeDecodeIfPresent(String.self, forKey: .url)
         let title = container.failsafeDecodeIfPresent(String.self, forKey: .title)
 
@@ -170,6 +182,7 @@ extension Note: Decodable {
                   noticon: noticon,
                   timestamp: timestamp,
                   type: type,
+                  subtype: subtype,
                   url: url,
                   title: title,
                   subject: subjectAsData,
@@ -194,6 +207,7 @@ extension Note {
         case noticon
         case timestamp
         case type
+        case subtype
         case url
         case title
         case subject
@@ -216,4 +230,10 @@ extension Note {
         case user
         case unknown
     }
+
+    /// Known Notification Subkind(s)
+    ///
+    public enum Subkind: String {
+        case storeReview = "store_review"
+    }
 }

Networking/NetworkingTests/Mapper/NoteListMapperTests.swift

@@ -250,6 +250,15 @@ class NoteListMapperTests: XCTestCase {
         let commentNote = sampleNotes.first(where: { $0.kind == .comment })
         XCTAssertEqual(commentNote?.body[1].kind, .comment)
     }
+
+
+    /// Verifies that the Notification's subtype is properly parsed.
+    ///
+    func testStoreReviewSubtypeIsProperlyParsed() {
+        let storeReview = sampleNotes.first(where: { $0.noteId == 100009 })
+        XCTAssertEqual(storeReview?.subtype, "store_review")
+        XCTAssertEqual(storeReview?.subkind, .storeReview)
+    }
 }
 
 

Networking/NetworkingTests/Responses/notifications-load-all.json

@@ -1228,6 +1228,7 @@
         "id": 100009,
         "note_hash": 987654,
         "type": "comment",
+        "subtype": "store_review",
         "read": 1,
         "noticon": "\uf300",
         "timestamp": "2018-10-19T12:56:47+00:00",

Storage/Storage/Model/MIGRATIONS.md

@@ -3,6 +3,9 @@
 This file documents changes in the WCiOS Storage data model. Please explain any changes to the data model as well as any custom migrations.
 
 ## Model 6
+- @jleandroperez 2018-11-12
+    - New `Note.subtype` property (optional type)
+
 - @thuycopeland 2018-11-8
     - Added new attribute: `isJetpackInstalled`, to site entity
     - Added new attribute: `plan`, to site entity

Storage/Storage/Model/Note+CoreDataProperties.swift

@@ -15,6 +15,7 @@ extension Note {
     @NSManaged public var noticon: String?
     @NSManaged public var timestamp: String?
     @NSManaged public var type: String?
+    @NSManaged public var subtype: String?
     @NSManaged public var url: String?
     @NSManaged public var title: String?
     @NSManaged public var subject: Data?

Storage/Storage/Model/WooCommerce.xcdatamodeld/Model 6.xcdatamodel/contents

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<model type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="14460.32" systemVersion="18A391" minimumToolsVersion="Automatic" sourceLanguage="Swift" userDefinedModelVersionIdentifier="">
+<model type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="14460.32" systemVersion="18B75" minimumToolsVersion="Automatic" sourceLanguage="Swift" userDefinedModelVersionIdentifier="">
     <entity name="Account" representedClassName="Account" syncable="YES">
         <attribute name="displayName" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="email" optional="YES" attributeType="String" syncable="YES"/>
@@ -17,6 +17,7 @@
         <attribute name="noticon" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="read" attributeType="Boolean" usesScalarValueType="YES" syncable="YES"/>
         <attribute name="subject" optional="YES" attributeType="Binary" syncable="YES"/>
+        <attribute name="subtype" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="timestamp" attributeType="String" syncable="YES"/>
         <attribute name="title" optional="YES" attributeType="String" syncable="YES"/>
         <attribute name="type" optional="YES" attributeType="String" syncable="YES"/>
@@ -175,7 +176,7 @@
     </entity>
     <elements>
         <element name="Account" positionX="-200.9765625" positionY="63.5625" width="128" height="120"/>
-        <element name="Note" positionX="-162" positionY="180" width="128" height="240"/>
+        <element name="Note" positionX="-162" positionY="180" width="128" height="255"/>
         <element name="Order" positionX="-20" positionY="27" width="128" height="690"/>
         <element name="OrderCoupon" positionX="-206.01953125" positionY="379.74609375" width="128" height="120"/>
         <element name="OrderItem" positionX="-364.890625" positionY="379.453125" width="128" height="225"/>

WooCommerce/Classes/ViewRelated/Notifications/Cells/NoteTableViewCell.swift

@@ -72,14 +72,6 @@ class NoteTableViewCell: UITableViewCell {
         noticonLabel.font = UIFont.noticon(forStyle: .title1)
     }
 
-    override func prepareForReuse() {
-        super.prepareForReuse()
-
-        noticon = nil
-        attributedSubject = nil
-        attributedSnippet = nil
-    }
-
     override func setSelected(_ selected: Bool, animated: Bool) {
         // Note: this is required, since the cell unhighlight mechanism will reset the new background color
         super.setSelected(selected, animated: animated)

WooCommerce/Classes/ViewRelated/Notifications/Cells/NoteTableViewCell.xib

@@ -18,11 +18,10 @@
                 <rect key="frame" x="0.0" y="0.0" width="375" height="87.5"/>
                 <autoresizingMask key="autoresizingMask"/>
                 <subviews>
-                    <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="🐮" textAlignment="natural" lineBreakMode="tailTruncation" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="MDO-G5-bNl">
-                        <rect key="frame" x="14" y="11" width="25" height="25"/>
+                    <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="-" textAlignment="natural" lineBreakMode="tailTruncation" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="MDO-G5-bNl">
+                        <rect key="frame" x="14" y="11" width="25" height="20.5"/>
                         <constraints>
                             <constraint firstAttribute="width" constant="25" id="Eqv-DJ-O5N"/>
-                            <constraint firstAttribute="height" priority="750" constant="25" id="w2h-Rr-ayg"/>
                         </constraints>
                         <fontDescription key="fontDescription" type="system" pointSize="17"/>
                         <nil key="textColor"/>

WooCommerce/Classes/ViewRelated/Notifications/NotificationsViewController.swift

@@ -1,6 +1,8 @@
 import UIKit
 import Gridicons
 import Yosemite
+import WordPressUI
+import SafariServices
 
 
 // MARK: - NotificationsViewController
@@ -20,11 +22,10 @@ class NotificationsViewController: UIViewController {
         return ResultsController<StorageNote>(storageManager: storageManager, sectionNameKeyPath: "normalizedAgeAsString", matching: filter, sortedBy: [descriptor])
     }()
 
-    /// Store Notifications CoreData Filter. IMPORTANT!! This is CLEARLY a quick hack (we can't filter based on the title!)
-    /// TODO: Remove ASAP as soon as the (pending) backend PR is merged
+    /// Store Notifications CoreData Filter.
     ///
     private var filter: NSPredicate {
-        return NSPredicate(format: "type == %@ OR title == 'Product Review'", Note.Kind.storeOrder.rawValue)
+        return NSPredicate(format: "type == %@ OR subtype == %@", Note.Kind.storeOrder.rawValue, Note.Subkind.storeReview.rawValue)
     }
 
     /// Pull To Refresh Support.
@@ -47,6 +48,24 @@ class NotificationsViewController: UIViewController {
     ///
     private let formatter = StringFormatter()
 
+    /// UI Active State
+    ///
+    private var state: State = .results {
+        didSet {
+            guard oldValue != state else {
+                return
+            }
+
+            didLeave(state: oldValue)
+            didEnter(state: state)
+        }
+    }
+
+    /// Indicates if there are no results onscreen.
+    ///
+    private var isEmpty: Bool {
+        return resultsController.isEmpty
+    }
 
 
     // MARK: - View Lifecycle
@@ -145,9 +164,11 @@ private extension NotificationsViewController {
                 DDLogError("⛔️ Error synchronizing notifications: \(error)")
             }
 
+            self.transitionToResultsUpdatedState()
             onCompletion?()
         }
 
+        transitionToSyncingState()
         StoresManager.shared.dispatch(action)
     }
 }
@@ -248,3 +269,119 @@ private extension NotificationsViewController {
         return snippet
     }
 }
+
+
+// MARK: - Placeholders
+//
+private extension NotificationsViewController {
+
+    /// Renders Placeholder Notes: For safety reasons, we'll also halt ResultsController <> UITableView glue.
+    ///
+    func displayPlaceholderNotes() {
+        let options = GhostOptions(reuseIdentifier: NoteTableViewCell.reuseIdentifier, rowsPerSection: Settings.placeholderRowsPerSection)
+        tableView.displayGhostContent(options: options)
+
+        resultsController.stopForwardingEvents()
+    }
+
+    /// Removes Placeholder Notes (and restores the ResultsController <> UITableView link).
+    ///
+    func removePlaceholderNotes() {
+        tableView.removeGhostContent()
+        resultsController.startForwardingEvents(to: self.tableView)
+    }
+
+    /// Displays the Empty State Overlay.
+    ///
+    func displayEmptyNotesOverlay() {
+        let overlayView: OverlayMessageView = OverlayMessageView.instantiateFromNib()
+        overlayView.messageImage = .waitingForCustomersImage
+        overlayView.messageText = NSLocalizedString("No Notifications Yet!", comment: "Empty Notifications List Message")
+        overlayView.actionText = NSLocalizedString("Share your Store", comment: "Action: Opens the Store in a browser")
+        overlayView.onAction = { [weak self] in
+            self?.displayDefaultSite()
+        }
+
+        overlayView.attach(to: view)
+    }
+
+    /// Removes all of the the OverlayMessageView instances in the view hierarchy.
+    ///
+    func removeAllOverlays() {
+        for subview in view.subviews where subview is OverlayMessageView {
+            subview.removeFromSuperview()
+        }
+    }
+
+    /// Displays the Default Site in a WebView.
+    ///
+    func displayDefaultSite() {
+        guard let urlAsString = StoresManager.shared.sessionManager.defaultSite?.url, let siteURL = URL(string: urlAsString) else {
+            return
+        }
+
+        let safariViewController = SFSafariViewController(url: siteURL)
+        safariViewController.modalPresentationStyle = .pageSheet
+        present(safariViewController, animated: true, completion: nil)
+    }
+}
+
+
+// MARK: - Finite State Machine Management
+//
+private extension NotificationsViewController {
+
+    /// Runs whenever the FSM enters a State.
+    ///
+    func didEnter(state: State) {
+        switch state {
+        case .empty:
+            displayEmptyNotesOverlay()
+        case .results:
+            break
+        case .syncing:
+            displayPlaceholderNotes()
+        }
+    }
+
+    /// Runs whenever the FSM leaves a State.
+    ///
+    func didLeave(state: State) {
+        switch state {
+        case .empty:
+            removeAllOverlays()
+        case .results:
+            break
+        case .syncing:
+            removePlaceholderNotes()
+        }
+    }
+
+    /// Should be called before Sync'ing Starts: Transitions to .results / .syncing
+    ///
+    func transitionToSyncingState() {
+        state = isEmpty ? .syncing : .results
+    }
+
+    /// Should be called after Sync'ing wraps up: Transitions to .empty / .results
+    ///
+    func transitionToResultsUpdatedState() {
+        state = isEmpty ? .empty : .results
+    }
+}
+
+
+// MARK: - Nested Types
+//
+private extension NotificationsViewController {
+
+    enum Settings {
+        static let placeholderRowsPerSection = [3]
+    }
+
+    enum State {
+        case empty
+        case results
+        case syncing
+    }
+}

WooCommerce/Classes/ViewRelated/Orders/OrdersViewController.swift

@@ -479,7 +479,7 @@ extension OrdersViewController {
 }
 
 
-// MARK: - FSM Management
+// MARK: - Finite State Machine Management
 //
 private extension OrdersViewController {
 
@@ -536,7 +536,6 @@ private extension OrdersViewController {
 
         state = .emptyUnfiltered
     }
-
 }