Merge branch 'apache:master' into eiriklt/damerau-levenshtein-distance

Author: LorgeN

.github/workflows/codeql-analysis.yml

@@ -45,10 +45,10 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         persist-credentials: false
-    - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+    - uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -57,7 +57,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@51f77329afa6477de8c49fc9c7046c15b9a4e79d    # 3.29.5
+      uses: github/codeql-action/init@192325c86100d080feab897ff886c34abd4c83a3    # 3.29.5
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -68,7 +68,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@51f77329afa6477de8c49fc9c7046c15b9a4e79d    # 3.29.5
+      uses: github/codeql-action/autobuild@192325c86100d080feab897ff886c34abd4c83a3    # 3.29.5
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -82,4 +82,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@51f77329afa6477de8c49fc9c7046c15b9a4e79d    # 3.29.5
+      uses: github/codeql-action/analyze@192325c86100d080feab897ff886c34abd4c83a3    # 3.29.5

.github/workflows/dependency-review.yml

@@ -26,6 +26,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: 'Dependency Review PR'
-        uses: actions/dependency-review-action@da24556b548a50705dd671f47852072ea4c105d9 # v4.7.1
+        uses: actions/dependency-review-action@595b5aeba73380359d98a5e087f648dbb0edce1b # v4.7.3

.github/workflows/maven.yml

@@ -34,11 +34,11 @@ jobs:
             experimental: true
 
     steps:
-    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         persist-credentials: false
     - name: Set up JDK ${{ matrix.java }}
-      uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
+      uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0
       with:
         distribution: 'temurin'
         java-version: ${{ matrix.java }}

.github/workflows/scorecards-analysis.yml

@@ -40,7 +40,7 @@ jobs:
     steps:
 
       - name: "Checkout code"
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
 
@@ -64,6 +64,6 @@ jobs:
           retention-days: 5
 
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@51f77329afa6477de8c49fc9c7046c15b9a4e79d    # 3.29.5
+        uses: github/codeql-action/upload-sarif@192325c86100d080feab897ff886c34abd4c83a3    # 3.29.5
         with:
           sarif_file: results.sarif

pom.xml

@@ -20,7 +20,7 @@
   <parent>
     <groupId>org.apache.commons</groupId>
     <artifactId>commons-parent</artifactId>
-    <version>85</version>
+    <version>87</version>
   </parent>
   <artifactId>commons-text</artifactId>
   <version>1.14.1-SNAPSHOT</version>
@@ -48,7 +48,7 @@
     <commons.scmPubUrl>https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-text</commons.scmPubUrl>
     <commons.scmPubCheckoutDirectory>site-content</commons.scmPubCheckoutDirectory>
     <commons.lang3.version>3.18.0</commons.lang3.version>
-    <commons.bytebuddy.version>1.17.6</commons.bytebuddy.version>
+    <commons.bytebuddy.version>1.17.7</commons.bytebuddy.version>
     <commons.rng.version>1.6</commons.rng.version>
     <japicmp.skip>false</japicmp.skip>
     <jmh.version>1.37</jmh.version>

src/changes/changes.xml

@@ -47,9 +47,13 @@ The <action> type attribute can be add,update,fix,remove.
   <body>
   <release version="1.14.1" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
       <!-- FIX -->
+      <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix exception message typo in XmlStringLookup.XmlStringLookup(Map, Path...).</action>
+      <action type="fix" dev="ggregory" due-to="Pierre Post, Sumit Bera, Alex Herbert, Gary Gregory" issue="TEXT-236">Inserting at end of a TextStringBuilder throws a StringIndexOutOfBoundsException.</action>
       <!-- ADD -->
       <action type="add" dev="ggregory" due-to="Piotr P. Karwasz, Gary Gregory">Add experimental CycloneDX VEX file #683.</action>
       <!-- UPDATE -->
+      <action type="update" dev="ggregory" due-to="Gary Gregory">Bump commons.bytebuddy.version from 1.17.6 to 1.17.7 #696.</action>
+      <action type="update" dev="ggregory" due-to="Gary Gregory">Bump org.apache.commons:commons-parent from 85 to 87.</action>
   </release>
   <release version="1.14.0" date="2025-07-20" description="Release 1.14.0. Requires Java 8 or above.">
     <!-- FIX -->
@@ -63,7 +67,6 @@ The <action> type attribute can be add,update,fix,remove.
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix PMD AvoidBranchingStatementAsLastInLoop in TextStringBuilder.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix PMD AvoidBranchingStatementAsLastInLoop in StrBuilder.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">org.apache.commons.text.translate.LookupTranslator.LookupTranslator(Map CharSequence>) now throws NullPointerException instead of java.security.InvalidParameterException.</action>
-    
     <!-- ADD -->
     <action type="add" dev="ggregory" due-to="Gary Gregory">Interface StringLookup now extends UnaryOperator&lt;String&gt;.</action>
     <action type="add" dev="ggregory" due-to="Gary Gregory">Interface TextRandomProvider extends IntUnaryOperator.</action>

src/conf/spotbugs-exclude-filter.xml

@@ -19,38 +19,39 @@
     xmlns="https://github.com/spotbugs/filter/3.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="https://github.com/spotbugs/filter/3.0.0 https://raw.githubusercontent.com/spotbugs/spotbugs/3.1.0/spotbugs/etc/findbugsfilter.xsd">
-
   <Match>
     <Class name="org.apache.commons.text.ExtendedMessageFormat" />
     <Bug code="UR" />
   </Match>
-
+  <Match>
+    <Class name="org.apache.commons.text.ExtendedMessageFormat" />
+    <!-- False positives -->
+    <!--  [lines 225-227] SF_SWITCH_FALLTHROUGH -->
+    <!--  [lines 424-426] SF_SWITCH_FALLTHROUGH -->
+    <Bug pattern="SF_SWITCH_FALLTHROUGH" />
+  </Match>
   <Match>
     <!-- False positives in regard to Locale property exposing inner implementation
     details of class. However, Locale is not mutable and therefore safe in this context. -->
     <Class name="org.apache.commons.text.similarity.FuzzyScore" />
     <Bug code="EI,EI2" />
   </Match>
-
   <Match>
     <Class name="org.apache.commons.text.StrTokenizer" />
     <Method name="clone" />
     <Bug code="CN" />
   </Match>
-
   <Match>
     <Class name="org.apache.commons.text.StringTokenizer" />
     <Method name="clone" />
     <Bug code="CN" />
   </Match>
-
   <!-- BiFunctionStringLookup#lookup catches NPE to return null -->
   <Match>
     <Class name="org.apache.commons.text.lookup.BiFunctionStringLookup" />
     <Method name="lookup" />
     <Bug pattern="DCN_NULLPOINTER_EXCEPTION" />
   </Match>
-
   <!-- FunctionStringLookup#lookup catches NPE to return null -->
   <Match>
     <Class name="org.apache.commons.text.lookup.FunctionStringLookup" />
@@ -62,14 +63,20 @@
     <Class name="~.*" />
     <Bug pattern="CT_CONSTRUCTOR_THROW" />
   </Match>
-  <!-- Can't make ctor private until next major release -->  
+  <!-- Can't make ctor private until next major release -->
   <Match>
     <Class name="org.apache.commons.text.similarity.LevenshteinDetailedDistance" />
     <Bug pattern="SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR" />
-  </Match>  
-  <!-- Can't make ctor private until next major release -->  
+  </Match>
+  <!-- Can't make ctor private until next major release -->
   <Match>
     <Class name="org.apache.commons.text.similarity.LevenshteinDistance" />
     <Bug pattern="SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR" />
-  </Match>  
+  </Match>
+  <!-- RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT false positive: Exceptions can be thrown -->
+  <Match>
+    <Class name="org.apache.commons.text.TextStringBuilder" />
+    <Method name="insert" />
+    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT" />
+  </Match>
 </FindBugsFilter>

src/main/java/org/apache/commons/text/ExtendedMessageFormat.java

@@ -135,52 +135,42 @@ public ExtendedMessageFormat(final String pattern, final Locale locale) {
      * Constructs a new ExtendedMessageFormat.
      *
      * @param pattern  the pattern to use, not null
-     * @param locale  the locale to use, not null
-     * @param registry  the registry of format factories, may be null
+     * @param locale   the locale to use, not null
+     * @param registry the registry of format factories, may be null
      * @throws IllegalArgumentException in case of a bad pattern.
      */
-    public ExtendedMessageFormat(final String pattern,
-                                 final Locale locale,
-                                 final Map<String, ? extends FormatFactory> registry) {
+    public ExtendedMessageFormat(final String pattern, final Locale locale, final Map<String, ? extends FormatFactory> registry) {
         super(EMPTY_PATTERN);
         setLocale(locale);
-        this.registry = registry != null
-                ? Collections.unmodifiableMap(new HashMap<>(registry))
-                : null;
+        this.registry = registry != null ? Collections.unmodifiableMap(new HashMap<>(registry)) : null;
         applyPattern(pattern);
     }
 
     /**
      * Constructs a new ExtendedMessageFormat for the default locale.
      *
      * @param pattern  the pattern to use, not null
-     * @param registry  the registry of format factories, may be null
+     * @param registry the registry of format factories, may be null
      * @throws IllegalArgumentException in case of a bad pattern.
      */
-    public ExtendedMessageFormat(final String pattern,
-                                 final Map<String, ? extends FormatFactory> registry) {
+    public ExtendedMessageFormat(final String pattern, final Map<String, ? extends FormatFactory> registry) {
         this(pattern, Locale.getDefault(Category.FORMAT), registry);
     }
 
     /**
-     * Consumes a quoted string, adding it to {@code appendTo} if
-     * specified.
+     * Consumes a quoted string, adding it to {@code appendTo} if specified.
      *
-     * @param pattern pattern to parse
-     * @param pos current parse position
+     * @param pattern  pattern to parse
+     * @param pos      current parse position
      * @param appendTo optional StringBuilder to append
      */
-    private void appendQuotedString(final String pattern, final ParsePosition pos,
-            final StringBuilder appendTo) {
-        assert pattern.toCharArray()[pos.getIndex()] == QUOTE
-                : "Quoted string must start with quote character";
-
+    private void appendQuotedString(final String pattern, final ParsePosition pos, final StringBuilder appendTo) {
+        assert pattern.toCharArray()[pos.getIndex()] == QUOTE : "Quoted string must start with quote character";
         // handle quote character at the beginning of the string
         if (appendTo != null) {
             appendTo.append(QUOTE);
         }
         next(pos);
-
         final int start = pos.getIndex();
         final char[] c = pattern.toCharArray();
         for (int i = pos.getIndex(); i < pattern.length(); i++) {
@@ -195,8 +185,7 @@ private void appendQuotedString(final String pattern, final ParsePosition pos,
                 next(pos);
             }
         }
-        throw new IllegalArgumentException(
-                "Unterminated quoted string at position " + start);
+        throw new IllegalArgumentException("Unterminated quoted string at position " + start);
     }
 
     /**
@@ -214,7 +203,6 @@ public final void applyPattern(final String pattern) {
         final ArrayList<Format> foundFormats = new ArrayList<>();
         final ArrayList<String> foundDescriptions = new ArrayList<>();
         final StringBuilder stripCustom = new StringBuilder(pattern.length());
-
         final ParsePosition pos = new ParsePosition(0);
         final char[] c = pattern.toCharArray();
         int fmtCount = 0;
@@ -233,8 +221,7 @@ public final void applyPattern(final String pattern) {
                 Format format = null;
                 String formatDescription = null;
                 if (c[pos.getIndex()] == START_FMT) {
-                    formatDescription = parseFormatDescription(pattern,
-                            next(pos));
+                    formatDescription = parseFormatDescription(pattern, next(pos));
                     format = getFormat(formatDescription);
                     if (format == null) {
                         stripCustom.append(START_FMT).append(formatDescription);
@@ -249,8 +236,7 @@ public final void applyPattern(final String pattern) {
                     throw new IllegalArgumentException("The validated expression is false");
                 }
                 if (c[pos.getIndex()] != END_FE) {
-                    throw new IllegalArgumentException(
-                            "Unreadable format element at position " + start);
+                    throw new IllegalArgumentException("Unreadable format element at position " + start);
                 }
                 //$FALL-THROUGH$
             default: