Merge pull request #29 from PatilShreyas/v1.0.0-beta02

Release v1.0.0-beta02

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-beta01"
+    const val VERSION = "v1.0.0-beta02"
 }

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/model/RawContent.kt

@@ -0,0 +1,30 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2022 Shreyas Patil
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package dev.shreyaspatil.composeCompilerMetricsGenerator.core.model
+
+/**
+ * Represents raw data provided by Compose compiler.
+ * Example: Composable function metric generated by compiler extracted from `-composables.txt` file
+ */
+data class RawContent(val content: String)

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/model/classes/ClassDetail.kt

@@ -24,6 +24,7 @@
 package dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.classes
 
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.Condition
+import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.RawContent
 
 /**
  * Model for holding class details
@@ -37,7 +38,8 @@ data class ClassDetail(
     val className: String,
     val stability: Condition,
     val runtimeStability: Condition?,
-    val fields: List<Field>
+    val fields: List<Field>,
+    val rawContent: RawContent,
 ) {
     /**
      * Model for holding field details of a class

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/model/composables/ComposableDetail.kt

@@ -24,6 +24,7 @@
 package dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.composables
 
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.Condition
+import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.RawContent
 
 /**
  * Model for holding Detail of a composable function
@@ -39,7 +40,8 @@ data class ComposableDetail(
     val isRestartable: Boolean,
     val isSkippable: Boolean,
     val isInline: Boolean,
-    val params: List<Parameter>
+    val params: List<Parameter>,
+    val rawContent: RawContent,
 ) {
     /**
      * Model for holding details of a parameter of a function

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/parser/ClassReportParser.kt

@@ -25,6 +25,7 @@ package dev.shreyaspatil.composeCompilerMetricsGenerator.core.parser
 
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.exception.ParsingException
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.mapper.ConditionMapper
+import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.RawContent
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.classes.ClassDetail
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.classes.ClassesReport
 
@@ -33,17 +34,16 @@ import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.classes.Class
  */
 object ClassReportParser : Parser<String, ClassesReport> {
     private val REGEX_RUNTIME_STABILITY = "<runtime stability> = (\\w+)".toRegex()
-    private val REGEX_CLASS_NAME = "(stable|unstable) class (\\w*)".toRegex()
+    private val REGEX_CLASS_NAME = "(stable|unstable|runtime) class (\\w*)".toRegex()
     private val REGEX_CLASS_FIELDS = "((\\w*) ((?:val|var) .*))".toRegex()
-    private val REGEX_ALL_CLASSES = "((?:stable|unstable) class \\w+ \\{\\s*(?:[^{}\\r\\n]|\\n|)*})".toRegex()
 
     /**
      * Parses all classes
      */
     override fun parse(content: String): ClassesReport {
         val errors = mutableListOf<ParsingException>()
-        val classes = REGEX_ALL_CLASSES.findAll(content)
-            .map { it.value }
+
+        val classes = getClasses(content)
             .mapNotNull { classBody ->
                 runCatching {
                     parseClassDetail(classBody)
@@ -55,6 +55,22 @@ object ClassReportParser : Parser<String, ClassesReport> {
         return ClassesReport(classes, errors.toList())
     }
 
+    internal fun getClasses(content: String): List<String> {
+        val lines = content.split("\n").filter { it.isNotBlank() }
+
+        val classIndexes = lines.mapIndexedNotNull { index, s ->
+            if (REGEX_CLASS_NAME.containsMatchIn(s)) {
+                index
+            } else {
+                null
+            }
+        }
+
+        return classIndexes.mapIndexed { index: Int, item: Int ->
+            lines.subList(item, classIndexes.getOrElse(index + 1) { lines.size }).joinToString(separator = "\n")
+        }
+    }
+
     /**
      * Parses unit class
      */
@@ -70,6 +86,12 @@ object ClassReportParser : Parser<String, ClassesReport> {
         val fields = REGEX_CLASS_FIELDS.findAll(classBody).map { it.groupValues }.filter { it.isNotEmpty() }
             .map { ClassDetail.Field(it[2], it[3]) }.toList()
 
-        return ClassDetail(className, stability, runtimeStability, fields = fields)
+        return ClassDetail(
+            className = className,
+            stability = stability,
+            runtimeStability = runtimeStability,
+            fields = fields,
+            rawContent = RawContent(classBody)
+        )
     }
 }

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/parser/ComposableReportParser.kt

@@ -25,16 +25,14 @@ package dev.shreyaspatil.composeCompilerMetricsGenerator.core.parser
 
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.exception.ParsingException
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.mapper.ConditionMapper
+import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.RawContent
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.composables.ComposableDetail
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.model.composables.ComposablesReport
 
 /**
  * Parses [ComposablesReport] from the [String] content.
  */
 object ComposableReportParser : Parser<String, ComposablesReport> {
-    private val REGEX_ALL_COMPOSABLES_FUNCTIONS =
-        "(.*(\\s|\\S)fun \\w*\\([\\s\\S]*?^\\))".toRegex(RegexOption.MULTILINE)
-
     private val REGEX_COMPOSABLE_FUNCTION = "(?:(.*))fun (\\w*)".toRegex()
     private val REGEX_COMPOSABLE_PARAMETERS = "(?:(stable|unstable|) (\\w*:\\s.*))".toRegex()
 
@@ -43,8 +41,8 @@ object ComposableReportParser : Parser<String, ComposablesReport> {
      */
     override fun parse(content: String): ComposablesReport {
         val errors = mutableListOf<ParsingException>()
-        val composables = REGEX_ALL_COMPOSABLES_FUNCTIONS.findAll(content)
-            .map { it.value }
+
+        val composables = getComposableFunctions(content)
             .mapNotNull { function ->
                 runCatching {
                     parseComposableDetail(function)
@@ -57,6 +55,22 @@ object ComposableReportParser : Parser<String, ComposablesReport> {
         return ComposablesReport(composables, errors.toList())
     }
 
+    internal fun getComposableFunctions(content: String): List<String> {
+        val lines = content.split("\n").filter { it.isNotBlank() }
+
+        val composableFunIndexes = lines.mapIndexedNotNull { index, s ->
+            if (REGEX_COMPOSABLE_FUNCTION.containsMatchIn(s)) {
+                index
+            } else {
+                null
+            }
+        }
+
+        return composableFunIndexes.mapIndexed { index: Int, item: Int ->
+            lines.subList(item, composableFunIndexes.getOrElse(index + 1) { lines.size }).joinToString(separator = "\n")
+        }
+    }
+
     /**
      * Parses unit composable
      */
@@ -73,6 +87,13 @@ object ComposableReportParser : Parser<String, ComposablesReport> {
         val params = REGEX_COMPOSABLE_PARAMETERS.findAll(function).map { it.groupValues }.filter { it.isNotEmpty() }
             .map { ComposableDetail.Parameter(ConditionMapper.from(it[1]), it[2]) }.toList()
 
-        return ComposableDetail(functionName, isRestartable, isSkippable, isInline, params)
+        return ComposableDetail(
+            functionName = functionName,
+            isRestartable = isRestartable,
+            isSkippable = isSkippable,
+            isInline = isInline,
+            params = params,
+            rawContent = RawContent(function)
+        )
     }
 }

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-beta01 options_list
+    Usage: Compose Compiler Report to HTML Generator ~ v1.0.0-beta02 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-beta01"
+      id "dev.shreyaspatil.compose-compiler-report-generator" version "1.0.0-beta02"
     }
     ```
 
 === "Kotlin"
 
     ```kotlin title="build.gradle.kts"
     plugins {
-      id("dev.shreyaspatil.compose-compiler-report-generator") version "1.0.0-beta01"
+      id("dev.shreyaspatil.compose-compiler-report-generator") version "1.0.0-beta02"
     }    
     ```
 
@@ -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-beta01"
+        classpath "dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.0-beta02"
       }
     }
     ```
@@ -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-beta01")
+        classpath("dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.0-beta02")
       }
     }
     ```

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

@@ -51,9 +51,6 @@ fun Project.createComposeCompilerReportGenTaskForVariant(
         // and again runs this task then compose metrics won't be generated by compiler again
         startParameter.isRerunTasks = true
 
-        // For the same reason as above, disable caching for this task.
-        startParameter.isBuildCacheEnabled = false
-
         tasks = listOf("compile${variant.name.capitalized()}Kotlin")
 
         doFirst {

gradle.properties

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