Merge pull request #1253 from MadeByDouglas/issue/1086_blockquote_multilevel_support

SergioEstevao · web-flow · commit 1079d89bfaf2 · 2020-01-08T13:48:44.000Z
Issue/1086 blockquote multilevel support
diff --git a/Aztec/Classes/Converters/ElementsToAttributedString/Implementations/GenericElementConverter.swift b/Aztec/Classes/Converters/ElementsToAttributedString/Implementations/GenericElementConverter.swift
@@ -15,7 +15,7 @@ class GenericElementConverter: ElementConverter {
     
     // MARK: - Built-in formatter instances
     
-    lazy var blockquoteFormatter = BlockquoteFormatter()
+    lazy var blockquoteFormatter = BlockquoteFormatter(increaseDepth: true)
     lazy var boldFormatter = BoldFormatter()
     lazy var divFormatter = HTMLDivFormatter()
     lazy var h1Formatter = HeaderFormatter(headerLevel: .h1)
diff --git a/Aztec/Classes/Formatters/Implementations/BlockquoteFormatter.swift b/Aztec/Classes/Formatters/Implementations/BlockquoteFormatter.swift
@@ -10,11 +10,15 @@ class BlockquoteFormatter: ParagraphAttributeFormatter {
     ///
     let placeholderAttributes: [NSAttributedString.Key: Any]?
 
+    /// Tells if the formatter is increasing the depth of a list or simple changing the current one if any
+    let increaseDepth: Bool
+    
 
     /// Designated Initializer
     ///
-    init(placeholderAttributes: [NSAttributedString.Key: Any]? = nil) {
+    init(placeholderAttributes: [NSAttributedString.Key: Any]? = nil, increaseDepth: Bool = false) {
         self.placeholderAttributes = placeholderAttributes
+        self.increaseDepth = increaseDepth
     }
 
 
@@ -26,11 +30,18 @@ class BlockquoteFormatter: ParagraphAttributeFormatter {
         if let paragraphStyle = attributes[.paragraphStyle] as? NSParagraphStyle {
             newParagraphStyle.setParagraphStyle(paragraphStyle)
         }
-
-        newParagraphStyle.appendProperty(Blockquote(with: representation))
+        
+        let newQuote = Blockquote(with: representation)
+        
+        if newParagraphStyle.blockquotes.isEmpty || increaseDepth {
+            newParagraphStyle.insertProperty(newQuote, afterLastOfType: Blockquote.self)
+        } else {
+            newParagraphStyle.replaceProperty(ofType: Blockquote.self, with: newQuote)
+        }
 
         var resultingAttributes = attributes
         resultingAttributes[.paragraphStyle] = newParagraphStyle
+        
         return resultingAttributes
     }
 
@@ -47,6 +58,7 @@ class BlockquoteFormatter: ParagraphAttributeFormatter {
 
         var resultingAttributes = attributes
         resultingAttributes[.paragraphStyle] = newParagraphStyle
+                
         return resultingAttributes
     }
 
@@ -56,4 +68,9 @@ class BlockquoteFormatter: ParagraphAttributeFormatter {
         }
         return !style.blockquotes.isEmpty
     }
+    
+    static func blockquotes(in attributes: [NSAttributedString.Key: Any]) -> [Blockquote] {
+        let style = attributes[.paragraphStyle] as? ParagraphStyle
+        return style?.blockquotes ?? []
+    }
 }
diff --git a/Aztec/Classes/Formatters/Implementations/TextListFormatter.swift b/Aztec/Classes/Formatters/Implementations/TextListFormatter.swift
@@ -35,6 +35,7 @@ class TextListFormatter: ParagraphAttributeFormatter {
         }
 
         let newList = TextList(style: self.listStyle, with: representation)
+        
         if newParagraphStyle.lists.isEmpty || increaseDepth {
             newParagraphStyle.insertProperty(newList, afterLastOfType: HTMLLi.self)
         } else {
diff --git a/Aztec/Classes/TextKit/LayoutManager.swift b/Aztec/Classes/TextKit/LayoutManager.swift
@@ -8,8 +8,8 @@ import QuartzCore
 class LayoutManager: NSLayoutManager {
 
     /// Blockquote's Left Border Color
-    ///
-    var blockquoteBorderColor: UIColor? = UIColor(red: 0.52, green: 0.65, blue: 0.73, alpha: 1.0)
+    /// Set the array with how many colors you like, they appear in the order they are set in the array.
+    var blockquoteBorderColors = [UIColor.systemGray]
 
     /// Blockquote's Background Color
     ///
@@ -62,17 +62,30 @@ private extension LayoutManager {
             guard let paragraphStyle = object as? ParagraphStyle, !paragraphStyle.blockquotes.isEmpty else {
                 return
             }
-
-            let blockquoteIndent = paragraphStyle.blockquoteIndent
+                        
             let blockquoteGlyphRange = glyphRange(forCharacterRange: range, actualCharacterRange: nil)
 
             enumerateLineFragments(forGlyphRange: blockquoteGlyphRange) { (rect, usedRect, textContainer, glyphRange, stop) in
+                
+                let startIndent = paragraphStyle.blockquoteIndent
+
                 let lineRange = self.characterRange(forGlyphRange: glyphRange, actualGlyphRange: nil)
                 let lineCharacters = textStorage.attributedSubstring(from: lineRange).string
                 let lineEndsParagraph = lineCharacters.isEndOfParagraph(before: lineCharacters.endIndex)
-                let blockquoteRect = self.blockquoteRect(origin: origin, lineRect: rect, blockquoteIndent: blockquoteIndent, lineEndsParagraph: lineEndsParagraph)
+                let blockquoteRect = self.blockquoteRect(origin: origin, lineRect: rect, blockquoteIndent: startIndent, lineEndsParagraph: lineEndsParagraph)
+
+                self.drawBlockquoteBackground(in: blockquoteRect.integral, with: context)
+                
+                let nestDepth = paragraphStyle.blockquoteNestDepth
+                for index in 0...nestDepth {
+                  let indent = startIndent + CGFloat(index) * Metrics.listTextIndentation
+
+                  let nestRect = self.blockquoteRect(origin: origin, lineRect: rect, blockquoteIndent: indent, lineEndsParagraph: lineEndsParagraph)
 
-                self.drawBlockquote(in: blockquoteRect.integral, with: context)
+                  self.drawBlockquoteBorder(in: nestRect.integral, with: context, at: index)
+                }
+                
+            
             }
         }
 
@@ -90,7 +103,8 @@ private extension LayoutManager {
         let extraIndent = paragraphStyle.blockquoteIndent
         let extraRect = blockquoteRect(origin: origin, lineRect: extraLineFragmentRect, blockquoteIndent: extraIndent, lineEndsParagraph: false)
 
-        drawBlockquote(in: extraRect.integral, with: context)
+        drawBlockquoteBackground(in: extraRect.integral, with: context)
+        drawBlockquoteBorder(in: extraRect.integral, with: context, at: 0)
     }
 
 
@@ -122,21 +136,28 @@ private extension LayoutManager {
 
         return blockquoteRect
     }
+    
+    private func drawBlockquoteBorder(in rect: CGRect, with context: CGContext, at depth: Int) {
+        let quoteCount = blockquoteBorderColors.count
+        let index = min(depth, quoteCount-1)
+        
+        guard quoteCount > 0 && index < quoteCount else {
+            return            
+        }
+        
+        let borderColor = blockquoteBorderColors[index]
+        let borderRect = CGRect(origin: rect.origin, size: CGSize(width: blockquoteBorderWidth, height: rect.height))
+        borderColor.setFill()
+        context.fill(borderRect)
+    }
 
     /// Draws a single Blockquote Line Fragment, in the specified Rectangle, using a given Graphics Context.
     ///
-    private func drawBlockquote(in rect: CGRect, with context: CGContext) {
-        if let blockquoteBackgroundColor = blockquoteBackgroundColor {
-            blockquoteBackgroundColor.setFill()
-            context.fill(rect)
-
-        }
-
-        if let blockquoteBorderColor = blockquoteBorderColor {
-            let borderRect = CGRect(origin: rect.origin, size: CGSize(width: blockquoteBorderWidth, height: rect.height))
-            blockquoteBorderColor.setFill()
-            context.fill(borderRect)
-        }
+    private func drawBlockquoteBackground(in rect: CGRect, with context: CGContext) {
+        guard let color = blockquoteBackgroundColor else {return}
+        
+        color.setFill()
+        context.fill(rect)
     }
 }
 
diff --git a/Aztec/Classes/TextKit/ParagraphStyle.swift b/Aztec/Classes/TextKit/ParagraphStyle.swift
@@ -175,22 +175,41 @@ open class ParagraphStyle: NSMutableParagraphStyle, CustomReflectable {
             super.tailIndent = newValue
         }
     }
-
-    /// The amount of indent for the blockquote of the paragraph if any.
-    ///
+    
+    /// The level of indent to start the blockquote of the paragraph. Includes list indentation.
+    /// Handles whether blockquote is outside or insdie of a list.
     public var blockquoteIndent: CGFloat {
-        let blockquoteIndex = properties.filter({ property in
+        let listAndBlockquotes = properties.filter({ property in
             return property is Blockquote || property is TextList
-        }).firstIndex(where: { property in
-            return property is Blockquote
         })
-
-        guard let depth = blockquoteIndex else {
+        if listAndBlockquotes.first is Blockquote {
             return 0
         }
-
+        var depth = 0
+        for position in (0..<listAndBlockquotes.count).reversed() {
+            if listAndBlockquotes[position] is Blockquote {
+                depth = position
+                break
+            }
+        }
         return CGFloat(depth) * Metrics.listTextIndentation
     }
+    
+    /// The level of depth for the nested blockquote of the paragraph. Excludes list indentation.
+    ///
+    public var blockquoteNestDepth: Int {
+        let listAndBlockquotes = properties.filter({ property in
+            return property is Blockquote
+        })
+        var depth = 0
+        for position in (0..<listAndBlockquotes.count).reversed() {
+            if listAndBlockquotes[position] is Blockquote {
+                depth = position
+                break
+            }
+        }
+        return depth
+    }
 
     /// The amount of indent for the list of the paragraph if any.
     ///
diff --git a/Aztec/Classes/TextKit/TextView.swift b/Aztec/Classes/TextKit/TextView.swift
@@ -223,6 +223,12 @@ open class TextView: UITextView {
     // MARK: - Properties: Text Lists
 
     var maximumListIndentationLevels = 7
+    
+    // MARK: - Properties: Blockquotes
+    
+    /// The max levels of quote indentation allowed
+    /// Default is 9
+    public var maximumBlockquoteIndentationLevels = 9
 
     // MARK: - Properties: UI Defaults
 
@@ -295,17 +301,18 @@ open class TextView: UITextView {
 
     // MARK: - Apparance Properties
 
-    /// Blockquote Blocks Border Color.
+    
+    /// Blockquote Blocks Border and Text Colors
     ///
-    @objc dynamic public var blockquoteBorderColor: UIColor? {
+    @objc dynamic public var blockquoteBorderColors: [UIColor] {
         get {
-            return layout.blockquoteBorderColor
+            return layout.blockquoteBorderColors
         }
         set {
-            layout.blockquoteBorderColor = newValue
+            layout.blockquoteBorderColors = newValue
         }
     }
-
+    
     /// Blockquote Blocks Background Color.
     ///
     @objc dynamic public var blockquoteBackgroundColor: UIColor? {
@@ -547,41 +554,110 @@ open class TextView: UITextView {
     }
 
     @objc func handleShiftTab(command: UIKeyCommand) {
-        guard let list = TextListFormatter.lists(in: typingAttributes).last else {
+        
+        let lists = TextListFormatter.lists(in: typingAttributes)
+        let quotes = BlockquoteFormatter.blockquotes(in: typingAttributes)
+        
+        if let list = lists.last {
+            indent(list: list, increase: false)
+            
+        } else if let quote = quotes.last {
+            indent(blockquote: quote, increase: false)
+            
+        } else {
             return
         }
+    }
+
+    @objc func handleTab(command: UIKeyCommand) {
+        
+        let lists = TextListFormatter.lists(in: typingAttributes)
+        let quotes = BlockquoteFormatter.blockquotes(in: typingAttributes)
+
+        if let list = lists.last, lists.count < maximumListIndentationLevels {
+            indent(list: list)
+
+        } else if let quote = quotes.last, quotes.count < maximumBlockquoteIndentationLevels {
+            indent(blockquote: quote)
+
+        } else {
+            insertText(String(.tab))
+        }
+        
+    }
+    
+    
+    // MARK: - Text List indent methods
+    
+    private func indent(list: TextList, increase: Bool = true) {
 
         let formatter = TextListFormatter(style: list.style, placeholderAttributes: nil, increaseDepth: true)
-        let liFormatter = LiFormatter(placeholderAttributes: nil)
+        let li = LiFormatter(placeholderAttributes: nil)
+
         let targetRange = formatter.applicationRange(for: selectedRange, in: storage)
 
         performUndoable(at: targetRange) {
-            let finalRange = formatter.removeAttributes(from: storage, at: targetRange)
-            liFormatter.removeAttributes(from: storage, at: targetRange)
+            let finalRange: NSRange
+            if increase {
+                finalRange = increaseIndent(listFormatter: formatter, liFormatter: li, targetRange: targetRange)
+            } else {
+                finalRange = decreaseIndent(listFormatter: formatter, liFormatter: li, targetRange: targetRange)
+            }
             typingAttributes = textStorage.attributes(at: targetRange.location, effectiveRange: nil)
             return finalRange
         }
-    }
-
-    @objc func handleTab(command: UIKeyCommand) {
-        let lists = TextListFormatter.lists(in: typingAttributes)
-        guard let list = lists.last, lists.count < maximumListIndentationLevels else {
-            insertText(String(.tab))
-            return
-        }
 
-        let formatter = TextListFormatter(style: list.style, placeholderAttributes: nil, increaseDepth: true)
-        let liFormatter = LiFormatter(placeholderAttributes: nil)
+    }
+    
+    // MARK: Text List increase or decrease indentation
+    private func increaseIndent(listFormatter: TextListFormatter, liFormatter: LiFormatter, targetRange: NSRange) -> NSRange {
+        let finalRange = listFormatter.applyAttributes(to: storage, at: targetRange)
+        liFormatter.applyAttributes(to: storage, at: targetRange)
+        
+        return finalRange
+    }
+    
+    private func decreaseIndent(listFormatter: TextListFormatter, liFormatter: LiFormatter, targetRange: NSRange) -> NSRange {
+        let finalRange = listFormatter.removeAttributes(from: storage, at: targetRange)
+        liFormatter.removeAttributes(from: storage, at: targetRange)
+        
+        return finalRange
+    }
+    
+    
+    // MARK: - Blockquote indent methods
+    
+    private func indent(blockquote: Blockquote, increase: Bool = true) {
+        
+        
+        
+        let formatter = BlockquoteFormatter(placeholderAttributes: typingAttributes, increaseDepth: true)
         let targetRange = formatter.applicationRange(for: selectedRange, in: storage)
 
-        performUndoable(at: targetRange) { 
-            let finalRange = formatter.applyAttributes(to: storage, at: targetRange)
-            liFormatter.applyAttributes(to: storage, at: targetRange)
+        performUndoable(at: targetRange) {
+            let finalRange: NSRange
+            if increase {
+                finalRange = increaseIndent(quoteFormatter: formatter, targetRange: targetRange)
+            } else {
+                finalRange = decreaseIndent(quoteFormatter: formatter, targetRange: targetRange)
+            }
             typingAttributes = textStorage.attributes(at: targetRange.location, effectiveRange: nil)
             return finalRange
         }
+
     }
 
+    // MARK: Blockquote increase or decrease indentation
+    private func increaseIndent(quoteFormatter: BlockquoteFormatter, targetRange: NSRange) -> NSRange {
+        let finalRange = quoteFormatter.applyAttributes(to: storage, at: targetRange)
+        return finalRange
+    }
+    
+    private func decreaseIndent(quoteFormatter: BlockquoteFormatter, targetRange: NSRange) -> NSRange {
+        let finalRange = quoteFormatter.removeAttributes(from: storage, at: targetRange)
+        return finalRange
+    }
+    
 
     // MARK: - Pasteboard Helpers
 
@@ -1004,6 +1080,7 @@ open class TextView: UITextView {
         ensureInsertionOfEndOfLineForEmptyParagraphAtEndOfFile(forApplicationRange: range)
 
         let formatter = BlockquoteFormatter(placeholderAttributes: typingAttributes)
+        
         toggle(formatter: formatter, atRange: range)
         
         let citeFormatter = CiteFormatter()
diff --git a/Example/Example/EditorDemoController.swift b/Example/Example/EditorDemoController.swift

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ class TextListFormatter: ParagraphAttributeFormatter {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`let newList = TextList(style: self.listStyle, with: representation)`
	`38`	`+`
`38`	`39`	`if newParagraphStyle.lists.isEmpty \|\| increaseDepth {`
`39`	`40`	`newParagraphStyle.insertProperty(newList, afterLastOfType: HTMLLi.self)`
`40`	`41`	`} else {`