feat: support summer grades, fix summer course parser (#596)

* feat: support summer grades, fix summer course parser

* chore: lint

* docs: mention summer terms in Course::number description

* feat: Course::getNumberWithoutTerm, strip summer term indicator when displaying grades

---------

Co-authored-by: doprz <52579214+doprz@users.noreply.github.com>

src/shared/types/Course.ts

@@ -44,7 +44,12 @@ export type Semester = {
 export class Course {
     /** Every course has a uniqueId within UT's registrar system corresponding to each course section */
     uniqueId!: number;
-    /** This is the course number for a course, i.e CS 314 would be 314, MAL 306H would be 306H */
+    /**
+     * This is the course number for a course, i.e CS 314 would be 314, MAL 306H would be 306H.
+     * UT prefixes summer courses with f, s, n, or w:
+     * [f]irst term, [s]econd term, [n]ine week term, [w]hole term.
+     * So, the first term of PSY 301 over the summer would be 'f301'
+     */
     number!: string;
     /** The full name of the course, i.e. CS 314 Data Structures and Algorithms */
     fullName!: string;
@@ -91,6 +96,46 @@ export class Course {
         }
         this.colors = course.colors ? structuredClone(course.colors) : getCourseColors('emerald', 500);
         this.core = course.core ?? [];
+        if (course.semester.season === 'Summer') {
+            // A bug from and old version put the summer term in the course,
+            // so we need to handle that case
+            const { department, number } = Course.cleanSummerTerm(course.department, course.number);
+            this.department = department;
+            this.number = number;
+        }
+    }
+
+    /**
+     * Due to a bug in an older version, the summer term was included in the course department code,
+     * instead of the course number.
+     * UT prefixes summer courses with f, s, n, or w:
+     * [f]irst term, [s]econd term, [n]ine week term, [w]hole term
+     *
+     * @param department - The course department code, like 'C S'
+     * @param number - The course number, like '314H'
+     * @returns The properly formatted department and course number
+     * @example
+     * ```ts
+     * cleanSummerTerm('C S',  '314H') // { department: 'C S', number: '314H' }
+     * cleanSummerTerm('P R',  'f378') // { department: 'P R', number: 'f378' }
+     * cleanSummerTerm('P R f', '378') // { department: 'P R', number: 'f378' }
+     * cleanSummerTerm('P S',  'n303') // { department: 'P S', number: 'n303' }
+     * cleanSummerTerm('P S n', '303') // { department: 'P S', number: 'n303' }
+     * ```
+     */
+    static cleanSummerTerm(department: string, number: string): { department: string; number: string } {
+        // UT prefixes summer courses with f, s, n, or w:
+        // [f]irst term, [s]econd term, [n]ine week term, [w]hole term
+        const summerTerm = department.match(/[fsnw]$/);
+
+        if (!summerTerm) {
+            return { department, number };
+        }
+
+        return {
+            department: department.slice(0, -1).trim(),
+            number: summerTerm[0] + number,
+        };
     }
 
     /**
@@ -111,6 +156,18 @@ export class Course {
 
         return conflicts;
     }
+
+    /**
+     * @returns The course number without the summer term
+     * @example
+     * ```ts
+     * const c = new Course({ number: 'f301', ... });
+     * c.getNumberWithoutTerm() // '301'
+     * ```
+     */
+    getNumberWithoutTerm(): string {
+        return this.number.replace(/^\D/, ''); // Remove nondigit at start, if it exists
+    }
 }
 
 /**

src/shared/types/tests/Course.test.ts

@@ -0,0 +1,57 @@
+import { describe, expect, it } from 'vitest';
+
+import { Course } from '../Course';
+
+describe('Course::cleanSummerTerm', () => {
+    it("shouldn't affect already cleaned summer terms", () => {
+        const inputs = [
+            ['C S', '314H'],
+            ['P R', 'f378'],
+            ['P S', 'f303'],
+            ['WGS', 's301'],
+            ['S W', 'n360K'],
+            ['GOV', 'w312L'],
+            ['J', 's311F'],
+            ['J S', '311F'],
+        ] as const;
+        const expected = [
+            { department: 'C S', number: '314H' },
+            { department: 'P R', number: 'f378' },
+            { department: 'P S', number: 'f303' },
+            { department: 'WGS', number: 's301' },
+            { department: 'S W', number: 'n360K' },
+            { department: 'GOV', number: 'w312L' },
+            { department: 'J', number: 's311F' },
+            { department: 'J S', number: '311F' },
+        ];
+
+        const results = inputs.map(input => Course.cleanSummerTerm(input[0], input[1]));
+
+        expect(results).toEqual(expected);
+    });
+
+    it('should move summer term indicator to course number', () => {
+        const inputs = [
+            ['P R f', '378'],
+            ['P S f', '303'],
+            ['WGS s', '301'],
+            ['S W n', '360K'],
+            ['GOV w', '312L'],
+            ['J s', '311F'],
+            ['J S', '311F'],
+        ] as const;
+        const expected = [
+            { department: 'P R', number: 'f378' },
+            { department: 'P S', number: 'f303' },
+            { department: 'WGS', number: 's301' },
+            { department: 'S W', number: 'n360K' },
+            { department: 'GOV', number: 'w312L' },
+            { department: 'J', number: 's311F' },
+            { department: 'J S', number: '311F' },
+        ];
+
+        const results = inputs.map(input => Course.cleanSummerTerm(input[0], input[1]));
+
+        expect(results).toEqual(expected);
+    });
+});