changes to the ts part

jplag · Aug 9, 2023 · 7e37aaa · 7e37aaa
1 parent 007d777
commit 7e37aaa
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 9 deletions.
diff --git a/report-viewer/src/model/HundredValueDistribution.ts b/report-viewer/src/model/HundredValueDistribution.ts
@@ -1,5 +1,9 @@
 import Distribution from './Distribution'
 
+/**
+ * This class represents he JPlag Distribution of a metric.
+ * It is composed of 100 values, each representing the sum of the values of the metric in the corresponding percentile.
+ */
 export default class HundredValueDistribution extends Distribution {
   constructor(distribution: number[]) {
     super(distribution)

diff --git a/report-viewer/src/model/Overview.ts b/report-viewer/src/model/Overview.ts
@@ -41,7 +41,8 @@ export class Overview {
     this._durationOfExecution = durationOfExecution
     this._topComparisons = topComparisons
     this._distributions = distributions
-    ;(this._clusters = clusters), (this._totalComparisons = totalComparisons)
+    this._clusters = clusters
+    this._totalComparisons = totalComparisons
   }
 
   /**

diff --git a/report-viewer/src/model/TenValueDistribution.ts b/report-viewer/src/model/TenValueDistribution.ts
@@ -1,5 +1,9 @@
 import Distribution from './Distribution'
 
+/**
+ * This class represents he JPlag Distribution of a metric.
+ * It is composed of 10 values, each representing the sum of the values of the metric in the corresponding percentiles.
+ */
 export default class TenValueDistribution extends Distribution {
   constructor(distribution: number[]) {
     super(distribution)

diff --git a/report-viewer/src/model/factories/BaseFactory.ts b/report-viewer/src/model/factories/BaseFactory.ts
@@ -15,13 +15,14 @@ export class BaseFactory {
       return this.getLocalFile(path)
     } else if (store().state.zipModeUsed) {
       const index = Object.keys(store().state.files).find((name) => name.endsWith(path))
-      if (index != undefined) {
-        const file = store().state.files[index]
-        if (file != undefined) {
-          return file
-        }
+      if (index == undefined) {
+        throw new Error(`Could not find ${path} in zip file.`)
       }
-      throw new Error(`Could not find ${path} in zip file.`)
+      const file = store().state.files[index]
+      if (file == undefined) {
+        throw new Error(`Could not load ${path}.`)
+      }
+      return file
     } else if (store().state.singleModeUsed) {
       return store().state.singleFillRawContent
     }

diff --git a/report-viewer/src/model/factories/OverviewFactory.ts b/report-viewer/src/model/factories/OverviewFactory.ts
@@ -10,6 +10,9 @@ import { BaseFactory } from './BaseFactory'
 import PercentileDistribution from '../HundredValueDistribution'
 import TenValueDistribution from '../TenValueDistribution'
 
+/**
+ * Factory class for creating Overview objects
+ */
 export class OverviewFactory extends BaseFactory {
   static reportViewerVersion: Version =
     versionJson['report_viewer_version'] !== undefined
@@ -129,15 +132,15 @@ export class OverviewFactory extends BaseFactory {
     const averageSimilarities: Map<string, number> = new Map<string, number>()
     const comparisons = [] as Array<ComparisonListElement>
 
-    // Average
+    // Save the average similarities in a temporary map to combine them with the max similarities later
     for (const comparison of metrics[0].topComparisons as Array<Record<string, unknown>>) {
       averageSimilarities.set(
         (comparison.first_submission as string) + '-' + (comparison.second_submission as string),
         comparison.similarity as number
       )
     }
 
-    // Max
+    // Extract the max similarities and combine them with the average similarities
     let counter = 0
     for (const comparison of metrics[1].topComparisons as Array<Record<string, unknown>>) {
       const avg = averageSimilarities.get(