From eb7a944532ba9b99e890d9fa1c45787dcbec33a0 Mon Sep 17 00:00:00 2001
From: jonasongg <120372506+jonasongg@users.noreply.github.com>
Date: Fri, 26 Jan 2024 13:45:04 +0800
Subject: [PATCH] [#2004] Remove redundant Segment class (#2085)

Remove Segment class, replace with AuthorshipFileSegment

The Segment class and AuthorshipFileSegment interface are equivalent in
their usage and their redundancy seems to be a remnant when the code
was migrated from JS to TS.

Let's remove the Segment class for consistency and to improve runtime
performance.
---
 frontend/src/components/c-segment-collection.vue |  4 ++--
 frontend/src/components/c-segment.vue            |  6 +++---
 frontend/src/utils/segment.ts                    | 13 -------------
 frontend/src/views/c-authorship.vue              | 15 +++++++--------
 4 files changed, 12 insertions(+), 26 deletions(-)
 delete mode 100644 frontend/src/utils/segment.ts

diff --git a/frontend/src/components/c-segment-collection.vue b/frontend/src/components/c-segment-collection.vue
index e305083a31..591dbb247d 100644
--- a/frontend/src/components/c-segment-collection.vue
+++ b/frontend/src/components/c-segment-collection.vue
@@ -7,7 +7,7 @@
 <script lang='ts'>
 import { defineComponent } from 'vue';
 import cSegment from './c-segment.vue';
-import Segment from '../utils/segment';
+import { AuthorshipFileSegment } from '../types/types';
 
 export default defineComponent({
   name: 'c-segment-collection',
@@ -16,7 +16,7 @@ export default defineComponent({
   },
   props: {
     segments: {
-      type: Array<Segment>,
+      type: Array<AuthorshipFileSegment>,
       required: true,
     },
     path: {
diff --git a/frontend/src/components/c-segment.vue b/frontend/src/components/c-segment.vue
index 0d3234ff1e..7e16cc5fd9 100644
--- a/frontend/src/components/c-segment.vue
+++ b/frontend/src/components/c-segment.vue
@@ -32,16 +32,16 @@
 </template>
 
 <script lang='ts'>
-import { defineComponent } from 'vue';
+import { defineComponent, PropType } from 'vue';
 import { mapState } from 'vuex';
-import Segment from '../utils/segment';
 import { StoreState } from '../types/vuex.d';
+import { AuthorshipFileSegment } from '../types/types';
 
 export default defineComponent({
   name: 'c-segment',
   props: {
     segment: {
-      type: Segment,
+      type: Object as PropType<AuthorshipFileSegment>,
       required: true,
     },
     path: {
diff --git a/frontend/src/utils/segment.ts b/frontend/src/utils/segment.ts
deleted file mode 100644
index 673cd52d18..0000000000
--- a/frontend/src/utils/segment.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-export default class Segment {
-  knownAuthor: string | null;
-
-  lineNumbers: Array<number>;
-
-  lines: Array<string>;
-
-  constructor(knownAuthor: string | null, lineNumbers: Array<number>, lines: Array<string>) {
-    this.knownAuthor = knownAuthor;
-    this.lineNumbers = lineNumbers;
-    this.lines = lines;
-  }
-}
diff --git a/frontend/src/views/c-authorship.vue b/frontend/src/views/c-authorship.vue
index 9fe5082b4c..706f650396 100644
--- a/frontend/src/views/c-authorship.vue
+++ b/frontend/src/views/c-authorship.vue
@@ -201,11 +201,10 @@ import minimatch from 'minimatch';
 import brokenLinkDisabler from '../mixin/brokenLinkMixin';
 import tooltipPositioner from '../mixin/dynamicTooltipMixin';
 import cSegmentCollection from '../components/c-segment-collection.vue';
-import Segment from '../utils/segment';
 import getNonRepeatingColor from '../utils/random-color-generator';
 import { StoreState } from '../types/vuex.d';
 import { FileResult, Line } from '../types/zod/authorship-type';
-import { AuthorshipFile } from '../types/types';
+import { AuthorshipFile, AuthorshipFileSegment } from '../types/types';
 import { FilesSortType, FilterType } from '../types/authorship';
 
 const filesSortDict = {
@@ -518,11 +517,11 @@ export default defineComponent({
       return name === '-';
     },
 
-    splitSegments(lines: Line[]): { segments: Segment[]; blankLineCount: number; } {
+    splitSegments(lines: Line[]): { segments: AuthorshipFileSegment[]; blankLineCount: number; } {
       // split into segments separated by knownAuthor
       let lastState: string | null;
       let lastId = -1;
-      const segments: Segment[] = [];
+      const segments: AuthorshipFileSegment[] = [];
       let blankLineCount = 0;
 
       lines.forEach((line, lineCount) => {
@@ -532,11 +531,11 @@ export default defineComponent({
         const knownAuthor = (line.author && isAuthorMatched) ? line.author.gitId : null;
 
         if (knownAuthor !== lastState || lastId === -1) {
-          segments.push(new Segment(
+          segments.push({
             knownAuthor,
-            [],
-            [],
-          ));
+            lineNumbers: [],
+            lines: [],
+          });
 
           lastId += 1;
           lastState = knownAuthor;