KON-118 Add KoImportDeclaration.isWildcard Property (#132)

* add KoImportDeclarationImpl.isWildcard property and tests for this

* add extensions: KoImportDeclarationSequenceExt.withWildcard() and KoImportDeclarationSequenceExt.withoutWildcard()

Author: nataliapeterwas

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koimportdeclaration/KoImportDeclarationTest.kt

@@ -24,7 +24,8 @@ class KoImportDeclarationTest {
     @Test
     fun `import-name-has-import-alias`() {
         // given
-        val sut = getSnippetFile("import-name-has-import-alias").imports()
+        val sut = getSnippetFile("import-name-has-import-alias")
+            .imports()
 
         // then
         assertSoftly(sut.toList()) {
@@ -34,6 +35,28 @@ class KoImportDeclarationTest {
         }
     }
 
+    @Test
+    fun `import-with-wildcard`() {
+        // given
+        val sut = getSnippetFile("import-with-wildcard")
+            .imports()
+            .first()
+
+        // then
+        sut.isWildcard shouldBeEqualTo true
+    }
+
+    @Test
+    fun `import-without-wildcard`() {
+        // given
+        val sut = getSnippetFile("import-without-wildcard")
+            .imports()
+            .first()
+
+        // then
+        sut.isWildcard shouldBeEqualTo false
+    }
+
     private fun getSnippetFile(fileName: String) =
         TestSnippetProvider.getSnippetKoScope("core/declaration/koimportdeclaration/snippet/", fileName)
 }

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koimportdeclaration/snippet/import-with-wildcard.kttxt

@@ -0,0 +1,3 @@
+import com.lemonappdev.konsist.testdata.*
+
+class SampleTopLevelClass(val sampleProperty2: SampleClass)

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koimportdeclaration/snippet/import-without-wildcard.kttxt

@@ -0,0 +1,3 @@
+import com.lemonappdev.konsist.testdata.SampleClass
+
+class SampleTopLevelClass(val sampleProperty2: SampleClass)

lib/src/main/kotlin/com/lemonappdev/konsist/api/declaration/KoImportDeclaration.kt

@@ -8,4 +8,9 @@ interface KoImportDeclaration : KoNamedDeclaration {
      * Alias of the import.
      */
     val alias: String
+
+    /**
+     * Whether this import is a wildcard.
+     */
+    val isWildcard: Boolean
 }

lib/src/main/kotlin/com/lemonappdev/konsist/api/ext/sequence/KoImportDeclarationSequenceExt.kt

@@ -21,3 +21,13 @@ fun Sequence<KoImportDeclaration>.withoutAlias(vararg names: String): Sequence<K
         else -> names.none { name -> it.alias == name }
     }
 }
+
+/**
+ * Sequence containing all declarations that have a wildcard.
+ */
+fun Sequence<KoImportDeclaration>.withWildcard(): Sequence<KoImportDeclaration> = filter { it.isWildcard }
+
+/**
+ * Sequence containing all declarations that don't have a wildcard.
+ */
+fun Sequence<KoImportDeclaration>.withoutWildcard(): Sequence<KoImportDeclaration> = filterNot { it.isWildcard }

lib/src/main/kotlin/com/lemonappdev/konsist/core/declaration/KoImportDeclarationImpl.kt

@@ -12,6 +12,8 @@ internal class KoImportDeclarationImpl private constructor(private val ktImportD
 
     override val alias by lazy { ktImportDirective.alias?.name ?: name }
 
+    override val isWildcard by lazy { ktImportDirective.text.endsWith('*') }
+
     internal companion object {
         private val cache = KoDeclarationCache<KoImportDeclarationImpl>()
 

lib/src/test/kotlin/com/lemonappdev/konsist/api/ext/sequence/KoImportDeclarationSequenceExtTest.kt

@@ -114,4 +114,40 @@ class KoImportDeclarationSequenceExtTest {
         // then
         sut.toList() shouldBeEqualTo listOf(import3, import4)
     }
+
+    @Test
+    fun `withWildcard() returns import with wildcard`() {
+        // given
+        val import1: KoImportDeclarationImpl = mockk {
+            every { isWildcard } returns true
+        }
+        val import2: KoImportDeclarationImpl = mockk {
+            every { isWildcard } returns false
+        }
+        val imports = sequenceOf(import1, import2)
+
+        // when
+        val sut = imports.withWildcard()
+
+        // then
+        sut.toList() shouldBeEqualTo listOf(import1)
+    }
+
+    @Test
+    fun `withoutWildcard() returns import without wildcard`() {
+        // given
+        val import1: KoImportDeclarationImpl = mockk {
+            every { isWildcard } returns true
+        }
+        val import2: KoImportDeclarationImpl = mockk {
+            every { isWildcard } returns false
+        }
+        val imports = sequenceOf(import1, import2)
+
+        // when
+        val sut = imports.withoutWildcard()
+
+        // then
+        sut.toList() shouldBeEqualTo listOf(import2)
+    }
 }