refactor(asciidoc)!: Make AsciiDocTemplateReporter abstract

Convert `AsciiDocTemplateReporter` to an abstract class. This allows to simplify the constructor by making `backend` an abstract property. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
oss-review-toolkit · Nov 9, 2024 · bd82abb · bd82abb
1 parent affb9fe
commit bd82abb
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 5 deletions.
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/AsciiDocTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/AsciiDocTemplateReporter.kt
@@ -42,7 +42,7 @@ import org.ossreviewtoolkit.utils.ort.createOrtTempDir
  * [3]: https://github.com/asciidoctor/asciidoctorj
  * [4]: https://docs.asciidoctor.org/asciidoctor/latest/convert/available
  */
-open class AsciiDocTemplateReporter(private val backend: String, override val type: String) : Reporter {
+abstract class AsciiDocTemplateReporter : Reporter {
     companion object {
         private const val ASCII_DOC_FILE_PREFIX = "AsciiDoc_"
         private const val ASCII_DOC_FILE_EXTENSION = "adoc"
@@ -53,6 +53,8 @@ open class AsciiDocTemplateReporter(private val backend: String, override val ty
         private const val DEFECT_TEMPLATE_ID = "defect_report"
     }
 
+    protected abstract val backend: String
+
     private val templateProcessor = FreemarkerTemplateProcessor(
         ASCII_DOC_TEMPLATE_DIRECTORY,
         ASCII_DOC_FILE_PREFIX,

diff --git a/plugins/reporters/asciidoc/src/main/kotlin/DocBookTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/DocBookTemplateReporter.kt
@@ -27,4 +27,7 @@ import org.ossreviewtoolkit.reporter.Reporter
  * [1]: https://docbook.org
  * [2]: https://freemarker.apache.org
  */
-class DocBookTemplateReporter : AsciiDocTemplateReporter("docbook", "DocBookTemplate")
+class DocBookTemplateReporter : AsciiDocTemplateReporter() {
+    override val backend = "docbook"
+    override val type = "DocBookTemplate"
+}
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/HtmlTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/HtmlTemplateReporter.kt
@@ -26,4 +26,7 @@ import org.ossreviewtoolkit.reporter.Reporter
  *
  * [1]: https://freemarker.apache.org
  */
-class HtmlTemplateReporter : AsciiDocTemplateReporter("html", "HtmlTemplate")
+class HtmlTemplateReporter : AsciiDocTemplateReporter() {
+    override val backend = "html"
+    override val type = "HtmlTemplate"
+}
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/ManPageTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/ManPageTemplateReporter.kt
@@ -26,4 +26,7 @@ import org.ossreviewtoolkit.reporter.Reporter
  *
  * [1]: https://freemarker.apache.org
  */
-class ManPageTemplateReporter : AsciiDocTemplateReporter("manpage", "ManPageTemplate")
+class ManPageTemplateReporter : AsciiDocTemplateReporter() {
+    override val backend = "manpage"
+    override val type = "ManPageTemplate"
+}
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/PdfTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/PdfTemplateReporter.kt
@@ -52,12 +52,15 @@ import org.ossreviewtoolkit.reporter.Reporter
  * [4]: https://github.com/asciidoctor/asciidoctorj-pdf
  * [5]: https://docs.asciidoctor.org/pdf-converter/latest/theme/
  */
-class PdfTemplateReporter : AsciiDocTemplateReporter("pdf", "PdfTemplate") {
+class PdfTemplateReporter : AsciiDocTemplateReporter() {
     companion object {
         private const val OPTION_PDF_THEME_FILE = "pdf.theme.file"
         private const val OPTION_PDF_FONTS_DIR = "pdf.fonts.dir"
     }
 
+    override val backend = "pdf"
+    override val type = "PdfTemplate"
+
     override fun processTemplateOptions(outputDir: File, options: MutableMap<String, String>): Attributes =
         Attributes.builder().apply {
             val pdfTheme = options.remove(OPTION_PDF_THEME_FILE)?.let { option ->