From 8b5fabce0cfb2a6ea20634662acf31a8a1bd0ff3 Mon Sep 17 00:00:00 2001
From: Sriram Hariharan <sghsri@gmail.com>
Date: Mon, 6 Mar 2023 00:10:03 -0600
Subject: [PATCH] properly generating and formating instructor text

---
 src/shared/types/Course.ts                    | 51 ++++++++++++++-----
 .../injected/CoursePopup/CoursePopup.tsx      |  8 ++-
 2 files changed, 45 insertions(+), 14 deletions(-)

diff --git a/src/shared/types/Course.ts b/src/shared/types/Course.ts
index ce0b4938..cf2e0d13 100644
--- a/src/shared/types/Course.ts
+++ b/src/shared/types/Course.ts
@@ -76,27 +76,40 @@ export class Course {
         Object.assign(this, course);
     }
 
-    getInstructorString(options: {
-        /** The maximum number of instructors to show */
-        max?: number;
-        format: 'abbr' | 'first_last' | 'last' | 'full_name';
-    }): string {
-        const { max = 3, format } = options;
-
-        if (!this.instructors) {
-            return 'Undecided';
+    /**
+     * Get a string representation of the instructors for this course
+     * @param options - the options for how to format the instructor string
+     * @returns
+     */
+    getInstructorString(options: InstructorFormatOptions): string {
+        const { max = 3, format, prefix = '' } = options;
+        if (!this.instructors.length) {
+            return `${prefix} Undecided`;
         }
 
         const instructors = this.instructors.slice(0, max);
         switch (format) {
             case 'abbr':
-                return instructors.map(instructor => `${instructor.firstName?.[0]}. ${instructor.lastName}`).join(', ');
+                return (
+                    prefix +
+                    instructors
+                        .map(instructor => {
+                            let firstInitial = instructor.firstName?.[0];
+                            if (firstInitial) {
+                                firstInitial += '. ';
+                            }
+                            return `${firstInitial}${instructor.lastName}`;
+                        })
+                        .join(', ')
+                );
             case 'full_name':
-                return instructors.map(instructor => instructor.fullName).join(', ');
+                return prefix + instructors.map(instructor => instructor.fullName).join(', ');
             case 'first_last':
-                return instructors.map(instructor => `${instructor.firstName} ${instructor.lastName}`).join(', ');
+                return (
+                    prefix + instructors.map(instructor => `${instructor.firstName} ${instructor.lastName}`).join(', ')
+                );
             case 'last':
-                return instructors.map(instructor => instructor.lastName).join(', ');
+                return prefix + instructors.map(instructor => instructor.lastName).join(', ');
             default:
                 throw new Error(`Invalid Instructor String format: ${format}`);
         }
@@ -110,3 +123,15 @@ export type ScrapedRow = {
     element: HTMLTableRowElement;
     course: Course | null;
 };
+
+/**
+ * Options for how to format the instructor string
+ */
+type InstructorFormatOptions = {
+    /** a prefix to add to the string, ex: "with" Mike Scott */
+    prefix?: string;
+    /** The maximum number of instructors to show */
+    max?: number;
+    /** How do you want the names of the professors formatted */
+    format: 'abbr' | 'first_last' | 'last' | 'full_name';
+};
diff --git a/src/views/components/injected/CoursePopup/CoursePopup.tsx b/src/views/components/injected/CoursePopup/CoursePopup.tsx
index 6702d0c8..4d63fc23 100644
--- a/src/views/components/injected/CoursePopup/CoursePopup.tsx
+++ b/src/views/components/injected/CoursePopup/CoursePopup.tsx
@@ -33,7 +33,13 @@ export default function CoursePopup({ course, onClose }: Props) {
                         #{course.uniqueId}
                     </Link>
                 </Text>
-                
+                <Text size='medium'>
+                    {course.getInstructorString({
+                        prefix: 'with ',
+                        format: 'first_last',
+                        max: 3,
+                    })}
+                </Text>
             </Card>
         </Popup>
     );