SONARPHP-1554 Remove dependency to Apache Commons Lang (#1595)

ZiadMarey · web-flow · commit a1d34b0edb23 · 2025-12-22T15:17:04.000+01:00
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -10,7 +10,6 @@ sslr = "1.24.0.633"
 junit = "6.0.0"
 assertj = "3.27.6"
 mockito = "5.20.0"
-commons-lang = "3.19.0"
 jsr305 = "3.0.2"
 staxmate = "2.0.1"
 awaitility = "4.3.0"
@@ -34,7 +33,6 @@ sslr-testing-harness = { module = "org.sonarsource.sslr:sslr-testing-harness", v
 junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" }
 assertj-core = { module = "org.assertj:assertj-core", version.ref = "assertj" }
 mockito-core = { module = "org.mockito:mockito-core", version.ref = "mockito" }
-commons-lang = { module = "org.apache.commons:commons-lang3", version.ref = "commons-lang" }
 jsr305 = { module = "com.google.code.findbugs:jsr305", version.ref = "jsr305" }
 # Version of JUnit Platform is taken from the JUnit BOM that is imported by junit-jupiter
 junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher" }
diff --git a/php-checks/build.gradle.kts b/php-checks/build.gradle.kts
@@ -25,7 +25,6 @@ dependencies {
   compileOnly(libs.sonar.plugin.api)
   implementation(project(":php-frontend"))
   implementation(libs.sonar.analyzer.commons)
-  implementation(libs.commons.lang)
 
   testImplementation(testFixtures(project(":php-frontend")))
   testImplementation(libs.junit.jupiter)
diff --git a/php-checks/src/main/java/org/sonar/php/checks/ClassCouplingCheck.java b/php-checks/src/main/java/org/sonar/php/checks/ClassCouplingCheck.java
@@ -22,7 +22,6 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Set;
-import org.apache.commons.lang3.StringUtils;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.php.parser.LexicalConstant;
@@ -168,7 +167,9 @@ private void retrieveTypeFromCommentLine(String line, Tree trivia) {
 
     if (commentLine.length > 2 && DOC_TAGS.contains(commentLine[1])) {
       for (String type : commentLine[2].split("\\|")) {
-        type = StringUtils.removeEnd(type, "[]");
+        if (type.endsWith("[]")) {
+          type = type.substring(0, type.length() - 2);
+        }
 
         if (!EXCLUDED_TYPES.contains(type.toLowerCase(Locale.ROOT))) {
           addType(type, trivia);
@@ -195,7 +196,7 @@ private void retrieveInstantiatedClassName(NewExpressionTree newExpression) {
   private static String getTypeName(NamespaceNameTree namespaceName) {
     String name = namespaceName.fullName();
     String prefix = "namespace\\";
-    if (StringUtils.startsWithIgnoreCase(name, prefix)) {
+    if (name.toLowerCase(Locale.ROOT).startsWith(prefix.toLowerCase(Locale.ROOT))) {
       // fixme (SONARPHP-552): Handle namespaces properly
       name = name.substring(prefix.length() - 1);
     }
diff --git a/php-checks/src/main/java/org/sonar/php/checks/FieldNameCheck.java b/php-checks/src/main/java/org/sonar/php/checks/FieldNameCheck.java
@@ -19,7 +19,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.regex.Pattern;
-import org.apache.commons.lang3.StringUtils;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.plugins.php.api.tree.Tree;
@@ -58,7 +57,7 @@ public void visitNode(Tree tree) {
     ClassPropertyDeclarationTree property = (ClassPropertyDeclarationTree) tree;
     for (VariableDeclarationTree variableDeclarationTree : property.declarations()) {
       String propertyName = variableDeclarationTree.identifier().text();
-      if (!pattern.matcher(StringUtils.remove(propertyName, "$")).matches()) {
+      if (!pattern.matcher(propertyName.replace("$", "")).matches()) {
         context().newIssue(this, variableDeclarationTree.identifier(), String.format(MESSAGE, propertyName, format));
       }
     }
diff --git a/php-checks/src/main/java/org/sonar/php/checks/LocalVariableAndParameterNameCheck.java b/php-checks/src/main/java/org/sonar/php/checks/LocalVariableAndParameterNameCheck.java
@@ -23,7 +23,6 @@
 import java.util.List;
 import java.util.Set;
 import java.util.regex.Pattern;
-import org.apache.commons.lang3.StringUtils;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.php.checks.utils.CheckUtils;
@@ -128,7 +127,7 @@ private static ExpressionTree getLeftHandExpression(Tree assignmentExpr) {
   }
 
   private boolean isCompliant(String varName) {
-    return pattern.matcher(StringUtils.remove(varName, "$")).matches() || isSuperGlobal(varName);
+    return pattern.matcher(varName.replace("$", "")).matches() || isSuperGlobal(varName);
   }
 
   private static boolean isSuperGlobal(String varName) {
diff --git a/php-checks/src/main/java/org/sonar/php/checks/MethodNameReturningBooleanCheck.java b/php-checks/src/main/java/org/sonar/php/checks/MethodNameReturningBooleanCheck.java
@@ -16,7 +16,7 @@
  */
 package org.sonar.php.checks;
 
-import org.apache.commons.lang3.StringUtils;
+import java.util.Locale;
 import org.sonar.check.Rule;
 import org.sonar.php.parser.LexicalConstant;
 import org.sonar.php.tree.impl.PHPTree;
@@ -50,7 +50,8 @@ private static boolean isReturningBoolean(MethodDeclarationTree methodDeclaratio
     for (SyntaxTrivia comment : ((PHPTree) methodDeclaration).getFirstToken().trivias()) {
       for (String line : comment.text().split(LexicalConstant.LINE_TERMINATOR)) {
 
-        if (StringUtils.containsIgnoreCase(line, RETURN_TAG)) {
+        if (line.toLowerCase(Locale.ROOT).contains(RETURN_TAG)) {
+
           return returnsBoolean(line);
         }
       }
diff --git a/php-checks/src/main/java/org/sonar/php/checks/UselessExpressionStatementCheck.java b/php-checks/src/main/java/org/sonar/php/checks/UselessExpressionStatementCheck.java
@@ -19,7 +19,6 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.regex.Pattern;
-import org.apache.commons.lang3.tuple.Pair;
 import org.sonar.check.Rule;
 import org.sonar.php.checks.utils.CheckUtils;
 import org.sonar.plugins.php.api.tree.CompilationUnitTree;
@@ -36,6 +35,7 @@
 public class UselessExpressionStatementCheck extends PHPVisitorCheck {
 
   public static final String KEY = "S905";
+
   private static final String MESSAGE = "Remove or refactor this statement.";
   private static final String MESSAGE_PARTIAL = "This statement part is useless, remove or refactor it.";
   private static final String MESSAGE_OPERATOR = "This binary operation is useless, remove it.";
@@ -88,7 +88,7 @@ public class UselessExpressionStatementCheck extends PHPVisitorCheck {
 
   private boolean fileContainsHTML;
   private List<Tree> uselessNodes;
-  private List<Pair<Tree, Tree>> uselessPartialNodes;
+  private List<TreePair> uselessPartialNodes;
   private List<Tree> uselessOperatorNodes;
 
   @Override
@@ -104,8 +104,8 @@ public void visitCompilationUnit(CompilationUnitTree tree) {
       for (Tree uselessNode : uselessNodes) {
         context().newIssue(this, uselessNode, MESSAGE);
       }
-      for (Pair<Tree, Tree> uselessPartialNode : uselessPartialNodes) {
-        context().newIssue(this, uselessPartialNode.getLeft(), uselessPartialNode.getRight(), MESSAGE_PARTIAL);
+      for (TreePair uselessPartialNode : uselessPartialNodes) {
+        context().newIssue(this, uselessPartialNode.left, uselessPartialNode.right, MESSAGE_PARTIAL);
       }
       for (Tree uselessOperatorNode : uselessOperatorNodes) {
         context().newIssue(this, uselessOperatorNode, MESSAGE_OPERATOR);
@@ -137,9 +137,9 @@ private void checkBinaryExpression(BinaryExpressionTree binaryExpression) {
     if (isLeftUseless && isRightUseless) {
       uselessNodes.add(binaryExpression);
     } else if (isLeftUseless) {
-      uselessPartialNodes.add(Pair.of(binaryExpression.leftOperand(), binaryExpression.operator()));
+      uselessPartialNodes.add(TreePair.of(binaryExpression.leftOperand(), binaryExpression.operator()));
     } else if (isRightUseless) {
-      uselessPartialNodes.add(Pair.of(binaryExpression.operator(), binaryExpression.rightOperand()));
+      uselessPartialNodes.add(TreePair.of(binaryExpression.operator(), binaryExpression.rightOperand()));
     } else {
       uselessOperatorNodes.add(binaryExpression.operator());
     }
@@ -162,4 +162,10 @@ public void visitToken(SyntaxToken token) {
       fileContainsHTML = true;
     }
   }
+
+  private record TreePair(Tree left, Tree right) {
+    static TreePair of(Tree left, Tree right) {
+      return new TreePair(left, right);
+    }
+  }
 }
diff --git a/php-checks/src/main/java/org/sonar/php/checks/utils/AbstractCommentContainsPatternCheck.java b/php-checks/src/main/java/org/sonar/php/checks/utils/AbstractCommentContainsPatternCheck.java
@@ -16,7 +16,7 @@
  */
 package org.sonar.php.checks.utils;
 
-import org.apache.commons.lang3.StringUtils;
+import java.util.Locale;
 import org.sonar.plugins.php.api.tree.lexical.SyntaxTrivia;
 import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;
 
@@ -29,20 +29,19 @@ public abstract class AbstractCommentContainsPatternCheck extends PHPVisitorChec
   @Override
   public void visitTrivia(SyntaxTrivia trivia) {
     String comment = trivia.text();
-
-    if (StringUtils.containsIgnoreCase(comment, pattern())) {
+    if (comment.toLowerCase(Locale.ROOT).contains(pattern().toLowerCase(Locale.ROOT))) {
       String[] lines = comment.split("\r\n?|\n");
 
       for (int i = 0; i < lines.length; i++) {
-        if (StringUtils.containsIgnoreCase(lines[i], pattern()) && !isLetterAround(lines[i])) {
+        if (lines[i].toLowerCase(Locale.ROOT).contains(pattern().toLowerCase(Locale.ROOT)) && !isLetterAround(lines[i])) {
           createIssue(trivia.line() + i);
         }
       }
     }
   }
 
   private boolean isLetterAround(String line) {
-    int start = StringUtils.indexOfIgnoreCase(line, pattern());
+    int start = line.toLowerCase(Locale.ROOT).indexOf(pattern().toLowerCase(Locale.ROOT));
     int end = start + pattern().length();
 
     boolean pre = start > 0 && Character.isLetter(line.charAt(start - 1));
diff --git a/php-checks/src/test/java/org/sonar/php/checks/FormattingStandardCheckTest.java b/php-checks/src/test/java/org/sonar/php/checks/FormattingStandardCheckTest.java
@@ -17,7 +17,7 @@
 package org.sonar.php.checks;
 
 import java.lang.reflect.Field;
-import org.apache.commons.lang3.ArrayUtils;
+import java.util.Arrays;
 
 public abstract class FormattingStandardCheckTest {
 
@@ -29,7 +29,7 @@ protected void activeOnly(String... fieldNames) throws IllegalAccessException {
       if (!f.getType().equals(boolean.class)) {
         continue;
       }
-      f.setBoolean(check, ArrayUtils.contains(fieldNames, f.getName()));
+      f.setBoolean(check, Arrays.asList(fieldNames).contains(f.getName()));
     }
   }
 
diff --git a/php-frontend/build.gradle.kts b/php-frontend/build.gradle.kts
@@ -27,7 +27,6 @@ dependencies {
   api(libs.sonar.regex.parsing)
 
   compileOnly(libs.sonar.plugin.api)
-  implementation(libs.commons.lang)
 
   testImplementation(libs.junit.jupiter)
   testImplementation(libs.mockito.core)
diff --git a/php-frontend/src/main/java/org/sonar/php/cache/CacheContextImpl.java b/php-frontend/src/main/java/org/sonar/php/cache/CacheContextImpl.java
@@ -17,7 +17,6 @@
 package org.sonar.php.cache;
 
 import javax.annotation.Nullable;
-import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonar.api.SonarProduct;
@@ -48,12 +47,12 @@ public CacheContextImpl(boolean isCacheEnabled, @Nullable PhpWriteCache writeCac
   public static CacheContextImpl of(SensorContext context) {
     String pluginVersion = getImplementationVersion(ProjectSymbolData.class);
     String sonarModules = context.config().get("sonar.modules").orElse("");
-    if (StringUtils.isNotBlank(sonarModules) && context.isCacheEnabled()) {
+    if (!sonarModules.isBlank() && context.isCacheEnabled()) {
       LOG.warn("The sonar.modules is a deprecated property and should not be used anymore, it inhibits an optimized analysis");
     }
     if (!context.runtime().getProduct().equals(SonarProduct.SONARLINT)
       && context.runtime().getApiVersion().isGreaterThanOrEqual(MINIMUM_RUNTIME_VERSION)
-      && StringUtils.isBlank(sonarModules)) {
+      && (sonarModules.isBlank())) {
       return new CacheContextImpl(context.isCacheEnabled(),
         new PhpWriteCacheImpl(context.nextCache()),
         new PhpReadCacheImpl(context.previousCache()),
diff --git a/php-frontend/src/main/java/org/sonar/php/tree/TreeUtils.java b/php-frontend/src/main/java/org/sonar/php/tree/TreeUtils.java
@@ -19,6 +19,7 @@
 import java.util.Collection;
 import java.util.EnumSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Optional;
 import java.util.Spliterator;
 import java.util.Spliterators;
@@ -27,7 +28,6 @@
 import java.util.stream.StreamSupport;
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
-import org.apache.commons.lang3.StringUtils;
 import org.sonar.php.tree.impl.PHPTree;
 import org.sonar.plugins.php.api.tree.SeparatedList;
 import org.sonar.plugins.php.api.tree.Tree;
@@ -104,7 +104,7 @@ public static boolean hasAnnotation(Tree declaration, String annotation) {
     List<SyntaxTrivia> trivias = ((PHPTree) declaration).getFirstToken().trivias();
 
     if (!trivias.isEmpty()) {
-      return StringUtils.containsIgnoreCase(getLast(trivias).text(), annotation);
+      return getLast(trivias).text().toLowerCase(Locale.ROOT).contains(annotation.toLowerCase(Locale.ROOT));
     }
 
     return false;
diff --git a/php-frontend/src/test/java/org/sonar/php/ParsingTestUtils.java b/php-frontend/src/test/java/org/sonar/php/ParsingTestUtils.java
@@ -18,7 +18,6 @@
 
 import com.sonar.sslr.api.typed.ActionParser;
 import java.io.File;
-import org.apache.commons.lang3.StringUtils;
 import org.sonar.php.parser.PHPLexicalGrammar;
 import org.sonar.php.parser.PHPParserBuilder;
 import org.sonar.plugins.php.api.tree.CompilationUnitTree;
@@ -44,6 +43,6 @@ public static CompilationUnitTree parseSource(String sourceCode) {
   }
 
   public static String asCode(String... args) {
-    return StringUtils.join(args, System.lineSeparator());
+    return String.join(System.lineSeparator(), args);
   }
 }
diff --git a/php-frontend/src/test/java/org/sonar/plugins/php/api/cfg/Validator.java b/php-frontend/src/test/java/org/sonar/plugins/php/api/cfg/Validator.java
@@ -20,7 +20,6 @@
 import java.util.Set;
 import java.util.StringJoiner;
 import java.util.stream.Collectors;
-import org.apache.commons.lang3.StringUtils;
 import org.sonar.php.cfg.LiveVariablesAnalysis;
 import org.sonar.plugins.php.api.symbols.Symbol;
 
@@ -151,7 +150,7 @@ private void assertVariablesAreEqual(String variableType, Set<Symbol> actualVari
       .isEqualTo(expectedSize);
     Set<String> actualVariableNames = actualVariables.stream().map(Symbol::name).collect(Collectors.toSet());
     assertThat(actualVariableNames)
-      .withFailMessage(buildDebugMessage(variableType + " elements differ. Actual: " + StringUtils.join(actualVariableNames, " ; "), blockTestId))
+      .withFailMessage(buildDebugMessage(variableType + " elements differ. Actual: " + String.join(" ; ", actualVariableNames), blockTestId))
       .hasSameElementsAs(expectedVariables);
   }
 
diff --git a/sonar-php-plugin/build.gradle.kts b/sonar-php-plugin/build.gradle.kts
@@ -29,7 +29,6 @@ dependencies {
   implementation(libs.sonar.analyzer.commons)
   implementation(libs.woodstox)
   implementation(libs.staxmate)
-  implementation(libs.commons.lang)
 
   testImplementation(testFixtures(project(":php-frontend")))
   testImplementation(libs.junit.jupiter)
@@ -84,7 +83,7 @@ tasks.shadowJar {
 
   val logger = project.logger
   doLast {
-    enforceJarSize(tasks.shadowJar.get().archiveFile.get().asFile, 3_000_000L, 3_500_000L, logger)
+    enforceJarSize(tasks.shadowJar.get().archiveFile.get().asFile, 2_750_000L, 3_250_000L, logger)
   }
 }
 
diff --git a/sonar-php-plugin/src/main/java/org/sonar/plugins/php/api/Php.java b/sonar-php-plugin/src/main/java/org/sonar/plugins/php/api/Php.java
@@ -18,7 +18,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import org.apache.commons.lang3.StringUtils;
+import java.util.Locale;
 import org.sonar.api.config.Configuration;
 import org.sonar.api.resources.AbstractLanguage;
 import org.sonar.plugins.php.PhpPlugin;
@@ -50,15 +50,15 @@ public Php(Configuration settings) {
   public String[] getFileSuffixes() {
     String[] suffixes = filterEmptyStrings(settings.getStringArray(PhpPlugin.FILE_SUFFIXES_KEY));
     if (suffixes.length == 0) {
-      suffixes = StringUtils.split(Php.DEFAULT_FILE_SUFFIXES, ",");
+      suffixes = Php.DEFAULT_FILE_SUFFIXES.split(",");
     }
     return suffixes;
   }
 
   private static String[] filterEmptyStrings(String[] stringArray) {
     List<String> nonEmptyStrings = new ArrayList<>();
     for (String string : stringArray) {
-      if (StringUtils.isNotBlank(string.trim())) {
+      if (!string.isBlank()) {
         nonEmptyStrings.add(string.trim());
       }
     }
@@ -72,9 +72,9 @@ private static String[] filterEmptyStrings(String[] stringArray) {
    * @return boolean <code>true</code> if the file name's suffix is known, <code>false</code> any other way
    */
   public boolean hasValidSuffixes(String fileName) {
-    String pathLowerCase = StringUtils.lowerCase(fileName);
+    String pathLowerCase = fileName.toLowerCase(Locale.ROOT);
     for (String suffix : getFileSuffixes()) {
-      if (pathLowerCase.endsWith("." + StringUtils.lowerCase(suffix))) {
+      if (pathLowerCase.endsWith("." + suffix.toLowerCase(Locale.ROOT))) {
         return true;
       }
     }
diff --git a/sonar-php-plugin/src/main/java/org/sonar/plugins/php/reports/phpunit/TestFileReport.java b/sonar-php-plugin/src/main/java/org/sonar/plugins/php/reports/phpunit/TestFileReport.java
diff --git a/sonar-php-plugin/src/main/java/org/sonar/plugins/php/reports/phpunit/xml/TestCase.java b/sonar-php-plugin/src/main/java/org/sonar/plugins/php/reports/phpunit/xml/TestCase.java
diff --git a/sonar-php-plugin/src/main/java/org/sonar/plugins/php/reports/phpunit/xml/TestSuites.java b/sonar-php-plugin/src/main/java/org/sonar/plugins/php/reports/phpunit/xml/TestSuites.java
diff --git a/sonar-php-plugin/src/main/resources/licenses/THIRD_PARTY_LICENSES/org.apache.commons.commons-lang3-LICENSE.txt b/sonar-php-plugin/src/main/resources/licenses/THIRD_PARTY_LICENSES/org.apache.commons.commons-lang3-LICENSE.txt
diff --git a/sonar-php-plugin/src/test/java/org/sonar/plugins/php/reports/phpunit/JUnitLogParserForPhpUnitTest.java b/sonar-php-plugin/src/test/java/org/sonar/plugins/php/reports/phpunit/JUnitLogParserForPhpUnitTest.java
diff --git a/sonar-php-plugin/src/test/java/org/sonar/plugins/php/reports/phpunit/TestFileReportTest.java b/sonar-php-plugin/src/test/java/org/sonar/plugins/php/reports/phpunit/TestFileReportTest.java

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@`
`23`	`23`	`import java.util.List;`
`24`	`24`	`import java.util.Set;`
`25`	`25`	`import java.util.regex.Pattern;`
`26`		`-import org.apache.commons.lang3.StringUtils;`
`27`	`26`	`import org.sonar.check.Rule;`
`28`	`27`	`import org.sonar.check.RuleProperty;`
`29`	`28`	`import org.sonar.php.checks.utils.CheckUtils;`
`@@ -128,7 +127,7 @@ private static ExpressionTree getLeftHandExpression(Tree assignmentExpr) {`
`128`	`127`	`}`
`129`	`128`
`130`	`129`	`private boolean isCompliant(String varName) {`
`131`		`- return pattern.matcher(StringUtils.remove(varName, "$")).matches() \|\| isSuperGlobal(varName);`
	`130`	`+ return pattern.matcher(varName.replace("$", "")).matches() \|\| isSuperGlobal(varName);`
`132`	`131`	`}`
`133`	`132`
`134`	`133`	`private static boolean isSuperGlobal(String varName) {`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`package org.sonar.php.checks;`
`18`	`18`
`19`	`19`	`import java.lang.reflect.Field;`
`20`		`-import org.apache.commons.lang3.ArrayUtils;`
	`20`	`+import java.util.Arrays;`
`21`	`21`
`22`	`22`	`public abstract class FormattingStandardCheckTest {`
`23`	`23`
`@@ -29,7 +29,7 @@ protected void activeOnly(String... fieldNames) throws IllegalAccessException {`
`29`	`29`	`if (!f.getType().equals(boolean.class)) {`
`30`	`30`	`continue;`
`31`	`31`	`}`
`32`		`- f.setBoolean(check, ArrayUtils.contains(fieldNames, f.getName()));`
	`32`	`+ f.setBoolean(check, Arrays.asList(fieldNames).contains(f.getName()));`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`