Added option to whether to respect visibility modifiers or not

Mr-Mappie · Jun 17, 2024 · 652606c · 652606c
1 parent b97874a
commit 652606c
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 9 deletions.
diff --git a/compiler-plugin/src/main/kotlin/io/github/mappie/MappieCommandLineProcessor.kt b/compiler-plugin/src/main/kotlin/io/github/mappie/MappieCommandLineProcessor.kt
@@ -18,18 +18,28 @@ class MappieCommandLineProcessor : CommandLineProcessor {
             valueDescription = "boolean",
             description = "strictness of enum validation",
             required = false,
+        ),
+        CliOption(
+            optionName = OPTION_STRICTNESS_VISIBILITY,
+            valueDescription = "boolean",
+            description = "strictness of visibility modifiers",
+            required = false,
         )
     )
 
     override fun processOption(option: AbstractCliOption, value: String, configuration: CompilerConfiguration) {
         return when (option.optionName) {
             OPTION_STRICTNESS_ENUMS -> configuration.put(ARGUMENT_STRICTNESS_ENUMS, value.toBooleanStrict())
+            OPTION_STRICTNESS_VISIBILITY -> configuration.put(ARGUMENT_STRICTNESS_VISIBILITY, value.toBooleanStrict())
             else -> throw IllegalArgumentException("Unknown option ${option.optionName}")
         }
     }
 
     companion object {
         const val OPTION_STRICTNESS_ENUMS = "strictness.enums"
+        const val OPTION_STRICTNESS_VISIBILITY = "strictness.visibility"
+
         val ARGUMENT_STRICTNESS_ENUMS = CompilerConfigurationKey<Boolean>(OPTION_STRICTNESS_ENUMS)
+        val ARGUMENT_STRICTNESS_VISIBILITY = CompilerConfigurationKey<Boolean>(OPTION_STRICTNESS_VISIBILITY)
     }
 }
diff --git a/compiler-plugin/src/main/kotlin/io/github/mappie/MappieCompilerPluginRegistrar.kt b/compiler-plugin/src/main/kotlin/io/github/mappie/MappieCompilerPluginRegistrar.kt
@@ -1,6 +1,7 @@
 package io.github.mappie
 
 import io.github.mappie.MappieCommandLineProcessor.Companion.ARGUMENT_STRICTNESS_ENUMS
+import io.github.mappie.MappieCommandLineProcessor.Companion.ARGUMENT_STRICTNESS_VISIBILITY
 import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
 import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys
 import org.jetbrains.kotlin.cli.common.messages.MessageCollector
@@ -18,7 +19,10 @@ class MappieCompilerPluginRegistrar : CompilerPluginRegistrar() {
         IrGenerationExtension.registerExtension(
             MappieIrRegistrar(
                 messageCollector,
-                MappieConfiguration(StrictnessConfiguration(configuration.get(ARGUMENT_STRICTNESS_ENUMS, true)))
+                MappieConfiguration(StrictnessConfiguration(
+                    enums = configuration.get(ARGUMENT_STRICTNESS_ENUMS, true),
+                    visibility = configuration.get(ARGUMENT_STRICTNESS_VISIBILITY, false)
+                ))
             )
         )
     }

diff --git a/compiler-plugin/src/main/kotlin/io/github/mappie/MappieConfiguration.kt b/compiler-plugin/src/main/kotlin/io/github/mappie/MappieConfiguration.kt
@@ -6,4 +6,5 @@ data class MappieConfiguration(
 
 data class StrictnessConfiguration(
     val enums: Boolean,
+    val visibility: Boolean,
 )
diff --git a/compiler-plugin/src/main/kotlin/io/github/mappie/MappieIrRegistrar.kt b/compiler-plugin/src/main/kotlin/io/github/mappie/MappieIrRegistrar.kt
@@ -1,7 +1,6 @@
 package io.github.mappie
 
 import io.github.mappie.generation.IrTransformer
-import io.github.mappie.util.error
 import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
 import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
 import org.jetbrains.kotlin.cli.common.messages.MessageCollector

diff --git a/compiler-plugin/src/main/kotlin/io/github/mappie/validation/MappingValidation.kt b/compiler-plugin/src/main/kotlin/io/github/mappie/validation/MappingValidation.kt
@@ -61,12 +61,12 @@ interface MappingValidation {
                 )
 
                 addAll(
-                    mapping.unknowns
-                        .map { Problem.error("Parameter ${it.first.asString()} does not occur as a parameter in constructor") }
+                    mapping.unknowns.map {
+                        Problem.error("Parameter ${it.first.asString()} does not occur as a parameter in constructor")
+                    }
                 )
 
-                // TODO: make optional via configuration
-                if (!mapping.symbol.owner.visibility.isPublicAPI) {
+                if (!mapping.symbol.owner.visibility.isPublicAPI && context.configuration.strictness.visibility) {
                     add(Problem.error("Constructor is not public", location(mapping.symbol.owner)))
                 }
             }

diff --git a/gradle-plugin/src/main/kotlin/io/github/mappie/MappieExtension.kt b/gradle-plugin/src/main/kotlin/io/github/mappie/MappieExtension.kt
@@ -12,15 +12,26 @@ abstract class MappieExtension(private val project: Project) {
             project.objects.newInstance(MappieStrictnessExtension::class.java)
         } as MappieStrictnessExtension
 
+    /**
+     * Configuration options for the strictness of validations.
+     */
     fun strictness(configuration: MappieStrictnessExtension.() -> Unit) {
         configuration(strictness)
     }
 }
 
 abstract class MappieStrictnessExtension {
 
+    /**
+     * Whether to require all enum sources have a defined target.
+     */
     abstract val enums: Property<Boolean>
 
+    /**
+     * Whether to require called elements to be visible from the current scope.
+     */
+    abstract val visibility: Property<Boolean>
+
     internal companion object {
         const val NAME = "mappie-strictness-extension"
     }

diff --git a/gradle-plugin/src/main/kotlin/io/github/mappie/MappieGradlePlugin.kt b/gradle-plugin/src/main/kotlin/io/github/mappie/MappieGradlePlugin.kt
@@ -16,9 +16,14 @@ class MappieGradlePlugin : KotlinCompilerPluginSupportPlugin {
     override fun applyToCompilation(kotlinCompilation: KotlinCompilation<*>): Provider<List<SubpluginOption>> {
         val extension = kotlinCompilation.project.extensions.getByType(MappieExtension::class.java)
         return kotlinCompilation.target.project.provider {
-            listOf(
-                SubpluginOption("strictness.enums", lazy { extension.strictness.enums.get().toString() }),
-            )
+            buildList {
+                extension.strictness.enums.orNull?.apply {
+                    add(SubpluginOption("strictness.enums", this.toString() ))
+                }
+                extension.strictness.visibility.orNull?.apply {
+                    add(SubpluginOption("strictness.visibility", this.toString()))
+                }
+            }
         }
     }