KON-609 Add Type Extensions (#914)

.github/workflows/check.yml

@@ -245,7 +245,7 @@ jobs:
           name: konsist-SNAPSHOT-${{ github.run_number }}.jar
           path: /home/runner/.m2/repository/com/lemonappdev/konsist/*
 
-      - name: Check dependencies exposed by the library artifact
+      - name: Check dependencies exposed by the Konsist artifact
         run: python3 scripts/check_dependencies_exposed_by_library_artifact.py
 
       - name: Check Bytecode version

detekt.yml

@@ -163,11 +163,11 @@ complexity:
   TooManyFunctions:
     active: true
     excludes: [ '**/test/**', '**/integrationTest/**', '**/konsistTest/**', '**/konsist/api/ext/sequence/**' ]
-    thresholdInFiles: 20
-    thresholdInClasses: 20
-    thresholdInInterfaces: 20
-    thresholdInObjects: 20
-    thresholdInEnums: 20
+    thresholdInFiles: 25
+    thresholdInClasses: 25
+    thresholdInInterfaces: 25
+    thresholdInObjects: 25
+    thresholdInEnums: 25
     ignoreDeprecated: false
     ignorePrivate: false
     ignoreOverridden: false

lib/src/apiTest/README.md

@@ -0,0 +1,3 @@
+# ApiTest Source Set
+
+Tests used to verify the Konsist API.

lib/src/integrationTest/README.md

@@ -0,0 +1,3 @@
+# IntegrationTest Source Set
+
+Integration tests used to verify the Konsist.

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/type/kotype/KoTypeDeclarationForKoKotlinTypeProviderTest.kt → lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/type/kotype/KoTypeDeclarationForKoTypeProviderTest.kt

@@ -7,7 +7,7 @@ import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.Arguments.arguments
 import org.junit.jupiter.params.provider.MethodSource
 
-class KoTypeDeclarationForKoKotlinTypeProviderTest {
+class KoTypeDeclarationForKoTypeProviderTest {
     @ParameterizedTest
     @MethodSource("provideValues")
     fun `kotlin-type`(

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/verify/koproviderassert/assertempty/AssertEmptyOnProviderListTest.kt

@@ -2,9 +2,9 @@ package com.lemonappdev.konsist.core.verify.koproviderassert.assertempty
 
 import com.lemonappdev.konsist.TestSnippetProvider
 import com.lemonappdev.konsist.api.declaration.KoFileDeclaration
-import com.lemonappdev.konsist.api.provider.KoKotlinTypeProvider
 import com.lemonappdev.konsist.api.provider.KoNameProvider
 import com.lemonappdev.konsist.api.provider.KoReturnProvider
+import com.lemonappdev.konsist.api.provider.KoTypeProvider
 import com.lemonappdev.konsist.api.verify.assertEmpty
 import com.lemonappdev.konsist.api.verify.assertNotEmpty
 import com.lemonappdev.konsist.core.exception.KoAssertionFailedException
@@ -54,7 +54,7 @@ class AssertEmptyOnProviderListTest {
             getSnippetFile("provider-assert-empty-error-on-list-containing-one-null-value")
                 .declarations()
                 .filterNot { it is KoFileDeclaration }
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
 
         // then
         try {
@@ -74,7 +74,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("provider-assert-empty-error-on-list-containing-two-null-values")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
 
         // then
         try {
@@ -181,7 +181,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("provider-assert-not-empty-error-with-custom-message")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
 
         // then
         try {
@@ -202,7 +202,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("provider-assert-not-empty-error-with-custom-message-and-strict-set-to-true")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
 
         // then
         try {
@@ -222,7 +222,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-empty-passes-when-item-list-is-empty")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
 
         // then
         sut.assertEmpty()
@@ -251,7 +251,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-empty-fails-when-item-list-has-only-nulls")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
 
         // when
         val func = {
@@ -268,7 +268,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-empty-passes-when-item-list-is-empty-and-strict-set-to-true")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
 
         // then
         sut.assertEmpty(strict = true)
@@ -295,7 +295,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-empty-passes-when-item-list-has-only-nulls-and-strict-set-to-true")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
 
         // then
         sut.assertEmpty(strict = true)
@@ -319,7 +319,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-not-empty-fails-when-item-list-is-empty")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
 
         // when
         val func = {
@@ -336,7 +336,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-not-empty-passes-when-item-list-has-only-nulls")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
 
         // then
         sut.assertNotEmpty()
@@ -360,7 +360,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-not-empty-fails-when-item-list-is-empty-and-strict-set-to-true")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
 
         // when
         val func = {
@@ -377,7 +377,7 @@ class AssertEmptyOnProviderListTest {
         val sut =
             getSnippetFile("assert-not-empty-fails-when-item-list-has-only-nulls-and-strict-set-to-true")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
 
         // when
         val func = {

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/verify/koproviderassert/assertempty/AssertEmptyOnProviderSequenceTest.kt

@@ -2,9 +2,9 @@ package com.lemonappdev.konsist.core.verify.koproviderassert.assertempty
 
 import com.lemonappdev.konsist.TestSnippetProvider
 import com.lemonappdev.konsist.api.declaration.KoFileDeclaration
-import com.lemonappdev.konsist.api.provider.KoKotlinTypeProvider
 import com.lemonappdev.konsist.api.provider.KoNameProvider
 import com.lemonappdev.konsist.api.provider.KoReturnProvider
+import com.lemonappdev.konsist.api.provider.KoTypeProvider
 import com.lemonappdev.konsist.api.verify.assertEmpty
 import com.lemonappdev.konsist.api.verify.assertNotEmpty
 import com.lemonappdev.konsist.core.exception.KoAssertionFailedException
@@ -56,7 +56,7 @@ class AssertEmptyOnProviderSequenceTest {
             getSnippetFile("provider-assert-empty-error-on-list-containing-one-null-value")
                 .declarations()
                 .filterNot { it is KoFileDeclaration }
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
                 .asSequence()
 
         // then
@@ -77,7 +77,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("provider-assert-empty-error-on-list-containing-two-null-values")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
                 .asSequence()
 
         // then
@@ -189,7 +189,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("provider-assert-not-empty-error-with-custom-message")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .asSequence()
 
         // then
@@ -211,7 +211,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("provider-assert-not-empty-error-with-custom-message-and-strict-set-to-true")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .asSequence()
 
         // then
@@ -232,7 +232,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-empty-passes-when-item-list-is-empty")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .asSequence()
 
         // then
@@ -263,7 +263,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-empty-fails-when-item-list-has-only-nulls")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
                 .asSequence()
 
         // when
@@ -281,7 +281,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-empty-passes-when-item-list-is-empty-and-strict-set-to-true")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .asSequence()
 
         // then
@@ -310,7 +310,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-empty-passes-when-item-list-has-only-nulls-and-strict-set-to-true")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
                 .asSequence()
 
         // then
@@ -336,7 +336,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-not-empty-fails-when-item-list-is-empty")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .asSequence()
 
         // when
@@ -354,7 +354,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-not-empty-passes-when-item-list-has-only-nulls")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
                 .asSequence()
 
         // then
@@ -380,7 +380,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-not-empty-fails-when-item-list-is-empty-and-strict-set-to-true")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .asSequence()
 
         // when
@@ -398,7 +398,7 @@ class AssertEmptyOnProviderSequenceTest {
         val sut =
             getSnippetFile("assert-not-empty-fails-when-item-list-has-only-nulls-and-strict-set-to-true")
                 .declarations()
-                .map { it as? KoKotlinTypeProvider }
+                .map { it as? KoTypeProvider }
                 .asSequence()
 
         // when

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/verify/koproviderassert/assertnull/AssertNullOnSingleProviderTest.kt

@@ -2,9 +2,8 @@ package com.lemonappdev.konsist.core.verify.koproviderassert.assertnull
 
 import com.lemonappdev.konsist.TestSnippetProvider
 import com.lemonappdev.konsist.api.declaration.KoFileDeclaration
-import com.lemonappdev.konsist.api.ext.list.declarations
-import com.lemonappdev.konsist.api.provider.KoKotlinTypeProvider
 import com.lemonappdev.konsist.api.provider.KoNameProvider
+import com.lemonappdev.konsist.api.provider.KoTypeProvider
 import com.lemonappdev.konsist.api.verify.assertNotNull
 import com.lemonappdev.konsist.api.verify.assertNull
 import com.lemonappdev.konsist.core.exception.KoAssertionFailedException
@@ -80,7 +79,7 @@ class AssertNullOnSingleProviderTest {
             getSnippetFile("provider-assert-not-null-error-with-custom-message")
                 .declarations()
                 .filterNot { it is KoFileDeclaration }
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .firstOrNull()
 
         // then
@@ -101,7 +100,7 @@ class AssertNullOnSingleProviderTest {
         val sut =
             getSnippetFile("assert-null-passes-when-item-has-null-value")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .firstOrNull()
 
         // then
@@ -130,7 +129,7 @@ class AssertNullOnSingleProviderTest {
         val sut =
             getSnippetFile("assert-not-null-fails-when-item-has-null-value")
                 .declarations()
-                .filterIsInstance<KoKotlinTypeProvider>()
+                .filterIsInstance<KoTypeProvider>()
                 .firstOrNull()
 
         // when

lib/src/konsistTest/README.md

@@ -0,0 +1,3 @@
+# KonsistTest Source Set
+
+Tests used to verify the Konsist codebase using the KonsistTest framework.

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

@@ -5,7 +5,6 @@ import com.lemonappdev.konsist.api.provider.KoBaseProvider
 import com.lemonappdev.konsist.api.provider.KoContainingDeclarationProvider
 import com.lemonappdev.konsist.api.provider.KoContainingFileProvider
 import com.lemonappdev.konsist.api.provider.KoGenericTypeProvider
-import com.lemonappdev.konsist.api.provider.KoKotlinTypeProvider
 import com.lemonappdev.konsist.api.provider.KoLocationProvider
 import com.lemonappdev.konsist.api.provider.KoModuleProvider
 import com.lemonappdev.konsist.api.provider.KoNameProvider
@@ -17,6 +16,7 @@ import com.lemonappdev.konsist.api.provider.KoSourceAndAliasTypeProvider
 import com.lemonappdev.konsist.api.provider.KoSourceDeclarationProvider
 import com.lemonappdev.konsist.api.provider.KoSourceSetProvider
 import com.lemonappdev.konsist.api.provider.KoTextProvider
+import com.lemonappdev.konsist.api.provider.KoTypeProvider
 
 /**
  * Represents a Kotlin type declaration.
@@ -33,7 +33,7 @@ interface KoTypeDeclaration :
     KoContainingDeclarationProvider,
     KoModuleProvider,
     KoSourceSetProvider,
-    KoKotlinTypeProvider,
+    KoTypeProvider,
     KoGenericTypeProvider,
     KoSourceAndAliasTypeProvider,
     KoPackageProvider,