Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[StringUtils::indexOfAnyBut] redesign due to inconsistent/faulty behavior regarding UTF-16 surrogates #1327

Merged
merged 5 commits into from
Jan 6, 2025
Merged

[StringUtils::indexOfAnyBut] redesign due to inconsistent/faulty behavior regarding UTF-16 surrogates #1327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f6e961e
[StringUtils::indexOfAnyBut] redesign due to inconsistent/faulty…
Dec 3, 2024
0c9920a
[StringUtils::indexOfAnyBut] further reduction of algorithm
Dec 6, 2024
13a2bde
[StringUtils::indexOfAnyBut] simplify input-sequence iteration
Dec 18, 2024
b585112
[StringUtils:indexOfAnyBut] parameterization of test functions
Jan 6, 2025
915ee33
[StringUtils:indexOfAnyBut] remove comment
Jan 6, 2025
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
7 changes: 5 additions & 2 deletions src/main/java/org/apache/commons/lang3/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Set;
import java.util.function.Supplier;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import org.apache.commons.lang3.function.Suppliers;
import org.apache.commons.lang3.stream.LangCollectors;
Expand Down Expand Up @@ -2853,11 +2855,12 @@ public static int indexOfAnyBut(final CharSequence seq, final CharSequence searc
if (isEmpty(seq) || isEmpty(searchChars)) {
return INDEX_NOT_FOUND;
}
final int[] codePoints = searchChars.codePoints().sorted().toArray();
final Set<Integer> searchSetCodePoints = searchChars.codePoints()
.boxed().collect(Collectors.toSet());
// advance character index from one interpreted codepoint to the next
for (int curSeqCharIdx = 0; curSeqCharIdx < seq.length();) {
final int curSeqCodePoint = Character.codePointAt(seq, curSeqCharIdx);
if (Arrays.binarySearch(codePoints, curSeqCodePoint) < 0) {
if (!searchSetCodePoints.contains(curSeqCodePoint)) {
return curSeqCharIdx;
}
curSeqCharIdx += Character.charCount(curSeqCodePoint); // skip indices to paired low-surrogates
Expand Down
75 changes: 37 additions & 38 deletions src/test/java/org/apache/commons/lang3/StringUtilsEqualsIndexOfTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.params.provider.Arguments.arguments;

import java.nio.CharBuffer;
import java.util.Locale;
import java.util.stream.Stream;

import org.hamcrest.core.IsNot;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

/**
* Tests {@link StringUtils} - Equals/IndexOf methods
Expand Down Expand Up @@ -90,6 +95,30 @@ public String toString() {

private static final String[] FOOBAR_SUB_ARRAY = {"ob", "ba"};

static Stream<Arguments> indexOfAnyBut_withSurrogateChars() {
// @formatter:off
return Stream.of(
arguments(CharU20000 + CharU20001, CharU20000, 2),
arguments(CharU20000 + CharU20001, CharU20001, 0),
arguments(CharU20000 + CharU20001, "abcd" + CharUSuppCharLow, 0),
arguments(CharU20000 + CharU20001, "abcd" + CharUSuppCharHigh, 0),
arguments(CharU20000, CharU20000, -1),
arguments(CharU20000, CharU20001, 0),
arguments(CharUSuppCharHigh + "aaaa", CharUSuppCharHigh + "abcd", -1),
arguments(CharUSuppCharHigh + "baaa", CharUSuppCharHigh + "abcd", -1),
arguments(CharUSuppCharHigh + "aaaa", CharU20000 + "abcd", 0),
arguments("aaaa" + CharUSuppCharHigh, CharU20000 + "abcd", 4),
arguments(CharUSuppCharLow + "aaaa", CharU20000 + "abcd", 0),
arguments("aaaa" + CharUSuppCharLow, CharU20000 + "abcd", 4),
arguments(CharU20000 + "aaaa", CharUSuppCharLow + "ab" + CharUSuppCharHigh + "cd", 0),
arguments(CharU20000 + "aaaa", "abcd", 0),
arguments(CharU20000 + "aaaa", "abcd" + CharUSuppCharHigh, 0),
arguments(CharU20000 + "aaaa", "abcd" + CharUSuppCharLow, 0),
arguments("aaaa" + CharU20000, CharU20000 + "abcd", -1)
);
// @formatter:on
}

@Test
public void testCompare_StringString() {
assertEquals(0, StringUtils.compare(null, null));
Expand Down Expand Up @@ -445,25 +474,10 @@ public void testIndexOfAnyBut_StringCharArray() {
assertEquals(0, StringUtils.indexOfAnyBut("aba", 'z'));
}

@Test
public void testIndexOfAnyBut_StringCharArrayWithSurrogateChars() {
assertEquals(2, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, CharU20000.toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, CharU20001.toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, ("abcd" + CharUSuppCharLow).toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, ("abcd" + CharUSuppCharHigh).toCharArray()));
assertEquals(-1, StringUtils.indexOfAnyBut(CharU20000, CharU20000.toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000, CharU20001.toCharArray()));
assertEquals(-1, StringUtils.indexOfAnyBut(CharUSuppCharHigh + "aaaa", (CharUSuppCharHigh + "abcd").toCharArray()));
assertEquals(-1, StringUtils.indexOfAnyBut(CharUSuppCharHigh + "baaa", (CharUSuppCharHigh + "abcd").toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharUSuppCharHigh + "aaaa", (CharU20000 + "abcd").toCharArray()));
assertEquals(4, StringUtils.indexOfAnyBut("aaaa" + CharUSuppCharHigh, (CharU20000 + "abcd").toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharUSuppCharLow + "aaaa", (CharU20000 + "abcd").toCharArray()));
assertEquals(4, StringUtils.indexOfAnyBut("aaaa" + CharUSuppCharLow, (CharU20000 + "abcd").toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", (CharUSuppCharLow + "ab" + CharUSuppCharHigh + "cd").toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", "abcd".toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", ("abcd" + CharUSuppCharHigh).toCharArray()));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", ("abcd" + CharUSuppCharLow).toCharArray()));
assertEquals(-1, StringUtils.indexOfAnyBut("aaaa" + CharU20000, (CharU20000 + "abcd").toCharArray()));
@ParameterizedTest
@MethodSource("indexOfAnyBut_withSurrogateChars")
public void testIndexOfAnyBut_StringCharArrayWithSurrogateChars(final CharSequence seq, final String searchChars, final int expected) {
assertEquals(expected, StringUtils.indexOfAnyBut(seq, searchChars.toCharArray()));
}

@Test
Expand All @@ -483,25 +497,10 @@ public void testIndexOfAnyBut_StringString() {
assertEquals(0, StringUtils.indexOfAnyBut("ab", "z"));
}

@Test
public void testIndexOfAnyBut_StringStringWithSurrogateChars() {
assertEquals(2, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, CharU20000));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, CharU20001));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, "abcd" + CharUSuppCharLow));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + CharU20001, "abcd" + CharUSuppCharHigh));
assertEquals(-1, StringUtils.indexOfAnyBut(CharU20000, CharU20000));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000, CharU20001));
assertEquals(-1, StringUtils.indexOfAnyBut(CharUSuppCharHigh + "aaaa", CharUSuppCharHigh + "abcd"));
assertEquals(-1, StringUtils.indexOfAnyBut(CharUSuppCharHigh + "baaa", CharUSuppCharHigh + "abcd"));
assertEquals(0, StringUtils.indexOfAnyBut(CharUSuppCharHigh + "aaaa", CharU20000 + "abcd"));
assertEquals(4, StringUtils.indexOfAnyBut("aaaa" + CharUSuppCharHigh, CharU20000 + "abcd"));
assertEquals(0, StringUtils.indexOfAnyBut(CharUSuppCharLow + "aaaa", CharU20000 + "abcd"));
assertEquals(4, StringUtils.indexOfAnyBut("aaaa" + CharUSuppCharLow, CharU20000 + "abcd"));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", CharUSuppCharLow + "ab" + CharUSuppCharHigh + "cd"));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", "abcd"));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", "abcd" + CharUSuppCharHigh));
assertEquals(0, StringUtils.indexOfAnyBut(CharU20000 + "aaaa", "abcd" + CharUSuppCharLow));
assertEquals(-1, StringUtils.indexOfAnyBut("aaaa" + CharU20000, CharU20000 + "abcd"));
@ParameterizedTest
@MethodSource("indexOfAnyBut_withSurrogateChars")
public void testIndexOfAnyBut_StringStringWithSurrogateChars(final CharSequence seq, final CharSequence searchChars, final int expected) {
assertEquals(expected, StringUtils.indexOfAnyBut(seq, searchChars));
}

@Test
Expand Down
Loading