Merge pull request #477 from woocommerce/issue/19-ratings

Notifications: Adds star rating to product review cell/detail

Author: bummytime

Podfile.lock

@@ -14,9 +14,9 @@ PODS:
   - CocoaLumberjack/Default (3.4.2)
   - CocoaLumberjack/Extensions (3.4.2):
     - CocoaLumberjack/Default
-  - Crashlytics (3.11.1):
-    - Fabric (~> 1.8.1)
-  - Fabric (1.8.2)
+  - Crashlytics (3.12.0):
+    - Fabric (~> 1.9.0)
+  - Fabric (1.9.0)
   - FormatterKit/Resources (1.8.2)
   - FormatterKit/TimeIntervalFormatter (1.8.2):
     - FormatterKit/Resources
@@ -39,7 +39,7 @@ PODS:
   - Reachability (3.2)
   - SVProgressHUD (2.2.5)
   - UIDeviceIdentifier (0.5.0)
-  - WordPressAuthenticator (1.1.5):
+  - WordPressAuthenticator (1.1.6):
     - 1PasswordExtension (= 1.8.5)
     - Alamofire (= 4.7.3)
     - CocoaLumberjack (= 3.4.2)
@@ -60,7 +60,7 @@ PODS:
     - UIDeviceIdentifier (~> 0.4)
     - WordPressShared (~> 1.4)
     - wpxmlrpc (= 0.8.3)
-  - WordPressShared (1.5.1):
+  - WordPressShared (1.6.0):
     - CocoaLumberjack (~> 3.4)
     - FormatterKit/TimeIntervalFormatter (= 1.8.2)
   - WordPressUI (1.1.1)
@@ -133,8 +133,8 @@ SPEC CHECKSUMS:
   Automattic-Tracks-iOS: 93f967b0ca5d7cba176366847e0f29debc339a04
   Charts: f122fb70b19847fa5817d018b77d6c5a2296ab25
   CocoaLumberjack: db7cc9e464771f12054c22ff6947c5a58d43a0fd
-  Crashlytics: ca7ab4bc304aa216bdc2e4c1a96389ee77252203
-  Fabric: d2b22f443ba195d8a7cc204da230977c72733b40
+  Crashlytics: 07fb167b1694128c1c9a5a5cc319b0e9c3ca0933
+  Fabric: f988e33c97f08930a413e08123064d2e5f68d655
   FormatterKit: 4b8f29acc9b872d5d12a63efb560661e8f2e1b98
   GoogleSignInRepacked: d357702618c555f38923576924661325eb1ef22b
   GoogleToolboxForMac: 91c824d21e85b31c2aae9bb011c5027c9b4e738f
@@ -146,9 +146,9 @@ SPEC CHECKSUMS:
   Reachability: 33e18b67625424e47b6cde6d202dce689ad7af96
   SVProgressHUD: 1428aafac632c1f86f62aa4243ec12008d7a51d6
   UIDeviceIdentifier: a959a6d4f51036b4180dd31fb26483a820f1cc46
-  WordPressAuthenticator: 0e60d89e1637212bc841a0cf66fc5ef8cac01e52
+  WordPressAuthenticator: 83f495cce863d3f65bb440f6dea57161af401729
   WordPressKit: 46fe8a4fa2ff4195f73a992f0f6f3a1eb2972b70
-  WordPressShared: 2a2d74bbe0ee4c31452f8c33aafe255278dc56f6
+  WordPressShared: a2fc2db66c210a05d317ae9678b5823dd6a4d708
   WordPressUI: 3c69543f0170e011226e48910b8c3071e5d400af
   wpxmlrpc: bfc572f62ce7ee897f6f38b098d2ba08732ecef4
   XLPagerTabStrip: 22d4c58200d7c105e0e407ab6bfd01a5d85014be

WooCommerce/Classes/Model/Note+Woo.swift

@@ -21,4 +21,27 @@ extension Note {
 
         return snippet
     }
+
+    /// Returns the number of stars for a review (or nil if the Note is not a review)
+    ///
+    var starRating: Int? {
+        guard subkind == .storeReview else {
+            return nil
+        }
+        guard let block = body.first(ofKind: .text) else {
+            return nil
+        }
+
+        return block.text?.filter({ Constants.filledInStar.contains($0) }).count
+    }
+}
+
+
+// MARK: - Constants!
+//
+private extension Note {
+    enum Constants {
+        static let filledInStar = "\u{2605}"  // Unicode Black Star ★
+        static let emptyStar    = "\u{2606}"  // Unicode White Star ☆
+    }
 }

WooCommerce/Classes/Styles/Style.swift

@@ -37,6 +37,7 @@ protocol Style {
     var statusSuccessColor: UIColor { get }
     var statusSuccessBoldColor: UIColor { get }
     var tableViewBackgroundColor: UIColor { get }
+    var goldStarColor: UIColor { get }
     var wooCommerceBrandColor: UIColor { get }
     var wooAccent: UIColor { get }
     var wooGreyLight: UIColor { get }
@@ -85,6 +86,7 @@ class DefaultStyle: Style {
     let sectionBackgroundColor          = HandbookColors.wooGreyLight
     let sectionTitleColor               = HandbookColors.wooSecondary
     let tableViewBackgroundColor        = HandbookColors.wooGreyLight
+    let goldStarColor                   = UIColor(red: 238.0/255.0, green: 180.0/255.0, blue: 34.0/255.0, alpha: 1.0)
 
     let statusDangerColor               = HandbookColors.statusRedDimmed
     let statusDangerBoldColor           = HandbookColors.statusRed
@@ -266,6 +268,10 @@ class StyleManager {
         return active.statusSuccessBoldColor
     }
 
+    static var goldStarColor: UIColor {
+        return active.goldStarColor
+    }
+
     static var tableViewBackgroundColor: UIColor {
         return active.tableViewBackgroundColor
     }

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

@@ -36,6 +36,10 @@ class NoteDetailsCommentTableViewCell: UITableViewCell {
     ///
     @IBOutlet private var approvalButton: UIButton!
 
+    /// Custom UIView: Rating star view
+    ///
+    @IBOutlet private var starRatingView: RatingView!
+
     /// Closure to be executed whenever the Spam Button is pressed.
     ///
     var onSpam: (() -> Void)?
@@ -132,6 +136,20 @@ class NoteDetailsCommentTableViewCell: UITableViewCell {
         }
     }
 
+    /// Star rating value (if nil, star rating view will be hidden)
+    ///
+    var starRating: Int? {
+        didSet {
+            guard let starRating = starRating else {
+                starRatingView.isHidden = true
+                return
+            }
+
+            starRatingView.rating = CGFloat(starRating)
+            starRatingView.isHidden = false
+        }
+    }
+
     /// Downloads the Gravatar Image at the specified URL (if any!).
     ///
     func downloadGravatar(with url: URL?) {
@@ -145,6 +163,7 @@ class NoteDetailsCommentTableViewCell: UITableViewCell {
     override func awakeFromNib() {
         super.awakeFromNib()
         configureActionButtons()
+        configureStarView()
         configureDefaultAppearance()
     }
 }
@@ -187,6 +206,14 @@ private extension NoteDetailsCommentTableViewCell {
         }
     }
 
+    /// Setup: Star rating view
+    ///
+    func configureStarView() {
+        starRatingView.starImage = Star.filledImage
+        starRatingView.emptyStarImage = Star.emptyImage
+        starRatingView.isHidden = (starRating == nil)
+    }
+
     /// Setup: Button Appearance
     ///
     func refreshAppearance(button: UIButton) {
@@ -262,3 +289,12 @@ private struct Approve {
     static let normalLabel      = NSLocalizedString("Approves the comment", comment: "Approves a comment. Spoken Hint.")
     static let selectedLabel    = NSLocalizedString("Unapproves the comment", comment: "Unapproves a comment. Spoken Hint.")
 }
+
+
+// MARK: - Star View: Defaults
+//
+private struct Star {
+    static let size        = Double(18)
+    static let filledImage = Gridicon.iconOfType(.star, withSize: CGSize(width: Star.size, height: Star.size)).imageWithTintColor(StyleManager.goldStarColor)
+    static let emptyImage  = Gridicon.iconOfType(.star, withSize: CGSize(width: Star.size, height: Star.size)).imageWithTintColor(StyleManager.wooGreyLight)
+}