Merge pull request #18 from PatilShreyas/v1.0.0-alpha03

Release v1.0.0 alpha03

Author: PatilShreyas

README.md

@@ -75,13 +75,14 @@ composeReport2Html -h
 Once you run, here's how it looks.
 
 ```shell
-Usage: Compose Compiler Report to HTML Generator options_list
+Usage: Compose Compiler Report to HTML Generator ~ v1.0.0-alpha03 options_list
 Options:
     --applicationName, -app -> Application name (To be displayed in the report) (always required) { String }
-    --overallStatsFile, -overallStatsReport -> Overall Statistics Metrics JSON file (always required) { String }
-    --detailedStatsFile, -detailedStatsMetrics -> Detailed Statistics Metrics CSV file (always required) { String }
-    --composableMetricsFile, -composableMetrics -> Composable Metrics TXT file (always required) { String }
-    --classMetricsFile, -classMetrics -> Class Metrics TXT file (always required) { String }
+    --inputDirectory, -i -> Input directory where composable report and metrics are available { String }
+    --overallStatsFile, -overallStatsReport -> Overall Statistics Metrics JSON files (separated by commas) { String }
+    --detailedStatsFile, -detailedStatsMetrics -> Detailed Statistics Metrics CSV files (separated by commas) { String }
+    --composableMetricsFile, -composableMetrics -> Composable Metrics TXT files (separated by commas) { String }
+    --classMetricsFile, -classMetrics -> Class Metrics TXT files (separated by commas) { String }
     --outputDirectory, -o -> Output directory name (always required) { String }
     --help, -h -> Usage info
 ```
@@ -95,32 +96,35 @@ this CLI utility to feed the data.
 
 To generate the report, provide details related to app, metric and report files and output directory.
 
+#### 3.1 When all metric and report files are available in the same directory
+
+Assuming report and metrics generated by Compose Compiler are available in one directory then you can specify path to 
+that directory only and utility will automatically pick files.
+
 ```shell
 java -jar composeReport2Html.jar \
-  -app <YOUR_APP_NAME> \
-  -overallStatsReport <PATH TO *-module.json FILE> \
-  -detailedStatsMetrics <PATH TO *-composables.csv FILE> \
-  -composableMetrics <PATH TO *-composables.txt FILE> \
-  -classMetrics <PATH TO *-classes.txt FILE> \
-  -o <OUTPUT DIRECTORY PATH FOR REPORT>
+  -app MyAppName \
+  -i composable_report \
+  -o htmlReportDir
 ```
 
-OR, directly use `composeReport2Html` (_if using NPM package_).
+#### 3.2 Provide path to individual report and metric files
 
-***Example Usage:***
+You can provide each metric/report file individually using separate parameters.
 
 ```shell
 java -jar composeReport2Html.jar \
-  -app NotyKT \
+  -app MyAppName \
   -overallStatsReport app_release-module.json \
   -detailedStatsMetrics app_release-composables.csv \
   -composableMetrics app_release-composables.txt \
   -classMetrics app_release-classes.txt \
-  -o notyReport
+  -o htmlReportDir
 ```
 
-In the above example, it will create report with name **"NotyKT"** with specified metric and report files and finally
-report will be generated in the specified path i.e. `notyReport/index.html`.
+_(Multiple files can be provided to the single parameter by separating path with commas)_
+
+***If you're using NPM package, directly use command: `composeReport2Html`***.
 
 ## Utility as a library
 

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

@@ -23,33 +23,39 @@
  */
 package dev.shreyaspatil.composeCompilerMetricsGenerator.cli
 
+import dev.shreyaspatil.composeCompilerMetricsGenerator.cli.file.ReportAndMetricsFileFinder
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.ComposeCompilerMetricsProvider
+import dev.shreyaspatil.composeCompilerMetricsGenerator.core.ComposeCompilerReportFiles
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.HtmlReportGenerator
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.ReportSpec
 import kotlinx.cli.ArgParser
 import kotlinx.cli.ArgType
 import kotlinx.cli.required
 import java.io.File
 import java.io.FileNotFoundException
+import java.nio.file.Path
 import java.nio.file.Paths
 
 /**
  * Entry point of a CLI application
  */
 fun main(args: Array<String>) {
-    val arguments = CliArguments(args)
+    val arguments = CliArguments(args, Paths.get("").toAbsolutePath())
 
     val reportSpec = ReportSpec(arguments.applicationName)
+    val inputFiles = arguments.getRequiredFiles()
 
     printHeader("Generating Composable HTML Report")
 
     val html = HtmlReportGenerator(
         reportSpec = reportSpec,
         metricsProvider = ComposeCompilerMetricsProvider(
-            briefStatisticsJsonFilePath = arguments.overallStatsFile,
-            detailedStatisticsJsonFilePath = arguments.detailedStatsFile,
-            composableReportFilePath = arguments.composableMetricsFile,
-            classesReportFilePath = arguments.classMetricsFile
+            ComposeCompilerReportFiles(
+                briefStatisticsJsonFiles = inputFiles.briefStatisticsJsonFilePath,
+                detailedStatisticsCsvFiles = inputFiles.detailedStatisticsJsonFilePath,
+                composableReportFiles = inputFiles.composableReportFilePath,
+                classesReportFiles = inputFiles.classesReportFilePath
+            )
         )
     ).generateHtml()
 
@@ -83,7 +89,7 @@ fun saveReportAsHtml(htmlContent: String, outputDirectory: String): String {
 /**
  * Parses and validates CLI arguments
  */
-class CliArguments(args: Array<String>) {
+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(
@@ -92,29 +98,35 @@ class CliArguments(args: Array<String>) {
         description = "Application name (To be displayed in the report)"
     ).required()
 
+    val inputDirectory by parser.option(
+        ArgType.String,
+        shortName = "i",
+        description = "Input directory where composable report and metrics are available"
+    )
+
     val overallStatsFile by parser.option(
         ArgType.String,
         shortName = "overallStatsReport",
-        description = "Overall Statistics Metrics JSON file"
-    ).required()
+        description = "Overall Statistics Metrics JSON files (separated by commas)"
+    )
 
     val detailedStatsFile by parser.option(
         ArgType.String,
         shortName = "detailedStatsMetrics",
-        description = "Detailed Statistics Metrics CSV file"
-    ).required()
+        description = "Detailed Statistics Metrics CSV files (separated by commas)"
+    )
 
     val composableMetricsFile by parser.option(
         ArgType.String,
         shortName = "composableMetrics",
-        description = "Composable Metrics TXT file"
-    ).required()
+        description = "Composable Metrics TXT files (separated by commas)"
+    )
 
     val classMetricsFile by parser.option(
         ArgType.String,
         shortName = "classMetrics",
-        description = "Class Metrics TXT file"
-    ).required()
+        description = "Class Metrics TXT files (separated by commas)"
+    )
 
     val outputDirectory by parser.option(
         ArgType.String,
@@ -129,28 +141,85 @@ class CliArguments(args: Array<String>) {
 
         require(applicationName.isNotBlank()) { "Application name should not be blank" }
         require(outputDirectory.isNotBlank()) { "Output directory path should not be blank" }
+    }
+
+    fun getRequiredFiles(): InputFiles {
+        val directory = inputDirectory
 
-        printHeader("Checking files")
-        listOf(overallStatsFile, detailedStatsFile, composableMetricsFile, classMetricsFile).forEach { filename ->
-            ensureFileExists(filename) { fileNotExistMessage(filename) }
+        val files = arrayOf(
+            overallStatsFile,
+            detailedStatsFile,
+            composableMetricsFile,
+            classMetricsFile
+        )
+
+        if (directory != null) {
+            ensureDirectory(directory) { "Directory '$directory' not exists" }
+            return findRequiredFilesInDirectory(directory)
+        } else if (files.all { !it.isNullOrBlank() }) {
+            return InputFiles(
+                briefStatisticsJsonFilePath = files(overallStatsFile!!),
+                detailedStatisticsJsonFilePath = files(detailedStatsFile!!),
+                composableReportFilePath = files(composableMetricsFile!!),
+                classesReportFilePath = files(classMetricsFile!!)
+            )
+        } else {
+            // Assume report and metric files available in the current working directory as specified in the `path`
+            val defaultDirectory = path.toAbsolutePath().toString()
+            return findRequiredFilesInDirectory(defaultDirectory)
         }
     }
 
-    companion object {
-        fun fileNotExistMessage(filename: String) = "File not exists with name '$filename'"
+    private fun findRequiredFilesInDirectory(directory: String): InputFiles {
+        val finder = ReportAndMetricsFileFinder(File(Paths.get(directory).toAbsolutePath().toString()))
+
+        return InputFiles(
+            briefStatisticsJsonFilePath = finder.findBriefStatisticsJsonFile(),
+            detailedStatisticsJsonFilePath = finder.findDetailsStatisticsCsvFile(),
+            composableReportFilePath = finder.findComposablesReportTxtFile(),
+            classesReportFilePath = finder.findClassesReportTxtFile()
+        )
+    }
+
+    private fun files(filenames: String): List<File> {
+        return filenames.split(",").map { ensureFileExists(it) { "File not exist: $it" } }
     }
+
+    /**
+     *
+     */
+    class InputFiles(
+        val briefStatisticsJsonFilePath: List<File>,
+        val detailedStatisticsJsonFilePath: List<File>,
+        val composableReportFilePath: List<File>,
+        val classesReportFilePath: List<File>
+    )
 }
 
 /**
  * Checks whether file with [filename] exists or not. Else throws [FileNotFoundException].
  */
-inline fun ensureFileExists(filename: String, lazyMessage: () -> Any) {
+inline fun ensureFileExists(filename: String, lazyMessage: () -> Any): File {
     val file = File(Paths.get(filename).toAbsolutePath().toString())
     println("Checking file '${file.absolutePath}'")
     if (!file.exists()) {
         val message = lazyMessage()
         throw FileNotFoundException(message.toString())
     }
+    return file
+}
+
+/**
+ * Checks whether directory with [name] exists or not.
+ * Else throws [FileNotFoundException].
+ */
+inline fun ensureDirectory(name: String, lazyMessage: () -> Any) {
+    val file = File(Paths.get(name).toAbsolutePath().toString())
+    println("Checking directory '${file.absolutePath}'")
+    if (!file.isDirectory) {
+        val message = lazyMessage()
+        throw FileNotFoundException(message.toString())
+    }
 }
 
 fun printHeader(header: String) = println(
@@ -161,5 +230,5 @@ fun printHeader(header: String) = println(
 )
 
 object Constants {
-    const val VERSION = "v1.0.0-alpha02"
+    const val VERSION = "v1.0.0-alpha03"
 }

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

@@ -0,0 +1,60 @@
+/**
+ * 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.cli.file
+
+import java.io.File
+
+/**
+ * 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()
+
+    fun findBriefStatisticsJsonFile(): List<File> {
+        return allFiles.filter { it.name.endsWith(FileSuffixes.MODULE_REPORT_JSON) }
+    }
+
+    fun findDetailsStatisticsCsvFile(): List<File> {
+        return allFiles.filter { it.name.endsWith(FileSuffixes.COMPOSABLES_STATS_METRICS_CSV) }
+    }
+
+    fun findComposablesReportTxtFile(): List<File> {
+        return allFiles.filter { it.name.endsWith(FileSuffixes.COMPOSABLES_REPORT_TXT) }
+    }
+
+    fun findClassesReportTxtFile(): List<File> {
+        return allFiles.filter { it.name.endsWith(FileSuffixes.CLASSES_REPORT_TXT) }
+    }
+
+    object FileSuffixes {
+        const val CLASSES_REPORT_TXT = "-classes.txt"
+        const val COMPOSABLES_REPORT_TXT = "-composables.txt"
+        const val COMPOSABLES_STATS_METRICS_CSV = "-composables.csv"
+        const val MODULE_REPORT_JSON = "-module.json"
+    }
+}