Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

remove SimpleGlob in favor of String.simplePatternToRegex() #5144

Merged
merged 1 commit into from Jul 29, 2022
Merged

remove SimpleGlob in favor of String.simplePatternToRegex() #5144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/SplitPattern.kt
View file
Open in desktop
Expand Up @@ -82,6 +82,6 @@ fun String.simplePatternToRegex(): Regex {
return this
.replace(".", "\\.")
.replace("*", ".*")
.replace("?", ".?")
.replace("?", ".")
.toRegex()
}
22 changes: 0 additions & 22 deletions detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/internal/SimpleGlob.kt
View file
Open in desktop

This file was deleted.

50 changes: 22 additions & 28 deletions ...sch/detekt/api/internal/SimpleGlobSpec.kt → ...ch/detekt/api/SimplePatternToRegexSpec.kt
View file
Open in desktop
@@ -1,14 +1,14 @@
package io.gitlab.arturbosch.detekt.api.internal
package io.gitlab.arturbosch.detekt.api

import org.assertj.core.api.Assertions.assertThat
import org.assertj.core.api.Assertions.assertThatThrownBy
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test

class SimpleGlobSpec {
internal class SimplePatternToRegexSpec {
@Nested
inner class `empty pattern` {
private val subject = SimpleGlob.of("")
private val subject = "".simplePatternToRegex()

@Test
fun `matches an empty string`() {
Expand All @@ -25,7 +25,7 @@ class SimpleGlobSpec {

@Nested
inner class `blank pattern` {
private val subject = SimpleGlob.of(" \t")
private val subject = " \t".simplePatternToRegex()

@Test
fun `matches an empty string`() {
Expand All @@ -42,7 +42,7 @@ class SimpleGlobSpec {

@Nested
inner class `Static pattern` {
private val subject = SimpleGlob.of("abc")
private val subject = "abc".simplePatternToRegex()

@Test
fun `matches the same string`() {
Expand All @@ -63,7 +63,7 @@ class SimpleGlobSpec {
inner class `single wildcard` {
@Nested
inner class `pattern with wildcard at the beginning` {
private val subject = SimpleGlob.of("*xyz")
private val subject = "*xyz".simplePatternToRegex()

@Test
fun `matches pattern exactly`() {
Expand All @@ -86,7 +86,7 @@ class SimpleGlobSpec {

@Nested
inner class `Pattern with wildcard at the end` {
private val subject = SimpleGlob.of("xyz*")
private val subject = "xyz*".simplePatternToRegex()

@Test
fun `matches pattern exactly`() {
Expand All @@ -109,7 +109,7 @@ class SimpleGlobSpec {

@Nested
inner class `Pattern with wildcard at the middle` {
private val subject = SimpleGlob.of("x*yz")
private val subject = "x*yz".simplePatternToRegex()

@Test
fun `matches pattern exactly`() {
Expand Down Expand Up @@ -139,7 +139,7 @@ class SimpleGlobSpec {

@Nested
inner class `multiple wildcards` {
private val subject = SimpleGlob.of("x*yz*")
private val subject = "x*yz*".simplePatternToRegex()

@Test
fun `matches pattern`() {
Expand All @@ -155,7 +155,7 @@ class SimpleGlobSpec {
inner class `single wildcard` {
@Nested
inner class `pattern with wildcard at the beginning` {
private val subject = SimpleGlob.of("?xyz")
private val subject = "?xyz".simplePatternToRegex()

@Test
fun `matches with any character before`() {
Expand All @@ -164,7 +164,7 @@ class SimpleGlobSpec {
}

@Test
fun `does not match with anything before`() {
fun `does not match with no character before`() {
val actual = subject.matches("xyz")
assertThat(actual).isFalse()
}
Expand All @@ -178,7 +178,7 @@ class SimpleGlobSpec {

@Nested
inner class `pattern with wildcard at the end` {
private val subject = SimpleGlob.of("xyz?")
private val subject = "xyz?".simplePatternToRegex()

@Test
fun `matches with any character after`() {
Expand All @@ -187,7 +187,7 @@ class SimpleGlobSpec {
}

@Test
fun `does not match with anything after`() {
fun `does not match with no character after`() {
val actual = subject.matches("xyz")
assertThat(actual).isFalse()
}
Expand All @@ -201,7 +201,7 @@ class SimpleGlobSpec {

@Nested
inner class `pattern with wildcard at the middle` {
private val subject = SimpleGlob.of("x?yz")
private val subject = "x?yz".simplePatternToRegex()

@Test
fun `matches with any single character`() {
Expand All @@ -219,11 +219,11 @@ class SimpleGlobSpec {

@Nested
inner class `multiple wildcards` {
private val subject = SimpleGlob.of("x?y?z")
private val subject = "x?y?z".simplePatternToRegex()

@Test
fun `matches pattern`() {
val actual = subject.matches("x.y.z")
val actual = subject.matches("x.y_z")
assertThat(actual).isTrue()
}
}
Expand All @@ -233,7 +233,7 @@ class SimpleGlobSpec {
inner class `characters that have a special meaning in regular expression must be escaped` {
@Nested
inner class `Period` {
private val subject = SimpleGlob.of("a.b.c")
private val subject = "a.b.c".simplePatternToRegex()

@Test
fun `matches the same string`() {
Expand All @@ -249,28 +249,22 @@ class SimpleGlobSpec {
}

@Nested
inner class `Backslash` {
private val subject = SimpleGlob.of("""ab\d""")
inner class `character classes and quantifiers` {
private val subject = """ab\d{2,5}\s\wc""".simplePatternToRegex()

@Test
fun `matches the same string`() {
val actual = subject.matches("""ab\d""")
fun `can be used`() {
val actual = subject.matches("""ab123 Xc""")
assertThat(actual).isTrue()
}

@Test
fun `does not match a other string`() {
val actual = subject.matches("ab5")
assertThat(actual).isFalse()
}
}
}

@Nested
inner class `invalid pattern` {
@Test
fun `fails during creation`() {
assertThatThrownBy { SimpleGlob.of("""a[b""") }
assertThatThrownBy { """a[b""".simplePatternToRegex() }
.isInstanceOf(IllegalArgumentException::class.java)
}
}
Expand Down
6 changes: 3 additions & 3 deletions ...rprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/AvoidReferentialEquality.kt
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@ import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.api.internal.RequiresTypeResolution
import io.gitlab.arturbosch.detekt.api.internal.SimpleGlob
import io.gitlab.arturbosch.detekt.api.simplePatternToRegex
import io.gitlab.arturbosch.detekt.rules.fqNameOrNull
import org.jetbrains.kotlin.lexer.KtTokens.EQEQEQ
import org.jetbrains.kotlin.lexer.KtTokens.EXCLEQEQEQ
Expand Down Expand Up @@ -50,11 +50,11 @@ class AvoidReferentialEquality(config: Config) : Rule(config) {
"The types are defined by a list of simple glob patterns (supporting `*` and `?` wildcards) " +
"that match the fully qualified type name."
)
private val forbiddenTypePatterns: List<SimpleGlob> by config(
private val forbiddenTypePatterns: List<Regex> by config(
listOf(
"kotlin.String"
)
) { it.map(SimpleGlob::of) }
) { it.map(String::simplePatternToRegex) }

override fun visitBinaryExpression(expression: KtBinaryExpression) {
super.visitBinaryExpression(expression)
Expand Down