enh: allow user to choose name of definitions object (#2)

Author: piiertho

README.md

@@ -1,7 +1,7 @@
 # kotlin-preprocessors
 Gradle plugin to define preprocessors for kotlin language
 
-This plugins enable to define kotlin constants from gradle.  
+This plugin enable to define kotlin constants from gradle.  
 As constants are inlined by compiler, and checks based on constants results in NOP after compiling,
 it makes constants good candidates for "conditional compiling".  
 
@@ -19,7 +19,7 @@ plugins {
 Then you can add definitions to your project:
 ```kotlin
 kotlinDefinitions {
-    definitionsObjectPrefix.set("WhateverNameYouWant") // Here to avoid overlap if a dependency uses this plugin. You can set this to your project name
+    definitionsObjectName.set("WhateverNameYouWant") // Here to avoid overlap if a dependency uses this plugin. BuildConfig by default
 
     define("DEBUG") // if no value specified, default is bool with value set to true.
     define("APP_VERSION", "1.0.0")
@@ -33,8 +33,8 @@ package kotlincompile.definitions
 
 import kotlin.Boolean
 
-public object SamplesDefinitions {
-  public const val DEBUG: Boolean = true
+public object SamplesBuildConfig {
+    public const val DEBUG: Boolean = true
 }
 ```
 

kotlin-preprocessors/src/main/kotlin/com/utopiarise/kotlin/preprocessors/codegen/GeneratePreProcessors.kt

@@ -3,14 +3,12 @@ package com.utopiarise.kotlin.preprocessors.codegen
 import com.squareup.kotlinpoet.*
 import java.io.File
 
-fun File.generateDefinitions(definitions: Map<String, Any>, definitionsObjectPrefix: String) {
-    val definitionsContainerName = "${definitionsObjectPrefix}Definitions"
-
+fun File.generateDefinitions(definitions: Map<String, Any>, definitionsObjectName: String) {
     val definitionsFile = FileSpec
-        .builder(definitionsPackage, definitionsContainerName)
+        .builder(definitionsPackage, definitionsObjectName)
 
     val definitionsObject = TypeSpec
-        .objectBuilder(definitionsContainerName)
+        .objectBuilder(definitionsObjectName)
 
     for (definition in definitions) {
         val definitionValue = definition.value

kotlin-preprocessors/src/main/kotlin/com/utopiarise/kotlin/preprocessors/gradle/PreProcessorPlugin.kt

@@ -9,15 +9,16 @@ import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.TaskAction
 import org.gradle.plugins.ide.idea.IdeaPlugin
 import org.gradle.plugins.ide.idea.model.IdeaModel
-import org.gradle.plugins.ide.idea.model.IdeaModule
 import org.jetbrains.gradle.ext.IdeaExtPlugin
 import org.jetbrains.gradle.ext.settings
 import org.jetbrains.gradle.ext.taskTriggers
 import org.jetbrains.kotlin.gradle.dsl.kotlinExtension
 
+private const val DEFAULT_DEFINITION_CLASS = "BuildConfig"
+
 open class PreProcessorPluginExtension(objects: ObjectFactory) {
     internal val definitions = mutableMapOf<String, Any>()
-    val definitionsObjectPrefix = objects.property(String::class.java)
+    val definitionsObjectName = objects.property(String::class.java)
 
     fun define(definition: String) {
         definitions[definition] = true
@@ -41,14 +42,14 @@ open class GenerateDefinitions : DefaultTask() {
     val definitions = project.objects.mapProperty(String::class.java, Any::class.java)
 
     @Input
-    val definitionsObjectPrefix = project.objects.property(String::class.java)
+    val definitionsObjectName = project.objects.property(String::class.java)
 
     @TaskAction
     fun execute() {
         val output = project.buildDir.resolve("definitions")
         output.deleteRecursively()
 
-        output.generateDefinitions(definitions.get(), definitionsObjectPrefix.get())
+        output.generateDefinitions(definitions.get(), definitionsObjectName.getOrElse(DEFAULT_DEFINITION_CLASS))
     }
 }
 
@@ -65,7 +66,7 @@ class PreProcessorPlugin : Plugin<Project> {
         val extension = project.extensions.create("kotlinDefinitions", PreProcessorPluginExtension::class.java)
         val generationTask = project.tasks.register("generateKotlinDefinitions", GenerateDefinitions::class.java) {
             definitions.set(extension.definitions)
-            definitionsObjectPrefix.set(extension.definitionsObjectPrefix)
+            definitionsObjectName.set(extension.definitionsObjectName)
 
             group = "kotlin-definitions"
             description = "Generate definitions for kotlin as constants."

samples/build.gradle.kts

@@ -8,7 +8,7 @@ group = "com.utopia-rise"
 version = "0.1.0-SNAPSHOT"
 
 kotlinDefinitions {
-    definitionsObjectPrefix.set("Samples")
+    definitionsObjectName.set("SamplesBuildConfig")
 
     define("DEBUG")
 }