Merge pull request #1204 from wordpress-mobile/release/1.8.0

Release/1.8.0

Author: etoledom

Aztec/Classes/Extensions/NSMutableAttributedString+ReplaceOcurrences.swift

@@ -32,17 +32,19 @@ extension NSMutableAttributedString {
 
         assert(!replacementString.contains(stringToFind),
                "Allowing the replacement string to contain the original string would result in a ininite loop.")
-
-        let swiftUTF16Range = string.utf16.range(from: range)
+        let rangeDifference = (replacementString as NSString).length - (stringToFind as NSString).length
+        var swiftUTF16Range = string.utf16.range(from: range)
         var swiftRange = string.range(from: swiftUTF16Range)
-
         while let matchRange = string.range(of: stringToFind, options: [], range: swiftRange, locale: nil) {
             let matchNSRange = string.utf16NSRange(from: matchRange)
 
             replaceCharacters(in: matchNSRange, with: replacementString)
 
             // Since the new string may invalidate the initial swift range, we want to update it.
-            swiftRange = swiftRange.lowerBound ..< string.index(matchRange.lowerBound, offsetBy: replacementString.count)
+            // And because the string that backs the NSAttributeString will change after the replace we need to recalculate the index from scratch
+            let updatedRange = range.extendedRight(by: rangeDifference)
+            swiftUTF16Range = string.utf16.range(from: updatedRange)
+            swiftRange = string.range(from: swiftUTF16Range)
         }
     }
 }

Aztec/Classes/Extensions/UITextView+Delegate.swift

@@ -6,6 +6,9 @@ extension UITextView {
     /// Notifies the delegate of a text change.
     ///
     final func notifyTextViewDidChange() {
+        if let textView = self as? TextView, !textView.shouldNotifyOfNonUserChanges {
+            return
+        }
         delegate?.textViewDidChange?(self)
         NotificationCenter.default.post(name: UITextView.textDidChangeNotification, object: self)
     }

Aztec/Classes/NSAttributedString/Conversions/HTMLConverter.swift

@@ -20,7 +20,11 @@ public class HTMLConverter {
     }
 
     // MARK: - Converters: HTML -> AttributedString
-    
+
+    /// If a value is set the character set will be used to replace any last empty line created by the converter.
+    ///
+    open var characterToReplaceLastEmptyLine: Character?
+
     let htmlToTree = HTMLParser()
 
     private(set) lazy var treeToAttributedString: AttributedStringSerializer = {
@@ -54,11 +58,27 @@ public class HTMLConverter {
         pluginManager.process(htmlTree: rootNode)
 
         let defaultAttributes = defaultAttributes ?? [:]
-        let attributedString = treeToAttributedString.serialize(rootNode, defaultAttributes: defaultAttributes)
+        var attributedString = treeToAttributedString.serialize(rootNode, defaultAttributes: defaultAttributes)
+
+        if let characterToUse = characterToReplaceLastEmptyLine {
+            attributedString = replaceLastEmptyLine(in: attributedString, with: characterToUse)
+        }
 
         return attributedString
     }
 
+    func replaceLastEmptyLine(in attributedString: NSAttributedString, with replacement: Character) -> NSAttributedString {
+        var result = attributedString
+        let string = attributedString.string
+        if !string.isEmpty, string.isEmptyLineAtEndOfFile(at: string.count), string.hasSuffix(String(.paragraphSeparator)), let location = string.location(before: attributedString.length) {
+            let mutableString = NSMutableAttributedString(attributedString: attributedString)
+            let attributes = mutableString.attributes(at: location, effectiveRange: nil)
+            mutableString.replaceCharacters(in: NSRange(location: location, length: attributedString.length-location), with: NSAttributedString(string: String(replacement), attributes: attributes))
+            result = mutableString
+        }
+        return result
+    }
+
 
     /// Check if the given html string is supported to be parsed into Attributed Strings.
     ///

Aztec/Classes/TextKit/TextStorage.swift

@@ -81,7 +81,7 @@ open class TextStorage: NSTextStorage {
 
     // MARK: - HTML Conversion
 
-    let htmlConverter = HTMLConverter()
+    public let htmlConverter = HTMLConverter()
 
     // MARK: - PluginManager
 

Aztec/Classes/TextKit/TextView.swift

@@ -173,6 +173,11 @@ open class TextView: UITextView {
     ///
     open var pasteboardDelegate: TextViewPasteboardDelegate = AztecTextViewPasteboardDelegate()
 
+
+    /// If this is true the text view will notify is delegate and notification system when changes happen by calls to methods like setHTML
+    ///
+    open var shouldNotifyOfNonUserChanges = true
+
     // MARK: - Customizable Input VC
 
     private var customInputViewController: UIInputViewController?
@@ -267,7 +272,7 @@ open class TextView: UITextView {
 
     // MARK: - TextKit Aztec Subclasses
 
-    var storage: TextStorage {
+    public var storage: TextStorage {
         return textStorage as! TextStorage
     }
 

AztecTests/Extensions/NSMutableAttributedStringReplaceOcurrencesTests.swift

@@ -88,4 +88,14 @@ class NSMutableAttributedStringReplaceOcurrencesTests: XCTestCase {
 
         XCTAssertEqual(newAttrString, NSAttributedString(string: "🌎💚💚😬💚🌎"))
     }
+
+    /// Tests that replacing ocurrences on the end of a range work correctly
+    ///
+    func testReplaceOcurrencesThatAreOnEndOfRange() {
+        let attrString = NSAttributedString(string: "Hello"+String(.paragraphSeparator)+"Amazing"+String(.paragraphSeparator)+"World"+String(.paragraphSeparator))
+        let newAttrString = NSMutableAttributedString(attributedString: attrString)
+        newAttrString.replaceOcurrences(of: String(.paragraphSeparator), with: String(.lineFeed), within: NSRange(location:6, length: 8))
+
+        XCTAssertEqual(newAttrString, NSAttributedString(string: "Hello"+String(.paragraphSeparator)+"Amazing"+String(.lineFeed)+"World"+String(.paragraphSeparator)))
+    }
 }

AztecTests/TextKit/TextStorageTests.swift

@@ -494,4 +494,48 @@ class TextStorageTests: XCTestCase {
 
         XCTAssertEqual(expectedResult, result)
     }
+
+    func testEmptyListOutput() {
+        let initialHTML = "<ul><li></li></ul>"
+
+        // Setup
+        let defaultAttributes: [NSAttributedString.Key: Any] = [.font: UIFont.systemFont(ofSize: 14),
+                                                                .paragraphStyle: ParagraphStyle.default]
+
+        storage.setHTML(initialHTML, defaultAttributes: defaultAttributes)
+        var expectedResult = String(.paragraphSeparator)
+        var result = String(storage.string)
+
+        XCTAssertEqual(expectedResult, result)
+
+        storage.htmlConverter.characterToReplaceLastEmptyLine = Character(.zeroWidthSpace)
+
+        storage.setHTML(initialHTML, defaultAttributes: defaultAttributes)
+        expectedResult = String(.zeroWidthSpace)
+        result = String(storage.string)
+
+        XCTAssertEqual(expectedResult, result)
+    }
+
+    func testCiteOutput() {
+        let initialHTML = "<cite>Hello<br></cite>"
+
+        // Setup
+        let defaultAttributes: [NSAttributedString.Key: Any] = [.font: UIFont.systemFont(ofSize: 14),
+                                                                .paragraphStyle: ParagraphStyle.default]
+
+        storage.setHTML(initialHTML, defaultAttributes: defaultAttributes)
+        var expectedResult = String("Hello")+String(.lineSeparator)
+        var result = String(storage.string)
+
+        XCTAssertEqual(expectedResult, result)
+
+        storage.htmlConverter.characterToReplaceLastEmptyLine = Character(.zeroWidthSpace)
+
+        storage.setHTML(initialHTML, defaultAttributes: defaultAttributes)
+        expectedResult = String("Hello")+String(.lineSeparator)
+        result = String(storage.string)
+
+        XCTAssertEqual(expectedResult, result)
+    }
 }

AztecTests/TextKit/TextViewTests.swift

@@ -1254,6 +1254,22 @@ class TextViewTests: XCTestCase {
         XCTAssertEqual(textView.text, Constants.sampleText0 + Constants.sampleText1 + String(.lineFeed) + String(.lineFeed))
     }
 
+    /// Verifies that toggling a Blockquote paragraph in the middle of paragraph does not crash system.    
+    ///
+    func testTogglingBlockquoteOnMiddleOfRangeDoesNotCrash() {
+        let initialQuote = """
+            <blockquote><strong>Quote One</strong></blockquote>
+            <blockquote><strong>Quote Two</strong></blockquote>
+            <blockquote><strong>Quote Three</strong></blockquote>
+        """
+        let textView = TextViewStub(withHTML: initialQuote)
+
+        textView.selectedTextRange = textView.textRange(from: textView.endOfDocument, to: textView.endOfDocument)
+        textView.toggleBlockquote(range: NSRange(location: 11, length: 0))
+
+        XCTAssertEqual(textView.text, "Quote One" + String(.paragraphSeparator)+"Quote Two"+String(.lineFeed)+"Quote Three")
+    }
+
 
     // MARK: - Pre
 

CONTRIBUTING.md

@@ -1,25 +1,31 @@
-# Contributing to Aztec
+# How to Contribute
 
-Hi! Thank you for your interest in contributing to the app, we really appreciate it.
+First off, thank you for contributing! We're excited to collaborate with you! 🎉
 
-There are many ways to contribute – reporting bugs, feature suggestions, fixing bugs, submitting pull requests for enhancements.
+The following is a set of guidelines for the many ways you can join our collective effort.
 
-## Reporting Bugs, Asking Questions, Sending Suggestions
+Before anything else, please take a moment to read our [Code of Conduct](CODE-OF-CONDUCT.md). We expect all participants, from full-timers to occasional tinkerers, to uphold it.
 
-Just [file a GitHub issue](https://github.com/wordpress-mobile/WordPress-Aztec-iOS/issues), that’s all. If you want to prefix the title with a “Question:”, “Bug:”, "Feature Request:", or the general area of the application, that would be helpful, but by no means mandatory. If you have write access, add the appropriate labels.
+## Reporting Bugs, Asking Questions, and Suggesting Features
 
-If you’re filing a bug, specific steps to reproduce are helpful. Please include the part of the app that has the bug, along with what you expected to see and what happened instead.  A screenshot is always helpful as well.
+Have a suggestion or feedback? Please go to [Issues](https://github.com/wordpress-mobile/AztecEditor-iOS/issues) and [open a new issue](https://github.com/wordpress-mobile/AztecEditor-iOS/issues/new). Prefix the title with a category like _"Bug:"_, _"Question:"_, or _"Feature Request:"_. Screenshots help us resolve issues and answer questions faster, so thanks for including some if you can.
 
-## Submitting code changes
+## Submitting Code Changes
 
-We welcome Pull Requests for bug fixes on any open issues that you'd like to contribute!  More details on our process can be found in the [Make WordPress Mobile handbook](https://make.wordpress.org/mobile/handbook/pathways/ios/), specifically [here](https://make.wordpress.org/mobile/handbook/pathways/ios/how-to-contribute/).
+If you're just getting started and want to familiarize yourself with the app’s code, we suggest looking at [these issues](https://github.com/wordpress-mobile/AztecEditor-iOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) with the **good first issue** label. But if you’d like to tackle something different, you're more than welcome to visit the [Issues](https://github.com/wordpress-mobile/AztecEditor-iOS/issues) page and pick an item that interests you.
 
-## Discussion
+We always try to avoid duplicating efforts, so if you decide to work on an issue, leave a comment to state your intent. If you choose to focus on a new feature or the change you’re proposing is significant, we recommend waiting for a response before proceeding. The issue may no longer align with project goals.
 
-Aside from writing issues and pull requests, you can also hang out in the #mobile WordPress.org Slack channel with other WordPress Mobile developers/contributors. Check out chat.wordpress.org for instructions on how to create an account in Slack.
+If the change is trivial, feel free to send a pull request without notifying us.
 
-The purpose of the Slack chat is to provide updates about ongoing initiatives regarding the mobile apps and to discuss, prioritize and coordinate future changes. If you have questions, Slack chat is a great place to start.
+### Pull Requests and Code Reviews
 
-## Contribute to translations
+All code contributions pass through pull requests. If you haven't created a pull request before, we recommend this free video series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 
-We use a tool called GlotPress to manage translations. The WordPress-iOS GlotPress instance lives here: http://translate.wordpress.org/projects/apps/ios/dev. To add new translations or fix existing ones, create an account over at GlotPress and submit your changes over at the GlotPress site.
+The core team monitors and reviews all pull requests. Depending on the changes, we will either approve them or close them with an explanation. We might also work with you to improve a pull request before approval.
+
+We do our best to respond quickly to all pull requests. If you don't get a response from us after a week, feel free to reach out to us via Slack.
+
+## Getting in Touch
+
+If you have questions or just want to say hi, join the [WordPress Slack](https://make.wordpress.org/chat/) and drop a message on the `#mobile` channel.

README.md

@@ -83,6 +83,14 @@ let textView = Aztec.TextView(
     defaultMissingImage: UIImage) {
 ```
 
+## Contributing
+
+Read our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues, contributing code, and more ways to contribute.
+
+## Getting in Touch
+
+If you have questions about getting setup or just want to say hi, join the [WordPress Slack](https://chat.wordpress.org) and drop a message on the `#mobile` channel.
+
 ## License
 
 WordPress-Aztec-iOS is available under the GPLv2 license. See the [LICENSE file](./LICENSE) for more info.