ahbeng/NUSMods

import { RawLesson } from '../types/modules';
import departments from './fixtures/departments.json';
import faculties from './fixtures/faculties.json';
import {
  cleanModuleInfo,
  getDepartmentCodeMap,
  getFacultyCodeMap,
  parseWorkload,
  getLessonCovidZones,
} from './GetSemesterData';

describe(getDepartmentCodeMap, () => {
  test('should map department codes to their description', () => {
    expect(getDepartmentCodeMap(departments)).toEqual({
      '001': 'Arts & Social Sciences',
      '00100ACAD1': 'FASS DO/Office of Programmes',
      '00101ACAD1': 'Chinese Studies',
      '00102ACAD1': 'Communications & New Media',
      '00103ACAD1': 'Economics',
      '00201ACAD1': 'Accounting',
      '00202ACAD1': 'Strategy and Policy',
      '00301ACAD1': 'Computer Science',
    });
  });
});

describe(getFacultyCodeMap, () => {
  test('should map faculty codes to their description', () => {
    expect(getFacultyCodeMap(faculties)).toEqual({
      '001': 'Faculty of Arts & Social Sci',
      '002': 'NUS Business School',
      '003': 'School of Computing',
      '004': 'Faculty of Dentistry',
    });
  });
});

describe(getLessonCovidZones, () => {
  test('should collect covid zones from lessons', () => {
    const lessons = [
      { covidZone: 'A' },
      { covidZone: 'A' },
      { covidZone: 'B' },
      { covidZone: 'Unknown' },
    ] as RawLesson[];

    expect(new Set(getLessonCovidZones(lessons))).toEqual(new Set(['A', 'B', 'Unknown']));
  });
});

describe(cleanModuleInfo, () => {
  test('should remove empty string requisite fields', () => {
    expect(
      cleanModuleInfo({
        acadYear: '2018/2019',
        preclusion: ' ',
        description: 'Systems Architecture deals with principles...',
        department: 'Industrial Systems Eng & Mgmt',
        faculty: 'Engineering',
        title: 'SYSTEMS ARCHITECTURE',
        workload: '3-0-0-5-2',
        moduleCredit: '4',
        moduleCode: 'SDM5001',
      }),
    ).not.toHaveProperty('Preclusion');

    expect(
      cleanModuleInfo({
        acadYear: '2018/2019',
        description: 'This module will introduce the history...',
        department: "FoL Dean's Office",
        faculty: 'Law',
        title: 'Singapore Law in Context',
        workload: '3-0-0-0-7',
        prerequisite: 'Nil.',
        moduleCredit: '4',
        moduleCode: 'LC1015',
      }),
    ).not.toHaveProperty('Prerequisite');

    const cleanedYID3216 = cleanModuleInfo({
      acadYear: '2018/2019',
      preclusion: 'None.',
      description: 'Asia is known for its fast-paced economic growth...',
      department: 'Yale-NUS College',
      faculty: 'Yale-NUS College',
      title: 'Environment, Development and Mobilisation in Asia',
      workload: '0-3-0-3-6.5',
      prerequisite:
        'YID1201 Introduction to Environmental Studies or with the permission of the instructor.',
      corequisite: 'None.',
      moduleCredit: '5',
      moduleCode: 'YID3216',
    });

    expect(cleanedYID3216).not.toHaveProperty('Preclusion');
    expect(cleanedYID3216).not.toHaveProperty('Corequisite');
  });

  test('should title case all caps titles', () => {
    expect(
      cleanModuleInfo({
        acadYear: '2018/2019',
        preclusion: ' ',
        description: 'The objective is to expose students to the...',
        department: 'Mechanical Engineering',
        faculty: 'Engineering',
        title: 'FRACTURE AND FATIGUE OF MATERIALS',
        moduleCredit: '4',
        moduleCode: 'ME5513',
      }),
    ).toHaveProperty('title', 'Fracture and Fatigue of Materials');

    expect(
      cleanModuleInfo({
        acadYear: '2018/2019',
        title: 'GRADUATE SEMINAR MODULE IN BIOLOGICAL SCIENCES',
        corequisite: 'NIL',
        moduleCode: 'BL5198',
        description: 'This is a required module for all research Masters and PhD...',
        moduleCredit: '4',
        prerequisite: 'Basic knowledge in life sciences',
        department: 'Life Sciences',
        faculty: 'Science',
      }),
    ).toHaveProperty('title', 'Graduate Seminar Module in Biological Sciences');
  });

  test('should trim titles and other fields with whitespace characters', () => {
    expect(
      cleanModuleInfo({
        acadYear: '2018/2019',
        description: 'The module covers the foundational knowledge of the sound...',
        title: ' Phonetics and Phonology',
        department: 'English Language and Literature',
        faculty: 'Arts and Social Science',
        prerequisite:
          'Must be registered as a Graduate student in the university or with the approval of the Department.  ',
        moduleCredit: '4',
        moduleCode: 'EL5102',
      }),
    ).toEqual({
      acadYear: '2018/2019',
      description: 'The module covers the foundational knowledge of the sound...',
      title: 'Phonetics and Phonology',
      department: 'English Language and Literature',
      faculty: 'Arts and Social Science',
      prerequisite:
        'Must be registered as a Graduate student in the university or with the approval of the Department.',
      moduleCredit: '4',
      moduleCode: 'EL5102',
    });
  });

  test('should decode HTML entities in description', () => {
    expect(
      cleanModuleInfo({
        acadYear: '2020/2021',
        description: 'These concepts pertain to the structure of "ultimate reality"...',
        title: 'Metaphysics',
        department: 'Philosophy',
        faculty: 'Arts and Social Science',
        moduleCredit: '4',
        moduleCode: 'PH2213',
      }),
    ).toHaveProperty(
      'description',
      'These concepts pertain to the structure of "ultimate reality"...',
    );
  });
});

describe(parseWorkload, () => {
  test('should be able to handle well formed strings', () => {
    expect(parseWorkload('2-1-0-8-2')).toEqual([2, 1, 0, 8, 2]);
    expect(parseWorkload('2-1-1-3-3')).toEqual([2, 1, 1, 3, 3]);
  });

  test('should parse decimal workloads', () => {
    expect(parseWorkload('2.5-0.5-0-3-4')).toEqual([2.5, 0.5, 0, 3, 4]);

    expect(parseWorkload('0-1-0-0-0.25')).toEqual([0, 1, 0, 0, 0.25]);

    expect(parseWorkload('0.0-0.0-0.0-20.0-0.0')).toEqual([0, 0, 0, 20, 0]);
  });

  test('should handle unusual workload strings', () => {
    // Extract all workload strings using jq
    // cat moduleInformation.json | jq '.[] | [.ModuleCode, .Workload] | join(": ")'

    // HY5660 / HY6660
    expect(parseWorkload('NA-NA-NA-NA-10')).toEqual([0, 0, 0, 0, 10]);

    // MKT3402A/B
    expect(parseWorkload('3-0-0-5-3 (tentative)')).toEqual([3, 0, 0, 5, 3]);

    expect(parseWorkload('3(sectional)-0-0-4-3')).toEqual([3, 0, 0, 4, 3]);

    // EC3343 - uses Unicode hyphen instead of dash
    expect(parseWorkload('2‐1‐0‐2‐5')).toEqual([2, 1, 0, 2, 5]);
  });

  test('parseWorkload should return input string as is if it cannot be parsed', () => {
    const invalidInputs = [
      '',
      '\n',
      '2-2-2-2-3-4', // CE1101 (six components)
      '2-4-5-4', // CE1102 (four components)
      'approximately 120 hours of independent study and research and consultation with a NUS lecturer.',
      'Varies depending on individual student with their supervisor',
      '16 weeks of industrial attachment',
      'See remarks',
      'Lectures: 450 hours, Clinics: 3150 hours, Seminars/Tutorial: 450 hours,Technique/Practical: 450 hou',
    ];

    invalidInputs.forEach((input) => {
      expect(parseWorkload(input)).toEqual(input);
    });
  });
});