Skip to content

Refactor TemplateRegexMatcher to externalize text normalization method #300

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

Merged
goneall merged 1 commit into from
Feb 27, 2025
Merged

Refactor TemplateRegexMatcher to externalize text normalization method #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 19 additions & 11 deletions src/main/java/org/spdx/utility/compare/TemplateRegexMatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,23 @@ public boolean isTemplateMatchWithinText(String text) throws SpdxCompareExceptio
}
}

/**
* Normalizes text for use in the template matcher
* @param text text to normalize
* @return text that is normalized for license comparison
*/
public String normalizeText(String text) {
StringBuilder normalizedText = new StringBuilder();

for (String token:LicenseTextHelper.tokenizeLicenseText(LicenseTextHelper.removeLineSeparators(
LicenseCompareHelper.removeCommentChars(text)), new HashMap<>())) {
normalizedText.append(
LicenseTextHelper.NORMALIZE_TOKENS.getOrDefault(token.toLowerCase(), token.toLowerCase()));
normalizedText.append(' ');
}
return normalizedText.toString();
}

/**
* @param text text to search for
* @return the text matching the beginning and end regular expressions for the template. Null if there is no match.
Expand All @@ -298,17 +315,8 @@ public boolean isTemplateMatchWithinText(String text) throws SpdxCompareExceptio
if (text == null || text.isEmpty() || template == null) {
return null;
}

StringBuilder normalizedText = new StringBuilder();

for (String token:LicenseTextHelper.tokenizeLicenseText(LicenseTextHelper.removeLineSeparators(
LicenseCompareHelper.removeCommentChars(text)), new HashMap<>())) {
normalizedText.append(
LicenseTextHelper.NORMALIZE_TOKENS.getOrDefault(token.toLowerCase(), token.toLowerCase()));
normalizedText.append(' ');
}

String compareText = normalizedText.toString();

String compareText = normalizeText(text);

Pattern quickPattern = Pattern.compile(getQuickMatchRegex(WORD_LIMIT));
if (quickPattern.matcher(compareText).find()) {
Expand Down