KON-525 Add isReadOnly property to the KoPropertyDeclaration

Author: jibidus

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koproperty/KoPropertyDeclarationForKoReadOnlyProviderTest.kt

@@ -0,0 +1,54 @@
+package com.lemonappdev.konsist.core.declaration.koproperty
+
+import com.lemonappdev.konsist.TestSnippetProvider.getSnippetKoScope
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.jupiter.api.Test
+
+class KoPropertyDeclarationForKoReadOnlyProviderTest {
+    @Test
+    fun `property-is-val`() {
+        // given
+        val sut = getSnippetFile("property-is-val")
+            .properties()
+            .first()
+
+        // then
+        sut.isReadOnly shouldBeEqualTo true
+    }
+
+    @Test
+    fun `property-is-var`() {
+        // given
+        val sut = getSnippetFile("property-is-var")
+            .properties()
+            .first()
+
+        // then
+        sut.isReadOnly shouldBeEqualTo false
+    }
+
+    @Test
+    fun `property-is-lateinit-var`() {
+        // given
+        val sut = getSnippetFile("property-is-lateinit-var")
+            .properties()
+            .first()
+
+        // then
+        sut.isReadOnly shouldBeEqualTo false
+    }
+
+    @Test
+    fun `property-is-const-val`() {
+        // given
+        val sut = getSnippetFile("property-is-const-val")
+            .properties()
+            .first()
+
+        // then
+        sut.isReadOnly shouldBeEqualTo true
+    }
+
+    private fun getSnippetFile(fileName: String) =
+        getSnippetKoScope("core/declaration/koproperty/snippet/forkoreadonlyprovider/", fileName)
+}

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koproperty/snippet/forkoreadonlyprovider/property-is-const-val.kttxt

@@ -0,0 +1 @@
+const val sampleProperty: String = ""

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koproperty/snippet/forkoreadonlyprovider/property-is-lateinit-var.kttxt

@@ -0,0 +1 @@
+lateinit var sampleProperty: String

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koproperty/snippet/forkoreadonlyprovider/property-is-val.kttxt

@@ -0,0 +1 @@
+val sampleProperty: String = ""

lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/declaration/koproperty/snippet/forkoreadonlyprovider/property-is-var.kttxt

@@ -0,0 +1 @@
+var sampleProperty: String = ""

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

@@ -16,6 +16,7 @@ import com.lemonappdev.konsist.api.provider.KoNameProvider
 import com.lemonappdev.konsist.api.provider.KoNullableTypeProvider
 import com.lemonappdev.konsist.api.provider.KoPackageProvider
 import com.lemonappdev.konsist.api.provider.KoPathProvider
+import com.lemonappdev.konsist.api.provider.KoReadOnlyProvider
 import com.lemonappdev.konsist.api.provider.KoReceiverTypeProvider
 import com.lemonappdev.konsist.api.provider.KoResideInPackageProvider
 import com.lemonappdev.konsist.api.provider.KoSetterProvider
@@ -75,4 +76,5 @@ interface KoPropertyDeclaration :
     KoExpectModifierProvider,
     KoConstModifierProvider,
     KoGetterProvider,
-    KoSetterProvider
+    KoSetterProvider,
+    KoReadOnlyProvider

lib/src/main/kotlin/com/lemonappdev/konsist/api/provider/KoReadOnlyProvider.kt

@@ -0,0 +1,8 @@
+package com.lemonappdev.konsist.api.provider
+
+interface KoReadOnlyProvider : KoBaseProvider {
+    /**
+     * Determines whatever declaration is read only (i.e. is declared as `val`).
+     */
+    val isReadOnly: Boolean
+}

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

@@ -21,6 +21,7 @@ import com.lemonappdev.konsist.core.provider.KoModuleProviderCore
 import com.lemonappdev.konsist.core.provider.KoNameProviderCore
 import com.lemonappdev.konsist.core.provider.KoNullableTypeProviderCore
 import com.lemonappdev.konsist.core.provider.KoPathProviderCore
+import com.lemonappdev.konsist.core.provider.KoReadOnlyProviderCore
 import com.lemonappdev.konsist.core.provider.KoReceiverTypeProviderCore
 import com.lemonappdev.konsist.core.provider.KoResideInPackageProviderCore
 import com.lemonappdev.konsist.core.provider.KoSetterProviderCore
@@ -103,7 +104,8 @@ internal class KoPropertyDeclarationCore private constructor(
     KoExpectModifierProviderCore,
     KoConstModifierProviderCore,
     KoGetterProviderCore,
-    KoSetterProviderCore {
+    KoSetterProviderCore,
+    KoReadOnlyProviderCore {
     override val ktAnnotated: KtAnnotated by lazy { ktCallableDeclaration }
 
     override val ktModifierListOwner: KtModifierListOwner by lazy { ktCallableDeclaration }

lib/src/main/kotlin/com/lemonappdev/konsist/core/provider/KoReadOnlyProviderCore.kt

@@ -0,0 +1,10 @@
+package com.lemonappdev.konsist.core.provider
+
+import com.lemonappdev.konsist.api.provider.KoReadOnlyProvider
+import com.lemonappdev.konsist.core.provider.modifier.KoValModifierProviderCore
+
+internal interface KoReadOnlyProviderCore : KoReadOnlyProvider, KoValModifierProviderCore {
+
+    override val isReadOnly: Boolean
+        get() = hasValModifier
+}