style: prepare semmantic commits for different configurations (#4275)

* style: prepare semmantic commits for different configurations

* refactor: remove semantic commit hotfix as it is not a part of it

* style: fix styling issues

* style: remove unused methods

* style: refactor to make it easier to understand

* refactor: cleed up functions that are only used in tests

* docs: add new hotfix commits to docs and changelog

---------

Co-authored-by: Christian Hühn <christian.huehn@maibornwolff.de>

Author: ChristianHuehn

analysis/CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 - Add new '--base-file' flag to unifiedparser and rawtextparser [#4270](https://github.com/MaibornWolff/codecharta/pull/4270)
 - UnifiedParser now automatically uses `.gitignore` files for file exclusion [#4254](https://github.com/MaibornWolff/codecharta/issues/4254)
 - RawTextParser now automatically uses `.gitignore` files for file exclusion [#4273](https://github.com/MaibornWolff/codecharta/issues/4273)
+- GitLogParser is now able to find commits that contain the word hotfixes 
 
 ### Removed
 

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/GitLogParser.kt

@@ -92,6 +92,7 @@ class GitLogParser(
                     "docs_commits",
                     "style_commits",
                     "refactor_commits",
+                    "hotfix_commits",
                     "test_commits",
                     "semantic_commit_ratio",
                     "hotfix_commit_ratio"

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/input/metrics/DefaultSemanticCommitStyle.kt

@@ -0,0 +1,46 @@
+package de.maibornwolff.codecharta.analysers.parsers.gitlog.input.metrics
+
+object DefaultSemanticCommitStyle {
+    private val defaultCommitTypes = listOf(
+        SemanticCommitType(
+            name = "feat",
+            metricName = "feat_commits",
+            description = "Feat Commits: Number of feature commits (starting with 'feat') for this file.",
+            matchPattern = MatchPattern.StartsWith("feat")
+        ),
+        SemanticCommitType(
+            name = "fix",
+            metricName = "fix_commits",
+            description = "Fix Commits: Number of bug fix commits (starting with 'fix') for this file.",
+            matchPattern = MatchPattern.StartsWith("fix")
+        ),
+        SemanticCommitType(
+            name = "docs",
+            metricName = "docs_commits",
+            description = "Docs Commits: Number of documentation commits (starting with 'docs') for this file.",
+            matchPattern = MatchPattern.StartsWith("docs")
+        ),
+        SemanticCommitType(
+            name = "style",
+            metricName = "style_commits",
+            description = "Style Commits: Number of style commits (starting with 'style') for this file.",
+            matchPattern = MatchPattern.StartsWith("style")
+        ),
+        SemanticCommitType(
+            name = "refactor",
+            metricName = "refactor_commits",
+            description = "Refactor Commits: Number of refactoring commits (starting with 'refactor') for this file.",
+            matchPattern = MatchPattern.StartsWith("refactor")
+        ),
+        SemanticCommitType(
+            name = "test",
+            metricName = "test_commits",
+            description = "Test Commits: Number of test commits (starting with 'test') for this file.",
+            matchPattern = MatchPattern.StartsWith("test")
+        )
+    )
+
+    fun getAllTypes(): List<SemanticCommitType> {
+        return defaultCommitTypes
+    }
+}

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/input/metrics/DocsCommits.kt

@@ -9,7 +9,7 @@ class HotfixCommitRatio : Metric {
     private var hotfixCommitsCount: Long = 0
 
     override fun description(): String {
-        return "Hotfix Commit Ratio: Ratio of hotfix commits to total commits for this file."
+        return "Hotfix Commit Ratio: Ratio of hotfix commits (containing 'hotfix') to total commits for this file."
     }
 
     override fun metricName(): String {
@@ -23,7 +23,7 @@ class HotfixCommitRatio : Metric {
     override fun registerCommit(commit: Commit) {
         totalCommitsCount++
 
-        if (SemanticCommitDetector.isHotfixCommit(commit.message)) {
+        if (commit.message.contains("hotfix", ignoreCase = true)) {
             hotfixCommitsCount++
         }
     }

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/input/metrics/FeatCommits.kt

@@ -3,23 +3,23 @@ package de.maibornwolff.codecharta.analysers.parsers.gitlog.input.metrics
 import de.maibornwolff.codecharta.analysers.parsers.gitlog.input.Commit
 
 class HotfixCommits : Metric {
-    private var hotfixCommitsCount: Long = 0
+    private var count: Long = 0
 
     override fun description(): String {
-        return "Hotfix Commits: Number of hotfix commits (containing 'hotfix' keyword) for this file."
+        return "Hotfix Commits: Number of hotfix commits (containing 'hotfix') for this file."
     }
 
     override fun metricName(): String {
         return "hotfix_commits"
     }
 
     override fun registerCommit(commit: Commit) {
-        if (SemanticCommitDetector.isHotfixCommit(commit.message)) {
-            hotfixCommitsCount++
+        if (commit.message.contains("hotfix", ignoreCase = true)) {
+            count++
         }
     }
 
     override fun value(): Number {
-        return hotfixCommitsCount
+        return count
     }
 }

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/input/metrics/HotfixCommitRatio.kt

@@ -0,0 +1,11 @@
+package de.maibornwolff.codecharta.analysers.parsers.gitlog.input.metrics
+
+sealed class MatchPattern {
+    abstract fun matches(message: String): Boolean
+
+    data class StartsWith(val prefix: String) : MatchPattern() {
+        override fun matches(message: String): Boolean {
+            return message.trim().startsWith(prefix, ignoreCase = true)
+        }
+    }
+}

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/input/metrics/HotfixCommits.kt

@@ -1,56 +1,50 @@
 package de.maibornwolff.codecharta.analysers.parsers.gitlog.input.metrics
 
-class MetricsFactory {
-    private val metricClasses: List<Class<out Metric>>
+data class MetricDefinition(
+    val metricName: String,
+    val factory: () -> Metric
+)
 
-    constructor() {
-        this.metricClasses = createAllMetrics().map { it.javaClass }
-    }
+class MetricsFactory(requestedMetrics: List<String> = emptyList()) {
+    private val metricDefinitions = createAllDefinitions().selectMetrics(requestedMetrics)
 
-    constructor(metricNames: List<String>) {
-        this.metricClasses =
-            createAllMetrics().filter { m -> metricNames.contains(m.metricName()) }.map { it.javaClass }
-    }
+    fun createMetrics(): List<Metric> = metricDefinitions.map { it.factory() }
 
-    private fun createMetric(clazz: Class<out Metric>): Metric {
-        try {
-            return clazz.getDeclaredConstructor().newInstance()
-        } catch (e: InstantiationException) {
-            throw IllegalArgumentException("metric $clazz not found.")
-        } catch (e: IllegalAccessException) {
-            throw IllegalArgumentException("metric $clazz not found.")
-        }
+    private fun createAllDefinitions(): List<MetricDefinition> {
+        val commitTypes = DefaultSemanticCommitStyle.getAllTypes()
+        val standard = createStandardDefinitions(commitTypes)
+        val dynamic = createCommitTypeDefinitions(commitTypes)
+        return standard + dynamic
     }
 
-    private fun createAllMetrics(): List<Metric> {
-        return listOf(
-            AbsoluteCodeChurn(),
-            AddedLines(),
-            DeletedLines(),
-            NumberOfAuthors(),
-            NumberOfOccurencesInCommits(),
-            RangeOfWeeksWithCommits(),
-            SuccessiveWeeksWithCommits(),
-            WeeksWithCommits(),
-            HighlyCoupledFiles(),
-            MedianCoupledFiles(),
-            AbsoluteCoupledChurn(),
-            AverageCodeChurnPerCommit(),
-            NumberOfRenames(),
-            AgeInWeeks(),
-            FeatCommits(),
-            FixCommits(),
-            DocsCommits(),
-            StyleCommits(),
-            RefactorCommits(),
-            TestCommits(),
-            HotfixCommits(),
-            SemanticCommitRatio(),
-            HotfixCommitRatio()
-        )
+    private fun createStandardDefinitions(commitTypes: List<SemanticCommitType>): List<MetricDefinition> = listOf(
+        MetricDefinition("abs_code_churn", { AbsoluteCodeChurn() }),
+        MetricDefinition("added_lines", { AddedLines() }),
+        MetricDefinition("deleted_lines", { DeletedLines() }),
+        MetricDefinition("number_of_authors", { NumberOfAuthors() }),
+        MetricDefinition("number_of_commits", { NumberOfOccurencesInCommits() }),
+        MetricDefinition("range_of_weeks_with_commits", { RangeOfWeeksWithCommits() }),
+        MetricDefinition("successive_weeks_with_commits", { SuccessiveWeeksWithCommits() }),
+        MetricDefinition("weeks_with_commits", { WeeksWithCommits() }),
+        MetricDefinition("highly_coupled_files", { HighlyCoupledFiles() }),
+        MetricDefinition("median_coupled_files", { MedianCoupledFiles() }),
+        MetricDefinition("abs_coupled_churn", { AbsoluteCoupledChurn() }),
+        MetricDefinition("avg_code_churn", { AverageCodeChurnPerCommit() }),
+        MetricDefinition("number_of_renames", { NumberOfRenames() }),
+        MetricDefinition("age_in_weeks", { AgeInWeeks() }),
+        MetricDefinition("semantic_commit_ratio", { SemanticCommitRatio(commitTypes) }),
+        MetricDefinition("hotfix_commits", { HotfixCommits() }),
+        MetricDefinition("hotfix_commit_ratio", { HotfixCommitRatio() })
+    )
+
+    private fun createCommitTypeDefinitions(commitTypes: List<SemanticCommitType>): List<MetricDefinition> = commitTypes.map { type ->
+        MetricDefinition(type.metricName, { SemanticCommitMetric(type) })
     }
 
-    fun createMetrics(): List<Metric> {
-        return metricClasses.map { createMetric(it) }
+    private fun List<MetricDefinition>.selectMetrics(names: List<String>): List<MetricDefinition> {
+        if (names.isEmpty()) {
+            return this
+        }
+        return filter { it.metricName in names }
     }
 }