| <?xml version="1.0"?> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| <!-- |
| This file is also used by the maven-changes-plugin to generate the release notes. |
| Useful ways of finding items to add to this file are: |
| |
| 1. Add items when you fix a bug or add a feature (this makes the |
| release process easy :-). |
| |
| 2. Do a JIRA search for tickets closed since the previous release. |
| |
| 3. Use the report generated by the maven-changelog-plugin to see all |
| git commits. TBA how to use this with git. |
| |
| To generate the release notes from this file: |
| |
| mvn changes:announcement-generate -Prelease-notes [-Dchanges.version=nnn] |
| |
| then tweak the formatting if necessary |
| and commit |
| |
| The <action> type attribute can be add,update,fix,remove. |
| --> |
| |
| |
| <document> |
| <properties> |
| <title>Apache Commons Text Changes</title> |
| </properties> |
| <body> |
| |
| <release version="1.8.1" date="2019-MM-DD" description="Release 1.8.1"> |
| <action type="update" dev="ggregory" due-to="Gary Gregory">[test] junit-jupiter 5.5.1 -> 5.5.2.</action> |
| <action type="update" dev="ggregory" due-to="Gary Gregory">com.puppycrawl.tools:checkstyle 8.23 -> 8.24.</action> |
| <action issue="TEXT-166" type="fix" dev="kinow" due-to="Mikko Maunu">removed non-existing parameter from Javadocs and spelled out parameters in throws</action> |
| <action issue="TEXT-149" type="fix" dev="kinow" due-to="Yuji Konishi">StringEscapeUtils.unescapeCsv doesn't remove quotes at begin and end of string</action> |
| </release> |
| |
| <release version="1.8" date="2019-08-30" description="Release 1.8"> |
| <action issue="TEXT-167" type="fix" dev="ggregory" due-to="Larry West">commons-text web page missing "RELEASE-NOTES-1.7.txt"</action> |
| <action issue="TEXT-168" type="fix" dev="ggregory" due-to="luksan47">(doc) Fixed wrong value for Jaro-Winkler example #117</action> |
| <action issue="TEXT-169" type="add" dev="ggregory" due-to="Gary Gregory">Add helper factory method org.apache.commons.text.StringSubstitutor.createInterpolator().</action> |
| <action issue="TEXT-170" type="add" dev="ggregory" due-to="Gary Gregory">Add String lookup for host names and IP addresses (DnsStringLookup).</action> |
| <action issue="TEXT-171" type="fix" dev="ggregory" due-to="Gary Gregory">StringLookupFactory.addDefaultStringLookups(Map) does not convert keys to lower case.</action> |
| <action type="update" dev="ggregory" due-to="Gary Gregory">Expand Javadoc for StringSubstitutor and friends.</action> |
| <action type="update" dev="ggregory" due-to="Gary Gregory">[site] checkstyle.version 8.21 -> 8.23.</action> |
| </release> |
| |
| <release version="1.7" date="2019-06-30" description="Release 1.7"> |
| <action issue="TEXT-111" type="fix" dev="kinow" due-to="@CAPS50">WordUtils.wrap must calculate offset increment from wrapOn pattern length</action> |
| <action issue="TEXT-104" type="update" dev="kinow" due-to="Sascha Szott">Jaro Winkler Distance refers to similarity</action> |
| <action issue="TEXT-148" type="add" dev="ggregory">Add an enum to the lookup package that lists all StringLookups</action> |
| <action issue="TEXT-127" type="add" dev="ggregory" due-to="Jean-Baptiste REICH, Sebb, Don Jeba, Gary Gregory">Add a toggle to throw an exception when a variable is unknown in StringSubstitutor</action> |
| <action issue="TEXT-138" type="add" dev="ggregory" due-to="Neal Johnson, Don Jeba">TextStringBuilder append sub-sequence not consistent with Appendable.</action> |
| <action issue="TEXT-152" type="add" dev="" due-to="@CAPS50">Fix possible infinite loop in WordUtils.wrap for a regex pattern that would trigger on a match of 0 length</action> |
| <action issue="TEXT-153" type="update" dev="" due-to="amirhadadi">Make prefixSet in LookupTranslator a BitSet</action> |
| <action issue="TEXT-156" type="update" dev="aherbert">Fix the RegexTokenizer to use a static Pattern</action> |
| <action issue="TEXT-157" type="update" dev="aherbert">Remove rounding from JaccardDistance and JaccardSimilarity</action> |
| <action issue="TEXT-151" type="fix" dev="aherbert">Fix the JaroWinklerSimilarity to use StringUtils.equals to test for CharSequence equality</action> |
| <action issue="TEXT-155" type="add" dev="aherbert">Add a generic IntersectionSimilarity measure</action> |
| <action issue="TEXT-162" type="update" dev="ggregory">Update Apache Commons Lang from 3.8.1 to 3.9.</action> |
| <action issue="TEXT-165" type="fix" dev="ggregory">ResourceBundleStringLookup.lookup(String) throws MissingResourceException instead of returning null.</action> |
| <action type="update" dev="ggregory">Update tests from org.assertj:assertj-core 3.12.1 to 3.12.2.</action> |
| <action type="update" dev="ggregory">Update site from com.puppycrawl.tools:checkstyle 8.18 to 8.21.</action> |
| </release> |
| |
| <release version="1.6" date="2018-10-12" description="Release 1.6"> |
| <action issue="TEXT-144" type="update" dev="ggregory">Add the resource string bundle string lookup to the default set of lookups</action> |
| <action issue="TEXT-145" type="update" dev="ggregory">Add StringLookupFactory methods for the URL encoder and decoder string lookups</action> |
| <action issue="TEXT-146" type="update" dev="ggregory">org.apache.commons.text.lookup.StringLookupFactory.interpolatorStringLookup() should reuse a singleton instance</action> |
| <action issue="TEXT-147" type="update" dev="ggregory">Add a Base64 encoder string lookup.</action> |
| </release> |
| |
| <release version="1.5" date="2018-09-29" description="Release 1.5"> |
| <action issue="TEXT-139" type="fix" dev="chtompki" due-to="Nick Wong">Improve JaccardSimilarity computational cost</action> |
| <action issue="TEXT-118" type="fix" dev="chtompki" due-to="Nandor Kollar">JSON escaping incorrect for the delete control character</action> |
| <action issue="TEXT-130" type="fix" dev="chtompki" due-to="Jan Martin Keil">Fixes JaroWinklerDistance: Wrong results due to precision of transpositions</action> |
| <action issue="TEXT-131" type="fix" dev="chtompki" due-to="Jan Martin Keil">JaroWinklerDistance: Calculation deviates from definition</action> |
| <action issue="TEXT-132" type="update" dev="ggregory">Update Apache Commons Lang from 3.7 to 3.8.1</action> |
| <action issue="TEXT-133" type="add" dev="ggregory">Add a XML file XPath string lookup.</action> |
| <action issue="TEXT-134" type="add" dev="ggregory">Add a Properties file string lookup.</action> |
| <action issue="TEXT-135" type="add" dev="ggregory">Add a script string lookup.</action> |
| <action issue="TEXT-136" type="add" dev="ggregory">Add a file string lookup.</action> |
| <action issue="TEXT-137" type="add" dev="ggregory">Add a URL string lookup.</action> |
| <action issue="TEXT-140" type="add" dev="ggregory">Add a Base64 string lookup.</action> |
| <action issue="TEXT-141" type="add" dev="ggregory">Add org.apache.commons.text.lookup.StringLookupFactory.resourceBundleStringLookup(String).</action> |
| <action issue="TEXT-142" type="add" dev="ggregory">Add URL encoder and decoder string lookups.</action> |
| <action issue="TEXT-143" type="add" dev="ggregory">Add constant string lookup like the one in Apache Commons Configuration.</action> |
| </release> |
| |
| <release version="1.4" date="2018-06-12" description="Release 1.4"> |
| <action issue="TEXT-120" type="fix" dev="pschumacher">StringEscapeUtils#unescapeJson does not unescape double quotes and forward slash</action> |
| <action issue="TEXT-119" type="fix" dev="pschumacher">Remove mention of SQL escaping from user guide</action> |
| <action issue="TEXT-121" type="update" dev="ggregory" due-to="pschumacher">Update Java requirement from version 7 to 8.</action> |
| <action issue="TEXT-122" type="update" dev="ggregory">Allow full customization with new API org.apache.commons.text.lookup.StringLookupFactory.interpolatorStringLookup(Map<String, StringLookup>, StringLookup, boolean).</action> |
| <action issue="TEXT-123" type="fix" dev="ggregory" due-to="Takanobu Asanuma">WordUtils.wrap throws StringIndexOutOfBoundsException when wrapLength is Integer.MAX_VALUE.</action> |
| </release> |
| |
| <release version="1.3" date="2018-03-16" description="Release 1.3"> |
| <action issue="TEXT-110" type="add" dev="pschumacher">Add Automatic-Module-Name MANIFEST entry for Java 9 compatibility</action> |
| <action issue="TEXT-70" type="fix" dev="pschumacher">Build failure with java 9-ea+159</action> |
| <action issue="TEXT-113" type="add" dev="ggregory">Add an interpolator string lookup: StringLookupFactory#interpolatorStringLookup()</action> |
| <action issue="TEXT-114" type="add" dev="ggregory">Add a StrSubstitutor replacement based on interfaces: StringSubstitutor</action> |
| <action issue="TEXT-115" type="add" dev="ggregory">Add a StrBuilder replacement based on the StringMatcher interface: TextStringBuilder</action> |
| <action issue="TEXT-116" type="add" dev="ggregory">Add a StrTokenizer replacement based on the StringMatcher interface: StringTokenizer</action> |
| <action issue="TEXT-117" type="add" dev="ggregory">Add a local host string lookup: LocalHostStringLookup</action> |
| <action issue="TEXT-80" type="fix" dev="ggregory">StrLookup API confusing</action> |
| </release> |
| |
| <release version="1.2" date="2017-12-12" description="Release 1.2"> |
| <action issue="TEXT-107" type="update" dev="chtompki">Upversion commons-lang to 3.7</action> |
| <action issue="TEXT-106" type="fix" dev="kinow" due-to="Benoit Moreau">Exception thrown in ExtendedMessageFormat using quotes with custom registry</action> |
| <action issue="TEXT-100" type="fix" dev="kinow" due-to="Don Jeba">StringEscapeUtils#UnEscapeJson doesn't recognize escape signs correctly</action> |
| <action issue="TEXT-74" type="add" dev="chtompki" due-to="Ioannis Sermetziadis">StrSubstitutor: Ability to turn off substitution in values</action> |
| <action issue="TEXT-97" type="add" dev="chtompki" due-to="Amey Jadiye">RandomStringGenerator able to pass multiple ranges to .withinRange()</action> |
| <action issue="TEXT-98" type="update" dev="chtompki" due-to="Arun Vinud S S">Deprecate isDelimiter and use HashSets for delimiter checks</action> |
| <action issue="TEXT-89" type="add" dev="chtompki" due-to="Arun Vinud S S">WordUtils.initials support for UTF-16 surrogate pairs</action> |
| <action issue="TEXT-88" type="update" dev="chtompki" due-to="Amey Jadiye">WordUtils should treat an empty delimiter array as no delimiters</action> |
| <action issue="TEXT-93" type="update" dev="chtompki" due-to="Amey Jadiye">Update RandomStringGenerator to accept a list of valid characters</action> |
| <action issue="TEXT-90" type="add" dev="pschumacher">Add CharacterPredicates for ASCII letters (uppercase/lowercase) and arabic numerals</action> |
| <action issue="TEXT-85" type="add" dev="chtompki" due-to="Arun Vinud S S">Added CaseUtils class with camel case conversion support</action> |
| <action issue="TEXT-91" type="add" dev="pschumacher">RandomStringGenerator should be able to generate a String with a random length</action> |
| <action issue="TEXT-92" type="update" dev="pschumacher">Update commons-lang dependency to version 3.6</action> |
| <action issue="TEXT-83" type="update" dev="chtompki" due-to="Amey Jadiye">Document that commons-csv should be used in preference to CsvTranslators</action> |
| <action issue="TEXT-67" type="update" dev="kinow">NumericEntityUnescaper.options - fix TODO</action> |
| <action issue="TEXT-84" type="update" dev="djones">RandomStringGenerator claims to be immutable, but isn't</action> |
| <action issue="TEXT-102" type="add" dev="ggregory">Add StrLookup.resourceBundleLookup(ResourceBundle)</action> |
| <action issue="TEXT-105" type="fix" dev="pschumacher" due-to="Abrasha">Typo in LongestCommonSubsequence#logestCommonSubsequence</action> |
| </release> |
| |
| <release version="1.1" date="2017-05-23" description="Release 1.1"> |
| <action issue="TEXT-39" type="update" dev="chtompki" due-to="Amey Jadiye">WordUtils should use toXxxxCase(int) rather than toXxxxCase(char)</action> |
| <action issue="TEXT-41" type="add" dev="chtompki" due-to="Amey Jadiye">WordUtils.abbreviate support</action> |
| <action issue="TEXT-82" type="add" dev="chtompki" due-to="Amey Jadiye">Putting WordUtils back in to the codebase</action> |
| <action issue="TEXT-81" type="add" dev="pschumacher" due-to="djones">Add RandomStringGenerator</action> |
| <action issue="TEXT-36" type="add" dev="pschumacher" due-to="Raymond DeCampo">RandomStringGenerator: allow users to provide source of randomness</action> |
| <action issue="TEXT-76" type="fix" dev="kinow">Correct round issue in Jaro Winkler implementation</action> |
| <action issue="TEXT-72" type="fix" dev="chtompki">Similar to LANG-1025, clirr fails site build.</action> |
| </release> |
| |
| <release version="1.0" date="2017-03-04" description=" |
| |
| Incompatible changes |
| ==================== |
| All package names changed from org.apache.commons.text.beta in 1.0-beta-1 to |
| org.apache.commons.text in 1.0. |
| |
| Methods StringEscapeUtils#escapeHtml3Once and StringEscapeUtils#escapeHtml4Once |
| have been removed; see TEXT-40 |
| "> |
| <action issue="TEXT-64" type="fix" dev="kinow" due-to="chtompki">Investigate locale issue in ExtendedMessageFormatTest</action> |
| <action issue="TEXT-69" type="fix" dev="chtompki">Resolve PMD/CMD Violations</action> |
| <action issue="TEXT-40" type="remove" dev="sebb">Escape HTML characters only once: revert</action> |
| <action issue="TEXT-65" type="fix" dev="chtompki">Fixing the 200 checkstyle errors present in 1.0-beta-1</action> |
| <action issue="TEXT-63" type="fix" dev="sebb">Mutable fields should be private</action> |
| </release> |
| |
| <release version="1.0-beta-1" date="2017-01-30" description="First release (beta) of Commons Text"> |
| <action issue="TEXT-62" type="fix" dev="chtompki">Incorporate suggestions from RC2 into 1.0 release</action> |
| <action issue="TEXT-61" type="update" dev="chtompki" due-to="Lee Adcock">Naming packages org.apache.commons.text.beta</action> |
| <action issue="TEXT-60" type="fix" dev="chtompki" due-to="Lee Adcock">Upgrading Jacoco for Java 9-ea compatibility.</action> |
| <action issue="TEXT-58" type="update" dev="chtompki">Refactor EntityArrays to have unmodifiableMaps in leu of String[][]</action> |
| <action issue="TEXT-53" type="update" dev="chtompki">Prepare site for 1.0 release</action> |
| <action issue="TEXT-56" type="add" dev="chtompki" due-to="Jarek Strzeleck">Move CvsTranslators out of StringEscapeUtils and make them DRY</action> |
| <action issue="TEXT-55" type="remove" dev="chtompki">Remove WordUtils to be added back in an upcoming 1.X release</action> |
| <action issue="TEXT-52" type="fix" dev="chtompki">Possible attacks through StringEscapeUtils.escapeEcmaScrip better javadoc</action> |
| <action issue="TEXT-51" type="remove" dev="chtompki">Remove RandomStringGenerator to be added back in the 1.1 release</action> |
| <action issue="TEXT-50" type="update" dev="chtompki">Upgrade from commons-parent version 41 to version 42</action> |
| <action issue="TEXT-40" type="add" dev="chtompki" due-to="Sampanna Kahu">Escape HTML characters only once</action> |
| <action issue="TEXT-37" type="fix" dev="djones">Global vs local source of randomness</action> |
| <action issue="TEXT-38" type="fix" dev="djones">Fluent API in "RandomStringBuilder"</action> |
| <action issue="TEXT-26" type="fix" dev="chtompki">Fix JaroWinklerDistance in the manner of LUCENE-1297</action> |
| <action issue="TEXT-32" type="add" dev="chtompki">Add LCS similarity and distance</action> |
| <action issue="TEXT-34" type="add" dev="djones">Add class to generate random strings</action> |
| <action issue="TEXT-35" type="fix" dev="kinow">Unfinished class Javadoc for CosineDistance</action> |
| <action issue="TEXT-33" type="update" dev="chtompki">Consolidating since tags at 1.0, removing deprecated methods</action> |
| <action issue="TEXT-29" type="add" dev="chtompki">Add a builder to StringEscapeUtils</action> |
| <action issue="TEXT-28" type="add" dev="chtompki">Add shell/XSI escape/unescape support</action> |
| <action issue="TEXT-22" type="fix" dev="chtompki">LevenshteinDistance reduce memory consumption</action> |
| <action issue="TEXT-31" type="remove" dev="chtompki">Remove org.apache.commons.text.names, for later release than 1.0</action> |
| <action issue="TEXT-2" type="add" dev="chtompki" due-to="Don Jeba">Add Jaccard Index and Jaccard Distance</action> |
| <action issue="TEXT-27" type="add" dev="chtompki">Move org.apache.commons.lang3.StringEscapeUtils.java into text</action> |
| <action issue="TEXT-23" type="add" dev="chtompki">Moving from commons-lang, the package org.apache.commons.lang3.text</action> |
| <action issue="TEXT-10" type="add" dev="kinow" due-to="Don Jeba">A more complex Levenshtein distance</action> |
| <action issue="TEXT-24" type="add" dev="chtompki">Add coveralls and Travis.ci integration</action> |
| <action issue="TEXT-19" type="add" dev="kinow" due-to="Eyal Allweil">Add alphabet converter</action> |
| <action issue="TEXT-13" type="add" dev="kinow">Create Commons Text logo</action> |
| <action issue="TEXT-16" type="update" dev="britter">Improve HumanNameParser</action> |
| <action issue="TEXT-5" type="fix" dev="kinow">IP clearance for the names package</action> |
| <action issue="TEXT-7" type="add" dev="kinow">Write user guide</action> |
| <action issue="TEXT-11" type="fix" dev="kinow">Work on the string metric, distance, and similarity definitions for the project</action> |
| <action issue="TEXT-15" type="add" dev="kinow">Human name parser</action> |
| <action issue="TEXT-12" type="fix" dev="kinow" due-to="Jonathan baker">Create StringDistanceFrom class that contains a StringMetric and the "left" side string. This would have a method that accepts the "right" side string to test.</action> |
| <action issue="TEXT-3" type="add" dev="kinow">Add Cosine Similarity and Cosine Distance</action> |
| <action issue="TEXT-8" type="fix" dev="kinow" due-to="Jonathan Baker">Change (R) StringMetric.compare(CS left, CS right) to "apply" so that it is consistent with BiFunction.</action> |
| <action issue="TEXT-6" type="fix" dev="kinow" due-to="Jonathan Baker">Allow extra information (e.g. Levenshtein threshold) to be stored as (final) fields in the StringMetric instance.</action> |
| <action issue="TEXT-4" type="add" dev="kinow">Port Myers algorithm from [collections]</action> |
| <action issue="TEXT-1" type="add" dev="kinow">Add Hamming distance</action> |
| <action issue="TEXT-9" type="add" dev="kinow" due-to="britter">Incorporate String algorithms from Commons Lang</action> |
| </release> |
| |
| </body> |
| </document> |