Merge pull request #35 from PatilShreyas/v1.0.0

Release v1.0.0

Author: PatilShreyas

cli/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/cli/Main.kt

@@ -185,5 +185,5 @@ fun printHeader(header: String) = println(
 )
 
 object Constants {
-    const val VERSION = "v1.0.0-beta03"
+    const val VERSION = "v1.0.0"
 }

docs/use/using-cli.md

@@ -56,7 +56,7 @@ Run the command to know the usage of CLI
 !!! success "▶️Output"
 
     ```shell
-    Usage: Compose Compiler Report to HTML Generator ~ v1.0.0-beta03 options_list
+    Usage: Compose Compiler Report to HTML Generator ~ v1.0.0 options_list
     Options:
         --applicationName, -app -> Application name (To be displayed in the report) (always required) { String }
         --inputDirectory, -i -> Input directory where composable report and metrics are available { String }

docs/use/using-gradle-plugin.md

@@ -19,15 +19,15 @@ Apply the plugin to the module in which _**compose is enabled**_.
 
     ```groovy title="build.gradle"
     plugins {
-      id "dev.shreyaspatil.compose-compiler-report-generator" version "1.0.0-beta03"
+      id "dev.shreyaspatil.compose-compiler-report-generator" version "1.0.0"
     }
     ```
 
 === "Kotlin"
 
     ```kotlin title="build.gradle.kts"
     plugins {
-      id("dev.shreyaspatil.compose-compiler-report-generator") version "1.0.0-beta03"
+      id("dev.shreyaspatil.compose-compiler-report-generator") version "1.0.0"
     }    
     ```
 
@@ -45,7 +45,7 @@ Add this to top project level `build.gradle`
         }
       }
       dependencies {
-        classpath "dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.0-beta03"
+        classpath "dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.0"
       }
     }
     ```
@@ -66,7 +66,7 @@ Add this to top project level `build.gradle`
         }
       }
       dependencies {
-        classpath("dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.0-beta03")
+        classpath("dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.0")
       }
     }
     ```

gradle-plugin/build.gradle.kts

@@ -20,7 +20,7 @@ group = GROUP
 version = VERSION_NAME
 
 dependencies {
-    implementation(gradleApi())
+    compileOnly(gradleApi())
     compileOnly(kotlin("stdlib"))
     compileOnly(libs.kotlin.gradle.plugin)
     compileOnly(libs.android.gradle.plugin)

gradle-plugin/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/plugin/ComposeCompilerReportExtension.kt

@@ -26,6 +26,7 @@ package dev.shreyaspatil.composeCompilerMetricsGenerator.plugin
 import org.gradle.api.Project
 import org.gradle.api.provider.Property
 import org.gradle.kotlin.dsl.create
+import org.gradle.kotlin.dsl.getByType
 import java.io.File
 
 interface ComposeCompilerReportExtension {
@@ -59,11 +60,16 @@ interface ComposeCompilerReportExtension {
         /**
          * Creates a extension of type [ComposeCompilerReportExtension] and returns
          */
-        fun get(target: Project) = target.extensions.create<ComposeCompilerReportExtension>(NAME).apply {
+        fun create(target: Project) = target.extensions.create<ComposeCompilerReportExtension>(NAME).apply {
             enableReport.convention(true)
             enableMetrics.convention(true)
             name.convention("${target.rootProject.name}:${target.name}")
             outputPath.convention(target.buildDir.resolve("compose_report").absolutePath)
         }
+
+        /**
+         * Get extensions applied to the [target] project.
+         */
+        fun get(target: Project) = target.extensions.getByType<ComposeCompilerReportExtension>()
     }
 }

gradle-plugin/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/plugin/ReportGenPlugin.kt

@@ -25,8 +25,8 @@ package dev.shreyaspatil.composeCompilerMetricsGenerator.plugin
 
 import com.android.build.api.dsl.CommonExtension
 import com.android.build.api.variant.AndroidComponentsExtension
-import dev.shreyaspatil.composeCompilerMetricsGenerator.plugin.task.createComposeCompilerReportGenTaskForVariant
 import dev.shreyaspatil.composeCompilerMetricsGenerator.plugin.task.executingComposeCompilerReportGenerationGradleTask
+import dev.shreyaspatil.composeCompilerMetricsGenerator.plugin.task.registerComposeCompilerReportGenTaskForVariant
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.getByType
@@ -36,7 +36,7 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinJvmOptions
 @Suppress("UnstableApiUsage")
 class ReportGenPlugin : Plugin<Project> {
     override fun apply(target: Project) {
-        val reportExt = ComposeCompilerReportExtension.get(target)
+        val reportExt = ComposeCompilerReportExtension.create(target)
 
         val android = runCatching {
             target.extensions.getByType(AndroidComponentsExtension::class.java)
@@ -46,7 +46,7 @@ class ReportGenPlugin : Plugin<Project> {
 
         android.onVariants { variant ->
             // Create gradle tasks for generating report
-            target.createComposeCompilerReportGenTaskForVariant(variant, reportExt)
+            target.registerComposeCompilerReportGenTaskForVariant(variant)
         }
 
         target.afterEvaluate {

gradle-plugin/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/plugin/task/ComposeCompilerReportGenerateTask.kt

@@ -29,52 +29,105 @@ import dev.shreyaspatil.composeCompilerMetricsGenerator.core.ComposeCompilerRawR
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.HtmlReportGenerator
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.ReportSpec
 import dev.shreyaspatil.composeCompilerMetricsGenerator.plugin.ComposeCompilerReportExtension
+import org.gradle.api.DefaultTask
 import org.gradle.api.Project
-import org.gradle.api.Task
-import org.gradle.api.tasks.GradleBuild
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.TaskAction
 import org.gradle.api.tasks.TaskProvider
-import org.gradle.configurationcache.extensions.capitalized
+import org.gradle.tooling.GradleConnector
 import java.io.File
 import java.io.FileNotFoundException
 
 const val KEY_ENABLE_REPORT_GEN = "dev.shreyaspatil.composeCompiler.reportGen.enable"
 
-fun Project.createComposeCompilerReportGenTaskForVariant(
-    variant: Variant,
-    reportExtension: ComposeCompilerReportExtension
-): TaskProvider<GradleBuild> {
-    val taskName = variant.name + "ComposeCompilerHtmlReport"
-    return tasks.register(taskName, GradleBuild::class.java) {
-        startParameter.projectProperties[KEY_ENABLE_REPORT_GEN] = true.toString()
+abstract class ComposeCompilerReportGenerateTask : DefaultTask() {
+    @get:Input
+    abstract val compileKotlinTasks: Property<String>
 
-        // All compilation tasks should be re-run. Because if any developer deletes report
-        // and again runs this task then compose metrics won't be generated by compiler again
-        startParameter.isRerunTasks = true
+    private val reportExtension: ComposeCompilerReportExtension
+        get() = ComposeCompilerReportExtension.get(project)
 
-        tasks = listOf("compile${variant.name.capitalized()}Kotlin")
+    @TaskAction
+    fun generate() {
+        val reportExt = reportExtension
+        cleanupDirectory(reportExtension.outputPath.get())
 
-        doFirst {
-            cleanupDirectory(reportExtension.outputPath.get())
-        }
+        generateRawMetricsAndReport()
 
-        doLast {
-            generateReport(reportExtension)
-        }
+        generateReport(reportExt)
+    }
 
-        group = "compose compiler report"
-        description = "Generate Compose Compiler Metrics and Report"
+    private fun generateRawMetricsAndReport() {
+        GradleConnector.newConnector().forProjectDirectory(project.layout.projectDirectory.asFile)
+            .connect()
+            .use {
+                it.newBuild()
+                    .setStandardOutput(System.out)
+                    .setStandardError(System.err)
+                    .setStandardInput(System.`in`)
+                    .forTasks(compileKotlinTasks.get())
+                    .withArguments(
+                        // Re-running is necessary. In case devs deleted raw files and if task uses cache
+                        // then this task will explode 💣
+                        "--rerun-tasks",
+
+                        // Signal for enabling report generation in `kotlinOptions{}` block.
+                        "-P$KEY_ENABLE_REPORT_GEN=true"
+                    )
+                    .run()
+            }
     }
-}
 
-fun cleanupDirectory(directory: String) {
-    val dirFile = File(directory)
-    if (dirFile.exists()) {
-        if (!dirFile.isDirectory) {
-            throw FileNotFoundException("'$directory' is not a directory")
+    private fun generateReport(reportExtension: ComposeCompilerReportExtension) {
+        val outputDirectory = reportExtension.outputPath.get().let { File(it) }
+
+        // Create a report specification with application name
+        val reportSpec = ReportSpec(reportExtension.name.get())
+
+        val rawReportProvider = ComposeCompilerRawReportProvider.FromDirectory(
+            directory = reportExtension.composeRawMetricsOutputDirectory
+        )
+
+        // Provide metric files to generator
+        val htmlGenerator = HtmlReportGenerator(
+            reportSpec = reportSpec,
+            metricsProvider = ComposeCompilerMetricsProvider(rawReportProvider)
+        )
+
+        // Generate HTML (as String)
+        val html = htmlGenerator.generateHtml()
+
+        // Create a report file
+        val file = outputDirectory.resolve("index.html")
+        file.writeText(html)
+
+        val reportUrl = file.toURI().toURL().toExternalForm()
+        logger.quiet("Compose Compiler report is generated: $reportUrl")
+    }
+
+    private fun cleanupDirectory(directory: String) {
+        val dirFile = File(directory)
+        if (dirFile.exists()) {
+            if (!dirFile.isDirectory) {
+                throw FileNotFoundException("'$directory' is not a directory")
+            }
         }
+
+        dirFile.deleteRecursively()
     }
+}
+
+fun Project.registerComposeCompilerReportGenTaskForVariant(variant: Variant): TaskProvider<ComposeCompilerReportGenerateTask> {
+    val taskName = variant.name + "ComposeCompilerHtmlReport"
+    val compileKotlinTaskName = compileKotlinTaskNameFromVariant(variant)
+
+    return tasks.register(taskName, ComposeCompilerReportGenerateTask::class.java) {
+        compileKotlinTasks.set(compileKotlinTaskName)
 
-    dirFile.deleteRecursively()
+        group = "compose compiler report"
+        description = "Generate Compose Compiler Metrics and Report"
+    }
 }
 
 /**
@@ -84,28 +137,10 @@ fun Project.executingComposeCompilerReportGenerationGradleTask() = runCatching {
     property(KEY_ENABLE_REPORT_GEN)
 }.getOrNull() == "true"
 
-private fun Task.generateReport(reportExtension: ComposeCompilerReportExtension) {
-    val outputDirectory = reportExtension.outputPath.get().let { File(it) }
-
-    // Create a report specification with application name
-    val reportSpec = ReportSpec(reportExtension.name.get())
-
-    val rawReportProvider = ComposeCompilerRawReportProvider.FromDirectory(
-        directory = reportExtension.composeRawMetricsOutputDirectory
-    )
-
-    // Provide metric files to generator
-    val htmlGenerator = HtmlReportGenerator(
-        reportSpec = reportSpec,
-        metricsProvider = ComposeCompilerMetricsProvider(rawReportProvider)
-    )
-
-    // Generate HTML (String)
-    val html = htmlGenerator.generateHtml()
-
-    // Create a report file
-    val file = outputDirectory.resolve("index.html")
-    file.writeText(html)
-
-    logger.quiet("Compose Compiler report is generated: ${file.absolutePath}")
+/**
+ * Returns a task name for compile<VARIANT>Kotlin with [variant]
+ */
+fun compileKotlinTaskNameFromVariant(variant: Variant): String {
+    val variantName = variant.name.let { it[0].toUpperCase() + it.substring(1) }
+    return "compile${variantName}Kotlin"
 }

gradle-plugin/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/plugin/utils/CommonExtensionsExt.kt

@@ -1,7 +1,7 @@
 kotlin.code.style=official
 
 GROUP=dev.shreyaspatil.compose-compiler-report-generator
-VERSION_NAME=1.0.0-beta03
+VERSION_NAME=1.0.0
 
 # Library configuration
 SONATYPE_HOST=DEFAULT

gradle.properties

@@ -7,7 +7,7 @@
   "main": "index.js",
   "preferGlobal": true,
   "repository": "https://github.com/PatilShreyas/compose-report-to-html",
-  "version": "1.0.0-beta03",
+  "version": "1.0.0",
   "jdeploy": {
     "jdk": false,
     "javaVersion": "11",