Test Case, Documentation, Refactoring for `group_graph.py`

[Lancasterwu]

Description of Pull Request

Fixes #241 Fixes #263 Fixed #247

This PR provides the group_graph.py test cases, a refactored group_graph.py, and documentation using group_graph.py in README.md.

This PR contains the following:

• Delete if __name__ == "__main__": in group_graph.py
• Provide 16 test functions in test_group_graph.py to have 100% coverage on group_graph.py.
• Provide the Exception handling for def compatibility when the input measure is invalid.
• Add Docstrings and comments to better explain group_graph.py
• Documentation in README.md of how to use this feature and the theory behind it
• Added 5 new parser arguments for user to provide parameters for def group_graph_partition by using command in terminal window: objective_weights, objective_measures, preferences, preferences_weight, preferences_weight_match.
• Added 5 default values for these arguments
• Notices that --objective-weights and --objective-measures requires the user to use the list as input which is hard to do in the terminal. However, we cannot use the CSV file due to Issue #265 . One solution probably can be refactoring the code to make it read in objective-weights and objective-measures at the same time from the same CSV file.
• Fixed a bug in read_student_file.py which it was not able to read in float and string at the same time.
• Edited the pytest fixture which I used to generate CSV files so the test coverage for read_student_file.py can still be 100% after the change.
• With the fix in read_student_file.py, temp.append(record[0].replace('"', "")) seems unnessesary.

Type of Change

Please describe the pull request as one of the following:

• [x] Bug fix
• [ ] Breaking change
• [x] New feature
• [X] Documentation update
• [X] Other (Refactoring and Testing)

  Tags

@Lancasterwu @thomad74 @wattob @baldeosinghm @yeej2

[thomad74]

@wattob and I finished the test for the group_graph_partition function with the help of @Lancasterwu . The most recent commit increases code coverage of the group_graph file to 97%, and overall code coverage to 99%. The only lines remaining that are not covered are 68 and 81.

[thomad74]

I also removed the main function from the group_graph file because it is unnecessary to have at this stage.

[wattob]

The most recent commit should pass Travis

[thomad74]

The most recent commit should pass Travis

@wattob Your most recent commit does not pass Travis because of what I mentioned in my comment about the two lines that still need coverage to obtain 100%. Once we complete that, it should pass the checks!

[baldeosinghm]

@yeej2 and I have finished adding test cases for group_graph, refactoringgroup_graph, and fixing all bugs in the file. @GatorEducator/gatorgrouper @gkapfham We now have 100% total coverage for GatorGrouper!!!!!!!!!!!!

----------- coverage: platform linux, python 3.7.1-final-0 -----------
Name                                           Stmts   Miss  Cover
------------------------------------------------------------------
gatorgrouper/models.py                            83      0   100%
gatorgrouper/utils/constants.py                   10      0   100%
gatorgrouper/utils/display.py                     23      0   100%
gatorgrouper/utils/group_creation.py             101      0   100%
gatorgrouper/utils/group_graph.py                 71      0   100%
gatorgrouper/utils/group_scoring.py               16      0   100%
gatorgrouper/utils/parse_arguments.py             28      0   100%
gatorgrouper/utils/read_student_file.py           33      0   100%
gatorgrouper/utils/remove_absent_students.py      10      0   100%
------------------------------------------------------------------
TOTAL                                            375      0   100%

[Lancasterwu]

@yeej2 and I have finished adding test cases for group_graph, refactoringgroup_graph, and fixing all bugs in the file. @GatorEducator/gatorgrouper @gkapfham We currently have 100% total coverage for GatorGrouper.

----------- coverage: platform linux, python 3.7.1-final-0 -----------
Name                                           Stmts   Miss  Cover
------------------------------------------------------------------
gatorgrouper/models.py                            83      0   100%
gatorgrouper/utils/constants.py                   10      0   100%
gatorgrouper/utils/display.py                     23      0   100%
gatorgrouper/utils/group_creation.py             101      0   100%
gatorgrouper/utils/group_graph.py                 71      0   100%
gatorgrouper/utils/group_scoring.py               16      0   100%
gatorgrouper/utils/parse_arguments.py             28      0   100%
gatorgrouper/utils/read_student_file.py           33      0   100%
gatorgrouper/utils/remove_absent_students.py      10      0   100%
------------------------------------------------------------------
TOTAL                                            375      0   100%

Not really since we still need to implement group_genetic and not all Django test cases are showing on test coverage report.