Merge branch 'trunk' into update-compile-sdk-to-33

Author: irfano

aztec/src/main/kotlin/org/wordpress/aztec/AztecText.kt

@@ -2203,6 +2203,7 @@ open class AztecText : AppCompatEditText, TextWatcher, UnknownHtmlSpan.OnUnknown
     }
 
     fun removeMedia(attributePredicate: AttributePredicate) {
+        history.beforeTextChanged(this@AztecText)
         text.getSpans(0, text.length, AztecMediaSpan::class.java)
                 .filter {
                     attributePredicate.matches(it.attributes)
@@ -2250,6 +2251,7 @@ open class AztecText : AppCompatEditText, TextWatcher, UnknownHtmlSpan.OnUnknown
                     }
                     mediaSpan.onMediaDeleted()
                 }
+        contentChangeWatcher.notifyContentChanged()
     }
 
     fun replaceMediaSpan(aztecMediaSpan: AztecMediaSpan, predicate: (Attributes) -> Boolean) {

media-placeholders/src/main/java/org/wordpress/aztec/placeholders/PlaceholderManager.kt

@@ -124,35 +124,74 @@ class PlaceholderManager(
         val targetSpan = targetItem?.span
         val currentType = targetSpan?.attributes?.getValue(TYPE_ATTRIBUTE)
         if (currentType != null && shouldMergeItem(currentType)) {
-            val adapter = adapters[type]
-                    ?: throw IllegalArgumentException("Adapter for inserted type not found. Register it with `registerAdapter` method")
-            val currentAttributes = mutableMapOf<String, String>()
-            val uuid = targetSpan.attributes.getValue(UUID_ATTRIBUTE)
-            for (i in 0 until targetSpan.attributes.length) {
-                val name = targetSpan.attributes.getQName(i)
-                val value = targetSpan.attributes.getValue(name)
-                currentAttributes[name] = value
-            }
-            val updatedAttributes = updateItem(currentAttributes, currentType, targetItem.placeAtStart)
-            val attrs = AztecAttributes().apply {
-                updatedAttributes.forEach { (key, value) ->
-                    setValue(key, value)
-                }
-            }
-            attrs.setValue(UUID_ATTRIBUTE, uuid)
-            attrs.setValue(TYPE_ATTRIBUTE, type)
-            val drawable = buildPlaceholderDrawable(adapter, attrs)
-            val span = AztecPlaceholderSpan(aztecText.context, drawable, 0, attrs,
-                    this, aztecText, WeakReference(adapter), TAG = htmlTag)
-            aztecText.replaceMediaSpan(span) { attributes ->
-                attributes.getValue(UUID_ATTRIBUTE) == uuid
-            }
-            insertContentOverSpanWithId(uuid)
+            updateSpan(type, targetItem.span, targetItem.placeAtStart, updateItem, currentType)
         } else {
             insertItem(type, *updateItem(null, null, false).toList().toTypedArray())
         }
     }
 
+    private suspend fun updateSpan(
+            type: String,
+            targetSpan: AztecPlaceholderSpan,
+            placeAtStart: Boolean,
+            updateItem: (currentAttributes: Map<String, String>, currentType: String, placeAtStart: Boolean) -> Map<String, String>,
+            currentType: String
+    ) {
+        val adapter = adapters[type]
+                ?: throw IllegalArgumentException("Adapter for inserted type not found. Register it with `registerAdapter` method")
+        val currentAttributes = mutableMapOf<String, String>()
+        val uuid = targetSpan.attributes.getValue(UUID_ATTRIBUTE)
+        for (i in 0 until targetSpan.attributes.length) {
+            val name = targetSpan.attributes.getQName(i)
+            val value = targetSpan.attributes.getValue(name)
+            currentAttributes[name] = value
+        }
+        val updatedAttributes = updateItem(currentAttributes, currentType, placeAtStart)
+        val attrs = AztecAttributes().apply {
+            updatedAttributes.forEach { (key, value) ->
+                setValue(key, value)
+            }
+        }
+        attrs.setValue(UUID_ATTRIBUTE, uuid)
+        attrs.setValue(TYPE_ATTRIBUTE, type)
+        val drawable = buildPlaceholderDrawable(adapter, attrs)
+        val span = AztecPlaceholderSpan(aztecText.context, drawable, 0, attrs,
+                this, aztecText, WeakReference(adapter), TAG = htmlTag)
+        aztecText.replaceMediaSpan(span) { attributes ->
+            attributes.getValue(UUID_ATTRIBUTE) == uuid
+        }
+        insertContentOverSpanWithId(uuid)
+    }
+
+    /**
+     * Use this function to either update or remove an item. The decision whether to remove or update will be made
+     * based upon the results of the parameter functions. An example of usage is a gallery of images. If the user wants
+     * to remove one image in the gallery, they would call this method. If the removed image is one of many, they might
+     * want to update the current parameters instead of removing the entire gallery. However, if the removed image is
+     * the last one in the gallery, they will probably want to remove the entire gallery.
+     * @param uuid UUID of the span we want to remove or update
+     * @param shouldUpdateItem This function should return true if the span can be updated, false if it should be removed
+     * @param updateItem Function that updates the selected item
+     */
+    suspend fun removeOrUpdate(uuid: String, shouldUpdateItem: (Attributes) -> Boolean, updateItem: (currentAttributes: Map<String, String>) -> Map<String, String>): Boolean {
+        val currentItem = aztecText.editableText.getSpans(0, aztecText.length(), AztecPlaceholderSpan::class.java).find {
+            it.attributes.getValue(UUID_ATTRIBUTE) == uuid
+        } ?: return false
+        if (shouldUpdateItem(currentItem.attributes)) {
+            val type = currentItem.attributes.getValue(TYPE_ATTRIBUTE)
+            val selectionStart = aztecText.selectionStart
+            val selectionEnd = aztecText.selectionEnd
+            aztecText.setSelection(aztecText.editableText.getSpanStart(currentItem))
+            updateSpan(type, currentItem, updateItem = { attributes, _, _ ->
+                updateItem(attributes)
+            }, placeAtStart = false, currentType = type)
+            aztecText.setSelection(selectionStart, selectionEnd)
+        } else {
+            removeItem(uuid)
+        }
+        return true
+    }
+
     private data class TargetItem(val span: AztecPlaceholderSpan, val placeAtStart: Boolean)
 
     private fun getTargetItem(): TargetItem? {
@@ -189,13 +228,21 @@ class PlaceholderManager(
     }
 
     /**
-     * Call this method to remove a placeholder from both the AztecText and the overlaying layer programatically.
+     * Call this method to remove a placeholder from both the AztecText and the overlaying layer programmatically.
      * @param predicate determines whether a span should be removed
      */
     fun removeItem(predicate: (Attributes) -> Boolean) {
         aztecText.removeMedia { predicate(it) }
     }
 
+    /**
+     * Call this method to remove a placeholder from both the AztecText and the overlaying layer programmatically.
+     * @param uuid of the removed item
+     */
+    fun removeItem(uuid: String) {
+        aztecText.removeMedia { it.getValue(UUID_ATTRIBUTE) == uuid }
+    }
+
     private suspend fun buildPlaceholderDrawable(adapter: PlaceholderAdapter, attrs: AztecAttributes): Drawable {
         val drawable = ContextCompat.getDrawable(aztecText.context, android.R.color.transparent)!!
         val editorWidth = if (aztecText.width > 0) {

media-placeholders/src/test/java/org/wordpress/aztec/placeholders/PlaceholderTest.kt

@@ -147,4 +147,69 @@ class PlaceholderTest {
     private fun placeholderWithCaption(caption: String): String {
         return "<placeholder src=\"image.jpg\" caption=\"$caption\" uuid=\"uuid123\" type=\"image_with_caption\" />"
     }
+
+    @Test
+    @Throws(Exception::class)
+    fun updatePlaceholderWhenItShouldBe() {
+        runBlocking {
+            val initialHtml = "<placeholder uuid=\"uuid123\" type=\"image_with_caption\" src=\"image.jpg;image2.jpg\" caption=\"Caption - 1, 2\" /><p>Line</p>"
+            editText.fromHtml(initialHtml)
+
+            placeholderManager.removeOrUpdate("uuid123", shouldUpdateItem = {
+                true
+            }) { currentAttributes ->
+                val result = mutableMapOf<String, String>()
+                result["src"] = currentAttributes["src"]?.split(";")?.firstOrNull() ?: ""
+                result["caption"] = "Updated caption"
+                result
+            }
+
+            Assert.assertEquals("<placeholder src=\"image.jpg\" caption=\"Updated caption\" uuid=\"uuid123\" type=\"image_with_caption\" /><p>Line</p>", editText.toHtml())
+        }
+    }
+
+    @Test
+    @Throws(Exception::class)
+    fun updatePlaceholderAtTheEnd() {
+        runBlocking {
+            val initialHtml = "<p>First Line</p><placeholder uuid=\"uuid123\" type=\"image_with_caption\" src=\"image.jpg;image2.jpg\" caption=\"Caption - 1, 2\" /><p>Second Line</p>"
+            editText.fromHtml(initialHtml)
+            editText.setSelection(editText.editableText.indexOf("First") + 1)
+            val initialSelectionStart = editText.selectionStart
+            val initialSelectionEnd = editText.selectionEnd
+
+            placeholderManager.removeOrUpdate("uuid123", shouldUpdateItem = {
+                true
+            }) { currentAttributes ->
+                val result = mutableMapOf<String, String>()
+                result["src"] = currentAttributes["src"]?.split(";")?.firstOrNull() ?: ""
+                result["caption"] = "Updated caption"
+                result
+            }
+
+            Assert.assertEquals("<p>First Line</p><placeholder src=\"image.jpg\" caption=\"Updated caption\" uuid=\"uuid123\" type=\"image_with_caption\" /><p>Second Line</p>", editText.toHtml())
+            Assert.assertEquals(initialSelectionStart, editText.selectionStart)
+            Assert.assertEquals(initialSelectionEnd, editText.selectionEnd)
+        }
+    }
+
+    @Test
+    @Throws(Exception::class)
+    fun removePlaceholderWhenItShouldNotBeUpdated() {
+        runBlocking {
+            val initialHtml = "<placeholder uuid=\"uuid123\" type=\"image_with_caption\" src=\"image.jpg;image2.jpg\" caption=\"Caption - 1, 2\" /><p>Line</p>"
+            editText.fromHtml(initialHtml)
+
+            placeholderManager.removeOrUpdate("uuid123", shouldUpdateItem = {
+                false
+            }) { currentAttributes ->
+                val result = mutableMapOf<String, String>()
+                result["src"] = currentAttributes["src"]?.split(";")?.firstOrNull() ?: ""
+                result["caption"] = "Updated caption"
+                result
+            }
+
+            Assert.assertEquals("<p>Line</p>", editText.toHtml())
+        }
+    }
 }