Merge branch 'develop' into issue/464-missing-suggestions

mzorz · web-flow · commit fe554bbc074e · 2017-11-16T10:00:40.000-03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
 
+## [Unreleased]
+### Fixed
+- Paragraphs with attributes being removed
 
 ## [1.0-beta.10](https://github.com/wordpress-mobile/AztecEditor-Android/releases/tag/v1.0-beta.10) - 2017-10-06
 ### Fixed
diff --git a/README.md b/README.md
@@ -8,6 +8,58 @@ documents in Android.
 
 Supports Android 4.1+ (API 16 - Jelly Bean)
 
+## Getting started
+
+Declare the main components in your layout:
+
+Visual editor
+```XML
+<org.wordpress.aztec.AztecText
+    android:id="@+id/visual"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:scrollbars="vertical"
+    android:imeOptions="flagNoExtractUi"
+    aztec:historyEnable="false" />
+```
+Source editor
+```XML
+<org.wordpress.aztec.source.SourceViewEditText
+    android:id="@+id/source"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:inputType="textNoSuggestions|textMultiLine"
+    android:scrollbars="vertical"
+    android:imeOptions="flagNoExtractUi"
+    aztec:codeBackgroundColor="@android:color/transparent"
+    aztec:codeTextColor="@android:color/white" />
+```
+
+Toolbar
+```XML
+<org.wordpress.aztec.toolbar.AztecToolbar
+    android:id="@+id/formatting_toolbar"
+    android:layout_width="match_parent"
+    android:layout_height="@dimen/format_bar_height"
+    android:layout_alignParentBottom="true" />
+```
+
+Inflate the views:
+```kotlin
+val visualEditor = findViewById<AztecText>(R.id.visual)
+val sourceEditor = findViewById<SourceViewEditText>(R.id.source)
+val toolbar = findViewById<AztecToolbar>(R.id.formatting_toolbar)
+```
+
+Configure Aztec with a provided image & video loaders:
+```kotlin
+Aztec.with(visualEditor, sourceEditor, toolbar, context)
+    .setImageGetter(GlideImageLoader(context))
+    .setVideoThumbnailGetter(GlideVideoThumbnailLoader(context))
+```
+
+For more options, such as edit history, listeners and plugins please refer to the [demo app implementation](https://github.com/wordpress-mobile/AztecEditor-Android/blob/9fdc1958ca1e1ad5de6fba15dabe251bcf0fc7b6/app/src/main/kotlin/org/wordpress/aztec/demo/MainActivity.kt#L331-L346).
+
 ## Build and test
 
 Build the library, build the example project and run unit tests:
@@ -39,7 +91,7 @@ On your device, under Settings -> Accessibility -> Touch & hold delay, set the d
 Run the instrumentation tests:
 
 ```shell
-$ adb shell am instrument -w -r -e package org.wordpress.aztec.demo -e debug false org.wordpress.aztec.test/android.support.test.runner.AndroidJUnitRunner
+$ ./gradlew cAT
 ```
 
 ## Integrating Aztec in your project
diff --git a/app/src/androidTest/kotlin/org/wordpress/aztec/demo/tests/ImageTests.kt b/app/src/androidTest/kotlin/org/wordpress/aztec/demo/tests/ImageTests.kt
@@ -50,7 +50,7 @@ class ImageTests : BaseTest() {
 
     @Test
     fun testAddTwoPhotos() {
-        val regex = Regex(".*<img src=.+>.*<img src=.+>.*")
+        val regex = Regex(".*<img src=.+>.*<img src=.+>.*", RegexOption.DOT_MATCHES_ALL)
 
         createImageIntentFilter()
         addPhotoWithHTML()
diff --git a/app/src/androidTest/kotlin/org/wordpress/aztec/demo/tests/MixedTextFormattingTests.kt b/app/src/androidTest/kotlin/org/wordpress/aztec/demo/tests/MixedTextFormattingTests.kt
@@ -66,6 +66,21 @@ class MixedTextFormattingTests : BaseTest() {
                 .verifyHTML(html2)
     }
 
+    @Test
+    fun testRetainParagraphFormatting() {
+        // Paragraph are only retained if they have at least one attribute
+        // https://github.com/wordpress-mobile/AztecEditor-Android/pull/483#discussion_r151377857
+        val text = "some text"
+        val html = "<p a=\"ok\">$text</p>"
+
+        EditorPage()
+                .toggleHtml()
+                .insertHTML(html)
+                .toggleHtml()
+                .toggleHtml()
+                .verifyHTML(html)
+    }
+
     @Test
     fun testRetainHeadingFormatting() {
         val text = "some text"
diff --git a/app/src/main/kotlin/org/wordpress/aztec/demo/MainActivity.kt b/app/src/main/kotlin/org/wordpress/aztec/demo/MainActivity.kt
@@ -57,6 +57,7 @@ import org.wordpress.aztec.toolbar.IAztecToolbarClickListener
 import org.wordpress.aztec.watchers.BlockElementWatcher
 import org.xml.sax.Attributes
 import java.io.File
+import java.util.Random
 
 open class MainActivity : AppCompatActivity(),
         AztecText.OnImeBackListener,
@@ -252,8 +253,7 @@ open class MainActivity : AppCompatActivity(),
     }
 
     private fun generateAttributesForMedia(mediaPath: String, isVideo: Boolean): Pair<String, AztecAttributes> {
-        val id = (Math.random() * Int.MAX_VALUE).toString()
-
+        val id = Random().nextInt(Integer.MAX_VALUE).toString()
         val attrs = AztecAttributes()
         attrs.setValue("src", mediaPath) // Temporary source value.  Replace with URL after uploaded.
         attrs.setValue("id", id)
@@ -346,7 +346,7 @@ open class MainActivity : AppCompatActivity(),
             .addPlugin(AudioShortcodePlugin())
 
         BlockElementWatcher(visualEditor)
-                .add(CaptionHandler())
+                .add(CaptionHandler(visualEditor))
                 .install(visualEditor)
 
         // initialize the text & HTML
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/AztecTagHandler.kt b/aztec/src/main/kotlin/org/wordpress/aztec/AztecTagHandler.kt
@@ -98,7 +98,7 @@ class AztecTagHandler(val context: Context, val plugins: List<IAztecPlugin> = Ar
                 return true
             }
             IMAGE -> {
-                handleMediaElement(opening, output, AztecImageSpan(context, loadingDrawable, AztecAttributes(attributes)))
+                handleMediaElement(opening, output, AztecImageSpan(context, loadingDrawable, nestingLevel, AztecAttributes(attributes)))
                 return true
             }
             VIDEO -> {
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/AztecText.kt b/aztec/src/main/kotlin/org/wordpress/aztec/AztecText.kt
@@ -905,7 +905,7 @@ class AztecText : AppCompatEditText, TextWatcher, UnknownHtmlSpan.OnUnknownHtmlT
 
         parser.syncVisualNewlinesOfBlockElements(output)
 
-        Format.postProcessSpanedText(output, isInCalypsoMode)
+        Format.postProcessSpannedText(output, isInCalypsoMode)
 
         return EndOfBufferMarkerAdder.removeEndOfTextMarker(parser.toHtml(output, withCursorTag))
     }
@@ -1064,7 +1064,7 @@ class AztecText : AppCompatEditText, TextWatcher, UnknownHtmlSpan.OnUnknownHtmlT
 
         clearMetaSpans(output)
         parser.syncVisualNewlinesOfBlockElements(output)
-        Format.postProcessSpanedText(output, isInCalypsoMode)
+        Format.postProcessSpannedText(output, isInCalypsoMode)
 
         // do not copy unnecessary block hierarchy, just the minimum required
         var deleteNext = false
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/formatting/LineBlockFormatter.kt b/aztec/src/main/kotlin/org/wordpress/aztec/formatting/LineBlockFormatter.kt
@@ -133,7 +133,8 @@ class LineBlockFormatter(editor: AztecText) : AztecFormatter(editor) {
 
     fun insertImage(drawable: Drawable?, attributes: Attributes, onImageTappedListener: OnImageTappedListener?,
                     onMediaDeletedListener: AztecText.OnMediaDeletedListener?) {
-        val span = AztecImageSpan(editor.context, drawable, AztecAttributes(attributes), onImageTappedListener,
+        val nestingLevel = IAztecNestable.getNestingLevelAt(editableText, selectionStart)
+        val span = AztecImageSpan(editor.context, drawable, nestingLevel, AztecAttributes(attributes), onImageTappedListener,
                 onMediaDeletedListener, editor)
         insertMedia(span)
     }
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/plugins/IToolbarButton.kt b/aztec/src/main/kotlin/org/wordpress/aztec/plugins/IToolbarButton.kt
@@ -3,6 +3,7 @@ package org.wordpress.aztec.plugins
 import android.content.Context
 import android.view.KeyEvent
 import android.view.ViewGroup
+import org.wordpress.aztec.toolbar.AztecToolbar
 import org.wordpress.aztec.toolbar.IToolbarAction
 import org.wordpress.aztec.toolbar.RippleToggleButton
 
@@ -40,4 +41,11 @@ interface IToolbarButton : IAztecPlugin {
      * @param parent view to be the parent of the generated hierarchy.
      */
     fun inflateButton(parent: ViewGroup)
+
+    /**
+     * Signals the ToolbarButton that the toolbar is about to change its enabled/disabled state
+     *
+     * This method is called when the toolbar buttons get "disabled/enabled"
+     */
+    fun toolbarStateAboutToChange(toolbar: AztecToolbar, enable: Boolean)
 }
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/source/Format.kt b/aztec/src/main/kotlin/org/wordpress/aztec/source/Format.kt
@@ -108,11 +108,10 @@ internal object Format {
         }
 
         // Pretty it up for the source editor
-        val blocklist = "blockquote|ul|ol|li|table|thead|tbody|tfoot|tr|th|td|h[1-6]|fieldset"
-        val blocklist1 = blocklist + "|div|p"
+        val blocklist = "blockquote|ul|ol|li|table|thead|tbody|tfoot|tr|th|td|h[1-6]|fieldset|div|p"
 
-        content = replaceAll(content, "\\s*</($blocklist1)>\\s*", "</$1>\n")
-        content = replaceAll(content, "\\s*<((?:$blocklist1)(?: [^>]*)?)>", "\n<$1>")
+        content = replaceAll(content, "\\s*</($blocklist)>\\s*", "</$1>\n")
+        content = replaceAll(content, "\\s*<((?:$blocklist)(?: [^>]*)?)>", "\n<$1>")
 
         content = replaceAll(content, "\\s*<(!--.*?--|hr)>\\s*", "\n\n<$1>\n\n")
 
@@ -153,7 +152,7 @@ internal object Format {
         }
 
         // Unmark special paragraph closing tags
-        content = replaceAll(content, "</p#>", "</p>\n")
+        content = replaceAll(content, "</p#>", "</p>")
         content = replaceAll(content, "\\s*(<p [^>]+>[\\s\\S]*?</p>)", "\n$1")
 
         // Trim whitespace
@@ -307,13 +306,15 @@ internal object Format {
             }
 
             // we don't need paragraph spans in calypso at this point
-            text.getSpans(0, text.length, ParagraphSpan::class.java).forEach {
-                text.removeSpan(it)
-            }
+            text.getSpans(0, text.length, ParagraphSpan::class.java)
+                    .filter { it.attributes.isEmpty() }
+                    .forEach {
+                        text.removeSpan(it)
+                    }
         }
     }
 
-    fun postProcessSpanedText(text: SpannableStringBuilder, isCalypsoFormat: Boolean) {
+    fun postProcessSpannedText(text: SpannableStringBuilder, isCalypsoFormat: Boolean) {
         if (isCalypsoFormat) {
             val spans = text.getSpans(0, text.length, EndOfParagraphMarker::class.java)
             spans.sortByDescending { text.getSpanStart(it) }
@@ -324,20 +325,36 @@ internal object Format {
                 val spanEnd = text.getSpanEnd(it)
 
                 if (text[spanStart] == '\n' && text.getSpans(spanEnd, spanEnd + 1, IAztecParagraphStyle::class.java)
-                        .filter { it !is ParagraphSpan && text.getSpanStart(it) == spanEnd }.isEmpty()) {
+                        .filter { (it !is ParagraphSpan || !it.attributes.isEmpty()) && text.getSpanStart(it) == spanEnd }.isEmpty()) {
                     text.insert(spanEnd, "\n")
                 }
 
                 if (text.getSpans(spanStart, spanEnd, AztecQuoteSpan::class.java)
-                        .filter { text.getSpanEnd(it) == spanEnd }.isEmpty()) {
+                        .filter { text.getSpanEnd(it) == spanEnd }.isEmpty() &&
+                    text.getSpans(spanStart, spanEnd, ParagraphSpan::class.java)
+                            .filter { !it.attributes.isEmpty() }.isEmpty()) {
                     text.getSpans(spanStart, spanEnd, AztecVisualLinebreak::class.java).forEach { text.removeSpan(it) }
                 }
             }
 
-            // we don't care about actual ParagraphSpan in calypso - paragraphs are made from double newline
-            text.getSpans(0, text.length, ParagraphSpan::class.java).forEach {
-                text.removeSpan(it)
-            }
+            // split up paragraphs that contain double newlines
+            text.getSpans(0, text.length, ParagraphSpan::class.java)
+                    .forEach {
+                        val start = text.getSpanStart(it)
+                        val end = text.getSpanEnd(it)
+                        val double = text.indexOf("\n\n", start)
+                        if (double != -1 && double < end) {
+                            text.setSpan(it, start, double + 1, text.getSpanFlags(it))
+                            text.setSpan(AztecVisualLinebreak(), double + 1, double + 2, text.getSpanFlags(it))
+                        }
+                    }
+
+            // we don't care about actual ParagraphSpan in calypso that don't have attributes or are empty (paragraphs are made from double newline)
+            text.getSpans(0, text.length, ParagraphSpan::class.java)
+                    .filter { it.attributes.isEmpty() || text.getSpanStart(it) == text.getSpanEnd(it) - 1 }
+                    .forEach {
+                        text.removeSpan(it)
+                    }
         }
     }
 
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/spans/AztecImageSpan.kt b/aztec/src/main/kotlin/org/wordpress/aztec/spans/AztecImageSpan.kt
@@ -5,10 +5,12 @@ import android.graphics.drawable.Drawable
 import org.wordpress.aztec.AztecAttributes
 import org.wordpress.aztec.AztecText
 
-class AztecImageSpan(context: Context, drawable: Drawable?, attributes: AztecAttributes = AztecAttributes(),
+class AztecImageSpan(context: Context, drawable: Drawable?,
+                     override var nestingLevel: Int,
+                     attributes: AztecAttributes = AztecAttributes(),
                      var onImageTappedListener: AztecText.OnImageTappedListener? = null,
                      onMediaDeletedListener: AztecText.OnMediaDeletedListener? = null,
-                     editor: AztecText? = null) :
+                     editor: AztecText? = null) : IAztecFullWidthImageSpan,
         AztecMediaSpan(context, drawable, attributes, onMediaDeletedListener, editor) {
     override val TAG: String = "img"
 
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/spans/AztecOrderedListSpan.kt b/aztec/src/main/kotlin/org/wordpress/aztec/spans/AztecOrderedListSpan.kt
@@ -31,8 +31,11 @@ class AztecOrderedListSpan(
     ) : AztecListSpan(nestingLevel, listStyle.verticalPadding) {
     override val TAG = "ol"
 
+    private var horizontalShift = 0
+    private var maxWidth = 0f
+
     override fun getLeadingMargin(first: Boolean): Int {
-        return listStyle.indicatorMargin + 2 * listStyle.indicatorWidth + listStyle.indicatorPadding
+        return listStyle.indicatorMargin + 2 * listStyle.indicatorWidth + listStyle.indicatorPadding + horizontalShift
     }
 
     override fun drawLeadingMargin(c: Canvas, p: Paint, x: Int, dir: Int,
@@ -56,7 +59,20 @@ class AztecOrderedListSpan(
         val textToDraw = if (lineIndex > -1) getIndexOfProcessedLine(text, end).toString() + "." else ""
 
         val width = p.measureText(textToDraw)
-        c.drawText(textToDraw, (listStyle.indicatorMargin + x + dir - width) * dir, baseline.toFloat(), p)
+        maxWidth = Math.max(maxWidth, width)
+
+        var textStart = (listStyle.indicatorMargin + x + dir - width) * dir
+
+        if (textStart < 0) {
+            horizontalShift = -textStart.toInt()
+            textStart = 0f
+        }
+
+        if (horizontalShift > 0 && width < maxWidth) {
+            textStart += horizontalShift
+        }
+
+        c.drawText(textToDraw, textStart, baseline.toFloat(), p)
 
         p.color = oldColor
         p.style = style
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/toolbar/AztecToolbar.kt b/aztec/src/main/kotlin/org/wordpress/aztec/toolbar/AztecToolbar.kt
@@ -766,6 +766,7 @@ class AztecToolbar : FrameLayout, OnMenuItemClickListener {
                 toggleButtonState(findViewById(action.buttonId), !isEnabled)
             }
         }
+        toolbarButtonPlugins.forEach { button -> button.toolbarStateAboutToChange(this, !isEnabled) }
     }
 
     private fun showDialogShortcuts() {
diff --git a/aztec/src/main/kotlin/org/wordpress/aztec/watchers/EndOfParagraphMarkerAdder.kt b/aztec/src/main/kotlin/org/wordpress/aztec/watchers/EndOfParagraphMarkerAdder.kt
@@ -9,6 +9,7 @@ import org.wordpress.aztec.spans.AztecHeadingSpan
 import org.wordpress.aztec.spans.AztecListItemSpan
 import org.wordpress.aztec.spans.AztecPreformatSpan
 import org.wordpress.aztec.spans.EndOfParagraphMarker
+import org.wordpress.aztec.spans.ParagraphSpan
 import java.lang.ref.WeakReference
 
 class EndOfParagraphMarkerAdder(aztecText: AztecText, val verticalParagraphMargin: Int) : TextWatcher {
@@ -36,6 +37,18 @@ class EndOfParagraphMarkerAdder(aztecText: AztecText, val verticalParagraphMargi
             if (paragraphMarkerCanBeApplied(aztecText.text)) {
                 aztecText.text.setSpan(EndOfParagraphMarker(verticalParagraphMargin), inputStart, inputEnd,
                         Spanned.SPAN_EXCLUSIVE_EXCLUSIVE)
+
+                // if we added a newline inside a paragraph, we should split it up into 2
+                val paragraphs = aztecText.text.getSpans(inputStart, inputEnd, ParagraphSpan::class.java)
+                if (paragraphs.isNotEmpty()) {
+                    val paragraph = paragraphs.first()
+                    val paragraphEnd = aztecText.text.getSpanEnd(paragraph)
+                    if (paragraphEnd > inputEnd) {
+                        val paragraphStart = aztecText.text.getSpanStart(paragraph)
+                        val paragraphFlags = aztecText.text.getSpanFlags(paragraph)
+                        aztecText.text.setSpan(paragraph, paragraphStart, inputEnd, paragraphFlags)
+                    }
+                }
             }
         }
     }
diff --git a/aztec/src/test/kotlin/org/wordpress/aztec/CalypsoFormattingTest.kt b/aztec/src/test/kotlin/org/wordpress/aztec/CalypsoFormattingTest.kt
diff --git a/build.gradle b/build.gradle
diff --git a/wordpress-comments/src/main/java/org/wordpress/aztec/plugins/wpcomments/toolbar/MoreToolbarButton.kt b/wordpress-comments/src/main/java/org/wordpress/aztec/plugins/wpcomments/toolbar/MoreToolbarButton.kt
diff --git a/wordpress-comments/src/main/java/org/wordpress/aztec/plugins/wpcomments/toolbar/PageToolbarButton.kt b/wordpress-comments/src/main/java/org/wordpress/aztec/plugins/wpcomments/toolbar/PageToolbarButton.kt
diff --git a/wordpress-shortcodes/build.gradle b/wordpress-shortcodes/build.gradle
diff --git a/wordpress-shortcodes/src/main/java/org/wordpress/aztec/plugins/shortcodes/handlers/CaptionHandler.kt b/wordpress-shortcodes/src/main/java/org/wordpress/aztec/plugins/shortcodes/handlers/CaptionHandler.kt

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ class AztecTagHandler(val context: Context, val plugins: List<IAztecPlugin> = Ar`
`98`	`98`	`return true`
`99`	`99`	`}`
`100`	`100`	`IMAGE -> {`
`101`		`- handleMediaElement(opening, output, AztecImageSpan(context, loadingDrawable, AztecAttributes(attributes)))`
	`101`	`+ handleMediaElement(opening, output, AztecImageSpan(context, loadingDrawable, nestingLevel, AztecAttributes(attributes)))`
`102`	`102`	`return true`
`103`	`103`	`}`
`104`	`104`	`VIDEO -> {`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,8 @@ class LineBlockFormatter(editor: AztecText) : AztecFormatter(editor) {`
`133`	`133`
`134`	`134`	`fun insertImage(drawable: Drawable?, attributes: Attributes, onImageTappedListener: OnImageTappedListener?,`
`135`	`135`	`onMediaDeletedListener: AztecText.OnMediaDeletedListener?) {`
`136`		`- val span = AztecImageSpan(editor.context, drawable, AztecAttributes(attributes), onImageTappedListener,`
	`136`	`+ val nestingLevel = IAztecNestable.getNestingLevelAt(editableText, selectionStart)`
	`137`	`+ val span = AztecImageSpan(editor.context, drawable, nestingLevel, AztecAttributes(attributes), onImageTappedListener,`
`137`	`138`	`onMediaDeletedListener, editor)`
`138`	`139`	`insertMedia(span)`
`139`	`140`	`}`