refactor(Repository): Make vcs and vcsProcessed val using @JsonIg…

…nore Will be squashed later. Signed-off-by: Jens Keim <jens.keim@forvia.com>
oss-review-toolkit · Jun 27, 2024 · ca44715 · ca44715
1 parent 5ba7d76
commit ca44715
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 12 deletions.
diff --git a/evaluator/src/main/kotlin/ProjectSourceRule.kt b/evaluator/src/main/kotlin/ProjectSourceRule.kt
@@ -91,7 +91,7 @@ open class ProjectSourceRule(
     /**
      * Return the [VcsType] of the project's code repository.
      */
-    fun projectSourceGetVcsType(): VcsType = ortResult.repository.vcsProcessed().type
+    fun projectSourceGetVcsType(): VcsType = ortResult.repository.vcsProcessed.type
 
     /**
      * Return the file paths matching any of the given [glob expressions][patterns] with its file content matching

diff --git a/evaluator/src/main/kotlin/RuleSet.kt b/evaluator/src/main/kotlin/RuleSet.kt
@@ -159,7 +159,7 @@ fun ruleSet(
     licenseInfoResolver: LicenseInfoResolver = ortResult.createLicenseInfoResolver(),
     resolutionProvider: ResolutionProvider = DefaultResolutionProvider.create(),
     projectSourceResolver: SourceTreeResolver = SourceTreeResolver.forRemoteRepository(
-        ortResult.repository.vcsProcessed()
+        ortResult.repository.vcsProcessed
     ),
     configure: RuleSet.() -> Unit = { }
 ) = RuleSet(ortResult, licenseInfoResolver, resolutionProvider, projectSourceResolver).apply(configure)
diff --git a/helper-cli/src/main/kotlin/utils/Extensions.kt b/helper-cli/src/main/kotlin/utils/Extensions.kt
@@ -691,7 +691,7 @@ internal fun OrtResult.getScanResultFor(packageConfiguration: PackageConfigurati
  * tree.
  */
 internal fun OrtResult.getRepositoryPaths(): Map<String, Set<String>> {
-    val result = mutableMapOf(repository.vcsProcessed().url to mutableSetOf(""))
+    val result = mutableMapOf(repository.vcsProcessed.url to mutableSetOf(""))
 
     repository.nestedRepositories.mapValues { (path, provenance) ->
         if (provenance is RepositoryProvenance) {

diff --git a/model/src/main/kotlin/Repository.kt b/model/src/main/kotlin/Repository.kt
@@ -19,6 +19,7 @@
 
 package org.ossreviewtoolkit.model
 
+import com.fasterxml.jackson.annotation.JsonIgnore
 import com.fasterxml.jackson.annotation.JsonInclude
 
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
@@ -57,14 +58,18 @@ data class Repository(
         )
     }
 
-    fun vcs(): VcsInfo {
-        if (provenance is RepositoryProvenance) { return provenance.vcsInfo }
-        return VcsInfo.EMPTY
+    @JsonIgnore
+    val vcs = if (provenance is RepositoryProvenance) {
+        provenance.vcsInfo
+    } else {
+        VcsInfo.EMPTY
     }
 
-    fun vcsProcessed(): VcsInfo {
-        if (provenance is RepositoryProvenance) { return provenance.vcsInfo.normalize() }
-        return VcsInfo.EMPTY
+    @JsonIgnore
+    val vcsProcessed = if (provenance is RepositoryProvenance) {
+        provenance.vcsInfo.normalize()
+    } else {
+        VcsInfo.EMPTY
     }
 
     /**

diff --git a/plugins/reporters/cyclonedx/src/main/kotlin/CycloneDxReporter.kt b/plugins/reporters/cyclonedx/src/main/kotlin/CycloneDxReporter.kt
@@ -186,7 +186,7 @@ class CycloneDxReporter : Reporter {
             // distributable), just create a single BOM for all projects in that case for now. As there also is no
             // single correct project to pick for adding external references in that case, simply only use the global
             // repository VCS information here.
-            val vcs = input.ortResult.repository.vcsProcessed()
+            val vcs = input.ortResult.repository.vcsProcessed
             bom.addExternalReference(
                 ExternalReference.Type.VCS,
                 vcs.url,

diff --git a/plugins/reporters/opossum/src/main/kotlin/OpossumReporter.kt b/plugins/reporters/opossum/src/main/kotlin/OpossumReporter.kt
@@ -499,7 +499,7 @@ class OpossumReporter : Reporter {
     internal fun generateOpossumInput(input: ReporterInput, maxDepth: Int = Int.MAX_VALUE): OpossumInput {
         val opossumInput = OpossumInput()
 
-        opossumInput.addBaseUrl("/", input.ortResult.repository.vcs())
+        opossumInput.addBaseUrl("/", input.ortResult.repository.vcs)
 
         SpdxLicense.entries.forEach {
             val licenseText = input.licenseTextProvider.getLicenseText(it.id)

diff --git a/plugins/reporters/static-html/src/main/kotlin/TablesReportModelMapper.kt b/plugins/reporters/static-html/src/main/kotlin/TablesReportModelMapper.kt
@@ -48,7 +48,7 @@ internal object TablesReportModelMapper {
             .sortedBy { it.id }
 
         return TablesReport(
-            input.ortResult.repository.vcsProcessed(),
+            input.ortResult.repository.vcsProcessed,
             input.ortResult.repository.config,
             ruleViolations,
             getAnalyzerIssueSummaryTable(input),