Remove FilePath (#7235)

* Replace FilePath with absolute path in Location

* Update tests

* Remove FilePath

detekt-api/api/detekt-api.api

@@ -190,10 +190,10 @@ public abstract interface class io/gitlab/arturbosch/detekt/api/Issue$RuleInfo {
 
 public final class io/gitlab/arturbosch/detekt/api/Location : io/gitlab/arturbosch/detekt/api/Compactable {
 	public static final field Companion Lio/gitlab/arturbosch/detekt/api/Location$Companion;
-	public fun <init> (Lio/gitlab/arturbosch/detekt/api/SourceLocation;Lio/gitlab/arturbosch/detekt/api/SourceLocation;Lio/gitlab/arturbosch/detekt/api/TextLocation;Lio/github/detekt/psi/FilePath;)V
+	public fun <init> (Lio/gitlab/arturbosch/detekt/api/SourceLocation;Lio/gitlab/arturbosch/detekt/api/SourceLocation;Lio/gitlab/arturbosch/detekt/api/TextLocation;Ljava/nio/file/Path;)V
 	public fun compact ()Ljava/lang/String;
 	public final fun getEndSource ()Lio/gitlab/arturbosch/detekt/api/SourceLocation;
-	public final fun getFilePath ()Lio/github/detekt/psi/FilePath;
+	public final fun getPath ()Ljava/nio/file/Path;
 	public final fun getSource ()Lio/gitlab/arturbosch/detekt/api/SourceLocation;
 	public final fun getText ()Lio/gitlab/arturbosch/detekt/api/TextLocation;
 	public fun toString ()Ljava/lang/String;

detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/Location.kt

@@ -1,15 +1,15 @@
 package io.gitlab.arturbosch.detekt.api
 
 import dev.drewhamilton.poko.Poko
-import io.github.detekt.psi.FilePath
+import io.github.detekt.psi.absolutePath
 import io.github.detekt.psi.getLineAndColumnInPsiFile
-import io.github.detekt.psi.toFilePath
 import org.jetbrains.kotlin.com.intellij.openapi.util.TextRange
 import org.jetbrains.kotlin.com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.diagnostics.PsiDiagnosticUtils
 import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.psi.psiUtil.endOffset
 import org.jetbrains.kotlin.psi.psiUtil.startOffset
+import java.nio.file.Path
 
 /**
  * Specifies a position within a source code fragment.
@@ -18,13 +18,13 @@ class Location(
     val source: SourceLocation,
     val endSource: SourceLocation,
     val text: TextLocation,
-    val filePath: FilePath,
+    val path: Path,
 ) : Compactable {
 
-    override fun compact(): String = "${filePath.absolutePath}:$source"
+    override fun compact(): String = "$path:$source"
 
     override fun toString(): String =
-        "Location(source=$source, endSource=$endSource, text=$text, filePath=$filePath)"
+        "Location(source=$source, endSource=$endSource, text=$text, path=$path)"
 
     companion object {
         /**
@@ -37,7 +37,7 @@ class Location(
             val end = endLineAndColumn(element, offset)
             val endSourceLocation = SourceLocation(end.line, end.column)
             val textLocation = TextLocation(element.startOffset + offset, element.endOffset + offset)
-            return Location(sourceLocation, endSourceLocation, textLocation, element.containingFile.toFilePath())
+            return Location(sourceLocation, endSourceLocation, textLocation, element.containingFile.absolutePath())
         }
 
         /**

detekt-api/src/test/kotlin/io/gitlab/arturbosch/detekt/api/CodeSmellSpec.kt

@@ -1,6 +1,5 @@
 package io.gitlab.arturbosch.detekt.api
 
-import io.gitlab.arturbosch.detekt.test.fromRelative
 import io.gitlab.arturbosch.detekt.test.location
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
@@ -19,10 +18,7 @@ class CodeSmellSpec {
                     source = SourceLocation(1, 1),
                     endSource = SourceLocation(1, 1),
                     text = TextLocation(0, 0),
-                    filePath = fromRelative(
-                        Path("/").absolute().resolve("Users/tester/detekt/"),
-                        Path("TestFile.kt"),
-                    ),
+                    path = Path("/").absolute().resolve("Users/tester/detekt/TestFile.kt"),
                 ),
                 ktElement = null
             ),
@@ -32,7 +28,7 @@ class CodeSmellSpec {
         assertThat(codeSmell.toString()).isEqualTo(
             "CodeSmell(entity=Entity(name=TestEntity, signature=TestEntitySignature, " +
                 "location=Location(source=1:1, endSource=1:1, text=0:0, " +
-                "filePath=${codeSmell.location.filePath}), ktElement=null), message=TestMessage, " +
+                "path=${codeSmell.location.path}), ktElement=null), message=TestMessage, " +
                 "references=[])"
         )
     }

detekt-api/src/test/kotlin/io/gitlab/arturbosch/detekt/api/CorrectableCodeSmellSpec.kt

@@ -18,8 +18,9 @@ class CorrectableCodeSmellSpec {
         assertThat(codeSmell.toString()).isEqualTo(
             "CorrectableCodeSmell(autoCorrectEnabled=true, " +
                 "entity=Entity(name=TestEntity, signature=TestEntitySignature, " +
-                "location=Location(source=1:1, endSource=1:1, text=0:0, filePath=${codeSmell.location.filePath}), " +
-                "ktElement=null), message=TestMessage, references=[])"
+                "location=Location(source=1:1, endSource=1:1, text=0:0, " +
+                "path=${codeSmell.location.path}), ktElement=null), " +
+                "message=TestMessage, references=[])"
         )
     }
 }

detekt-api/src/test/kotlin/io/gitlab/arturbosch/detekt/api/EntitySpec.kt

@@ -10,14 +10,10 @@ import org.junit.jupiter.api.Nested
 import org.junit.jupiter.api.Test
 import kotlin.io.path.Path
 import kotlin.io.path.absolute
-import kotlin.io.path.relativeToOrSelf
-import kotlin.io.path.toPath
 
 class EntitySpec {
 
     private val path = Path("src/test/resources/EntitySpecFixture.kt").absolute()
-    private val basePath = EntitySpec::class.java.getResource("/")!!.toURI().toPath()
-    private val relativePath = path.relativeToOrSelf(basePath)
     private val code = compileForTest(path)
 
     @Nested
@@ -57,7 +53,7 @@ class EntitySpec {
                 .isEqualTo(
                     "Entity(name=memberFun, signature=EntitySpecFixture.kt\$C\$private fun memberFun(): Int, " +
                         "location=Location(source=5:17, endSource=5:26, text=49:58, " +
-                        "filePath=FilePath(absolutePath=$path, basePath=$basePath, relativePath=$relativePath)), " +
+                        "path=$path), " +
                         "ktElement=FUN)"
                 )
         }
@@ -84,7 +80,7 @@ class EntitySpec {
                 .isEqualTo(
                     "Entity(name=C, signature=EntitySpecFixture.kt\$C : Any, " +
                         "location=Location(source=3:7, endSource=3:8, text=20:21, " +
-                        "filePath=FilePath(absolutePath=$path, basePath=$basePath, relativePath=$relativePath)), " +
+                        "path=$path), " +
                         "ktElement=CLASS)"
                 )
         }
@@ -115,7 +111,7 @@ class EntitySpec {
                 .isEqualTo(
                     "Entity(name=EntitySpecFixture.kt, signature=EntitySpecFixture.kt\$test.EntitySpecFixture.kt, " +
                         "location=Location(source=1:1, endSource=9:1, text=0:109, " +
-                        "filePath=FilePath(absolutePath=$path, basePath=$basePath, relativePath=$relativePath)), " +
+                        "path=$path), " +
                         "ktElement=KtFile: EntitySpecFixture.kt)"
                 )
         }

detekt-api/src/test/kotlin/io/gitlab/arturbosch/detekt/api/LocationSpec.kt

@@ -47,8 +47,7 @@ class LocationSpec {
 
         assertThat(location.toString()).isEqualTo(
             "Location(source=2:5, endSource=2:11, text=22:28, " +
-                "filePath=FilePath(absolutePath=${location.filePath.absolutePath}, " +
-                "basePath=${location.filePath.basePath}, relativePath=${location.filePath.relativePath}))"
+                "path=${location.path})"
         )
     }
 }

detekt-api/src/testFixtures/kotlin/io/gitlab/arturbosch/detekt/test/TestFactory.kt

@@ -1,6 +1,5 @@
 package io.gitlab.arturbosch.detekt.test
 
-import io.github.detekt.psi.FilePath
 import io.gitlab.arturbosch.detekt.api.Entity
 import io.gitlab.arturbosch.detekt.api.Issue
 import io.gitlab.arturbosch.detekt.api.Location
@@ -10,7 +9,6 @@ import io.gitlab.arturbosch.detekt.api.Severity
 import io.gitlab.arturbosch.detekt.api.SourceLocation
 import io.gitlab.arturbosch.detekt.api.TextLocation
 import org.jetbrains.kotlin.psi.KtElement
-import java.nio.file.Path
 import kotlin.io.path.Path
 import kotlin.io.path.absolute
 
@@ -80,7 +78,7 @@ fun createIssueForRelativePath(
                 source = SourceLocation(1, 1),
                 endSource = SourceLocation(1, 1),
                 text = TextLocation(0, 0),
-                filePath = fromRelative(Path("/").absolute().resolve(basePath), Path(relativePath))
+                path = Path("/").absolute().resolve(basePath).resolve(relativePath)
             ),
             ktElement = null
         ),
@@ -111,8 +109,7 @@ fun createLocation(
         source = SourceLocation(position.first, position.second),
         endSource = SourceLocation(endPosition.first, endPosition.second),
         text = TextLocation(text.first, text.last),
-        filePath = basePath?.let { fromRelative(Path("/").absolute().resolve(it), Path(path)) }
-            ?: fromAbsolute(Path("/").absolute().resolve(path)),
+        path = basePath?.let { Path(it).absolute().resolve(path) } ?: Path(path).absolute(),
     )
 }
 
@@ -130,10 +127,3 @@ private data class IssueImpl(
         override val description: String,
     ) : Issue.RuleInfo
 }
-
-fun fromAbsolute(path: Path) = FilePath(absolutePath = path.normalize())
-fun fromRelative(basePath: Path, relativePath: Path) = FilePath(
-    absolutePath = basePath.resolve(relativePath).normalize(),
-    basePath = basePath.normalize(),
-    relativePath = relativePath
-)

detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/FileBasedIssuesReport.kt

@@ -2,6 +2,7 @@ package io.gitlab.arturbosch.detekt.core.reporting.console
 
 import io.gitlab.arturbosch.detekt.api.Issue
 import io.gitlab.arturbosch.detekt.core.reporting.printIssues
+import kotlin.io.path.absolutePathString
 
 /**
  * Contains all rule violations grouped by file location.
@@ -12,7 +13,7 @@ class FileBasedIssuesReport : AbstractIssuesReport() {
     override val id: String = "FileBasedIssuesReport"
 
     override fun render(issues: List<Issue>): String {
-        val issuesPerFile = issues.groupBy { it.entity.location.filePath.absolutePath.toString() }
+        val issuesPerFile = issues.groupBy { it.entity.location.path.absolutePathString() }
         return printIssues(issuesPerFile)
     }
 }

detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/FileBasedIssuesReportSpec.kt

@@ -28,10 +28,10 @@ class FileBasedIssuesReportSpec {
 
         assertThat(output).isEqualTo(
             """
-                ${location1.filePath.absolutePath}
+                ${location1.path}
                 	TestSmell - [TestMessage] at ${location1.compact()}
                 	TestSmell - [TestMessage] at ${location1.compact()}
-                ${location2.filePath.absolutePath}
+                ${location2.path}
                 	TestSmell - [TestMessage] at ${location2.compact()}
                 
             """.trimIndent()

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/FormattingRule.kt

@@ -4,8 +4,7 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.CODE_STYLE_PROPERT
 import com.pinterest.ktlint.rule.engine.core.api.editorconfig.EditorConfig
 import com.pinterest.ktlint.rule.engine.core.api.editorconfig.EditorConfigProperty
 import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_STYLE_PROPERTY
-import io.github.detekt.psi.FilePath
-import io.github.detekt.psi.toFilePath
+import io.github.detekt.psi.absolutePath
 import io.gitlab.arturbosch.detekt.api.CodeSmell
 import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.api.CorrectableCodeSmell
@@ -21,6 +20,7 @@ import org.jetbrains.kotlin.com.intellij.psi.impl.source.JavaDummyElement
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.JavaDummyHolder
 import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.psi.KtPsiFactory
+import java.nio.file.Path
 
 /**
  * Rule to detect formatting violations.
@@ -38,13 +38,13 @@ abstract class FormattingRule(config: Config, description: String) : Rule(config
 
     private lateinit var positionByOffset: (offset: Int) -> Pair<Int, Int>
     private lateinit var root: KtFile
-    private lateinit var originalFilePath: FilePath
+    private lateinit var originalFilePath: Path
 
     override fun visit(root: KtFile) {
         val fileCopy = KtPsiFactory(root.project).createPhysicalFile(root.name, root.modifiedText ?: root.text)
 
         this.root = fileCopy
-        originalFilePath = root.toFilePath()
+        originalFilePath = root.absolutePath()
         positionByOffset = KtLintLineColCalculator.calculateLineColByOffset(fileCopy.text)
 
         wrapping.beforeFirstNode(computeEditorConfigProperties())
@@ -95,7 +95,7 @@ abstract class FormattingRule(config: Config, description: String) : Rule(config
             endSource = SourceLocation(line, column),
             // Use offset + 1 since ktlint always reports a single location.
             text = TextLocation(offset, offset + 1),
-            filePath = originalFilePath
+            path = originalFilePath
         )
         val entity = Entity.from(node.psi, location)
 

detekt-formatting/src/test/kotlin/io/gitlab/arturbosch/detekt/formatting/FormattingRuleSpec.kt

@@ -75,7 +75,7 @@ class FormattingRuleSpec {
         val rule = ChainWrapping(Config.empty)
         val findings = rule.visitFile(compileForTest(expectedPath))
         assertThat(findings).anySatisfy { finding ->
-            assertThat(finding.location.filePath.absolutePath.toString()).isEqualTo(expectedPath.toString())
+            assertThat(finding.location.path).isEqualTo(expectedPath)
         }
     }
 }

detekt-psi-utils/api/detekt-psi-utils.api

@@ -3,15 +3,6 @@ public final class io/github/detekt/psi/AnnotationExcluder {
 	public final fun shouldExclude (Ljava/util/List;)Z
 }
 
-public final class io/github/detekt/psi/FilePath {
-	public fun <init> (Ljava/nio/file/Path;Ljava/nio/file/Path;Ljava/nio/file/Path;)V
-	public synthetic fun <init> (Ljava/nio/file/Path;Ljava/nio/file/Path;Ljava/nio/file/Path;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
-	public final fun getAbsolutePath ()Ljava/nio/file/Path;
-	public final fun getBasePath ()Ljava/nio/file/Path;
-	public final fun getRelativePath ()Ljava/nio/file/Path;
-	public fun toString ()Ljava/lang/String;
-}
-
 public abstract class io/github/detekt/psi/FunctionMatcher {
 	public static final field Companion Lio/github/detekt/psi/FunctionMatcher$Companion;
 	public abstract fun match (Lorg/jetbrains/kotlin/descriptors/CallableDescriptor;)Z
@@ -38,7 +29,6 @@ public final class io/github/detekt/psi/KtFilesKt {
 	public static final fun getAbsolutePath (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;)Ljava/nio/file/Path;
 	public static final fun getLineAndColumnInPsiFile (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;Lorg/jetbrains/kotlin/com/intellij/openapi/util/TextRange;)Lorg/jetbrains/kotlin/diagnostics/PsiDiagnosticUtils$LineAndColumn;
 	public static final fun setAbsolutePath (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;Ljava/nio/file/Path;)V
-	public static final fun toFilePath (Lorg/jetbrains/kotlin/com/intellij/psi/PsiFile;)Lio/github/detekt/psi/FilePath;
 }
 
 public final class io/gitlab/arturbosch/detekt/rules/AllowedExceptionNamePatternKt {

detekt-psi-utils/src/main/kotlin/io/github/detekt/psi/KtFiles.kt

@@ -34,45 +34,6 @@ instead.
 */
 fun PsiFile.absolutePath(): Path = absolutePath ?: Path(virtualFile.path)
 
-/**
- * Represents both absolute path and relative path if available.
- */
-class FilePath(
-    val absolutePath: Path,
-    val basePath: Path? = null,
-    val relativePath: Path? = null
-) {
-
-    init {
-        require(
-            basePath == null ||
-                relativePath == null ||
-                absolutePath == basePath.resolve(relativePath).normalize()
-        ) {
-            "Absolute path = $absolutePath much match base path = $basePath and relative path = $relativePath"
-        }
-        require(absolutePath.isAbsolute) { "absolutePath should be absolute" }
-        require(basePath?.isAbsolute != false) { "basePath should be absolute" }
-        require(relativePath?.isAbsolute != true) { "relativePath should not be absolute" }
-    }
-
-    override fun toString(): String =
-        "FilePath(absolutePath=$absolutePath, basePath=$basePath, relativePath=$relativePath)"
-}
-
-fun PsiFile.toFilePath(): FilePath {
-    return when {
-        basePath != null && relativePath != null -> FilePath(
-            absolutePath = absolutePath(),
-            basePath = basePath,
-            relativePath = relativePath
-        )
-
-        basePath == null && relativePath == null -> FilePath(absolutePath = absolutePath())
-        else -> error("Cannot build a FilePath from base path = $basePath and relative path = $relativePath")
-    }
-}
-
 // #3317 If any rule mutates the PsiElement, searching the original PsiElement may throw an exception.
 fun getLineAndColumnInPsiFile(file: PsiFile, range: TextRange): PsiDiagnosticUtils.LineAndColumn? {
     return if (file.textLength == 0) {

detekt-psi-utils/src/test/kotlin/io/github/detekt/psi/KtFilesSpec.kt

@@ -5,8 +5,6 @@ import org.assertj.core.api.Assertions.assertThat
 import org.jetbrains.kotlin.com.intellij.psi.PsiFile
 import org.junit.jupiter.api.Nested
 import org.junit.jupiter.api.Test
-import kotlin.io.path.Path
-import kotlin.io.path.absolute
 
 class KtFilesSpec {
 
@@ -45,15 +43,4 @@ class KtFilesSpec {
     }
 
     private fun makeFile(filename: String): PsiFile = FakePsiFile(name = filename)
-
-    @Test
-    fun `FilePath toString`() {
-        val basePath = Path("/").absolute().resolve("a/b")
-        val relativePath = Path("c/d")
-        val absolutePath = Path("/").absolute().resolve("a/b/c/d")
-        val filePath = FilePath(absolutePath, basePath, relativePath)
-
-        assertThat(filePath.toString())
-            .isEqualTo("FilePath(absolutePath=$absolutePath, basePath=$basePath, relativePath=$relativePath)")
-    }
 }

detekt-report-html/src/main/kotlin/io/github/detekt/report/html/HtmlOutputReport.kt

@@ -142,7 +142,7 @@ class HtmlOutputReport : BuiltInOutputReport, OutputReport() {
                 issues
                     .sortedWith(
                         compareBy(
-                            { it.location.filePath.absolutePath.toString() },
+                            { it.location.path },
                             { it.location.source.line },
                             { it.location.source.column },
                         )
@@ -157,8 +157,7 @@ class HtmlOutputReport : BuiltInOutputReport, OutputReport() {
     }
 
     private fun FlowContent.renderIssue(issue: Issue) {
-        val filePath = basePath?.let { issue.location.filePath.absolutePath.relativeTo(it) }
-            ?: issue.location.filePath.absolutePath
+        val filePath = basePath?.let { issue.location.path.relativeTo(it) } ?: issue.location.path
         val pathString = filePath.invariantSeparatorsPathString
         span("location") {
             text(