Move PathFilters from detekt-api to detekt-utils (#6866)

* Move test to the correct project * Simplify code * Move PathFilters to detekt-utils
detekt · May 6, 2024 · 60b2413 · 60b2413
1 parent 731735b
commit 60b2413
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 53 deletions.
diff --git a/detekt-cli/build.gradle.kts b/detekt-cli/build.gradle.kts
@@ -22,6 +22,7 @@ val pluginsJarFiles by configurations.resolvable("pluginsJarFiles") {
 dependencies {
     implementation(libs.jcommander)
     implementation(projects.detektTooling)
+    implementation(projects.detektUtils)
     implementation(libs.kotlin.compilerEmbeddable) {
         version {
             strictly(libs.versions.kotlin.get())

diff --git a/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/Spec.kt b/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/Spec.kt
@@ -2,9 +2,9 @@ package io.gitlab.arturbosch.detekt.cli
 
 import io.github.detekt.tooling.api.spec.ProcessingSpec
 import io.github.detekt.tooling.api.spec.RulesSpec
+import io.github.detekt.utils.PathFilters
 import io.gitlab.arturbosch.detekt.api.Rule
 import io.gitlab.arturbosch.detekt.api.RuleSet
-import io.gitlab.arturbosch.detekt.api.internal.PathFilters
 import java.nio.file.Path
 import kotlin.io.path.ExperimentalPathApi
 import kotlin.io.path.absolute

diff --git a/detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/PathFiltersSpec.kt b/detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/PathFiltersSpec.kt
diff --git a/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/util/ConfigExtensions.kt b/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/util/ConfigExtensions.kt
@@ -1,8 +1,8 @@
 package io.gitlab.arturbosch.detekt.core.util
 
 import io.github.detekt.psi.absolutePath
+import io.github.detekt.utils.PathFilters
 import io.gitlab.arturbosch.detekt.api.Config
-import io.gitlab.arturbosch.detekt.api.internal.PathFilters
 import org.jetbrains.kotlin.psi.KtFile
 import java.nio.file.Path
 import kotlin.io.path.Path

diff --git a/...rbosch/detekt/api/internal/PathFilters.kt → ...lin/io/github/detekt/utils/PathFilters.kt b/...rbosch/detekt/api/internal/PathFilters.kt → ...lin/io/github/detekt/utils/PathFilters.kt
@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.api.internal
+package io.github.detekt.utils
 
 import java.nio.file.Path
 import java.nio.file.PathMatcher

diff --git a/...bosch/detekt/api/internal/PathMatchers.kt → ...in/io/github/detekt/utils/PathMatchers.kt b/...bosch/detekt/api/internal/PathMatchers.kt → ...in/io/github/detekt/utils/PathMatchers.kt
@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.api.internal
+package io.github.detekt.utils
 
 import java.nio.file.FileSystem
 import java.nio.file.FileSystems
@@ -9,7 +9,7 @@ import java.nio.file.PathMatcher
  * We only support the "glob:" syntax to stay os independently.
  * Internally a globbing pattern is transformed to a regex respecting the Windows file system.
  */
-fun pathMatcher(pattern: String): PathMatcher {
+internal fun pathMatcher(pattern: String): PathMatcher {
     val result = when (pattern.substringBefore(":")) {
         "glob" -> pattern
         "regex" -> throw IllegalArgumentException(USE_GLOB_MSG)

diff --git a/detekt-utils/src/test/kotlin/io/github/detekt/utils/PathFiltersSpec.kt b/detekt-utils/src/test/kotlin/io/github/detekt/utils/PathFiltersSpec.kt
@@ -0,0 +1,42 @@
+package io.github.detekt.utils
+
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
+import kotlin.io.path.Path
+
+class PathFiltersSpec {
+
+    @Test
+    fun `returns an empty path filter when includes are empty and excludes are empty`() {
+        val pathFilter = PathFilters.of(emptyList(), emptyList())
+        assertThat(pathFilter).isNull()
+    }
+
+    @Test
+    fun `parses includes correctly`() {
+        val pathFilter = PathFilters.of(listOf("**/one/**", "**/two/**"), emptyList())
+        assertThat(pathFilter).isNotNull
+        assertThat(pathFilter?.isIgnored(Path("/one/path"))).isFalse
+        assertThat(pathFilter?.isIgnored(Path("/two/path"))).isFalse
+        assertThat(pathFilter?.isIgnored(Path("/three/path"))).isTrue
+    }
+
+    @Test
+    fun `parses excludes correctly`() {
+        val pathFilter = PathFilters.of(emptyList(), listOf("**/one/**", "**/two/**"))
+        assertThat(pathFilter).isNotNull
+        assertThat(pathFilter?.isIgnored(Path("/one/path"))).isTrue
+        assertThat(pathFilter?.isIgnored(Path("/two/path"))).isTrue
+        assertThat(pathFilter?.isIgnored(Path("/three/path"))).isFalse
+    }
+
+    @Test
+    fun `parses both includes and excludes correctly`() {
+        val pathFilter = PathFilters.of(listOf("**/one/**"), listOf("**/two/**"))
+        assertThat(pathFilter).isNotNull
+        assertThat(pathFilter?.isIgnored(Path("/one/path"))).isFalse
+        assertThat(pathFilter?.isIgnored(Path("/two/path"))).isTrue
+        assertThat(pathFilter?.isIgnored(Path("/three/path"))).isTrue
+        assertThat(pathFilter?.isIgnored(Path("/one/two/three/path"))).isTrue
+    }
+}
diff --git a/...h/detekt/api/internal/PathMatchersSpec.kt → ...o/github/detekt/utils/PathMatchersSpec.kt b/...h/detekt/api/internal/PathMatchersSpec.kt → ...o/github/detekt/utils/PathMatchersSpec.kt
@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.api.internal
+package io.github.detekt.utils
 
 import org.assertj.core.api.Assertions.assertThat
 import org.assertj.core.api.Assertions.assertThatThrownBy