Merge pull request #395 from woocommerce/issue/19-block-formatter

StringDescriptor Formatter

Author: jleandroperez

WooCommerce/Classes/Extensions/NSMutableAttributedString+Helpers.swift

@@ -0,0 +1,16 @@
+import Foundation
+
+
+/// NSMutableAttributedString: Helper Methods
+///
+extension NSMutableAttributedString {
+
+    /// Applies the specified attributes to the receiver's quoted text.
+    ///
+    func applyAttributesToQuotedText( attributes: [NSAttributedString.Key: Any]) {
+        let scanner = Scanner(string: string)
+        for range in scanner.scanQuotedRanges() {
+            addAttributes(attributes, range: range)
+        }
+    }
+}

WooCommerce/Classes/Extensions/NSMutableParagraphStyle+Helpers.swift

@@ -0,0 +1,33 @@
+import Foundation
+import UIKit
+
+
+/// NSMutableParagraphStyle: Helper Methods
+///
+extension NSMutableParagraphStyle {
+
+    /// No Maximum Line Height constant
+    ///
+    static let NoMaximum = CGFloat(0)
+
+    /// Convenience Initializer
+    ///
+    convenience init(minLineHeight: CGFloat,
+                     maxLineHeight: CGFloat = NoMaximum,
+                     lineBreakMode: NSLineBreakMode = .byWordWrapping,
+                     alignment: NSTextAlignment = .natural) {
+
+        self.init()
+        self.minimumLineHeight = minLineHeight
+        self.maximumLineHeight = maxLineHeight
+        self.lineBreakMode = lineBreakMode
+        self.alignment = alignment
+    }
+
+    /// Convenience Initializer: Returns a Paragraph Style with a standard "minimum line height" set to accommodate a
+    /// given UIFont instance.
+    ///
+    convenience init(standardLineHeightUsingFont font: UIFont, alignment: NSTextAlignment = .natural) {
+        self.init(minLineHeight: font.lineHeight.rounded(.up), alignment: alignment)
+    }
+}

WooCommerce/Classes/Extensions/NSParagraphStyle+Woo.swift

@@ -0,0 +1,26 @@
+import Foundation
+import UIKit
+
+
+/// NSParagraphStyle: Helper Methods
+///
+extension NSParagraphStyle {
+
+    /// Returns a ParagraphStyle with it's minimum Line Height set to accomodate `UIFont.subheadline`
+    ///
+    static var subheadline: NSParagraphStyle {
+        return NSMutableParagraphStyle(standardLineHeightUsingFont: UIFont.subheadline)
+    }
+
+    /// Returns a ParagraphStyle with it's minimum Line Height set to accomodate `UIFont.body`
+    ///
+    static var body: NSParagraphStyle {
+        return NSMutableParagraphStyle(standardLineHeightUsingFont: UIFont.body)
+    }
+
+    /// Returns a ParagraphStyle with it's minimum Line Height set to accomodate `UIFont.body` / Centered
+    ///
+    static var badge: NSParagraphStyle {
+        return NSMutableParagraphStyle(standardLineHeightUsingFont: UIFont.body, alignment: .center)
+    }
+}

WooCommerce/Classes/Extensions/Scanner+Helpers.swift

@@ -0,0 +1,38 @@
+import Foundation
+
+
+/// Scanner: Helper Methods
+///
+extension Scanner {
+
+    /// Returns the NSRange(s) for all of the quotes contained within the scanned string.
+    ///
+    func scanQuotedRanges() -> [NSRange] {
+        var output = [NSRange]()
+        let marker = "\""
+
+        while isAtEnd == false {
+            // Find + Drop the first quotation mark
+            scanUpTo(marker, into: nil)
+            scanString(marker, into: nil)
+
+            // Scan the actual quoted text
+            let start = scanLocation
+            scanUpTo(marker, into: nil)
+            let end = scanLocation
+
+            // Drop the closing mark
+            scanString(marker, into: nil)
+
+            // Build the Range
+            guard start >= 0 && end < string.count && start < end else {
+                continue
+            }
+
+            let foundationRange = NSRange(location: start, length: end - start)
+            output.append(foundationRange)
+        }
+
+        return output
+    }
+}

WooCommerce/Classes/Extensions/String+Woo.swift

@@ -0,0 +1,19 @@
+import Foundation
+
+
+/// String: Constant Helpers
+///
+extension String {
+
+    /// Returns a string containing the Hair Space.
+    ///
+    static var hairSpace: String {
+        return "\u{200A}"
+    }
+
+    /// Returns a string containing a Space.
+    ///
+    static var space: String {
+        return " "
+    }
+}

WooCommerce/Classes/Extensions/UIFont+Woo.swift

@@ -0,0 +1,30 @@
+import Foundation
+import UIKit
+
+
+/// WooCommerce UIFont Helpers
+///
+extension UIFont {
+
+    /// Returns the receiver *Bold* version.
+    ///
+    var bold: UIFont {
+        guard let descriptor = fontDescriptor.withSymbolicTraits(.traitBold) else {
+            DDLogError("# Error: Cannot toggle font to Bold: [\(self)]")
+            return self
+        }
+
+        return UIFont(descriptor: descriptor, size: pointSize)
+    }
+
+    /// Returns the receiver *Italics* version.
+    ///
+    var italics: UIFont {
+        guard let descriptor = fontDescriptor.withSymbolicTraits(.traitItalic) else {
+            DDLogError("# Error: Cannot toggle font to Italics: [\(self)]")
+            return self
+        }
+
+        return UIFont(descriptor: descriptor, size: pointSize)
+    }
+}

WooCommerce/Classes/Styles/Style.swift

@@ -4,8 +4,16 @@ import UIKit
 // MARK: - Style defines the basic API of a Woo Skin.
 //
 protocol Style {
+
+    /// Fonts
+    ///
     var actionButtonTitleFont: UIFont { get }
     var alternativeLoginsTitleFont: UIFont { get }
+    var chartLabelFont: UIFont { get }
+    var subheadlineFont: UIFont { get }
+
+    /// Colors
+    ///
     var buttonPrimaryColor: UIColor { get }
     var buttonPrimaryHighlightedColor: UIColor { get }
     var buttonPrimaryTitleColor: UIColor { get }
@@ -16,14 +24,10 @@ protocol Style {
     var buttonDisabledHighlightedColor: UIColor { get }
     var buttonDisabledTitleColor: UIColor { get }
     var cellSeparatorColor: UIColor { get }
-    var chartLabelFont: UIFont { get }
     var defaultTextColor: UIColor { get }
     var destructiveActionColor: UIColor { get }
-    var navBarImage: UIImage { get }
     var sectionBackgroundColor: UIColor { get }
     var sectionTitleColor: UIColor { get }
-    var statusBarDark: UIStatusBarStyle { get }
-    var statusBarLight: UIStatusBarStyle { get }
     var statusDangerColor: UIColor { get }
     var statusDangerBoldColor: UIColor { get }
     var statusNotIdentifiedColor: UIColor { get }
@@ -32,7 +36,6 @@ protocol Style {
     var statusPrimaryBoldColor: UIColor { get }
     var statusSuccessColor: UIColor { get }
     var statusSuccessBoldColor: UIColor { get }
-    var subheadlineFont: UIFont { get }
     var tableViewBackgroundColor: UIColor { get }
     var wooCommerceBrandColor: UIColor { get }
     var wooAccent: UIColor { get }
@@ -42,22 +45,31 @@ protocol Style {
     var wooGreyBorder: UIColor { get }
     var wooSecondary: UIColor { get }
     var wooWhite: UIColor { get }
+
+    /// NavBar
+    ///
+    var navBarImage: UIImage { get }
+
+    /// StatusBar
+    ///
+    var statusBarDark: UIStatusBarStyle { get }
+    var statusBarLight: UIStatusBarStyle { get }
 }
 
 
 // MARK: - WooCommerce's Default Style
 //
 class DefaultStyle: Style {
 
-    // Fonts!
-    //
+    /// Fonts!
+    ///
     let actionButtonTitleFont           = UIFont.font(forStyle: .headline, weight: .semibold)
     let alternativeLoginsTitleFont      = UIFont.font(forStyle: .subheadline, weight: .semibold)
     let subheadlineFont                 = UIFont.font(forStyle: .subheadline, weight: .regular)
     let chartLabelFont                  = UIFont.font(forStyle: .caption2, weight: .ultraLight)
 
-    // Colors!
-    //
+    /// Colors!
+    ///
     let buttonPrimaryColor              = UIColor(red: 0x96/255.0, green: 0x58/255.0, blue: 0x8A/255.0, alpha: 0xFF/255.0)
     let buttonPrimaryHighlightedColor   = UIColor(red: 0x6E/255.0, green: 0x29/255.0, blue: 0x67/255.0, alpha: 0xFF/255.0)
     let buttonPrimaryTitleColor         = HandbookColors.wooWhite
@@ -70,14 +82,10 @@ class DefaultStyle: Style {
     let cellSeparatorColor              = HandbookColors.wooGreyBorder
     let defaultTextColor                = HandbookColors.wooSecondary
     let destructiveActionColor          = UIColor(red: 197.0/255.0, green: 60.0/255.0, blue: 53.0/255.0, alpha: 1.0)
-    let navBarImage                     = UIImage(named: "woo-logo")!
     let sectionBackgroundColor          = HandbookColors.wooGreyLight
     let sectionTitleColor               = HandbookColors.wooSecondary
     let tableViewBackgroundColor        = HandbookColors.wooGreyLight
 
-    let statusBarDark                   = UIStatusBarStyle.default
-    let statusBarLight                  = UIStatusBarStyle.lightContent
-
     let statusDangerColor               = HandbookColors.statusRedDimmed
     let statusDangerBoldColor           = HandbookColors.statusRed
     let statusNotIdentifiedColor        = HandbookColors.wooGreyLight
@@ -95,6 +103,15 @@ class DefaultStyle: Style {
     let wooGreyMid                      = HandbookColors.wooGreyMid
     let wooGreyTextMin                  = HandbookColors.wooGreyTextMin
     let wooWhite                        = HandbookColors.wooWhite
+
+    /// NavBar
+    ///
+    let navBarImage                     = UIImage(named: "woo-logo")!
+
+    /// StatusBar
+    ///
+    let statusBarDark                   = UIStatusBarStyle.default
+    let statusBarLight                  = UIStatusBarStyle.lightContent
 }
 
 
@@ -141,6 +158,8 @@ class StyleManager {
         }
     }
 
+    // MARK: - Fonts
+
     static var actionButtonTitleFont: UIFont {
         return active.actionButtonTitleFont
     }
@@ -149,6 +168,16 @@ class StyleManager {
         return active.alternativeLoginsTitleFont
     }
 
+    static var chartLabelFont: UIFont {
+        return active.chartLabelFont
+    }
+
+    static var subheadlineFont: UIFont {
+        return active.subheadlineFont
+    }
+
+    // MARK: - Colors
+
     static var buttonPrimaryColor: UIColor {
         return active.buttonPrimaryColor
     }
@@ -189,10 +218,6 @@ class StyleManager {
         return active.cellSeparatorColor
     }
 
-    static var chartLabelFont: UIFont {
-        return active.chartLabelFont
-    }
-
     static var defaultTextColor: UIColor {
         return active.defaultTextColor
     }
@@ -201,18 +226,6 @@ class StyleManager {
         return active.destructiveActionColor
     }
 
-    static var navBarImage: UIImage {
-        return active.navBarImage
-    }
-
-    static var statusBarDark: UIStatusBarStyle {
-        return active.statusBarDark
-    }
-
-    static var statusBarLight: UIStatusBarStyle {
-        return active.statusBarLight
-    }
-
     static var sectionBackgroundColor: UIColor {
         return active.sectionBackgroundColor
     }
@@ -253,10 +266,6 @@ class StyleManager {
         return active.statusSuccessBoldColor
     }
 
-    static var subheadlineFont: UIFont {
-        return active.subheadlineFont
-    }
-
     static var tableViewBackgroundColor: UIColor {
         return active.tableViewBackgroundColor
     }
@@ -292,4 +301,20 @@ class StyleManager {
     static var wooWhite: UIColor {
         return active.wooWhite
     }
+
+    // MARK: - NavBar
+
+    static var navBarImage: UIImage {
+        return active.navBarImage
+    }
+
+    // MARK: - StatusBar
+
+    static var statusBarDark: UIStatusBarStyle {
+        return active.statusBarDark
+    }
+
+    static var statusBarLight: UIStatusBarStyle {
+        return active.statusBarLight
+    }
 }

WooCommerce/Classes/Tools/StringFormatter/StringDescriptor.swift

@@ -0,0 +1,23 @@
+import Foundation
+
+
+/// Describes the kind of data contained within a specific Text Range.
+///
+protocol StringDescriptor {
+
+    /// Text Range associated.
+    ///
+    var range: NSRange { get }
+
+    /// Associated URL.
+    ///
+    var url: URL?  { get }
+
+    /// String Payload associated to the range.
+    ///
+    var value: String? { get }
+
+    /// Returns the `Text Style` that should be applied over the associated range.
+    ///
+    func attributes(from styles: StringStyles) -> [NSAttributedString.Key: Any]?
+}