Fix/3316/rawtextparser asking twice

CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ## [unreleased] (Added 🚀 | Changed | Removed 🗑 | Fixed 🐞 | Chore 👨‍💻 👩‍💻)
 
+### Changed
+
+-   Changed short form of parameter `--file-extensions` of RawTextParser from `-f` to `-fe` [#3405](https://github.com/MaibornWolff/codecharta/pull/3405)
+-   Update readme and gh-pages for RawTextParser [#3405](https://github.com/MaibornWolff/codecharta/pull/3405)
+
+### Fixed 🐞
+
+-   Fix RawTextParser producing incorrect output when no (or multiple) file extensions were specified in interactive mode [#3405](https://github.com/MaibornWolff/codecharta/pull/3405)
+
 ## [1.120.1] - 2023-11-17
 
 ### Removed 🗑

analysis/parser/RawTextParser/README.md

@@ -9,28 +9,33 @@ This parser analyzes code regardless of the programming language used to generat
 ## Parameters
 
 ```
-Usage: rawtextparser [-hv] [--withoutDefaultExcludes]
-                     [--maxIndentationLevel=<maxIndentLvl>]
-                     [--tabWidth=<tabWith>] [-o=<outputFile>]
-                     [-p=<projectName>] [-e=<exclude>]... [-m
-                     [=<metrics>...]]... FILE or FOLDER
+Usage: rawtextparser [-hv] [-nc] [--without-default-excludes]
+                          [--max-indentation-level=<maxIndentLvl>]
+                          [-o=<outputFile>] [--tab-width=<tabWidth>]
+                          [-e=<exclude>]... [-fe=<fileExtensions>[\s*,
+                          \s*<fileExtensions>...]]... [-m[=<metrics>...]]...
+                          FILE or FOLDER
 generates cc.json from projects or source code files
-      FILE or FOLDER         file/project to parse
-      --maxIndentationLevel=<maxIndentLvl>
-                             maximum Indentation Level (default 10)
-      --tabWidth=<tabWith>   tab width used (estimated if not provided)
-      --withoutDefaultExcludes
-                             include build, target, dist, resources and out folders
-                               as well as files/folders starting with '.'
-  -e, --exclude=<exclude>    exclude file/folder according to regex pattern
-  -h, --help                 displays this help and exits
+      FILE or FOLDER        file/project to parse
+  -e, --exclude=<exclude>   exclude file/folder according to regex pattern
+      -fe, --file-extensions=<fileExtensions>[\s*,\s*<fileExtensions>...]
+                            parse only files with specified extensions
+                              (default: any)
+  -h, --help                displays this help and exits
   -m, --metrics[=<metrics>...]
-                             metrics to be computed (select all if not specified)
-  -o, --outputFile=<outputFile>
-                             output File (or empty for stdout)
-  -p, --projectName=<projectName>
-                             project name
-  -v, --verbose              verbose mode
+                            metrics to be computed (select all if not specified)
+      --max-indentation-level=<maxIndentLvl>
+                            maximum Indentation Level (default 10)
+      -nc, --not-compressed save uncompressed output File
+  -o, --output-file=<outputFile>
+                            output File (or empty for stdout)
+      --tab-width=<tabWidth>
+                            tab width used (estimated if not provided)
+  -v, --verbose             verbose mode
+      --without-default-excludes
+                            include build, target, dist, resources and out
+                              folders as well as files/folders starting with
+                              '.'
 ```
 
 ## Examples
@@ -42,7 +47,7 @@ ccsh rawtextparser foo/bar/project
 ```
 
 ```
-ccsh rawtextparser foo.txt --maxIndentationLevel=6 tabWidth=4 --metrics=IndentationLevel
+ccsh rawtextparser foo.txt --max-indentation-level=6 tab-width=4 --metrics=IndentationLevel
 ```
 
 ```

analysis/parser/RawTextParser/build.gradle

@@ -12,6 +12,7 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter', version: junit5_version
     testImplementation group: 'org.assertj', name: 'assertj-core', version: assertj_version
     testImplementation group: 'io.mockk', name: 'mockk', version: mockk_version
+    testImplementation group: 'org.skyscreamer', name: 'jsonassert', version: '1.5.1'
 }
 
 test {

analysis/parser/RawTextParser/src/main/kotlin/de/maibornwolff/codecharta/parser/rawtextparser/MetricCollector.kt

@@ -58,7 +58,10 @@ class MetricCollector(
     }
 
     private fun isParsableFileExtension(path: String): Boolean {
-        return fileExtensions.isEmpty() || fileExtensions.contains(path.substringAfterLast("."))
+        return fileExtensions.isEmpty() ||
+               fileExtensions.contentEquals(arrayOf("")) ||
+               fileExtensions.contains(path.substringAfterLast(".")) ||
+               fileExtensions.contains(".${path.substringAfterLast(".")}")
     }
 
     private fun isPathExcluded(path: String): Boolean {

analysis/parser/RawTextParser/src/main/kotlin/de/maibornwolff/codecharta/parser/rawtextparser/ParserDialog.kt

@@ -18,7 +18,7 @@ class ParserDialog {
             )
 
             val outputFileName: String = KInquirer.promptInput(
-                message = "What is the name of the output file?",
+                message = "What is the name of the output file (leave empty to print to stdout)?",
             )
 
             val isCompressed = (outputFileName.isEmpty()) || KInquirer.promptConfirm(
@@ -44,7 +44,7 @@ class ParserDialog {
                 KInquirer.promptInput(message = "Do you want to exclude file/folder according to regex pattern?", default = "", hint = "regex1, regex2.. (leave empty if you don't want to exclude anything)")
 
             val fileExtensions: String =
-                KInquirer.promptInput(message = "Do you want to exclude file/folder according to regex pattern?", default = "", hint = "regex1, regex2.. (leave empty if you don't want to exclude anything)")
+                KInquirer.promptInput(message = "Do you only want to parse files with specific file-extensions? ", default = "", hint = "fileType1, fileType2... (leave empty to include all file-extensions)")
 
             val withoutDefaultExcludes: Boolean =
                 KInquirer.promptConfirm(message = "Do you want to include build, target, dist, resources and out folders as well as files/folders starting with '.'?", default = false)

analysis/parser/RawTextParser/src/main/kotlin/de/maibornwolff/codecharta/parser/rawtextparser/RawTextParser.kt

@@ -8,6 +8,7 @@ import de.maibornwolff.codecharta.tools.interactiveparser.InteractiveParser
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 import de.maibornwolff.codecharta.tools.interactiveparser.util.CodeChartaConstants
 import de.maibornwolff.codecharta.util.InputHelper
+import mu.KotlinLogging
 import picocli.CommandLine
 import java.io.File
 import java.io.IOException
@@ -27,6 +28,8 @@ class RawTextParser(
     private val error: PrintStream = System.err,
 ) : Callable<Void>, InteractiveParser {
 
+    private val logger = KotlinLogging.logger {}
+
     private val DEFAULT_EXCLUDES = arrayOf("/out/", "/build/", "/target/", "/dist/", "/resources/", "/\\..*")
 
     @CommandLine.Option(names = ["-h", "--help"], usageHelp = true, description = ["displays this help and exits"])
@@ -61,8 +64,9 @@ class RawTextParser(
     private var exclude: Array<String> = arrayOf()
 
     @CommandLine.Option(
-        names = ["-f", "--file-extensions"],
-        description = ["parse only files with specified extensions (defualt: any)"]
+        names = ["-fe", "--file-extensions"],
+        description = ["parse only files with specified extensions (default: any)"],
+        split = "\\s*,\\s*"
     )
     private var fileExtensions: Array<String> = arrayOf()
 
@@ -97,6 +101,15 @@ class RawTextParser(
         val parameterMap = assembleParameterMap()
         val results: Map<String, FileMetrics> =
             MetricCollector(inputFile!!, exclude, fileExtensions, parameterMap, metrics).parse()
+        println()
+
+        if (results.isEmpty()) {
+            println()
+            logger.error("No files with specified file extension(s) were found within the given folder - not generating an output file!")
+            return null
+        }
+
+        logWarningsForNotFoundFileExtensions(results)
 
         val pipedProject = ProjectDeserializer.deserializeProject(input)
         val project = ProjectGenerator().generate(results, pipedProject)
@@ -114,6 +127,25 @@ class RawTextParser(
         ).filterValues { it != null }.mapValues { it.value as Int }
     }
 
+    private fun logWarningsForNotFoundFileExtensions(results: Map<String, FileMetrics>) {
+        val notFoundFileExtensions = mutableListOf<String>()
+        for (fileExtension in fileExtensions) {
+            var isFileExtensionIncluded = false
+            for (relativeFileName in results.keys) {
+                if (relativeFileName.contains(fileExtension)) {
+                    isFileExtensionIncluded = true
+                }
+            }
+            if (!isFileExtensionIncluded) {
+                notFoundFileExtensions.add(fileExtension)
+            }
+        }
+        if (notFoundFileExtensions.isNotEmpty()) {
+            println()
+            notFoundFileExtensions.forEach { logger.warn("The specified file extension '$it' was not found within the given folder!") }
+        }
+    }
+
     override fun getDialog(): ParserDialogInterface = ParserDialog
     override fun isApplicable(resourceToBeParsed: String): Boolean {
         println("Checking if RawTextParser is applicable...")

analysis/parser/RawTextParser/src/test/kotlin/de/maibornwolff/codecharta/rawtextparser/MetricCollectorTest.kt

@@ -8,21 +8,21 @@ import java.io.File
 class MetricCollectorTest {
     @Test
     fun `Should collect information about a single file`() {
-        val result = MetricCollector(File("src/test/resources/sampleproject/tabs.xyz").absoluteFile).parse()
+        val result = MetricCollector(File("src/test/resources/sampleproject/tabs.included").absoluteFile).parse()
 
         Assertions.assertThat(result.size).isEqualTo(1)
-        Assertions.assertThat(result).containsKey("/tabs.xyz")
-        Assertions.assertThat(result["/tabs.xyz"]?.metricMap).isNotEmpty
+        Assertions.assertThat(result).containsKey("/tabs.included")
+        Assertions.assertThat(result["/tabs.included"]?.metricMap).isNotEmpty
     }
 
     @Test
     fun `Should collect information about all files within a project`() {
         val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile).parse()
 
-        Assertions.assertThat(result.size).isEqualTo(4)
-        Assertions.assertThat(result).containsKey("/tabs.xyz")
-        Assertions.assertThat(result).containsKey("/spaces/spaces_3.xyz")
-        Assertions.assertThat(result["/tabs.xyz"]?.metricMap).isNotEmpty
+        Assertions.assertThat(result.size).isEqualTo(5)
+        Assertions.assertThat(result).containsKey("/tabs.included")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_3.included")
+        Assertions.assertThat(result["/tabs.included"]?.metricMap).isNotEmpty
     }
 
     @Test
@@ -33,18 +33,59 @@ class MetricCollectorTest {
     }
 
     @Test
-    fun `Should exlude regex patterns`() {
-        val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, exclude = arrayOf(".*\\.xyz", "foobar")).parse()
+    fun `Should exclude regex patterns`() {
+        val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, exclude = arrayOf(".*\\.excluded$", "foobar")).parse()
 
-        Assertions.assertThat(result.size).isEqualTo(1)
-        Assertions.assertThat(result).containsKey("/spaces/spaces_xyz.wrong")
+        Assertions.assertThat(result.size).isEqualTo(4)
+        Assertions.assertThat(result).containsKey("/spaces/spaces_3.included")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_5.includedtoo")
+        Assertions.assertThat(result).doesNotContainKey("/spaces/spaces_x_not_included.excluded")
     }
 
     @Test
-    fun `Should include only spedified File extensions`() {
-        val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, fileExtensions = arrayOf("wrong")).parse()
+    fun `Should include only specified File extension with one given`() {
+        val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, fileExtensions = arrayOf("includedtoo")).parse()
 
         Assertions.assertThat(result.size).isEqualTo(1)
-        Assertions.assertThat(result).containsKey("/spaces/spaces_xyz.wrong")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_5.includedtoo")
+        Assertions.assertThat(result).doesNotContainKey("/spaces/spaces_3.included")
+        Assertions.assertThat(result).doesNotContainKey("tabs.included")
+    }
+
+    @Test
+    fun `Should include only specified File extensions with multiple given`() {
+        val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, fileExtensions = arrayOf("included", "includedtoo")).parse()
+
+        Assertions.assertThat(result.size).isEqualTo(4)
+        Assertions.assertThat(result).containsKey("/spaces/spaces_3.included")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_4.included")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_5.includedtoo")
+        Assertions.assertThat(result).doesNotContainKey("/spaces/spaces_x_not_included.excluded")
+    }
+
+    @Test
+    fun `Should include all Files when no specific extensions were given (default for interactive mode)`() {
+        val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, fileExtensions = arrayOf("")).parse()
+
+        Assertions.assertThat(result.size).isEqualTo(5)
+        Assertions.assertThat(result).containsKey("/spaces/spaces_x_not_included.excluded")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_3.included")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_4.included")
+        Assertions.assertThat(result).containsKey("/spaces/spaces_5.includedtoo")
+        Assertions.assertThat(result).containsKey("/tabs.included")
+    }
+
+    @Test
+    fun `Should produce empty result if no valid file extensions were given`() {
+        val result = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, fileExtensions = arrayOf("none")).parse()
+        Assertions.assertThat(result.size).isEqualTo(0)
+    }
+
+    @Test
+    fun `Should produce the same result whether the user included a dot in the filetype or not`() {
+        val resultWithoutDot = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, fileExtensions = arrayOf("included", "includedtoo")).parse()
+        val resultWithDot = MetricCollector(File("src/test/resources/sampleproject").absoluteFile, fileExtensions = arrayOf(".included", ".includedtoo")).parse()
+
+        Assertions.assertThat(resultWithoutDot == resultWithDot)
     }
 }