Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.liferay.source.formatter.checks.StringMethodsCheck Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.source.formatter.checks;
import com.liferay.petra.string.StringBundler;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.tools.ToolsUtil;
import com.liferay.source.formatter.checks.util.JavaSourceUtil;
import java.lang.reflect.Field;
import java.util.List;
import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* @author Hugo Huijser
*/
public class StringMethodsCheck extends BaseFileCheck {
@Override
public boolean isLiferaySourceCheck() {
return true;
}
@Override
protected String doProcess(
String fileName, String absolutePath, String content)
throws ReflectiveOperationException {
content = _checkStringUtilReplaceCalls(fileName, content);
if (isExcludedPath(RUN_OUTSIDE_PORTAL_EXCLUDES, absolutePath)) {
_checkStringReplaceCalls(fileName, content);
return content;
}
_checkInefficientStringMethods(
fileName, content, "(\\w+)\\.equalsIgnoreCase\\(",
"equalsIgnoreCase");
_checkInefficientStringMethods(
fileName, content, "(\\w+)\\.join\\(", "merge");
_checkInefficientStringMethods(
fileName, content, "(\\w+)\\.replace\\(", "replace");
_checkInefficientStringMethods(
fileName, content, "(\\w+)\\.toLowerCase\\(\\)", "toLowerCase");
_checkInefficientStringMethods(
fileName, content, "(\\w+)\\.toUpperCase\\(\\)", "toUpperCase");
return content;
}
protected boolean isJavaSource(String content, int pos) {
return true;
}
private void _checkInefficientStringMethods(
String fileName, String content, String regex, String methodName) {
Pattern pattern = Pattern.compile(regex);
Matcher matcher = pattern.matcher(content);
while (matcher.find()) {
if (!isJavaSource(content, matcher.start())) {
continue;
}
String s = matcher.group(1);
if (s.equals("String") ||
Objects.equals(
getVariableTypeName(content, content, s), "String")) {
addMessage(
fileName, "Use StringUtil." + methodName,
getLineNumber(content, matcher.start(1)));
}
}
}
private void _checkStringReplaceCalls(String fileName, String content)
throws ReflectiveOperationException {
Matcher matcher = _stringReplacePattern.matcher(content);
while (matcher.find()) {
String variableName = matcher.group(1);
if (!Objects.equals(
getVariableTypeName(content, content, variableName),
"String")) {
continue;
}
List parameterList = JavaSourceUtil.getParameterList(
content.substring(matcher.start()));
if ((parameterList.size() != 2) ||
!_isSingleLenghtString(parameterList.get(0)) ||
!_isSingleLenghtString(parameterList.get(1))) {
continue;
}
StringBundler sb = new StringBundler(5);
sb.append("Use ");
sb.append(variableName);
sb.append(".replace(char, char) instead of ");
sb.append(variableName);
sb.append(".replace(CharSequence, CharSequence)");
addMessage(
fileName, sb.toString(),
getLineNumber(content, matcher.start()));
}
}
private String _checkStringUtilReplaceCalls(String fileName, String content)
throws ReflectiveOperationException {
if (content.contains("com.liferay.poshi.runner.util.StringUtil") ||
content.contains("package com.liferay.poshi.runner.util;")) {
return content;
}
Matcher matcher = _stringUtilReplacePattern.matcher(content);
while (matcher.find()) {
if (ToolsUtil.isInsideQuotes(content, matcher.start())) {
continue;
}
List parameterList = JavaSourceUtil.getParameterList(
content.substring(matcher.start()));
if (parameterList.size() != 3) {
continue;
}
if (matcher.group(2) == null) {
String lastParameter = parameterList.get(2);
String middleParameter = parameterList.get(1);
if ((lastParameter.equals("\"\"") ||
lastParameter.equals("StringPool.BLANK")) &&
!middleParameter.startsWith(StringPool.APOSTROPHE) &&
!middleParameter.startsWith("CharPool.")) {
return _fixReplaceWithBlankCall(
content, parameterList, matcher.start());
}
}
if (!_isSingleLenghtString(parameterList.get(1))) {
continue;
}
String methodName = matcher.group(1);
StringBundler sb = new StringBundler(5);
sb.append("Use StringUtil.");
sb.append(methodName);
sb.append("(String, char, char) or StringUtil.");
sb.append(methodName);
sb.append("(String, char, String) instead");
addMessage(
fileName, sb.toString(),
getLineNumber(content, matcher.start()));
}
return content;
}
private String _fixReplaceWithBlankCall(
String content, List parameterList, int pos) {
int x = pos;
while (true) {
x = content.indexOf(StringPool.CLOSE_PARENTHESIS, x + 1);
String call = content.substring(pos, x + 1);
if ((ToolsUtil.getLevel(call, "(", ")") == 0) &&
(ToolsUtil.getLevel(call, "{", "}") == 0)) {
String replacement = StringBundler.concat(
"StringUtil.removeSubstring(", parameterList.get(0), ", ",
parameterList.get(1), ")");
return StringUtil.replaceFirst(content, call, replacement);
}
}
}
private boolean _isSingleLenghtString(String s)
throws ReflectiveOperationException {
Matcher singleLengthMatcher = _singleLengthStringPattern.matcher(s);
if (!singleLengthMatcher.find()) {
return false;
}
if (s.startsWith(StringPool.QUOTE)) {
return true;
}
String fieldName = singleLengthMatcher.group(2);
Field field = StringPool.class.getDeclaredField(fieldName);
String value = (String)field.get(null);
if (value.length() == 1) {
return true;
}
return false;
}
private static final Pattern _singleLengthStringPattern = Pattern.compile(
"^(\".\"|StringPool\\.([A-Z_]+))$");
private static final Pattern _stringReplacePattern = Pattern.compile(
"(\\w+)\\.replace\\(");
private static final Pattern _stringUtilReplacePattern = Pattern.compile(
"StringUtil\\.(replace(First|Last)?)\\(");
}
