Merge branch 'main' of github.com:PatilShreyas/compose-report-to-html

Author: PatilShreyas

.github/workflows/build.yml

@@ -7,22 +7,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
+      - name: Checkout branch
+        uses: actions/checkout@v3.5.3
 
-      - name: Set up JDK 11
-        uses: actions/setup-java@v1
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
-          java-version: 11
-
-      - name: Cache Gradle and wrapper
-        uses: actions/cache@v2
-        with:
-          path: |
-            ~/.gradle/caches
-            ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
-          restore-keys: |
-            ${{ runner.os }}-gradle-
+          java-version: 17
+          distribution: temurin
+          cache: gradle
 
       - name: Grant Permission to Execute
         run: chmod +x gradlew

.github/workflows/publish-docs.yml

@@ -11,12 +11,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout branch
+        uses: actions/checkout@v3.5.3
 
-      - name: set up JDK
-        uses: actions/setup-java@v1
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
-          java-version: 11
+          java-version: 17
+          distribution: temurin
+          cache: gradle
 
       - name: Setup Python
         uses: actions/setup-python@v2

.github/workflows/release.yml

@@ -10,22 +10,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
+      - name: Checkout branch
+        uses: actions/checkout@v3.5.3
 
-      - name: Set up JDK 11
-        uses: actions/setup-java@v1
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
-          java-version: 11
-
-      - name: Cache Gradle and wrapper
-        uses: actions/cache@v2
-        with:
-          path: |
-            ~/.gradle/caches
-            ~/.gradle/wrapper
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
-          restore-keys: |
-            ${{ runner.os }}-gradle-
+          java-version: 17
+          distribution: temurin
+          cache: gradle
 
       - name: Set up NPM
         uses: actions/setup-node@v3

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

@@ -98,14 +98,18 @@ fun saveReportAsHtml(
 /**
  * Parses and validates CLI arguments
  */
-class CliArguments(args: Array<String>, private val path: Path) {
+class CliArguments(
+    args: Array<String>,
+    private val path: Path,
+) {
     private val parser = ArgParser("Compose Compiler Report to HTML Generator ~ ${Constants.VERSION}")
 
-    val applicationName by parser.option(
-        ArgType.String,
-        shortName = "app",
-        description = "Application name (To be displayed in the report)",
-    ).required()
+    val applicationName by parser
+        .option(
+            ArgType.String,
+            shortName = "app",
+            description = "Application name (To be displayed in the report)",
+        ).required()
 
     val inputDirectory by parser.option(
         ArgType.String,
@@ -137,31 +141,36 @@ class CliArguments(args: Array<String>, private val path: Path) {
         description = "Class Metrics TXT files (separated by commas)",
     )
 
-    val outputDirectory by parser.option(
-        ArgType.String,
-        shortName = "o",
-        description = "Output directory name",
-    ).default(path.toAbsolutePath().toString())
-
-    val includeStableComposables by parser.option(
-        ArgType.Boolean,
-        description = "Whether to include stable Composable functions in the report",
-    ).default(true)
-
-    val includeStableClasses by parser.option(
-        ArgType.Boolean,
-        description = "Whether to include stable classes in the report",
-    ).default(true)
-
-    val includeClasses by parser.option(
-        ArgType.Boolean,
-        description = "Whether to include all the classes in the report",
-    ).default(true)
-
-    val showOnlyUnstableComposables by parser.option(
-        ArgType.Boolean,
-        description = "Whether to ONLY include unstable composables in the report",
-    ).default(false)
+    val outputDirectory by parser
+        .option(
+            ArgType.String,
+            shortName = "o",
+            description = "Output directory name",
+        ).default(path.toAbsolutePath().toString())
+
+    val includeStableComposables by parser
+        .option(
+            ArgType.Boolean,
+            description = "Whether to include stable Composable functions in the report",
+        ).default(true)
+
+    val includeStableClasses by parser
+        .option(
+            ArgType.Boolean,
+            description = "Whether to include stable classes in the report",
+        ).default(true)
+
+    val includeClasses by parser
+        .option(
+            ArgType.Boolean,
+            description = "Whether to include all the classes in the report",
+        ).default(true)
+
+    val showOnlyUnstableComposables by parser
+        .option(
+            ArgType.Boolean,
+            description = "Whether to ONLY include unstable composables in the report",
+        ).default(false)
 
     init {
         parser.parse(args)
@@ -195,22 +204,18 @@ class CliArguments(args: Array<String>, private val path: Path) {
         }
     }
 
-    private fun getRawReportProviderFromIndividualFiles(): ComposeCompilerRawReportProvider {
-        return ComposeCompilerRawReportProvider.FromIndividualFiles(
+    private fun getRawReportProviderFromIndividualFiles(): ComposeCompilerRawReportProvider =
+        ComposeCompilerRawReportProvider.FromIndividualFiles(
             briefStatisticsJsonFiles = files(overallStatsFile!!),
             detailedStatisticsCsvFiles = files(detailedStatsFile!!),
             composableReportFiles = files(composableMetricsFile!!),
             classesReportFiles = files(classMetricsFile!!),
         )
-    }
 
-    private fun getRawReportProviderFromDirectory(directory: String): ComposeCompilerRawReportProvider.FromDirectory {
-        return ComposeCompilerRawReportProvider.FromDirectory(File(Paths.get(directory).toAbsolutePath().toString()))
-    }
+    private fun getRawReportProviderFromDirectory(directory: String): ComposeCompilerRawReportProvider.FromDirectory =
+        ComposeCompilerRawReportProvider.FromDirectory(File(Paths.get(directory).toAbsolutePath().toString()))
 
-    private fun files(filenames: String): List<File> {
-        return filenames.split(",").map { ensureFileExists(it) { "File not exist: $it" } }
-    }
+    private fun files(filenames: String): List<File> = filenames.split(",").map { ensureFileExists(it) { "File not exist: $it" } }
 }
 
 fun printHeader(header: String) =

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/ComposeCompilerMetricsProvider.kt

@@ -101,7 +101,8 @@ private class DefaultComposeCompilerMetricsProvider(
             if (csv.size > 1) {
                 val headers = splitWithCsvSeparator(csv.first())
 
-                csv.subList(1, csv.size)
+                csv
+                    .subList(1, csv.size)
                     .map { splitWithCsvSeparator(it) }
                     .map { items -> RowItems(items.mapIndexed { index, value -> Item(headers[index], value) }) }
             } else {
@@ -111,13 +112,9 @@ private class DefaultComposeCompilerMetricsProvider(
         return DetailedStatistics(metrics)
     }
 
-    override fun getComposablesReport(): ComposablesReport {
-        return ComposableReportParser.parse(contentProvider.composablesReportContents)
-    }
+    override fun getComposablesReport(): ComposablesReport = ComposableReportParser.parse(contentProvider.composablesReportContents)
 
-    override fun getClassesReport(): ClassesReport {
-        return ClassReportParser.parse(contentProvider.classesReportContents)
-    }
+    override fun getClassesReport(): ClassesReport = ClassReportParser.parse(contentProvider.classesReportContents)
 
     private fun splitWithCsvSeparator(content: String) = content.split(",").filter { it.isNotBlank() }
 }

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/ComposeCompilerRawReportProvider.kt

@@ -54,7 +54,9 @@ sealed interface ComposeCompilerRawReportProvider {
     /**
      * Searches for files in the given [directory] and provides report and metric files found in that directory.
      */
-    class FromDirectory(directory: File) : ComposeCompilerRawReportProvider {
+    class FromDirectory(
+        directory: File,
+    ) : ComposeCompilerRawReportProvider {
         private val finder = ReportAndMetricsFileFinder(directory)
 
         override val briefStatisticsJsonFiles: List<File> = finder.findBriefStatisticsJsonFile()

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/ComposeMetricsContentProvider.kt

@@ -26,7 +26,9 @@ package dev.shreyaspatil.composeCompilerMetricsGenerator.core
 /**
  * Provides content of a composable report and metrics
  */
-class ComposeMetricsContentProvider(private val fileProvider: ComposeCompilerRawReportProvider) {
+class ComposeMetricsContentProvider(
+    private val fileProvider: ComposeCompilerRawReportProvider,
+) {
     val briefStatisticsContents: List<String> get() = fileProvider.briefStatisticsJsonFiles.map { it.readText() }
     val detailedStatisticsCsvRows: List<String> get() = fileProvider.detailedStatisticsCsvFiles.flatMap { it.readLines() }
     val composablesReportContents: String get() = fileProvider.composableReportFiles.joinToString(separator = "\n") { it.readText() }

core/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/core/file/ReportAndMetricsFileFinder.kt

@@ -24,34 +24,40 @@
 package dev.shreyaspatil.composeCompilerMetricsGenerator.core.file
 
 import java.io.File
+import java.nio.file.Files
 
 /**
  * Finds reports and metrics files generated by Compose compiler
  *
  * @param directory The directory in which files will be searched
  */
-class ReportAndMetricsFileFinder(directory: File) {
-    private val allFiles =
-        directory
-            .listFiles()
-            ?.filterNotNull()
-            ?: emptyList()
-
-    fun findBriefStatisticsJsonFile(): List<File> {
-        return allFiles.filter { it.name.endsWith(FileSuffixes.MODULE_REPORT_JSON) }
-    }
+class ReportAndMetricsFileFinder(
+    directory: File,
+) {
+    private val allFiles = directory.listAllFiles()
 
-    fun findDetailsStatisticsCsvFile(): List<File> {
-        return allFiles.filter { it.name.endsWith(FileSuffixes.COMPOSABLES_STATS_METRICS_CSV) }
-    }
+    fun findBriefStatisticsJsonFile(): List<File> = allFiles.filter { it.name.endsWith(FileSuffixes.MODULE_REPORT_JSON) }
 
-    fun findComposablesReportTxtFile(): List<File> {
-        return allFiles.filter { it.name.endsWith(FileSuffixes.COMPOSABLES_REPORT_TXT) }
-    }
+    fun findDetailsStatisticsCsvFile(): List<File> = allFiles.filter { it.name.endsWith(FileSuffixes.COMPOSABLES_STATS_METRICS_CSV) }
 
-    fun findClassesReportTxtFile(): List<File> {
-        return allFiles.filter { it.name.endsWith(FileSuffixes.CLASSES_REPORT_TXT) }
-    }
+    fun findComposablesReportTxtFile(): List<File> = allFiles.filter { it.name.endsWith(FileSuffixes.COMPOSABLES_REPORT_TXT) }
+
+    fun findClassesReportTxtFile(): List<File> = allFiles.filter { it.name.endsWith(FileSuffixes.CLASSES_REPORT_TXT) }
+
+    private fun File.listAllFiles(): List<File> =
+        buildList {
+            val currentPath = toPath()
+            Files.newDirectoryStream(currentPath).use { directoryStream ->
+                for (entry in directoryStream) {
+                    val file = entry.toFile() ?: continue
+                    if (Files.isDirectory(entry)) {
+                        addAll(file.listAllFiles())
+                    } else {
+                        add(file)
+                    }
+                }
+            }
+        }
 
     object FileSuffixes {
         const val CLASSES_REPORT_TXT = "-classes.txt"

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

@@ -28,7 +28,9 @@ package dev.shreyaspatil.composeCompilerMetricsGenerator.core.model
  *
  * @property items List of detailed items
  */
-data class DetailedStatistics(val items: List<RowItems>) {
+data class DetailedStatistics(
+    val items: List<RowItems>,
+) {
     /**
      * Headers of a report
      */
@@ -38,9 +40,14 @@ data class DetailedStatistics(val items: List<RowItems>) {
 /**
  * Model for holding list of name and value pairs i.e. item details
  */
-data class RowItems(val item: List<Item>)
+data class RowItems(
+    val item: List<Item>,
+)
 
 /**
  * Model representing name-value pairs
  */
-data class Item(val name: String, val value: String)
+data class Item(
+    val name: String,
+    val value: String,
+)

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

@@ -27,4 +27,6 @@ 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)
+data class RawContent(
+    val content: String,
+)