Add PathFileObject#getAbsolutePath

Create PathFileObject#getAbsolutePath and make it return the same thing as
PathFileObject#getFullPath. I have then deprecated PathFileObject#getFullPath
as the naming is not completely clear as to what a 'full path' implies. This
will be removed in 1.0.0.

Author: ascopes

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/PathFileObjectAssert.java

@@ -55,14 +55,29 @@ public AbstractPathAssert<?> relativePath() {
   }
 
   /**
-   * Perform an assertion on the file object's full path.
+   * Perform an assertion on the file object's absolute path.
    *
    * @return the assertions for the path.
    * @throws AssertionError if the file object is null.
+   * @deprecated use {@link #absolutePath()} instead.
    */
+  @Deprecated(forRemoval = true, since = "0.7.3")
+  @SuppressWarnings("removal")
   public AbstractPathAssert<?> fullPath() {
     isNotNull();
 
     return assertThat(actual.getFullPath());
   }
+
+  /**
+   * Perform an assertion on the file object's absolute path.
+   *
+   * @return the assertions for the path.
+   * @throws AssertionError if the file object is null.
+   */
+  public AbstractPathAssert<?> absolutePath() {
+    isNotNull();
+
+    return assertThat(actual.getAbsolutePath());
+  }
 }

java-compiler-testing/src/main/java/io/github/ascopes/jct/containers/impl/JarContainerImpl.java

@@ -90,7 +90,7 @@ public void close() throws IOException {
 
   @Override
   public boolean contains(PathFileObject fileObject) {
-    var path = fileObject.getFullPath();
+    var path = fileObject.getAbsolutePath();
     var root = holder.access().getPathRoot().getPath();
     return path.startsWith(root) && Files.isRegularFile(path);
   }
@@ -183,7 +183,7 @@ public String inferBinaryName(PathFileObject javaFileObject) {
     // we cannot then parse the URI back to a path without removing the `file://` bit first. Since
     // we assume we always have instances of PathJavaFileObject here, let's just cast to that and
     // get the correct path immediately.
-    var fullPath = javaFileObject.getFullPath();
+    var fullPath = javaFileObject.getAbsolutePath();
 
     if (fullPath.startsWith( holder.access().getPathRoot().getPath())) {
       return FileUtils.pathToBinaryName(javaFileObject.getRelativePath());

java-compiler-testing/src/main/java/io/github/ascopes/jct/containers/impl/PathWrappingContainerImpl.java

@@ -74,7 +74,7 @@ public void close() throws IOException {
 
   @Override
   public boolean contains(PathFileObject fileObject) {
-    var path = fileObject.getFullPath();
+    var path = fileObject.getAbsolutePath();
     return path.startsWith(root.getPath()) && Files.isRegularFile(path);
   }
 
@@ -143,7 +143,7 @@ public PathRoot getPathRoot() {
 
   @Override
   public String inferBinaryName(PathFileObject javaFileObject) {
-    return javaFileObject.getFullPath().startsWith(root.getPath())
+    return javaFileObject.getAbsolutePath().startsWith(root.getPath())
         ? FileUtils.pathToBinaryName(javaFileObject.getRelativePath())
         : null;
   }

java-compiler-testing/src/main/java/io/github/ascopes/jct/filemanagers/PathFileObject.java

@@ -69,7 +69,7 @@ public final class PathFileObject implements JavaFileObject {
   private final Location location;
   private final Path rootPath;
   private final Path relativePath;
-  private final Path fullPath;
+  private final Path absolutePath;
   private final String name;
   private final URI uri;
   private final Kind kind;
@@ -93,15 +93,15 @@ public PathFileObject(Location location, Path rootPath, Path relativePath) {
     this.location = location;
     this.rootPath = rootPath;
 
-    // TODO(ascopes): should we allow absolute paths here? Not sure that it makes a lot of sense
-    // here. 
+    // TODO(ascopes): should we allow absolute paths in the input here? Not sure that it makes a
+    //  lot of sense.
     this.relativePath = relativePath.isAbsolute()
         ? rootPath.relativize(relativePath)
         : relativePath;
 
-    fullPath = rootPath.resolve(relativePath);
+    absolutePath = rootPath.resolve(relativePath);
     name = this.relativePath.toString();
-    uri = fullPath.toUri();
+    uri = absolutePath.toUri();
     kind = FileUtils.pathToKind(relativePath);
   }
 
@@ -113,7 +113,7 @@ public PathFileObject(Location location, Path rootPath, Path relativePath) {
   @Override
   public boolean delete() {
     try {
-      return Files.deleteIfExists(fullPath);
+      return Files.deleteIfExists(absolutePath);
     } catch (IOException ex) {
       LOGGER.debug("Ignoring error deleting {}", uri, ex);
       return false;
@@ -133,6 +133,15 @@ public boolean equals(@Nullable Object other) {
     return other instanceof FileObject && uri.equals(((FileObject) other).toUri());
   }
 
+  /**
+   * Get the absolute path of this file object.
+   *
+   * @return the full path.
+   */
+  public Path getAbsolutePath() {
+    return absolutePath;
+  }
+
   /**
    * Get the class access level, where appropriate.
    *
@@ -182,9 +191,12 @@ public String getCharContent(boolean ignoreEncodingErrors) throws IOException {
    * Get the full path of this file object.
    *
    * @return the full path.
+   * @deprecated use {@link #getAbsolutePath()} instead.
    */
+  @Deprecated(since = "0.7.3", forRemoval = true)
+  @SuppressWarnings("DeprecatedIsStillUsed")
   public Path getFullPath() {
-    return fullPath;
+    return absolutePath;
   }
 
   /**
@@ -206,7 +218,7 @@ public Kind getKind() {
   @Override
   public long getLastModified() {
     try {
-      return Files.getLastModifiedTime(fullPath).toMillis();
+      return Files.getLastModifiedTime(absolutePath).toMillis();
     } catch (IOException ex) {
       LOGGER.debug("Ignoring error reading last modified time for {}", uri, ex);
       return NOT_MODIFIED;
@@ -402,13 +414,13 @@ public String toString() {
   }
 
   private InputStream openUnbufferedInputStream() throws IOException {
-    return Files.newInputStream(fullPath);
+    return Files.newInputStream(absolutePath);
   }
 
   private OutputStream openUnbufferedOutputStream() throws IOException {
     // Ensure parent directories exist first.
-    Files.createDirectories(fullPath.getParent());
-    return Files.newOutputStream(fullPath);
+    Files.createDirectories(absolutePath.getParent());
+    return Files.newOutputStream(absolutePath);
   }
 
   private CharsetDecoder decoder(boolean ignoreEncodingErrors) {

java-compiler-testing/src/test/java/io/github/ascopes/jct/tests/unit/filemanagers/PathFileObjectTest.java

@@ -202,6 +202,7 @@ void equalsReturnsTrueIfTheFileObjectHasTheSameUri() {
   }
 
   @DisplayName(".equals(PathFileObject) returns true if the file object is the same instance")
+  @SuppressWarnings("EqualsWithItself")
   @Test
   void equalsReturnsTrueIfTheFileObjectIsTheSameInstance() {
     // Given
@@ -212,7 +213,20 @@ void equalsReturnsTrueIfTheFileObjectIsTheSameInstance() {
     var fileObject = new PathFileObject(location, rootPath, relativePath);
 
     // Then
-    assertThat(fileObject).isEqualTo(fileObject);
+    assertThat(fileObject.equals(fileObject)).isTrue();
+  }
+
+  @DisplayName(".getAbsolutePath() returns the absolute path")
+  @Test
+  void getAbsolutePathReturnsTheAbsolutePath() {
+    // Given
+    var rootPath = someAbsolutePath();
+    var relativePath = someRelativePath();
+    var fileObject = new PathFileObject(someLocation(), rootPath, relativePath);
+
+    // Then
+    assertThat(fileObject.getAbsolutePath())
+        .isEqualTo(rootPath.resolve(relativePath));
   }
 
   @DisplayName(".getAccessLevel() returns null")
@@ -310,6 +324,7 @@ void getCharContentPropagatesEncodingErrors() throws IOException {
 
   @DisplayName(".getFullPath() returns the full path")
   @Test
+  @SuppressWarnings("removal")
   void getFullPathReturnsTheFullPath() {
     // Given
     var rootPath = someAbsolutePath();