Add tests to curriculum mapper functions

mathtext_fastapi/curriculum_mapper.py

@@ -5,46 +5,45 @@ import re
 from pathlib import Path
 
 
-def read_and_preprocess_spreadsheet():
-    # path = list(Path.cwd().glob('Rori_Framework_v1.xlsx'))
-    DATA_DIR = Path(__file__).parent.parent / "mathtext_fastapi" / "data" / "Rori_Framework_v1.xlsx"
+def read_and_preprocess_spreadsheet(file_name):
+    """ Creates a pandas dataframe from the curriculum overview spreadsheet """
+    DATA_DIR = Path(__file__).parent.parent / "mathtext_fastapi" / "data" / file_name
     script_df = pd.read_excel(DATA_DIR, engine='openpyxl')
+    # Ensures the grade level columns are integers instead of floats
     script_df.columns = script_df.columns[:2].tolist() + script_df.columns[2:11].astype(int).astype(str).tolist() + script_df.columns[11:].tolist()
     script_df.fillna('', inplace=True)
     return script_df
 
 
-def build_horizontal_transitions_by_row(direction, skill_code, row):
-    match_arr = []
-    sideways_transitions = []
-
-    second_match = match+1
-    if direction == 'left':
-        second_match = match-1
-
-    for i in range(9):
-        # Grade column
-        current_grade = i+1
-        if row[current_grade].lower().strip() == 'x':
-            match_arr.append(i)
-            
-    for match in match_arr:
-        if match_arr[-1] != match:
-            sideways_transitions.append([
-                direction,
-                f"{skill_code}_G{match}",
-                f"{skill_code}_G{second_match}"
-            ])
-    return sideways_transitions
+def extract_skill_code(skill):
+    """ Looks within a curricular skill description for its descriptive code
 
+    Input
+    - skill: str - a brief description of a curricular skill
 
-def extract_skill_code(skill):
+    >>> extract_skill_code('A3.3.4 - Solve inequalities')
+    'A3.3.4'
+    >>> extract_skill_code('A3.3.2 - Graph linear equations, and identify the x- and y-intercepts or the slope of a line')
+    'A3.3.2'
+    """
     pattern = r'[A-Z][0-9]\.\d+\.\d+'
     result = re.search(pattern, skill)
     return result.group()
 
 
 def build_horizontal_transitions(script_df):
+    """ Build a list of transitional relationships within a curricular skill
+
+    Inputs
+    - script_df: pandas dataframe - an overview of the curriculum skills by grade level
+
+    Output
+    - horizontal_transitions: array of arrays - transition data with label, from state, and to state
+
+    >>> script_df = read_and_preprocess_spreadsheet('curriculum_framework_for_tests.xlsx')
+    >>> build_horizontal_transitions(script_df)
+    [['right', 'N1.1.1_G1', 'N1.1.1_G2'], ['right', 'N1.1.1_G2', 'N1.1.1_G3'], ['right', 'N1.1.1_G3', 'N1.1.1_G4'], ['right', 'N1.1.1_G4', 'N1.1.1_G5'], ['right', 'N1.1.1_G5', 'N1.1.1_G6'], ['left', 'N1.1.1_G6', 'N1.1.1_G5'], ['left', 'N1.1.1_G5', 'N1.1.1_G4'], ['left', 'N1.1.1_G4', 'N1.1.1_G3'], ['left', 'N1.1.1_G3', 'N1.1.1_G2'], ['left', 'N1.1.1_G2', 'N1.1.1_G1'], ['right', 'N1.1.2_G1', 'N1.1.2_G2'], ['right', 'N1.1.2_G2', 'N1.1.2_G3'], ['right', 'N1.1.2_G3', 'N1.1.2_G4'], ['right', 'N1.1.2_G4', 'N1.1.2_G5'], ['right', 'N1.1.2_G5', 'N1.1.2_G6'], ['left', 'N1.1.2_G6', 'N1.1.2_G5'], ['left', 'N1.1.2_G5', 'N1.1.2_G4'], ['left', 'N1.1.2_G4', 'N1.1.2_G3'], ['left', 'N1.1.2_G3', 'N1.1.2_G2'], ['left', 'N1.1.2_G2', 'N1.1.2_G1']]
+    """
     horizontal_transitions = []
     for index, row in script_df.iterrows():     
         skill_code = extract_skill_code(row['Knowledge or Skill'])
@@ -82,6 +81,18 @@ def build_horizontal_transitions(script_df):
 
 
 def gather_all_vertical_matches(script_df):
+    """ Build a list of transitional relationships within a grade level across skills
+
+    Inputs
+    - script_df: pandas dataframe - an overview of the curriculum skills by grade level
+
+    Output
+    - all_matches: array of arrays - represents skills at each grade level
+
+    >>> script_df = read_and_preprocess_spreadsheet('curriculum_framework_for_tests.xlsx')
+    >>> gather_all_vertical_matches(script_df)
+    [['N1.1.1', '1'], ['N1.1.2', '1'], ['N1.1.1', '2'], ['N1.1.2', '2'], ['N1.1.1', '3'], ['N1.1.2', '3'], ['N1.1.1', '4'], ['N1.1.2', '4'], ['N1.1.1', '5'], ['N1.1.2', '5'], ['N1.1.1', '6'], ['N1.1.2', '6']]
+    """
     all_matches = []
     columns = ['1', '2', '3', '4', '5', '6', '7', '8', '9']
 
@@ -99,6 +110,18 @@ def gather_all_vertical_matches(script_df):
 
 
 def build_vertical_transitions(script_df):
+    """ Build a list of transitional relationships within a grade level across skills
+
+    Inputs
+    - script_df: pandas dataframe - an overview of the curriculum skills by grade level
+
+    Output
+    - vertical_transitions: array of arrays - transition data with label, from state, and to state
+
+    >>> script_df = read_and_preprocess_spreadsheet('curriculum_framework_for_tests.xlsx')
+    >>> build_vertical_transitions(script_df)
+    [['down', 'N1.1.1_G1', 'N1.1.2_G1'], ['down', 'N1.1.2_G1', 'N1.1.1_G1'], ['down', 'N1.1.1_G2', 'N1.1.2_G2'], ['down', 'N1.1.2_G2', 'N1.1.1_G2'], ['down', 'N1.1.1_G3', 'N1.1.2_G3'], ['down', 'N1.1.2_G3', 'N1.1.1_G3'], ['down', 'N1.1.1_G4', 'N1.1.2_G4'], ['down', 'N1.1.2_G4', 'N1.1.1_G4'], ['down', 'N1.1.1_G5', 'N1.1.2_G5'], ['down', 'N1.1.2_G5', 'N1.1.1_G5'], ['down', 'N1.1.1_G6', 'N1.1.2_G6'], ['up', 'N1.1.2_G6', 'N1.1.1_G6'], ['up', 'N1.1.1_G6', 'N1.1.2_G6'], ['up', 'N1.1.2_G5', 'N1.1.1_G5'], ['up', 'N1.1.1_G5', 'N1.1.2_G5'], ['up', 'N1.1.2_G4', 'N1.1.1_G4'], ['up', 'N1.1.1_G4', 'N1.1.2_G4'], ['up', 'N1.1.2_G3', 'N1.1.1_G3'], ['up', 'N1.1.1_G3', 'N1.1.2_G3'], ['up', 'N1.1.2_G2', 'N1.1.1_G2'], ['up', 'N1.1.1_G2', 'N1.1.2_G2'], ['up', 'N1.1.2_G1', 'N1.1.1_G1']]
+    """
     vertical_transitions = []
 
     all_matches = gather_all_vertical_matches(script_df)
@@ -129,6 +152,18 @@ def build_vertical_transitions(script_df):
 
 
 def build_all_states(all_transitions):
+    """ Creates an array with all state labels for the curriculum
+
+    Input
+    - all_transitions: list of lists - all possible up, down, left, or right transitions in curriculum
+
+    Output
+    - all_states: list - a collection of state labels (skill code and grade number)
+    
+    >>> all_transitions = [['right', 'N1.1.1_G1', 'N1.1.1_G2'], ['right', 'N1.1.1_G2', 'N1.1.1_G3'], ['right', 'N1.1.1_G3', 'N1.1.1_G4'], ['right', 'N1.1.1_G4', 'N1.1.1_G5'], ['right', 'N1.1.1_G5', 'N1.1.1_G6'], ['left', 'N1.1.1_G6', 'N1.1.1_G5'], ['left', 'N1.1.1_G5', 'N1.1.1_G4'], ['left', 'N1.1.1_G4', 'N1.1.1_G3'], ['left', 'N1.1.1_G3', 'N1.1.1_G2'], ['left', 'N1.1.1_G2', 'N1.1.1_G1'], ['right', 'N1.1.2_G1', 'N1.1.2_G2'], ['right', 'N1.1.2_G2', 'N1.1.2_G3'], ['right', 'N1.1.2_G3', 'N1.1.2_G4'], ['right', 'N1.1.2_G4', 'N1.1.2_G5'], ['right', 'N1.1.2_G5', 'N1.1.2_G6'], ['left', 'N1.1.2_G6', 'N1.1.2_G5'], ['left', 'N1.1.2_G5', 'N1.1.2_G4'], ['left', 'N1.1.2_G4', 'N1.1.2_G3'], ['left', 'N1.1.2_G3', 'N1.1.2_G2'], ['left', 'N1.1.2_G2', 'N1.1.2_G1'], ['down', 'N1.1.1_G1', 'N1.1.2_G1'], ['down', 'N1.1.2_G1', 'N1.1.1_G1'], ['down', 'N1.1.1_G2', 'N1.1.2_G2'], ['down', 'N1.1.2_G2', 'N1.1.1_G2'], ['down', 'N1.1.1_G3', 'N1.1.2_G3'], ['down', 'N1.1.2_G3', 'N1.1.1_G3'], ['down', 'N1.1.1_G4', 'N1.1.2_G4'], ['down', 'N1.1.2_G4', 'N1.1.1_G4'], ['down', 'N1.1.1_G5', 'N1.1.2_G5'], ['down', 'N1.1.2_G5', 'N1.1.1_G5'], ['down', 'N1.1.1_G6', 'N1.1.2_G6'], ['up', 'N1.1.2_G6', 'N1.1.1_G6'], ['up', 'N1.1.1_G6', 'N1.1.2_G6'], ['up', 'N1.1.2_G5', 'N1.1.1_G5'], ['up', 'N1.1.1_G5', 'N1.1.2_G5'], ['up', 'N1.1.2_G4', 'N1.1.1_G4'], ['up', 'N1.1.1_G4', 'N1.1.2_G4'], ['up', 'N1.1.2_G3', 'N1.1.1_G3'], ['up', 'N1.1.1_G3', 'N1.1.2_G3'], ['up', 'N1.1.2_G2', 'N1.1.1_G2'], ['up', 'N1.1.1_G2', 'N1.1.2_G2'], ['up', 'N1.1.2_G1', 'N1.1.1_G1']]
+    >>> build_all_states(all_transitions)
+    ['N1.1.1_G1', 'N1.1.1_G2', 'N1.1.1_G3', 'N1.1.1_G4', 'N1.1.1_G5', 'N1.1.1_G6', 'N1.1.2_G1', 'N1.1.2_G2', 'N1.1.2_G3', 'N1.1.2_G4', 'N1.1.2_G5', 'N1.1.2_G6']
+    """
     all_states = []
     for transition in all_transitions:
         for index, state in enumerate(transition):
@@ -140,7 +175,7 @@ def build_all_states(all_transitions):
 
 
 def build_curriculum_logic():
-    script_df = read_and_preprocess_spreadsheet()
+    script_df = read_and_preprocess_spreadsheet('Rori_Framework_v1.xlsx')
     horizontal_transitions = build_horizontal_transitions(script_df)
     vertical_transitions = build_vertical_transitions(script_df)
     all_transitions = horizontal_transitions + vertical_transitions

mathtext_fastapi/data/text2int_results.csv

@@ -20,10 +20,10 @@ eight oh,80.0,8.0,False
 eighty,80.0,80.0,True
 ate,8.0,1.0,False
 double eight,88.0,8.0,False
-eight three seven five three O nine,8375309.0,8375329.0,False
+eight three seven five three O nine,8375309.0,8375319.0,False
 eight three seven five three oh nine,8375309.0,8375309.0,True
 eight three seven five three zero nine,8375309.0,8375309.0,True
-eight three seven five three oh ni-ee-ine,8375309.0,837530619.0,False
+eight three seven five three oh ni-ee-ine,8375309.0,837530111.0,False
 two eight,28.0,16.0,False
 seven oh eleven,7011.0,77.0,False
 seven elevens,77.0,77.0,True
@@ -31,10 +31,10 @@ seven eleven,711.0,77.0,False
 ninety nine oh five,9905.0,149.0,False
 seven 0 seven 0 seven 0 seven,7070707.0,7070707.0,True
 123 hundred,123000.0,223.0,False
-5 o 5,505.0,525.0,False
-15 o 5,1505.0,22.0,False
-15-o 5,1505.0,22.0,False
-15 o-5,1505.0,22.0,False
+5 o 5,505.0,515.0,False
+15 o 5,1505.0,21.0,False
+15-o 5,1505.0,21.0,False
+15 o-5,1505.0,21.0,False
 911-thousand,911000.0,911000.0,True
 twenty-two twenty-two,2222.0,44.0,False
 twenty-two twenty-twos,484.0,44.0,False