Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -987,8 +987,11 @@ class DictionaryFacilitatorImpl : DictionaryFacilitator {

override fun removeWord(word: String) {
sessionWordBoost?.removeWord(word)
// Decide once for all groups: blacklist matching ignores case and checks every group,
// so a word of one language must not get blacklisted through another language's group.
val isMainDictWord = dictionaryGroups.any { it.isMainDictWord(word) }
for (dictionaryGroup in dictionaryGroups) {
dictionaryGroup.removeWord(word)
dictionaryGroup.removeWord(word, isMainDictWord)
}
}

Expand Down Expand Up @@ -1163,11 +1166,20 @@ private class DictionaryGroup(
// concurrent blacklist operations could then run without mutual exclusion.
private val blacklistLock = Any()

/** Removes a word from all dictionaries in this group. If the word is in a read-only dictionary, it is blacklisted. */
fun removeWord(word: String) {
/**
* Whether any case variant of [word] is in the main dictionary. Blacklist matching ignores case,
* so "i'm" must count as a main dictionary word when the dictionary only has "I'm".
*/
fun isMainDictWord(word: String): Boolean {
val mainDict = getDict(Dictionary.TYPE_MAIN) ?: return false
val lowercase = word.lowercase(locale)
return setOf(word, lowercase, StringUtils.capitalizeFirstCodePoint(lowercase, locale), word.uppercase(locale))
.any { mainDict.isValidWord(it) }
}

/** Removes a word from all dictionaries in this group. Unless [isMainDictWord], it is also blacklisted. */
fun removeWord(word: String, isMainDictWord: Boolean = isMainDictWord(word)) {
val lowercase = word.lowercase(locale)
val mainDict = getDict(Dictionary.TYPE_MAIN)
val isLowercaseInMainDict = mainDict?.isValidWord(lowercase) == true

// Remove from user history
getSubDict(Dictionary.TYPE_USER_HISTORY)?.removeUnigramEntryDynamically(word)
Expand Down Expand Up @@ -1202,7 +1214,7 @@ private class DictionaryGroup(

// Only add to blacklist if the word is NOT a standard valid word in the main system dictionary.
// Never blacklist core dictionary words (e.g. "in", "is", "me", "ok") when deleting suggestions.
if (!isLowercaseInMainDict) {
if (!isMainDictWord) {
addToBlacklist(lowercase)
} else {
// If it's a main dict word, un-blacklist it in case it was previously mistakenly blacklisted
Expand Down
25 changes: 25 additions & 0 deletions app/src/test/java/helium314/keyboard/latin/DictionaryGroupTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import org.junit.Test
import org.mockito.Mockito.mock
import org.mockito.Mockito.verify
import org.mockito.Mockito.never
import org.mockito.Mockito.`when`
import java.util.Locale

class DictionaryGroupTest {
Expand Down Expand Up @@ -113,4 +114,28 @@ class DictionaryGroupTest {
assertTrue(isBlacklistedMethod.invoke(instance, "superbad") as Boolean)
assertFalse(isBlacklistedMethod.invoke(instance, "goodword") as Boolean)
}

@Test
fun testRemoveWord_DoesNotBlacklistCapitalizedMainDictWord() {
val dictGroupClass = Class.forName("helium314.keyboard.latin.DictionaryGroup")
val constructor = dictGroupClass.declaredConstructors.first { it.parameterCount == 4 }
constructor.isAccessible = true

// The main dictionary only has the capitalized form, like "I'm" in English.
val mockMainDict = mock(Dictionary::class.java)
`when`(mockMainDict.isValidWord("I'm")).thenReturn(true)
val instance = constructor.newInstance(Locale.ENGLISH, mockMainDict, emptyMap<String, ExpandableBinaryDictionary>(), null)
val isMainDictWordMethod = dictGroupClass.getDeclaredMethod("isMainDictWord", String::class.java)
val removeWordMethod = dictGroupClass.getDeclaredMethod("removeWord", String::class.java, Boolean::class.javaPrimitiveType)
val isBlacklistedMethod = dictGroupClass.getDeclaredMethod("isBlacklisted", String::class.java)
listOf(isMainDictWordMethod, removeWordMethod, isBlacklistedMethod).forEach { it.isAccessible = true }

for (word in listOf("I'm", "i'm", "I,m")) {
removeWordMethod.invoke(instance, word, isMainDictWordMethod.invoke(instance, word) as Boolean)
}

assertFalse(isBlacklistedMethod.invoke(instance, "I'm") as Boolean)
assertFalse(isBlacklistedMethod.invoke(instance, "i'm") as Boolean)
assertTrue(isBlacklistedMethod.invoke(instance, "I,m") as Boolean)
}
}
Loading