Merge pull request Catrobat#3797 from david-loe/CATROID-721

CATROID-721 Extended Keyword search

Author: wslany

catroid/src/main/java/org/catrobat/catroid/utils/HtmlRegexExtractor.java

@@ -27,19 +27,70 @@
 
 import org.catrobat.catroid.R;
 
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import androidx.annotation.VisibleForTesting;
+
 public class HtmlRegexExtractor {
+
 	private Context context;
+
 	public HtmlRegexExtractor(Context context) {
 		this.context = context;
 	}
-	public void searchKeyword(String search, String text) {
-		int index = text.indexOf(search);
-		if (index >= 0) {
-			ToastUtil.showSuccess(context,
-					R.string.formula_editor_function_regex_html_extractor_found);
+
+	public void searchKeyword(String keyword, String text) {
+		if (findKeyword(keyword, text) == null) {
+			showError();
 		} else {
-			ToastUtil.showError(context,
-					R.string.formula_editor_function_regex_html_extractor_not_found);
+			showSuccess();
+		}
+	}
+
+	private void showSuccess() {
+		ToastUtil.showSuccess(context,
+				R.string.formula_editor_function_regex_html_extractor_found);
+	}
+	private void showError() {
+		ToastUtil.showError(context,
+				R.string.formula_editor_function_regex_html_extractor_not_found);
+	}
+
+	@VisibleForTesting
+	public String findKeyword(String keyword, String text) {
+		if (keyword.equals("")) {
+			throw new IllegalArgumentException("No empty keywords allowed");
+		}
+		if (text.indexOf(keyword) >= 0) {
+			return keyword;
+		} else {
+			return findKeywordWithHtmlBetweenWordsInText(keyword, text);
+		}
+	}
+
+	private String findKeywordWithHtmlBetweenWordsInText(String keyword, String text) {
+		String[] splittedKeyword = keyword.split(" ");
+		String regex = Pattern.quote(splittedKeyword[0]);
+
+		for (int i = 1; i < splittedKeyword.length; i++) {
+			regex += ".*?" + Pattern.quote(splittedKeyword[i]);
+		}
+		return findShortestOccurrenceInText(regex, text);
+	}
+
+	private String findShortestOccurrenceInText(String regex, String text) {
+		Matcher m = Pattern.compile(regex).matcher(text);
+
+		String shortestOccurrence = null;
+		int lastIndex = -1;
+		while (m.find(lastIndex + 1)) {
+			String found = m.group();
+			if (shortestOccurrence == null || shortestOccurrence.length() > found.length()) {
+				shortestOccurrence = found;
+				lastIndex = m.start();
+			}
 		}
+		return shortestOccurrence;
 	}
 }

catroid/src/test/java/org/catrobat/catroid/test/ui/regexassistant/HtmlRegexExtractorTest.java

@@ -0,0 +1,111 @@
+/*
+ * Catroid: An on-device visual programming system for Android devices
+ * Copyright (C) 2010-2020 The Catrobat Team
+ * (<http://developer.catrobat.org/credits>)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * An additional term exception under section 7 of the GNU Affero
+ * General Public License, version 3, is available at
+ * http://developer.catrobat.org/license_additional_term
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.catrobat.catroid.test.ui.regexassistant;
+
+import android.app.Activity;
+
+import org.catrobat.catroid.utils.HtmlRegexExtractor;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+
+public class HtmlRegexExtractorTest {
+
+	@Before
+	public void setUp() {
+		Activity context = new Activity();
+		htmlExtractor = new HtmlRegexExtractor(context);
+	}
+	private HtmlRegexExtractor htmlExtractor;
+
+	@Test(expected = IllegalArgumentException.class)
+	public void testFindKeywordWithEmptyKeyword() {
+		htmlExtractor.findKeyword("", "abc");
+	}
+
+	@Test
+	public void testFindKeywordWithWrongKeyword() {
+		assertNull(htmlExtractor.findKeyword("def", "abc"));
+	}
+
+	@Test
+	public void testFindOneKeywordInLongWord() {
+		assertEquals("abc", htmlExtractor.findKeyword("abc", "abcdefg"));
+	}
+
+	@Test
+	public void testFindKeywordInSentence() {
+		assertEquals("abc", htmlExtractor.findKeyword("abc", "Wer are looking for the abc "
+				+ "statement in long text"));
+	}
+
+	@Test
+	public void testFindKeywordInSentenceWithSpaceInKeyword() {
+		assertEquals("ab c", htmlExtractor.findKeyword("ab c", "Wer are looking for the "
+				+ "ab c statement in long text"));
+	}
+
+	@Test
+	public void testFindKeywordInSentenceWithSpaceInKeywordAndTextWithNBSP() {
+		assertEquals("ab&nbsp;c", htmlExtractor.findKeyword("ab c", "Wer are looking for "
+				+ "the "
+				+ "ab&nbsp;c statement in long text"));
+	}
+
+	@Test
+	public void testKeywordWithNonBreakingSpace() {
+		assertEquals("Key&nbsp;Word", htmlExtractor.findKeyword("Key Word", "Key&nbsp;Word"));
+	}
+
+	@Test
+	public void testKeywordWithTag() {
+		assertEquals("Key <i>Word", htmlExtractor.findKeyword("Key Word", "Key "
+				+ "<i>Word</i>"));
+	}
+
+	@Test
+	public void testFalseKeywordOrder() {
+		assertNull(htmlExtractor.findKeyword("Key Word", "Word Key"));
+	}
+
+	@Test
+	public void testRegexAsKeyword() {
+		assertNull("A regular expression should not be found inside a html text that "
+						+ "doesn't contain it literally",
+				htmlExtractor.findKeyword("[A-Z]", "ABCDE"));
+	}
+
+	@Test
+	public void testRegexAsKeywordAndInText() {
+		assertEquals("[A-Z]", htmlExtractor.findKeyword("[A-Z]", "[A-Z]+.*"));
+	}
+
+	@Test
+	public void testFindKeywordSmallestOccurrence() {
+		assertEquals("Hello&nbsp;World", htmlExtractor.findKeyword("Hello World",
+				"Hello Banana Animal Text Hello&nbsp;World Ape"));
+	}
+}