alhudz opened a new pull request, #786:
URL: https://github.com/apache/commons-text/pull/786
`StringSubstitutor` takes the escape character from the end of a substituted
value when another variable follows it directly in the template. Same issue as
commons-lang `StrSubstitutor`, fixed in apache/commons-lang#1834.
Repro:
```java
Map<String, String> m = Map.of("price", "5$", "x", "X", "a", "$", "b", "B");
StringSubstitutor s = new StringSubstitutor(m);
s.replace("${price}${x}"); // expected "5$X", actual "5${x}"
s.replace("${a}${b}"); // expected "$B", actual "${b}"
```
After `${price}` is replaced, `substitute` resumes scanning at the end of
the inserted value, and the escape check (`pos > offset && builder.charAt(pos -
1) == escapeCh`) reaches back into that value. The value loses its trailing `$`
and `${x}` is passed through unresolved.
Fix: only accept an escape character at or after the end of the last
substitution, same as the commons-lang change. The class Javadoc gets the same
note that was added there.
Tests are ported from commons-lang (`testReplaceValueEndingWithEscape*`:
plain, custom delimiters, default value, empty value, variable name
substitution, `preserveEscapes`, recursive). All 7 fail without the change and
pass with it. Default `mvn` goal is green.
The deprecated `org.apache.commons.text.StrSubstitutor` has the same check
(`pos > offset && chars[pos - 1] == escape`). I've left it alone here; happy to
add it if you want it covered too.
- [ ] Read the [contribution guidelines](CONTRIBUTING.md) for this project.
- [ ] Read the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) if you use
Artificial Intelligence (AI).
- [x] I used AI to create any part of, or all of, this pull request. Which
AI tool was used to create this pull request, and to what extent did it
contribute? Claude (Anthropic) ported the commons-lang fix and tests to this
class and drafted this description.
- [x] Run a successful build using the default
[Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command
line by itself.
- [x] Write unit tests that match behavioral changes, where the tests fail
if the changes to the runtime are not applied. This may not always be possible,
but it is a best practice.
- [x] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- [x] Each commit in the pull request should have a meaningful subject line
and body. Note that a maintainer may squash commits during the merge process.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
