Merge pull request #96 from Jolanrensen/configuration-cache

refactoring to allow for configuration cache

Author: Jolanrensen

gradle.properties

@@ -0,0 +1 @@
+org.gradle.configuration-cache=warn

kodex-example-gradle-project-jvm/build.gradle.kts

@@ -1,5 +1,4 @@
 import nl.jolanrensen.kodex.defaultProcessors.ARG_DOC_PROCESSOR_LOG_NOT_FOUND
-import nl.jolanrensen.kodex.gradle.creatingRunKodexTask
 
 plugins {
     kotlin("jvm") // version "2.2.21"
@@ -13,6 +12,7 @@ version = "1.0"
 
 repositories {
     mavenCentral()
+    mavenLocal()
     google()
 }
 
@@ -35,6 +35,22 @@ kodex {
     preprocess(kotlin.sourceSets.main) {
         // optional setup
         arguments(ARG_DOC_PROCESSOR_LOG_NOT_FOUND to false)
+
+        // Can be enabled if `PluginExtensionTest` has been run to test if extensions work
+//        processors = listOf(
+//            COMMENT_DOC_PROCESSOR,
+//            INCLUDE_DOC_PROCESSOR,
+//            INCLUDE_FILE_DOC_PROCESSOR,
+//            ARG_DOC_PROCESSOR,
+//            SAMPLE_DOC_PROCESSOR,
+//            EXPORT_AS_HTML_DOC_PROCESSOR,
+//            REMOVE_ESCAPE_CHARS_PROCESSOR,
+//            "nl.jolanrensen.extension.Extension",
+//        )
+//
+//        dependencies {
+//            plugin("nl.jolanrensen:PluginExtensionTest:0.5.1-SNAPSHOT")
+//        }
     }
 }
 

kodex-gradle-plugin/build.gradle.kts

@@ -141,6 +141,7 @@ tasks.check {
 }
 
 tasks.withType<KotlinCompile> {
+    dependsOn(":kodex-common:shadowJar")
     compilerOptions.jvmTarget = JvmTarget.JVM_17
 }
 

kodex-gradle-plugin/src/main/kotlin/nl/jolanrensen/kodex/gradle/CommonKodexTaskProperties.kt

@@ -11,7 +11,7 @@ import org.gradle.api.Action
 import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.Project
 import org.gradle.api.artifacts.Configuration
-import org.gradle.api.artifacts.DependencySet
+import org.gradle.api.file.FileCollection
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.MapProperty
@@ -100,7 +100,7 @@ interface CommonKodexTaskProperties {
 
     /** The classpath of this task. */
     @get:Classpath
-    val classpath: Property<Configuration>
+    val classpath: Property<FileCollection>
 
     @get:Nested
     val exportAsHtml: Property<ExportAsHtmlDsl>
@@ -121,7 +121,24 @@ interface CommonKodexTaskProperties {
      * ```
      */
     @get:Internal
-    val dependencies: Property<DependencySetPluginDsl>
+    val dependencies: DependencySetPluginDsl
+        get() = object : DependencySetPluginDsl {
+            /**
+             * Gets the set of declared dependencies directly contained in this configuration
+             * (ignoring super configurations).
+             *
+             * This method does not resolve the configuration. Therefore, the return value does not include
+             * transitive dependencies.
+             *
+             * @return the set of dependencies
+             * @see #extendsFrom(Configuration...)
+             */
+            override fun Project.plugin(dependencyNotation: Any) {
+                (classpath.get() as Configuration).dependencies.add(
+                    dependencies.create(dependencyNotation),
+                )
+            }
+        }
 
     /**
      * DSL to add plugin dependencies to the current task. If you want to include a processor from an external library,
@@ -135,7 +152,7 @@ interface CommonKodexTaskProperties {
      * }
      * ```
      */
-    fun dependencies(action: Action<DependencySetPluginDsl>): Unit = action.execute(dependencies.get())
+    fun dependencies(action: Action<DependencySetPluginDsl>): Unit = action.execute(dependencies)
 
     /** like "2.3", uses languageVersion or latest stable if not supplied. */
     @get:Input
@@ -201,7 +218,7 @@ interface DependencySetPluginDsl {
      *
      * @param dependencyNotation Dependency notation
      */
-    fun plugin(dependencyNotation: Any)
+    fun Project.plugin(dependencyNotation: Any)
 }
 
 fun CommonKodexTaskProperties.applyPropertiesFrom(other: CommonKodexTaskProperties) {
@@ -251,29 +268,6 @@ fun CommonKodexTaskProperties.applyConventions(project: Project, factory: Object
     exportAsHtmlInstance.dir.convention(target.map { File(it, "htmlExports") })
     exportAsHtmlInstance.outputReadOnly.convention(true)
     exportAsHtml.set(exportAsHtmlInstance)
-
-    dependencies.set(
-        object : DependencySetPluginDsl {
-            /**
-             * Gets the set of declared dependencies directly contained in this configuration
-             * (ignoring super configurations).
-             * <p>
-             * This method does not resolve the configuration. Therefore, the return value does not include
-             * transitive dependencies.
-             *
-             * @return the set of dependencies
-             * @see #extendsFrom(Configuration...)
-             */
-            val dependencies: DependencySet
-                get() = classpath.get().dependencies
-
-            override fun plugin(dependencyNotation: Any) {
-                dependencies.add(
-                    project.dependencies.create(dependencyNotation),
-                )
-            }
-        },
-    )
 }
 
 internal fun Project.maybeCreateRuntimeConfiguration(): Configuration =

kodex-gradle-plugin/src/main/kotlin/nl/jolanrensen/kodex/gradle/RunKodexTask.kt

@@ -12,8 +12,10 @@ import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFiles
+import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.OutputFiles
 import org.gradle.api.tasks.TaskAction
+import org.gradle.kotlin.dsl.listProperty
 import org.gradle.kotlin.dsl.property
 import org.gradle.workers.WorkerExecutor
 import java.io.File
@@ -27,8 +29,10 @@ private val log = KotlinLogging.logger { }
  */
 abstract class RunKodexTask
     @Inject
-    constructor(factory: ObjectFactory, project: Project) :
-    DefaultTask(),
+    constructor(
+        @get:Internal val factory: ObjectFactory,
+        project: Project,
+    ) : DefaultTask(),
         CommonKodexTaskProperties {
 
         init {
@@ -72,13 +76,18 @@ abstract class RunKodexTask
         fun calculateTargets(): FileCollection {
             val relativeSources = sources.get().map { it.relativeTo(baseDir.get()) }
             val target = target.get()
-            return project.files(relativeSources.map { File(target, it.path) })
+            return factory.fileCollection().from(relativeSources.map { File(target, it.path) })
         }
 
         /** Used by the task to execute [RunKodexGradleAction]. */
         @get:Inject
         abstract val workerExecutor: WorkerExecutor
 
+        @get:InputFiles
+        internal val projectClassPath: ListProperty<File> = factory
+            .listProperty<File>()
+            .convention(project.files().toList())
+
         @Deprecated(
             "This notation is no longer needed.",
             replaceWith = ReplaceWith("block()"),
@@ -108,7 +117,7 @@ abstract class RunKodexTask
 
             val sourceRoots = sources.get()
             val target = target.get()
-            val runtime = classpath.get().resolve()
+            val runtime = classpath.get() // .resolve()
             val processors = processors.get()
 
             (targets as ConfigurableFileCollection).setFrom(calculateTargets())
@@ -128,7 +137,7 @@ abstract class RunKodexTask
                 languageVersion = languageVersion.getOrNull(),
                 apiVersion = apiVersion.getOrNull(),
                 analysisPlatform = analysisPlatform.getOrNull(),
-                classpath = project.files().toList(),
+                classpath = projectClassPath.get(),
             )
 
             val workQueue = workerExecutor.classLoaderIsolation {