E1934 - Grading Audit Trail
Introduction
Problem Statement
After an instructor gave a grade to an assignment, there is no way to track who gave the grade. A grading audit trail must be created and the following information needs to be stored:
- 1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
- 2. Comments previously provided by other instructors must also be preserved.
This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.
Currently, there are two places need to add grading audit trail:
- 1. Review grade: Log in as instructor -> Manage -> Assignments -> View Review Report
- 2. Submission grade: Log in as instructor -> Manage -> Assignments -> View submissions
Previous Work
The team that worked previously was able to achieve the task fully. They were able to create a record when the grade of a student was changed. It also recorded a timestamp with it. There were able to complete all the assigned functionalities. The issue that was found is that any TA, an instructor was able to change the grade of a student which should not have been the case.
We plan to overcome this by adding a method which checks whether the logged in instructor/TA is of the same course and then allow him to carry out the tasks.
Proposed Solution
Design
We plan to create a database called grading_history in the system which stores elements of instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
We will use MVC design to create a model, a controller, and a view for both of Review Grade and Submission Grade.
- Model: grading_history.rb. Has a list of attributes contains instructor id, assignment id, grade type, student id, grade, comment, and timestamp.
- Controller: grading_history_controller.rb. Saves a new entry into the database every time a review grade or submission grade is saved
- View: index_html.erb. Displays current submission or review's grading history. An existing example of this is a submission record in the system.
We will also need to modify grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry saves into the database.
Expected View
The list submission page with the new "grade history" option
The review report page with the new "grade history" option
Grade history for a given team
Diagram
Testing Plan
Functional testing:
1. Test if SubmissionGradeHistory.create is being called when a submission grade is changed.
spec/controllers/grades_controller_spec.rb
2. Test if ReviewGradeHistory.create is being called when a submission grade is changed.
spec/controllers/review_mapping_controller_spec.rb
3. Test if GradeHistory.where is being called when grading history button is clicked.
spec/controllers/grading_histories_controller_test.rb
Code Changes
Files to be Modified
- app/controllers/grades_controller.rb
Creates a Grading History Record for every Submission grade edited by the instructor for a Team.
- app/controllers/review_mapping_controller.rb
Creates a Grading History Record for every Review grade edited by the instructor for a Student.
- app/views/assignments/list_submissions.html.erb
Add code to support view changes for Grade Record
- app/views/review_mapping/_review_report.html.erb
Add code to support view changes for Grade Record
Files to be Added
- app/controllers/grading_histories_controller.rb
Calls the grading history view after validating Submission and Review Type.
- app/models/grading_history.rb
Model for Grading History.
- app/models/review_grading_history.rb
Model containing specifics of Review Grading History. Inherits Grading History.
- app/models/submission_grading_history.rb
Model containing specifics of Submission Grading History. Inherits Grading History.
- app/views/grading_history/index_html.erb
This is a view for grading audit trail, it will display all grading histories of a submission/review