Add to the 120 credits on repeated courses

Resolve #141. Implemented according to my proposal during the meeting: - Lifting the total credits requirement out of the generated requirement json and special case it on frontend - As a result, it will not become part of requirement graph as desired. - In addition, the requirement json dropped from 2.5M to 800k!
cornell-dti · Feb 12, 2021 · 87fc51d · 87fc51d
1 parent 84ef322
commit 87fc51d
Show file tree

Hide file tree

Showing 9 changed files with 127 additions and 100 deletions.
diff --git a/src/requirements/__test__/__snapshots__/requirement-data-id.test.ts.snap b/src/requirements/__test__/__snapshots__/requirement-data-id.test.ts.snap
@@ -9,7 +9,6 @@ Array [
   "College-AG-Physical and Life Sciences",
   "College-AG-Quantitative Literacy",
   "College-AG-Social Sciences and Humanities",
-  "College-AG-Total Academic Credits",
   "College-AG-Written and Oral Expression",
   "College-AG-Written Expression",
   "College-AS-(PBS-AS) or (MQR-AS)",
@@ -22,8 +21,6 @@ Array [
   "College-AS-Liberal Arts",
   "College-AS-Mathematics & Quantitative Reasoning (MQR-AS)",
   "College-AS-Physical & Biological Sceiences (PBS-AS)",
-  "College-AS-Total Academic Credits",
-  "College-BU-Total Academic Credits",
   "College-EN-Advisor-Approved Electives",
   "College-EN-Chemistry",
   "College-EN-Computing",
@@ -38,12 +35,10 @@ Array [
   "College-HE-9 Credits In HE Outside Major",
   "College-HE-Human Ecology Credits",
   "College-HE-Technical Communication",
-  "College-HE-Total Academic Credits",
   "College-IL-Core Requirements",
   "College-IL-Distribution Requirements",
   "College-IL-First-Year Writing Seminars",
   "College-IL-ILR Advance Writing",
-  "College-IL-Total Academic Credits",
   "College-UNI-Physical Education",
   "College-UNI-Swim Test",
   "Major-AEM-AEM Concentration Requirement",

diff --git a/src/requirements/data/checkers-common.ts b/src/requirements/data/checkers-common.ts
@@ -1,5 +1,5 @@
 import { Course } from '../types';
-import { CREDITS_COURSE_ID, FWS_COURSE_ID } from './constants';
+import { FWS_COURSE_ID } from './constants';
 
 /**
  * @param courseName name of the course (as a code)
@@ -31,14 +31,6 @@ export const courseMatchesCode = (course: Course, code: string): boolean =>
 export const courseMatchesCodeOptions = (course: Course, codeOptions: readonly string[]): boolean =>
   codeOptions.some(code => ifCodeMatch(`${course.subject} ${course.catalogNbr}`, code));
 
-/**
- * @param course course object with useful information retrived from Cornell courses API.
- * @returns true if the course is AP/IB equivalent course or credit
- */
-export const courseIsAPIB = (course: Course): boolean =>
-  [CREDITS_COURSE_ID, FWS_COURSE_ID].includes(course.crseId) ||
-  ['AP', 'IB', 'CREDITS'].includes(course.subject);
-
 /**
  * Almost colleges have FWS requirements. Instead of writing them from scratch each time, call this
  * function.
@@ -51,17 +43,6 @@ export const courseIsFWS = (course: Course): boolean =>
   course.titleLong.includes('FWS:') ||
   (course.catalogSatisfiesReq?.includes('First-Year Writing Seminar') ?? false);
 
-/**
- * Used for total academic credit requirements for all colleges except EN and AR
- * @param course course object with useful information retrived from Cornell courses API.
- * @returns true if the course is not PE or 10** level
- */
-export const courseIsAllEligible = (course: Course): boolean =>
-  course.crseId === CREDITS_COURSE_ID ||
-  (!courseIsAPIB(course) &&
-    !ifCodeMatch(course.subject, 'PE') &&
-    !ifCodeMatch(course.catalogNbr, '10**'));
-
 /**
  * This function returns a checker that checks whether a course satisfy a single requirement by
  * checking whether the course code appears in the includes array.

diff --git a/src/requirements/data/colleges/ag.ts b/src/requirements/data/colleges/ag.ts
@@ -1,19 +1,6 @@
 import { Course, CollegeOrMajorRequirement } from '../../types';
 import { includesWithSingleRequirement } from '../checkers-common';
 
-const totalAcademicCreditsRequirement: CollegeOrMajorRequirement = {
-  name: 'Total Academic Credits',
-  description:
-    '120 academic credits are required for graduation. ' +
-    'A minimum of 100 credits must be in courses for which a letter grade was recieved. ' +
-    'PE courses do not count.',
-  source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11561',
-  checker: (course: Course): boolean => !['PE'].includes(course.subject),
-  subRequirementProgress: 'any-can-count',
-  fulfilledBy: 'credits',
-  minCount: 120,
-};
-
 const calsCreditsRequirement: CollegeOrMajorRequirement = {
   name: 'CALS Credits',
   description:
@@ -220,7 +207,6 @@ const calsWrittenExpressionRequirement: CollegeOrMajorRequirement = {
 };
 
 const calsRequirements: readonly CollegeOrMajorRequirement[] = [
-  totalAcademicCreditsRequirement,
   calsCreditsRequirement,
   calsIntroductoryLifeSciencesOrBiologyRequirement,
   calsPhysicalAndLifeSciencesRequirement,

diff --git a/src/requirements/data/colleges/as.ts b/src/requirements/data/colleges/as.ts
@@ -1,22 +1,7 @@
 import { Course, CollegeOrMajorRequirement } from '../../types';
-import {
-  courseIsFWS,
-  includesWithSingleRequirement,
-  courseIsAllEligible,
-} from '../checkers-common';
+import { courseIsFWS, includesWithSingleRequirement } from '../checkers-common';
 
 const casRequirements: readonly CollegeOrMajorRequirement[] = [
-  {
-    name: 'Total Academic Credits',
-    description:
-      '120 academic credits are required' +
-      'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
-    source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11570#credit-req',
-    checker: courseIsAllEligible,
-    subRequirementProgress: 'any-can-count',
-    fulfilledBy: 'credits',
-    minCount: 120,
-  },
   {
     name: 'A&S Credits',
     description:

diff --git a/src/requirements/data/colleges/bu.ts b/src/requirements/data/colleges/bu.ts
@@ -1,18 +1,5 @@
 import { CollegeOrMajorRequirement } from '../../types';
-import { courseIsAllEligible } from '../checkers-common';
 
-const businessRequirements: readonly CollegeOrMajorRequirement[] = [
-  {
-    name: 'Total Academic Credits',
-    description:
-      '120 academic credits are required' +
-      'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
-    source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11715',
-    checker: courseIsAllEligible,
-    subRequirementProgress: 'any-can-count',
-    fulfilledBy: 'credits',
-    minCount: 120,
-  },
-];
+const businessRequirements: readonly CollegeOrMajorRequirement[] = [];
 
 export default businessRequirements;
diff --git a/src/requirements/data/colleges/he.ts b/src/requirements/data/colleges/he.ts
@@ -1,19 +1,6 @@
 import { Course, CollegeOrMajorRequirement } from '../../types';
-import { courseIsAllEligible } from '../checkers-common';
 
 const humanEcologyRequirements: readonly CollegeOrMajorRequirement[] = [
-  {
-    name: 'Total Academic Credits',
-    description:
-      '120 academic credits are required' +
-      'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
-    source:
-      'http://courses.cornell.edu/content.php?catoid=41&navoid=11600#Cornell_Credit_Requirements',
-    checker: courseIsAllEligible,
-    subRequirementProgress: 'any-can-count',
-    fulfilledBy: 'credits',
-    minCount: 120,
-  },
   {
     name: 'Human Ecology Credits',
     description:

diff --git a/src/requirements/data/colleges/il.ts b/src/requirements/data/colleges/il.ts
@@ -3,21 +3,9 @@ import {
   courseIsFWS,
   includesWithSingleRequirement,
   includesWithSubRequirements,
-  courseIsAllEligible,
 } from '../checkers-common';
 
 const ilrRequirements: readonly CollegeOrMajorRequirement[] = [
-  {
-    name: 'Total Academic Credits',
-    description:
-      '120 academic credits are required' +
-      'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
-    source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11587',
-    checker: courseIsAllEligible,
-    subRequirementProgress: 'any-can-count',
-    fulfilledBy: 'credits',
-    minCount: 120,
-  },
   {
     name: 'Core Requirements',
     description:

diff --git a/src/requirements/decorated-requirements.json b/src/requirements/decorated-requirements.json
diff --git a/src/requirements/reqs-functions.ts b/src/requirements/reqs-functions.ts
@@ -1,4 +1,5 @@
 import store from '../store';
+import { CREDITS_COURSE_ID, FWS_COURSE_ID } from './data/constants';
 import buildRequirementFulfillmentGraphFromUserData from './requirement-graph-builder-from-user-data';
 import {
   CourseTaken,
@@ -8,6 +9,121 @@ import {
   GroupedRequirementFulfillmentReport,
 } from './types';
 
+type FulfillmentStatistics = {
+  readonly id: string;
+  readonly requirement: RequirementWithIDSourceType;
+  readonly courses: readonly (readonly CourseTaken[])[];
+} & RequirementFulfillmentStatistics;
+
+/**
+ * @param course course object with useful information retrived from Cornell courses API.
+ * @returns true if the course is AP/IB equivalent course or credit
+ */
+const courseIsAPIB = (course: CourseTaken): boolean =>
+  [CREDITS_COURSE_ID, FWS_COURSE_ID].includes(course.courseId) ||
+  ['AP', 'IB', 'CREDITS'].includes(course.subject);
+
+/**
+ * Used for total academic credit requirements for all colleges except EN and AR
+ * @param course course object with useful information retrived from Cornell courses API.
+ * @returns true if the course is not PE or 10** level
+ */
+const courseIsAllEligible = (course: CourseTaken): boolean =>
+  course.courseId === CREDITS_COURSE_ID ||
+  (!courseIsAPIB(course) && course.subject !== 'PE' && !course.number.startsWith('10'));
+
+const getTotalCreditsFulfillmentStatistics = (
+  college: string,
+  courses: readonly CourseTaken[]
+): FulfillmentStatistics | null => {
+  const requirementCommon = {
+    sourceType: 'College',
+    sourceSpecificName: college,
+    name: 'Total Academic Credits',
+    courses: [],
+    subRequirementProgress: 'any-can-count',
+    fulfilledBy: 'credits',
+    minCount: 120,
+  } as const;
+  let requirement: RequirementWithIDSourceType;
+  switch (college) {
+    case 'AG':
+      requirement = {
+        ...requirementCommon,
+        id: 'College-AG-total-credits',
+        description:
+          '120 academic credits are required for graduation. ' +
+          'A minimum of 100 credits must be in courses for which a letter grade was recieved. ' +
+          'PE courses do not count.',
+        source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11561',
+      };
+      break;
+    case 'AS':
+      requirement = {
+        ...requirementCommon,
+        id: 'College-AS-total-credits',
+        description:
+          '120 academic credits are required' +
+          'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
+        source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11570#credit-req',
+      };
+      break;
+    case 'HE':
+      requirement = {
+        ...requirementCommon,
+        id: 'College-HE-total-credits',
+        description:
+          '120 academic credits are required' +
+          'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
+        source:
+          'http://courses.cornell.edu/content.php?catoid=41&navoid=11600#Cornell_Credit_Requirements',
+      };
+      break;
+    case 'IL':
+      requirement = {
+        ...requirementCommon,
+        id: 'College-IL-total-credits',
+        description:
+          '120 academic credits are required' +
+          'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
+        source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11587',
+      };
+      break;
+    case 'BU':
+      requirement = {
+        ...requirementCommon,
+        id: 'College-BU-total-credits',
+        description:
+          '120 academic credits are required' +
+          'PE courses and courses numbered 1000-1099 do not count towards the 120 credits',
+        source: 'http://courses.cornell.edu/content.php?catoid=41&navoid=11715',
+      };
+      break;
+    default:
+      return null;
+  }
+
+  let minCountFulfilled = 0;
+  if (college === 'AG') {
+    courses.forEach(course => {
+      if (course.subject !== 'PE') minCountFulfilled += course.credits;
+    });
+  } else {
+    courses.forEach(course => {
+      if (courseIsAllEligible(course)) minCountFulfilled += course.credits;
+    });
+  }
+
+  return {
+    id: requirement.id,
+    requirement,
+    courses: [],
+    fulfilledBy: 'credits',
+    minCountFulfilled,
+    minCountRequired: 120,
+  };
+};
+
 function computeFulfillmentStatisticsFromCourses(
   coursesThatFulfilledRequirement: readonly (readonly CourseTaken[])[],
   counting: 'courses' | 'credits',
@@ -163,12 +279,14 @@ export default function computeRequirements(
     minors
   );
 
-  type FulfillmentStatistics = {
-    readonly id: string;
-    readonly requirement: RequirementWithIDSourceType;
-    readonly courses: readonly (readonly CourseTaken[])[];
-  } & RequirementFulfillmentStatistics;
   const collegeFulfillmentStatistics: FulfillmentStatistics[] = [];
+  const totalCreditsFulfillmentStatistics = getTotalCreditsFulfillmentStatistics(
+    college,
+    coursesTaken
+  );
+  if (totalCreditsFulfillmentStatistics != null) {
+    collegeFulfillmentStatistics.push(totalCreditsFulfillmentStatistics);
+  }
   const majorFulfillmentStatisticsMap = new Map<string, FulfillmentStatistics[]>();
   const minorFulfillmentStatisticsMap = new Map<string, FulfillmentStatistics[]>();
   requirementFulfillmentGraph.getAllRequirements().forEach(requirement => {