refactor(static-html): Make the ProjectTable self-contained

Put all needed information into the project table, so that it is no more necessary to pass the project as a separate argument. Signed-off-by: Frank Viernau <frank_viernau@epam.com>
oss-review-toolkit · May 7, 2024 · e8360e6 · e8360e6
1 parent e547afa
commit e8360e6
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 8 deletions.
diff --git a/plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt b/plugins/reporters/static-html/src/main/kotlin/StaticHtmlReporter.kt
@@ -35,7 +35,6 @@ import org.ossreviewtoolkit.model.ArtifactProvenance
 import org.ossreviewtoolkit.model.HashAlgorithm
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.PackageProvider
-import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.Provenance
 import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.RepositoryProvenance
@@ -162,8 +161,8 @@ class StaticHtmlReporter : Reporter {
                         issueTable(tablesReport.advisorIssueSummary)
                     }
 
-                    tablesReport.projectDependencies.forEach { (project, table) ->
-                        projectTable(project, table)
+                    tablesReport.projectDependencies.forEach { (_, table) ->
+                        projectTable(table)
                     }
 
                     repositoryConfiguration(tablesReport.config)
@@ -386,12 +385,12 @@ class StaticHtmlReporter : Reporter {
         }
     }
 
-    private fun DIV.projectTable(project: Project, table: ProjectTable) {
+    private fun DIV.projectTable(table: ProjectTable) {
         val excludedClass = "ort-excluded".takeIf { table.isExcluded() }.orEmpty()
 
         h2 {
-            id = project.id.toCoordinates()
-            +"${project.id.toCoordinates()} (${table.fullDefinitionFilePath})"
+            id = table.id.toCoordinates()
+            +"${table.id.toCoordinates()} (${table.fullDefinitionFilePath})"
         }
 
         if (table.isExcluded()) {
@@ -405,7 +404,7 @@ class StaticHtmlReporter : Reporter {
             }
         }
 
-        project.vcsProcessed.let { vcsInfo ->
+        table.vcs.let { vcsInfo ->
             h3(excludedClass) { +"VCS Information" }
 
             table("ort-report-labels $excludedClass") {
@@ -446,7 +445,7 @@ class StaticHtmlReporter : Reporter {
 
             tbody {
                 table.rows.forEachIndexed { rowIndex, row ->
-                    projectRow(project.id.toCoordinates(), rowIndex + 1, row)
+                    projectRow(table.id.toCoordinates(), rowIndex + 1, row)
                 }
             }
         }

diff --git a/plugins/reporters/static-html/src/main/kotlin/TablesReport.kt b/plugins/reporters/static-html/src/main/kotlin/TablesReport.kt
@@ -105,6 +105,16 @@ internal data class IssueTable(
 }
 
 internal data class ProjectTable(
+    /**
+     * The identifier of the project.
+     */
+    val id: Identifier,
+
+    /**
+     * The (processed) VCS info of the project.
+     */
+    val vcs: VcsInfo,
+
     /**
      * The dependencies of this project.
      */

diff --git a/plugins/reporters/static-html/src/main/kotlin/TablesReportModelMapper.kt b/plugins/reporters/static-html/src/main/kotlin/TablesReportModelMapper.kt
@@ -167,6 +167,8 @@ private fun getProjectTable(input: ReporterInput, project: Project): ProjectTabl
     }
 
     return ProjectTable(
+        id = project.id,
+        vcs = project.vcsProcessed,
         rows = rows.sortedWith(compareByDescending<Row> { it.id == project.id }.thenBy { it.id }),
         fullDefinitionFilePath = input.ortResult.getDefinitionFilePathRelativeToAnalyzerRoot(project),
         pathExcludes = input.ortResult.getExcludes().findPathExcludes(project, input.ortResult)