Replace File with Path at codemodder-plugin-maven (#233)

Remove the usage of File and replace it to Path

Author: carlosu7

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/AbstractCommand.java

@@ -1,8 +1,9 @@
 package io.codemodder.plugins.maven.operator;
 
-import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.List;
 import javax.xml.stream.XMLStreamException;
 import org.dom4j.Element;
@@ -63,17 +64,17 @@ public boolean postProcess(ProjectModel c) throws XMLStreamException {
    * @param pm The ProjectModel containing information about the project.
    * @return A File object representing the local repository path.
    */
-  protected File getLocalRepositoryPath(ProjectModel pm) {
-    File localRepositoryPath = null;
+  protected Path getLocalRepositoryPath(ProjectModel pm) {
+    Path localRepositoryPath = null;
 
     if (pm.getRepositoryPath() != null) {
       localRepositoryPath = pm.getRepositoryPath();
     } else if (System.getenv("M2_REPO") != null) {
-      localRepositoryPath = new File(System.getenv("M2_REPO"));
+      localRepositoryPath = Paths.get(System.getenv("M2_REPO"));
     } else if (System.getProperty("maven.repo.local") != null) {
-      localRepositoryPath = new File(System.getProperty("maven.repo.local"));
+      localRepositoryPath = Paths.get(System.getProperty("maven.repo.local"));
     } else {
-      localRepositoryPath = new File(System.getProperty("user.home"), ".m2/repository");
+      localRepositoryPath = Paths.get(System.getProperty("user.home"), ".m2/repository");
     }
 
     return localRepositoryPath;

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/AbstractQueryCommand.java

@@ -2,10 +2,9 @@
 
 import io.github.pixee.security.BoundedLineReader;
 import java.io.BufferedReader;
-import java.io.File;
-import java.io.FileReader;
 import java.io.IOException;
 import java.net.URISyntaxException;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.*;
@@ -29,24 +28,21 @@ abstract class AbstractQueryCommand extends AbstractCommand {
    *
    * @param pomFilePath POM Original File Path
    */
-  private File getOutputPath(File pomFilePath) {
-    File basePath = pomFilePath.getParentFile();
+  private Path getOutputPath(Path pomFilePath) {
+    Path basePath = pomFilePath.getParent();
 
     String outputBasename = String.format("output-%08X.txt", pomFilePath.hashCode());
 
-    File outputPath = new File(basePath, outputBasename);
-
-    return outputPath;
+    return basePath.resolve(outputBasename);
   }
 
   /**
    * Given a POM URI, returns a File Object
    *
    * @param d POMDocument
    */
-  private File getPomFilePath(POMDocument d) throws URISyntaxException {
-    Path pomPath = Paths.get(d.getPomPath().toURI());
-    return pomPath.toFile();
+  private Path getPomFilePath(POMDocument d) throws URISyntaxException {
+    return Paths.get(d.getPomPath().toURI());
   }
 
   /**
@@ -56,7 +52,7 @@ private File getPomFilePath(POMDocument d) throws URISyntaxException {
    * @param pomFilePath Input Pom Path
    * @param c Project Model
    */
-  protected abstract void extractDependencyTree(File outputPath, File pomFilePath, ProjectModel c);
+  protected abstract void extractDependencyTree(Path outputPath, Path pomFilePath, ProjectModel c);
 
   /**
    * Internal Holder Variable
@@ -85,11 +81,11 @@ public Collection<Dependency> getResult() {
    */
   @Override
   public boolean execute(ProjectModel pm) throws URISyntaxException, IOException {
-    File pomFilePath = getPomFilePath(pm.getPomFile());
-    File outputPath = getOutputPath(pomFilePath);
+    Path pomFilePath = getPomFilePath(pm.getPomFile());
+    Path outputPath = getOutputPath(pomFilePath);
 
-    if (outputPath.exists()) {
-      outputPath.delete();
+    if (Files.exists(outputPath)) {
+      Files.delete(outputPath);
     }
 
     try {
@@ -118,9 +114,9 @@ public boolean execute(ProjectModel pm) throws URISyntaxException, IOException {
    *
    * @param outputPath file to read
    */
-  private Map<String, Dependency> extractDependencies(File outputPath) throws IOException {
+  private Map<String, Dependency> extractDependencies(Path outputPath) throws IOException {
     Map<String, Dependency> dependencyMap = new HashMap<>();
-    try (BufferedReader reader = new BufferedReader(new FileReader(outputPath))) {
+    try (BufferedReader reader = Files.newBufferedReader(outputPath)) {
       String line;
       boolean skipFirstLine = true;
       while ((line = BoundedLineReader.readLine(reader, 5_000_000)) != null) {

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/CheckLocalRepositoryDirCommand.java

@@ -1,6 +1,8 @@
 package io.codemodder.plugins.maven.operator;
 
-import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 
 /** Commands for checking and creating the local repository directory if it doesn't exist. */
 class CheckLocalRepositoryDirCommand {
@@ -29,7 +31,7 @@ public static CheckParentDirCommand getInstance() {
      * @throws InvalidContextException Always throws an InvalidContextException.
      */
     @Override
-    protected void extractDependencyTree(File outputPath, File pomFilePath, ProjectModel c) {
+    protected void extractDependencyTree(Path outputPath, Path pomFilePath, ProjectModel c) {
       throw new InvalidContextException();
     }
 
@@ -42,11 +44,11 @@ protected void extractDependencyTree(File outputPath, File pomFilePath, ProjectM
      *     errors.
      */
     @Override
-    public boolean execute(ProjectModel c) {
-      File localRepositoryPath = getLocalRepositoryPath(c);
+    public boolean execute(ProjectModel c) throws IOException {
+      Path localRepositoryPath = getLocalRepositoryPath(c);
 
-      if (!localRepositoryPath.exists()) {
-        localRepositoryPath.mkdirs();
+      if (Files.notExists(localRepositoryPath)) {
+        Files.createDirectories(localRepositoryPath);
       }
 
       return false;

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/InvalidPathException.java

@@ -1,13 +1,11 @@
 package io.codemodder.plugins.maven.operator;
 
-import java.io.File;
 import java.io.IOException;
+import java.nio.file.Path;
 
 /** Exception class for handling invalid file paths. */
 class InvalidPathException extends IOException {
-  private final File parentPath;
   private final String relativePath;
-  private final boolean loop;
 
   /**
    * Constructs an InvalidPathException with the specified details.
@@ -16,29 +14,19 @@ class InvalidPathException extends IOException {
    * @param relativePath The relative path that is considered invalid.
    * @param loop Indicates whether the path forms a loop.
    */
-  public InvalidPathException(File parentPath, String relativePath, boolean loop) {
+  public InvalidPathException(Path parentPath, String relativePath, boolean loop) {
     super(
         "Invalid Relative Path "
             + relativePath
             + " (from "
-            + parentPath.getAbsolutePath()
+            + parentPath.toAbsolutePath()
             + ") (loops? "
             + loop
             + ")");
-    this.parentPath = parentPath;
     this.relativePath = relativePath;
-    this.loop = loop;
-  }
-
-  public File getParentPath() {
-    return parentPath;
   }
 
   public String getRelativePath() {
     return relativePath;
   }
-
-  public boolean isLoop() {
-    return loop;
-  }
 }

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/POMDocument.java

@@ -1,9 +1,10 @@
 package io.codemodder.plugins.maven.operator;
 
-import java.io.File;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.nio.charset.Charset;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import org.dom4j.Document;
 
 /**
@@ -24,7 +25,7 @@ public class POMDocument {
   private Document pomDocument;
 
   private Document resultPom;
-  private File file;
+  private Path path;
   private Charset charset;
   private String endl;
   private String indent;
@@ -54,7 +55,7 @@ public POMDocument(byte[] originalPom, URL pomPath, Document pomDocument)
     this.pomPath = pomPath;
     this.pomDocument = pomDocument;
     this.resultPom = (Document) pomDocument.clone();
-    this.file = this.pomPath != null ? new File(this.pomPath.toURI()) : null;
+    this.path = this.pomPath != null ? Paths.get(this.pomPath.toURI()) : null;
     this.charset = Charset.defaultCharset();
     this.endl = "\n";
     this.indent = "  ";
@@ -117,12 +118,12 @@ public void setResultPom(Document resultPom) {
     this.resultPom = resultPom;
   }
 
-  public File getFile() {
-    return file;
+  public Path getPath() {
+    return path;
   }
 
-  public void setFile(File file) {
-    this.file = file;
+  public void setPath(Path file) {
+    this.path = file;
   }
 
   public Charset getCharset() {

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/POMDocumentFactory.java

@@ -1,11 +1,11 @@
 package io.codemodder.plugins.maven.operator;
 
 import java.io.ByteArrayInputStream;
-import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.nio.file.Path;
 import org.apache.commons.io.IOUtils;
 import org.dom4j.Document;
 import org.dom4j.DocumentException;
@@ -41,15 +41,15 @@ public static POMDocument load(InputStream is)
   /**
    * Loads a POM document from the provided file.
    *
-   * @param f The file representing the POM document.
+   * @param filePath The file representing the POM document.
    * @return A new instance of {@link POMDocument} representing the loaded POM.
    * @throws IOException If an I/O error occurs while reading the file.
    * @throws DocumentException If an error occurs while parsing the POM document.
    * @throws URISyntaxException If there is an issue with the URI syntax.
    */
-  public static POMDocument load(File f) throws IOException, DocumentException, URISyntaxException {
-
-    URL fileUrl = f.toURI().toURL();
+  public static POMDocument load(Path filePath)
+      throws IOException, DocumentException, URISyntaxException {
+    URL fileUrl = filePath.toUri().toURL();
     return load(fileUrl);
   }
 

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/POMOperator.java

@@ -16,7 +16,7 @@ public class POMOperator {
   private final POMScanner pomScanner;
 
   public POMOperator(final Path pomFile, final Path projectDir) {
-    this.pomScanner = new POMScanner(pomFile.toFile(), projectDir.toFile());
+    this.pomScanner = new POMScanner(pomFile, projectDir);
   }
 
   public POMScanner getPomScanner() {
@@ -42,7 +42,7 @@ public ProjectModel addDependency(final DependencyGAV newDependencyGAV)
             .withDependency(newDependency)
             .withSkipIfNewer(true)
             .withUseProperties(true)
-            .withRepositoryPath(FileUtils.createTempDirectoryWithPermissions().toFile())
+            .withRepositoryPath(FileUtils.createTempDirectoryWithPermissions())
             .build();
 
     return modify(projectModel) ? projectModel : null;
@@ -65,7 +65,7 @@ public Collection<DependencyGAV> getAllFoundDependencies()
         pomScanner
             .scanFrom()
             .withSafeQueryType()
-            .withRepositoryPath(FileUtils.createTempDirectoryWithPermissions().toFile())
+            .withRepositoryPath(FileUtils.createTempDirectoryWithPermissions())
             .build();
 
     final Collection<Dependency> foundDependencies = queryDependency(originalProjectModel);